Skip to content

Commit aec3230

Browse files
committed
docs: update root README with new Codex plugin install and migration guide
1 parent e4e127e commit aec3230

1 file changed

Lines changed: 44 additions & 87 deletions

File tree

README.md

Lines changed: 44 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -51,103 +51,52 @@ Named after the [Ralph agentic loop pattern](https://ghuntley.com/ralph/) and ev
5151

5252
### Codex
5353

54-
Codex support ships as a versioned package under `platforms/codex/`. Current package version: `4.8.4`.
54+
Smart Ralph ships as a real Codex plugin at `plugins/ralph-specum-codex/`. Version synced with the Claude Code plugin.
55+
56+
**Step 1**: Add the marketplace entry to your repo (or copy ours):
57+
58+
```json
59+
// .agents/plugins/marketplace.json
60+
{
61+
"name": "smart-ralph",
62+
"interface": { "displayName": "Smart Ralph Plugins" },
63+
"plugins": [{
64+
"name": "ralph-specum-codex",
65+
"source": { "source": "local", "path": "./plugins/ralph-specum-codex" },
66+
"policy": { "installation": "AVAILABLE" },
67+
"category": "Productivity"
68+
}]
69+
}
70+
```
5571

56-
Install the primary skill from this repo:
72+
**Step 2**: Restart Codex, open the plugin directory, install `ralph-specum-codex`.
5773

58-
Prompt to send to Codex:
74+
**Step 3** (recommended): Enable the Stop hook for automatic task execution:
5975

60-
```text
61-
Use $skill-installer to install the Smart Ralph Codex skill from repo `tzachbon/smart-ralph` at path `platforms/codex/skills/ralph-specum`.
62-
First ask whether to install globally under `$CODEX_HOME/skills` or project-local inside this repo.
63-
Before installing, check whether an existing install already has a `manifest.json` version for Smart Ralph Codex.
64-
Compare that installed version to `platforms/codex/manifest.json` in this repo.
65-
If no install exists or the versions differ, run the installer for the selected target.
66-
If the versions match, say it is already up to date and skip reinstalling.
76+
```toml
77+
# ~/.codex/config.toml
78+
[features]
79+
codex_hooks = true
6780
```
6881

69-
```bash
70-
python3 "$CODEX_HOME/skills/.system/skill-installer/scripts/install-skill-from-github.py" \
71-
--repo tzachbon/smart-ralph \
72-
--path platforms/codex/skills/ralph-specum
73-
```
82+
Without hooks, you run `$ralph-specum-implement` once per task. With hooks, the execution loop runs to completion.
7483

75-
Install the helper bundle when you want explicit skill entrypoints:
84+
**Step 4** (optional): Install agent configs from `plugins/ralph-specum-codex/agent-configs/`. See [agent-configs/README.md](plugins/ralph-specum-codex/agent-configs/README.md).
7685

77-
Prompt to send to Codex:
86+
Full installation and migration details in [`plugins/ralph-specum-codex/README.md`](plugins/ralph-specum-codex/README.md).
7887

79-
```text
80-
Use $skill-installer to install the Smart Ralph Codex skills from repo `tzachbon/smart-ralph` at these paths:
81-
- `platforms/codex/skills/ralph-specum`
82-
- `platforms/codex/skills/ralph-specum-start`
83-
- `platforms/codex/skills/ralph-specum-triage`
84-
- `platforms/codex/skills/ralph-specum-research`
85-
- `platforms/codex/skills/ralph-specum-requirements`
86-
- `platforms/codex/skills/ralph-specum-design`
87-
- `platforms/codex/skills/ralph-specum-tasks`
88-
- `platforms/codex/skills/ralph-specum-implement`
89-
- `platforms/codex/skills/ralph-specum-status`
90-
- `platforms/codex/skills/ralph-specum-switch`
91-
- `platforms/codex/skills/ralph-specum-cancel`
92-
- `platforms/codex/skills/ralph-specum-index`
93-
- `platforms/codex/skills/ralph-specum-refactor`
94-
- `platforms/codex/skills/ralph-specum-feedback`
95-
- `platforms/codex/skills/ralph-specum-help`
96-
First ask whether to install globally under `$CODEX_HOME/skills` or project-local inside this repo.
97-
Before installing, check whether an existing Smart Ralph Codex install already has a `manifest.json` version.
98-
Compare that installed version to `platforms/codex/manifest.json` in this repo.
99-
If no install exists or the versions differ, run the installer for the selected target.
100-
If the versions match, say it is already up to date and skip reinstalling.
101-
```
88+
<details>
89+
<summary>Migrating from old skills (platforms/codex/)?</summary>
10290

103-
```bash
104-
python3 "$CODEX_HOME/skills/.system/skill-installer/scripts/install-skill-from-github.py" \
105-
--repo tzachbon/smart-ralph \
106-
--path \
107-
platforms/codex/skills/ralph-specum \
108-
platforms/codex/skills/ralph-specum-start \
109-
platforms/codex/skills/ralph-specum-triage \
110-
platforms/codex/skills/ralph-specum-research \
111-
platforms/codex/skills/ralph-specum-requirements \
112-
platforms/codex/skills/ralph-specum-design \
113-
platforms/codex/skills/ralph-specum-tasks \
114-
platforms/codex/skills/ralph-specum-implement \
115-
platforms/codex/skills/ralph-specum-status \
116-
platforms/codex/skills/ralph-specum-switch \
117-
platforms/codex/skills/ralph-specum-cancel \
118-
platforms/codex/skills/ralph-specum-index \
119-
platforms/codex/skills/ralph-specum-refactor \
120-
platforms/codex/skills/ralph-specum-feedback \
121-
platforms/codex/skills/ralph-specum-help
122-
```
91+
The old `platforms/codex/` skill-installer approach is deprecated. Remove your old skill installs and switch to the plugin:
12392

124-
Upgrade prompt to send to Codex:
93+
1. Remove old skills: `rm -rf $CODEX_HOME/skills/ralph-specum*`
94+
2. Follow the plugin install steps above
95+
3. All 15 skills ship in one package now
12596

126-
```text
127-
Use $skill-installer to update the Smart Ralph Codex install from repo `tzachbon/smart-ralph`.
128-
First ask whether the current install lives globally under `$CODEX_HOME/skills` or project-local inside this repo.
129-
Check the installed Smart Ralph Codex `manifest.json` version and compare it to `platforms/codex/manifest.json` in this repo.
130-
Only if the versions differ, reinstall these paths into the selected target:
131-
- `platforms/codex/skills/ralph-specum`
132-
- `platforms/codex/skills/ralph-specum-start`
133-
- `platforms/codex/skills/ralph-specum-triage`
134-
- `platforms/codex/skills/ralph-specum-research`
135-
- `platforms/codex/skills/ralph-specum-requirements`
136-
- `platforms/codex/skills/ralph-specum-design`
137-
- `platforms/codex/skills/ralph-specum-tasks`
138-
- `platforms/codex/skills/ralph-specum-implement`
139-
- `platforms/codex/skills/ralph-specum-status`
140-
- `platforms/codex/skills/ralph-specum-switch`
141-
- `platforms/codex/skills/ralph-specum-cancel`
142-
- `platforms/codex/skills/ralph-specum-index`
143-
- `platforms/codex/skills/ralph-specum-refactor`
144-
- `platforms/codex/skills/ralph-specum-feedback`
145-
- `platforms/codex/skills/ralph-specum-help`
146-
If the versions match, say it is already up to date and do not reinstall.
147-
Then restart Codex.
148-
```
97+
See the [migration guide](plugins/ralph-specum-codex/README.md#migration-from-old-skills-platformscodex) for full details.
14998

150-
More Codex packaging details, including the package manifest at `platforms/codex/manifest.json`, live in [`platforms/codex/README.md`](platforms/codex/README.md).
99+
</details>
151100

152101
<details>
153102
<summary>Troubleshooting & alternative methods</summary>
@@ -212,7 +161,7 @@ Codex Ralph is approval-gated by default. After each spec artifact, Ralph stops
212161

213162
## Commands
214163

215-
For Codex, the equivalent public surface is the primary `$ralph-specum` skill plus the installable helper skills under `platforms/codex/skills/`.
164+
For Codex, the equivalent surface is `$ralph-specum` plus 14 helper skills installed via the `ralph-specum-codex` plugin.
216165

217166
| Command | What it does |
218167
|---------|--------------|
@@ -391,14 +340,22 @@ smart-ralph/
391340
├── .claude-plugin/
392341
│ └── marketplace.json
393342
├── plugins/
394-
│ ├── ralph-specum/ # Spec workflow (self-contained)
343+
│ ├── ralph-specum/ # Claude Code plugin (self-contained)
395344
│ │ ├── .claude-plugin/
396345
│ │ │ └── plugin.json
397346
│ │ ├── agents/ # Sub-agent definitions
398347
│ │ ├── commands/ # Slash commands
399348
│ │ ├── hooks/ # Stop watcher (controls execution loop)
400349
│ │ ├── templates/ # Spec templates
401350
│ │ └── schemas/ # Validation schemas
351+
│ ├── ralph-specum-codex/ # Codex plugin (full parity)
352+
│ │ ├── .codex-plugin/
353+
│ │ │ └── plugin.json
354+
│ │ ├── skills/ # 15 skills ($ralph-specum-*)
355+
│ │ ├── hooks/ # Stop watcher (Codex format)
356+
│ │ ├── agent-configs/ # 9 TOML bootstrap templates
357+
│ │ ├── templates/ # Spec templates
358+
│ │ └── references/ # Workflow, state, parity docs
402359
│ └── ralph-speckit/ # Spec-kit methodology
403360
│ ├── .claude-plugin/
404361
│ │ └── plugin.json

0 commit comments

Comments
 (0)