docs: update marketplace install and plugin update instructions
This commit is contained in:
@@ -1,6 +1,6 @@
|
|||||||
# Arcana Codex Plugins
|
# Arcana Codex Plugins
|
||||||
|
|
||||||
This repository is a Codex plugin marketplace for Arcana workflows.
|
Codex plugin marketplace for reusable agent workflows.
|
||||||
|
|
||||||
## Included Plugins
|
## Included Plugins
|
||||||
|
|
||||||
@@ -11,7 +11,7 @@ This repository is a Codex plugin marketplace for Arcana workflows.
|
|||||||
Add this Git repository as a Codex marketplace:
|
Add this Git repository as a Codex marketplace:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
codex plugin marketplace add ssh://git@your-git-server/path/arcana-codex-plugins.git --ref main
|
codex plugin marketplace add dayowe/arcana-codex-plugins --ref master
|
||||||
```
|
```
|
||||||
|
|
||||||
Install the staged implementation plugin:
|
Install the staged implementation plugin:
|
||||||
@@ -41,9 +41,16 @@ plugins/
|
|||||||
|
|
||||||
## Updating
|
## Updating
|
||||||
|
|
||||||
After changing a plugin, commit and push the repository, then refresh the marketplace:
|
After pushing changes, refresh the marketplace snapshot:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
codex plugin marketplace upgrade arcana-codex-plugins
|
codex plugin marketplace upgrade arcana-codex-plugins
|
||||||
|
```
|
||||||
|
|
||||||
|
If `plugins/staged-implementation/` changed, reinstall the plugin:
|
||||||
|
|
||||||
|
```bash
|
||||||
codex plugin add staged-implementation@arcana-codex-plugins
|
codex plugin add staged-implementation@arcana-codex-plugins
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Start a new Codex session after reinstalling so updated skills are loaded.
|
||||||
|
|||||||
@@ -31,7 +31,7 @@ staged-implementation/
|
|||||||
Codex installs plugins from a marketplace catalog. To publish this from Git, put the plugin inside a marketplace repository:
|
Codex installs plugins from a marketplace catalog. To publish this from Git, put the plugin inside a marketplace repository:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
codex-plugins/
|
arcana-codex-plugins/
|
||||||
.agents/
|
.agents/
|
||||||
plugins/
|
plugins/
|
||||||
marketplace.json
|
marketplace.json
|
||||||
@@ -50,9 +50,9 @@ Example `.agents/plugins/marketplace.json`:
|
|||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "my-codex-plugins",
|
"name": "arcana-codex-plugins",
|
||||||
"interface": {
|
"interface": {
|
||||||
"displayName": "My Codex Plugins"
|
"displayName": "Arcana Codex Plugins"
|
||||||
},
|
},
|
||||||
"plugins": [
|
"plugins": [
|
||||||
{
|
{
|
||||||
@@ -76,13 +76,13 @@ Example `.agents/plugins/marketplace.json`:
|
|||||||
Add the marketplace repository:
|
Add the marketplace repository:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
codex plugin marketplace add ssh://git@your-git-server/path/codex-plugins.git --ref main
|
codex plugin marketplace add dayowe/arcana-codex-plugins --ref master
|
||||||
```
|
```
|
||||||
|
|
||||||
Install the plugin:
|
Install the plugin:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
codex plugin add staged-implementation@my-codex-plugins
|
codex plugin add staged-implementation@arcana-codex-plugins
|
||||||
```
|
```
|
||||||
|
|
||||||
Start a new Codex session after installation so the bundled skills are available.
|
Start a new Codex session after installation so the bundled skills are available.
|
||||||
@@ -126,4 +126,6 @@ Validate an individual skill:
|
|||||||
python3 /path/to/skill-creator/scripts/quick_validate.py /path/to/staged-implementation/skills/planner
|
python3 /path/to/skill-creator/scripts/quick_validate.py /path/to/staged-implementation/skills/planner
|
||||||
```
|
```
|
||||||
|
|
||||||
When updating an installed local plugin, bump or cache-bust the plugin version and reinstall it from the marketplace so Codex picks up the new files.
|
After pushing marketplace changes, run `codex plugin marketplace upgrade arcana-codex-plugins`.
|
||||||
|
|
||||||
|
If this plugin changed, reinstall it with `codex plugin add staged-implementation@arcana-codex-plugins`, then start a new Codex session so updated skills are loaded.
|
||||||
|
|||||||
Reference in New Issue
Block a user