|
| 1 | +# Installing Spectacular for Codex |
| 2 | + |
| 3 | +Spectacular enables spec-anchored development with automatic parallel task execution in Codex CLI. |
| 4 | + |
| 5 | +## Prerequisites |
| 6 | + |
| 7 | +- **Codex CLI** installed and working |
| 8 | +- **Node.js** (for running the spectacular-codex CLI tool) |
| 9 | +- **Git** with **git-spice** installed ([installation guide](https://github.com/abhinav/git-spice#installation)) |
| 10 | +- **superpowers** plugin installed ([installation guide](https://github.com/obra/superpowers#codex-experimental)) |
| 11 | + |
| 12 | +## Installation Steps |
| 13 | + |
| 14 | +### 1. Clone Spectacular |
| 15 | + |
| 16 | +Clone the spectacular repository to `~/.codex/spectacular`: |
| 17 | + |
| 18 | +```bash |
| 19 | +git clone https://github.com/drewritter/spectacular.git ~/.codex/spectacular |
| 20 | +``` |
| 21 | + |
| 22 | +Alternatively, if you prefer a different location: |
| 23 | + |
| 24 | +```bash |
| 25 | +git clone https://github.com/drewritter/spectacular.git /path/to/spectacular |
| 26 | +``` |
| 27 | + |
| 28 | +### 2. Update AGENTS.md |
| 29 | + |
| 30 | +Add spectacular to your `~/.codex/AGENTS.md` file: |
| 31 | + |
| 32 | +```bash |
| 33 | +# Create ~/.codex/AGENTS.md if it doesn't exist |
| 34 | +mkdir -p ~/.codex |
| 35 | +touch ~/.codex/AGENTS.md |
| 36 | +``` |
| 37 | + |
| 38 | +Add the following to `~/.codex/AGENTS.md`: |
| 39 | + |
| 40 | +```markdown |
| 41 | +# Codex Agents Configuration |
| 42 | + |
| 43 | +## Superpowers |
| 44 | + |
| 45 | +run: `~/.codex/superpowers/.codex/superpowers-codex bootstrap` |
| 46 | + |
| 47 | +Follow the output from that command. |
| 48 | + |
| 49 | +## Spectacular |
| 50 | + |
| 51 | +run: `~/.codex/spectacular/.codex/spectacular-codex bootstrap` |
| 52 | + |
| 53 | +Follow the output from that command. |
| 54 | +``` |
| 55 | + |
| 56 | +**If using a custom installation path**, update the path accordingly: |
| 57 | + |
| 58 | +```markdown |
| 59 | +## Spectacular |
| 60 | + |
| 61 | +run: `/path/to/spectacular/.codex/spectacular-codex bootstrap` |
| 62 | + |
| 63 | +Follow the output from that command. |
| 64 | +``` |
| 65 | + |
| 66 | +### 3. Verify Installation |
| 67 | + |
| 68 | +Test the installation by running the bootstrap command: |
| 69 | + |
| 70 | +```bash |
| 71 | +~/.codex/spectacular/.codex/spectacular-codex bootstrap |
| 72 | +``` |
| 73 | + |
| 74 | +You should see: |
| 75 | +- List of available commands (init, spec, plan, execute) |
| 76 | +- List of available skills (decomposing-tasks, writing-specs, etc.) |
| 77 | +- Auto-loaded spectacular:using-spectacular skill |
| 78 | + |
| 79 | +### 4. Initialize Your Project |
| 80 | + |
| 81 | +In your project directory, run: |
| 82 | + |
| 83 | +```bash |
| 84 | +# From Codex CLI |
| 85 | +"Initialize spectacular for this project" |
| 86 | +``` |
| 87 | + |
| 88 | +Codex will use the `spectacular:using-spectacular` skill to guide you through: |
| 89 | +- Adding required CLAUDE.md sections |
| 90 | +- Setting up git-spice |
| 91 | +- Configuring development commands |
| 92 | + |
| 93 | +## Using Spectacular in Codex |
| 94 | + |
| 95 | +Once installed, you can use spectacular workflows in Codex: |
| 96 | + |
| 97 | +```bash |
| 98 | +# Start a Codex CLI session in your project |
| 99 | +codex |
| 100 | + |
| 101 | +# Generate feature specification |
| 102 | +"I need a spec for user authentication with magic links" |
| 103 | + |
| 104 | +# Codex will use spectacular:writing-specs skill to guide brainstorming and spec creation |
| 105 | + |
| 106 | +# Once spec exists, decompose into plan |
| 107 | +"Create an implementation plan from specs/abc123-magic-link/spec.md" |
| 108 | + |
| 109 | +# Codex will use spectacular:decomposing-tasks skill to generate plan.md |
| 110 | + |
| 111 | +# Execute the plan |
| 112 | +"Execute the plan at specs/abc123-magic-link/plan.md" |
| 113 | + |
| 114 | +# Codex will use spectacular:executing-parallel-phase and spectacular:executing-sequential-phase |
| 115 | +# skills to orchestrate parallel/sequential execution |
| 116 | +``` |
| 117 | + |
| 118 | +## How Spectacular Works in Codex |
| 119 | + |
| 120 | +**At session start:** |
| 121 | +1. Codex reads your `~/.codex/AGENTS.md` |
| 122 | +2. Runs `spectacular-codex bootstrap` |
| 123 | +3. Loads all available commands and skills |
| 124 | +4. Auto-loads the `spectacular:using-spectacular` skill |
| 125 | + |
| 126 | +**During workflows:** |
| 127 | +1. You describe what you want to do |
| 128 | +2. Codex identifies relevant spectacular skills/commands |
| 129 | +3. Codex follows the skill instructions |
| 130 | +4. Work happens in your project using git-spice and worktrees |
| 131 | + |
| 132 | +**Key difference from Claude Code:** |
| 133 | +- In Claude Code: You use `/spectacular:*` slash commands |
| 134 | +- In Codex: You describe what you want, Codex uses spectacular skills automatically |
| 135 | + |
| 136 | +## Available Commands |
| 137 | + |
| 138 | +Run `~/.codex/spectacular/.codex/spectacular-codex find-commands` to see all commands: |
| 139 | + |
| 140 | +- **init** - Initialize spectacular environment |
| 141 | +- **spec** - Generate feature specification |
| 142 | +- **plan** - Decompose spec into executable plan |
| 143 | +- **execute** - Execute plan with parallel orchestration |
| 144 | + |
| 145 | +## Available Skills |
| 146 | + |
| 147 | +Run `~/.codex/spectacular/.codex/spectacular-codex find-skills` to see all skills: |
| 148 | + |
| 149 | +- **using-spectacular** - Mandatory workflow for all spectacular projects |
| 150 | +- **writing-specs** - Feature specification generation |
| 151 | +- **decomposing-tasks** - Task breakdown and phase analysis |
| 152 | +- **executing-parallel-phase** - Parallel task orchestration |
| 153 | +- **executing-sequential-phase** - Sequential task execution |
| 154 | +- **versioning-constitutions** - Constitution evolution workflow |
| 155 | +- **using-git-spice** - Stacked branch management |
| 156 | +- And more... |
| 157 | + |
| 158 | +## Updating Spectacular |
| 159 | + |
| 160 | +To get the latest version: |
| 161 | + |
| 162 | +```bash |
| 163 | +cd ~/.codex/spectacular |
| 164 | +git pull |
| 165 | +``` |
| 166 | + |
| 167 | +Codex will notify you at session start if updates are available. |
| 168 | + |
| 169 | +## Troubleshooting |
| 170 | + |
| 171 | +### "spectacular-codex: command not found" |
| 172 | + |
| 173 | +Make sure the script is executable: |
| 174 | + |
| 175 | +```bash |
| 176 | +chmod +x ~/.codex/spectacular/.codex/spectacular-codex |
| 177 | +``` |
| 178 | + |
| 179 | +### "Skill not found" |
| 180 | + |
| 181 | +Run the bootstrap command to see available skills: |
| 182 | + |
| 183 | +```bash |
| 184 | +~/.codex/spectacular/.codex/spectacular-codex bootstrap |
| 185 | +``` |
| 186 | + |
| 187 | +### "git-spice not found" |
| 188 | + |
| 189 | +Install git-spice following [the official guide](https://github.com/abhinav/git-spice#installation). |
| 190 | + |
| 191 | +### "superpowers not found" |
| 192 | + |
| 193 | +Install superpowers first - spectacular depends on it: |
| 194 | + |
| 195 | +```bash |
| 196 | +git clone https://github.com/obra/superpowers.git ~/.codex/superpowers |
| 197 | +``` |
| 198 | + |
| 199 | +Add to `~/.codex/AGENTS.md`: |
| 200 | + |
| 201 | +```markdown |
| 202 | +## Superpowers |
| 203 | + |
| 204 | +run: `~/.codex/superpowers/.codex/superpowers-codex bootstrap` |
| 205 | + |
| 206 | +Follow the output from that command. |
| 207 | +``` |
| 208 | + |
| 209 | +## Differences from Claude Code Plugin |
| 210 | + |
| 211 | +If you've used spectacular in Claude Code, note these differences: |
| 212 | + |
| 213 | +| Claude Code | Codex | |
| 214 | +|-------------|-------| |
| 215 | +| Slash commands `/spectacular:*` | Natural language + skills | |
| 216 | +| Plugin in `~/.claude/plugins/` | Scripts in `~/.codex/spectacular/` | |
| 217 | +| Automatic skill loading | Manual skill activation via bootstrap | |
| 218 | +| Subagents via Task tool | (TBD - may need MCP wrapper) | |
| 219 | + |
| 220 | +## Next Steps |
| 221 | + |
| 222 | +1. Read `~/.codex/spectacular/README.md` for methodology overview |
| 223 | +2. Check your project has required CLAUDE.md sections |
| 224 | +3. Try the spec → plan → execute workflow |
| 225 | +4. Review generated branches with `gs log short` |
| 226 | + |
| 227 | +## Support |
| 228 | + |
| 229 | +- Report issues: https://github.com/drewritter/spectacular/issues |
| 230 | +- Documentation: https://github.com/drewritter/spectacular |
| 231 | +- superpowers: https://github.com/obra/superpowers |
0 commit comments