Skip to content

Commit 5640578

Browse files
committed
docs(codex): add usage instructions for Codex plugin
- Explain that Codex uses natural language prompts instead of slash commands - Map defaultPrompt phrases to their actions in a table - Note that specs are written to .codex/specs/ under Codex
1 parent c39367b commit 5640578

2 files changed

Lines changed: 38 additions & 0 deletions

File tree

README.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -208,6 +208,20 @@ export SPEC_AGENT_CMD='codex exec --full-auto -'
208208
bash scripts/spec-exec.sh --spec-name user-authentication
209209
```
210210

211+
#### Usage in Codex
212+
213+
Codex does not use slash commands. Instead, invoke the skill by typing one of the prompt phrases defined in the plugin manifest:
214+
215+
| What you type in Codex | What it does |
216+
| --- | --- |
217+
| `Create a spec for this feature` | Start a new spec workflow |
218+
| `Validate the current spec` | Run validation on the active spec |
219+
| `Break this design into tasks` | Regenerate tasks from the design doc |
220+
221+
You can also reference the skill by its display name, e.g. `Use Spec Driven to plan user authentication`.
222+
223+
All generated spec files live in `.codex/specs/<feature-name>/` when running under Codex.
224+
211225
## Inspiration
212226

213227
This plugin was inspired by [Kiro](https://kiro.dev)'s spec-driven development functionality. Kiro introduced the concept of structured specification workflows that guide developers through requirements gathering, design, and task breakdown before implementation.

docs/getting-started/installation.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,30 @@ Restart Claude Code after saving the file.
3333

3434
After restarting, type `/spec` in a Claude Code session. If the plugin is installed correctly, you will see the spec command activate.
3535

36+
## Codex
37+
38+
The plugin also works with Codex via the manifest at `.codex-plugin/plugin.json`.
39+
40+
### Install in Codex
41+
42+
```bash
43+
codex plugin marketplace add Habib0x0/spec-driven-plugin
44+
```
45+
46+
### Usage in Codex
47+
48+
Codex does not use slash commands. Invoke the skill by typing one of its default prompts:
49+
50+
| Prompt | Action |
51+
| --- | --- |
52+
| `Create a spec for this feature` | Start a new spec workflow |
53+
| `Validate the current spec` | Run validation on the active spec |
54+
| `Break this design into tasks` | Regenerate tasks from the design doc |
55+
56+
You can also reference the skill by its display name, e.g. `Use Spec Driven to plan user authentication`.
57+
58+
Under Codex, spec files are written to `.codex/specs/<feature-name>/`.
59+
3660
## Next steps
3761

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

0 commit comments

Comments
 (0)