clone/codex
1
0
Fork 0
mirror of https://github.com/openai/codex.git synced 2026-05-17 09:43:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(skills): clarify plugin activation path

Browse Source
This commit is contained in:
Casey Chow
2026-05-06 16:04:19 -04:00
parent c8fc1d480b
commit 4c49182490
2 changed files with 6 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
codex-rs/skills/src/assets/samples/plugin-creator/SKILL.md
View File

@@ -46,6 +46,9 @@ python3 .agents/skills/plugin-creator/scripts/create_basic_plugin.py my-plugin -
`<parent-plugin-directory>` is the directory where the plugin folder `<plugin-name>` will be created (for example `~/code/plugins`).
Creating a plugin directory does not make the plugin usable by Codex yet. Codex can use it only
after it is sideloaded for local testing or installed through a marketplace workflow.
## What this skill creates
- If the user has not made the plugin location explicit, ask whether they want a repo-local plugin or a home-local plugin before generating marketplace entries.
@@ -148,6 +151,8 @@ python3 .agents/skills/plugin-creator/scripts/create_basic_plugin.py my-plugin -
- Outer folder name and `plugin.json` `"name"` are always the same normalized plugin name.
- Do not remove required structure; keep `.codex-plugin/plugin.json` present.
- Make clear that a newly scaffolded plugin is not usable until it is sideloaded or installed from
a marketplace.
- Prefer completing manifest metadata during scaffold creation when the value is supported by
explicit user input or strong local context.
- If a metadata value is still unknown, ask the user before replacing its placeholder; do not

2
codex-rs/skills/src/assets/samples/sideload-plugin/SKILL.md
View File

@@ -5,7 +5,7 @@ description: Install a local Codex plugin into the temporary local Codex plugin
# Sideload Plugin
Use this skill to copy a local plugin into Codex's local plugin cache so it can be tested in the current Codex installation.
Use this skill to copy a local plugin into Codex's local plugin cache so it can be tested in the current Codex installation. A plugin directory by itself is not usable by Codex; it must be sideloaded like this or installed through a marketplace workflow first.
This is a development workflow. The plugin cache is temporary runtime state under `$CODEX_HOME/plugins/cache` and can be overwritten, refreshed, deleted, or replaced by Codex at any time. Do not treat it as source storage, a publication mechanism, or a durable install location.