mirror of
https://github.com/openai/codex.git
synced 2026-10-23 18:08:45 +00:00
refactor(skills): rename sideload plugin skill
This commit is contained in:
@@ -56,7 +56,7 @@ python3 .agents/skills/plugin-creator/scripts/create_basic_plugin.py my-plugin -
|
||||
author, homepage, repository, license, keywords, and interface fields from explicit user input
|
||||
or strong repo context; when that evidence is missing, ask the user for the value instead of
|
||||
inventing one.
|
||||
- For local testing after scaffold creation, use `plugin-sideload`; it installs the plugin into the temporary `$CODEX_HOME/plugins/cache` development cache.
|
||||
- For local testing after scaffold creation, use `sideload-plugin`; it installs the plugin into the temporary `$CODEX_HOME/plugins/cache` development cache.
|
||||
- Creates or updates `<repo-root>/.agents/plugins/marketplace.json` when `--with-marketplace` is set.
|
||||
- If the marketplace file does not exist yet, seed top-level `name` plus `interface.displayName` placeholders before adding the first plugin entry.
|
||||
- `<plugin-name>` is normalized using skill-creator naming rules:
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
interface:
|
||||
display_name: "Plugin Creator"
|
||||
short_description: "Scaffold plugins and marketplace entries"
|
||||
default_prompt: "Use $plugin-creator to scaffold a plugin with placeholder plugin.json, optional structure, and a marketplace.json entry. Fill metadata from explicit user input or strong local context, and ask rather than guess when values are unknown. Use $plugin-sideload next when the user wants to install the local plugin into the temporary Codex cache for testing."
|
||||
default_prompt: "Use $plugin-creator to scaffold a plugin with placeholder plugin.json, optional structure, and a marketplace.json entry. Fill metadata from explicit user input or strong local context, and ask rather than guess when values are unknown. Use $sideload-plugin next when the user wants to install the local plugin into the temporary Codex cache for testing."
|
||||
icon_small: "./assets/plugin-creator-small.svg"
|
||||
icon_large: "./assets/plugin-creator.png"
|
||||
|
||||
+10
-10
@@ -1,9 +1,9 @@
|
||||
---
|
||||
name: plugin-sideload
|
||||
name: sideload-plugin
|
||||
description: Install a local Codex plugin into the temporary local Codex plugin cache for development and testing. Use after plugin-creator or when a user asks to try, reinstall, refresh, or test a local plugin in Codex without publishing it.
|
||||
---
|
||||
|
||||
# Plugin Sideload
|
||||
# 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.
|
||||
|
||||
@@ -14,13 +14,13 @@ This is a development workflow. The plugin cache is temporary runtime state unde
|
||||
Install a local plugin source directory into the dev marketplace cache and enable it:
|
||||
|
||||
```bash
|
||||
python3 .agents/skills/plugin-sideload/scripts/install_plugin_to_cache.py <plugin-path>
|
||||
python3 .agents/skills/sideload-plugin/scripts/install_plugin_to_cache.py <plugin-path>
|
||||
```
|
||||
|
||||
On Windows, run the same script with the Python launcher or `python`:
|
||||
|
||||
```powershell
|
||||
py -3 .agents\skills\plugin-sideload\scripts\install_plugin_to_cache.py <plugin-path>
|
||||
py -3 .agents\skills\sideload-plugin\scripts\install_plugin_to_cache.py <plugin-path>
|
||||
```
|
||||
|
||||
The script:
|
||||
@@ -41,31 +41,31 @@ Restart Codex after installation so the refreshed plugin cache and enabled plugi
|
||||
Reinstall after editing plugin files:
|
||||
|
||||
```bash
|
||||
python3 .agents/skills/plugin-sideload/scripts/install_plugin_to_cache.py <plugin-path>
|
||||
python3 .agents/skills/sideload-plugin/scripts/install_plugin_to_cache.py <plugin-path>
|
||||
```
|
||||
|
||||
Use a custom marketplace namespace:
|
||||
|
||||
```bash
|
||||
python3 .agents/skills/plugin-sideload/scripts/install_plugin_to_cache.py <plugin-path> --marketplace debug
|
||||
python3 .agents/skills/sideload-plugin/scripts/install_plugin_to_cache.py <plugin-path> --marketplace debug
|
||||
```
|
||||
|
||||
Install to a specific cache version:
|
||||
|
||||
```bash
|
||||
python3 .agents/skills/plugin-sideload/scripts/install_plugin_to_cache.py <plugin-path> --version local
|
||||
python3 .agents/skills/sideload-plugin/scripts/install_plugin_to_cache.py <plugin-path> --version local
|
||||
```
|
||||
|
||||
Install without modifying `$CODEX_HOME/config.toml`:
|
||||
|
||||
```bash
|
||||
python3 .agents/skills/plugin-sideload/scripts/install_plugin_to_cache.py <plugin-path> --no-enable
|
||||
python3 .agents/skills/sideload-plugin/scripts/install_plugin_to_cache.py <plugin-path> --no-enable
|
||||
```
|
||||
|
||||
Use a non-default Codex home:
|
||||
|
||||
```bash
|
||||
python3 .agents/skills/plugin-sideload/scripts/install_plugin_to_cache.py <plugin-path> --codex-home <path>
|
||||
python3 .agents/skills/sideload-plugin/scripts/install_plugin_to_cache.py <plugin-path> --codex-home <path>
|
||||
```
|
||||
|
||||
## Behavior
|
||||
@@ -89,7 +89,7 @@ Use `plugin-creator` or a real marketplace workflow when the goal is to publish,
|
||||
After changing the script, run a smoke test with a temporary Codex home:
|
||||
|
||||
```bash
|
||||
python3 codex-rs/skills/src/assets/samples/plugin-sideload/scripts/install_plugin_to_cache.py \
|
||||
python3 codex-rs/skills/src/assets/samples/sideload-plugin/scripts/install_plugin_to_cache.py \
|
||||
<plugin-path> \
|
||||
--codex-home <temporary-codex-home>
|
||||
```
|
||||
+2
-2
@@ -1,4 +1,4 @@
|
||||
interface:
|
||||
display_name: "Plugin Sideload"
|
||||
display_name: "Sideload Plugin"
|
||||
short_description: "Install local plugins into the temporary Codex cache"
|
||||
default_prompt: "Use $plugin-sideload to install a local plugin into the temporary Codex plugin cache for development testing."
|
||||
default_prompt: "Use $sideload-plugin to install a local plugin into the temporary Codex plugin cache for development testing."
|
||||
Reference in New Issue
Block a user