Skip to content

Commit 2bd9dcd

Browse files
committed
docs(codex): document plan mode and build mode compatibility
- Add Plan Mode vs Build Mode section to installation docs - Explain spec generation works in both modes - Note that execution scripts run from terminal in Codex - Add platform comparison table (Claude Code vs Codex features) - Update README Codex section with $spec-driven: syntax and plan/build note
1 parent 3781556 commit 2bd9dcd

2 files changed

Lines changed: 39 additions & 3 deletions

File tree

README.md

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -219,15 +219,25 @@ bash scripts/spec-exec.sh --spec-name user-authentication
219219

220220
#### Usage in Codex
221221

222-
Codex does not use slash commands. Instead, invoke the skill by typing one of the prompt phrases defined in the plugin manifest:
222+
Codex commands use `$spec-driven:` prefix instead of `/`:
223223

224-
| What you type in Codex | What it does |
224+
```
225+
$spec-driven:spec user-authentication
226+
$spec-driven:spec-status
227+
$spec-driven:spec-exec
228+
```
229+
230+
You can also invoke the skill by typing one of its default prompt phrases:
231+
232+
| Prompt | Action |
225233
| --- | --- |
226234
| `Create a spec for this feature` | Start a new spec workflow |
227235
| `Validate the current spec` | Run validation on the active spec |
228236
| `Break this design into tasks` | Regenerate tasks from the design doc |
229237

230-
You can also reference the skill by its display name, e.g. `Use Spec Driven to plan user authentication`.
238+
Or reference it by display name: `Use Spec Driven to plan user authentication`.
239+
240+
**Plan mode vs build mode:** Works in both. Plan mode generates the spec for review before writing; build mode writes files directly. Implementation scripts (`spec-exec.sh`, `spec-loop.sh`) run from your terminal.
231241

232242
All generated spec files live in `.codex/specs/<feature-name>/` when running under Codex.
233243

docs/getting-started/installation.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -70,6 +70,32 @@ You can also reference the skill by its display name, e.g. `Use Spec Driven to p
7070

7171
Under Codex, spec files are written to `.codex/specs/<feature-name>/`.
7272

73+
### Plan Mode vs Build Mode
74+
75+
Codex supports two execution modes. The plugin works in both:
76+
77+
**Plan Mode (`codex --plan`)**
78+
79+
- The agent generates the full spec content (requirements, design, tasks)
80+
- Codex presents it as a plan for review — no files are written yet
81+
- Review the spec, then approve to apply it in build mode
82+
- Use this when you want to see what the spec would look like before committing
83+
84+
**Build Mode (`codex` default)**
85+
86+
- The agent generates and writes spec files directly to `.codex/specs/`
87+
- Implementation scripts (`spec-exec.sh`, `spec-loop.sh`) must be run from your terminal, not inside Codex
88+
- Use this when you want the spec created immediately and are ready to implement
89+
90+
**Key differences from Claude Code:**
91+
92+
| Feature | Claude Code | Codex |
93+
|---------|-------------|-------|
94+
| Spec generation | Writes files directly | Writes files in build mode; plans in plan mode |
95+
| Task sync | Syncs to Claude Code todo system | No native todo sync; tasks live in `tasks.md` |
96+
| Execution | `/spec-exec` and `/spec-loop` slash commands | Run `spec-exec.sh` / `spec-loop.sh` from terminal |
97+
| Spec directory | `.claude/specs/` | `.codex/specs/` |
98+
7399
## Next steps
74100

75101
- Follow the [Quick start](quick-start.md) to create your first spec

0 commit comments

Comments
 (0)