Skip to content

Commit 0080c9d

Browse files
committed
docs: refactor codex plugin README with update instructions and clarity improvements
1 parent cd7bddf commit 0080c9d

1 file changed

Lines changed: 27 additions & 13 deletions

File tree

plugins/codex/README.md

Lines changed: 27 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,11 @@ Spec-driven development plugin for OpenAI Codex. Full parity with the Claude Cod
44

55
Transforms feature requests into structured specs (research, requirements, design, tasks) then executes them task-by-task with fresh context per task.
66

7+
## Prerequisites
8+
9+
- [OpenAI Codex CLI](https://github.com/openai/codex) installed: `npm install -g @openai/codex`
10+
- A ChatGPT account (Plus, Pro, Team, Edu, or Enterprise) or an OpenAI API key
11+
712
## Installation
813

914
Pick one of these two methods.
@@ -32,8 +37,6 @@ cat > ~/.agents/plugins/marketplace.json << 'EOF'
3237
EOF
3338
```
3439

35-
Restart Codex. Open the plugin directory. Install `ralph-specum`.
36-
3740
### Per-project install (one repo only)
3841

3942
```bash
@@ -58,7 +61,7 @@ EOF
5861
rm -rf /tmp/smart-ralph
5962
```
6063

61-
Restart Codex. Open the plugin directory. Install `ralph-specum`.
64+
After either method: restart Codex, open the plugin directory, and install `ralph-specum`.
6265

6366
### Enable hooks (recommended)
6467

@@ -71,7 +74,24 @@ codex_hooks = true
7174

7275
Without hooks, you run `$ralph-specum-implement` once per task manually (see `references/workflow.md` for the fallback workflow).
7376

74-
### Agent configs (optional)
77+
## Updating
78+
79+
Re-run the install steps to pull the latest version:
80+
81+
```bash
82+
rm -rf /tmp/smart-ralph
83+
git clone https://github.com/tzachbon/smart-ralph.git /tmp/smart-ralph
84+
cp -R /tmp/smart-ralph/plugins/codex ~/.codex/plugins/codex
85+
rm -rf /tmp/smart-ralph
86+
```
87+
88+
For per-project installs, replace `~/.codex/plugins/codex` with `./plugins/codex`.
89+
90+
Check your version in `.codex-plugin/plugin.json`. Compare against the [latest release](https://github.com/tzachbon/smart-ralph/releases).
91+
92+
Restart Codex after updating.
93+
94+
## Agent configs (optional)
7595

7696
Copy templates from `agent-configs/*.toml.template` into your `.codex/config.toml` for specialized subagents. See `agent-configs/README.md`.
7797

@@ -82,11 +102,7 @@ If you previously installed Ralph Specum skills from `platforms/codex/skills/` v
82102
### Step 1: Remove old skills
83103

84104
```bash
85-
# Remove each old skill (adjust path for your install location)
86-
for skill in ralph-specum ralph-specum-start ralph-specum-triage ralph-specum-research ralph-specum-requirements ralph-specum-design ralph-specum-tasks ralph-specum-implement ralph-specum-status ralph-specum-switch ralph-specum-cancel ralph-specum-index ralph-specum-refactor ralph-specum-feedback ralph-specum-help; do
87-
rm -rf "$CODEX_HOME/skills/$skill" 2>/dev/null
88-
rm -rf "$HOME/.codex/skills/$skill" 2>/dev/null
89-
done
105+
rm -rf ~/.codex/skills/ralph-specum*
90106
```
91107

92108
### Step 2: Install the new plugin
@@ -111,7 +127,7 @@ Run `$ralph-specum-status` to confirm the plugin is active and can find your spe
111127
| Manual skill updates | Plugin version tracking |
112128
| Skills at `platforms/codex/skills/` | Plugin at `plugins/codex/` |
113129

114-
## What Ships
130+
## Skills Reference
115131

116132
| Skill | Description |
117133
|-------|-------------|
@@ -153,6 +169,4 @@ This starts the spec-driven workflow: research, requirements, design, tasks, the
153169

154170
## Version
155171

156-
Current version: 4.9.1 (synced with Claude Code plugin)
157-
158-
Package manifest: `.codex-plugin/plugin.json`
172+
Check `.codex-plugin/plugin.json` for the current version.

0 commit comments

Comments
 (0)