a7353aea9a
* feat(status): add --all for batch status of every active change
`openspec status --all --json` reports every active change in one
process instead of one CLI spawn (~500ms module-load) per change,
mirroring the existing `validate --all`. Emits a single
`{ changes: [ChangeStatus, ...], root }` envelope sorted by change
name; a change that fails to load contributes a per-change error entry
instead of failing the sweep. `--all` and `--change` are mutually
exclusive, honoring the --json null-shape on failure.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix(status): harden --all per adversarial review findings
- Validate --schema before the no-changes early return so a bogus
schema fails consistently whether or not any change exists.
- Text mode now exits 1 when any change fails to load (mirrors
validate --all); JSON mode still exits 0 with per-change diagnostics.
- Add tests for the --all --schema interaction (unknown schema
null-shape, override propagation, broken-metadata precedence) and
text-mode failure rendering.
- Changeset heading to "### New Features" per repo convention; add
status --all to the agent quick-reference table in docs/cli.md.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix(status): thread batch null-shape through root resolution, align sort with validate
Code-review findings on --all:
- Pass failurePayload: { changes: [] } to resolveRootForCommand so a
root-selection failure under --all --json still emits the documented
batch null-shape (siblings like list/doctor/context already do this).
- Sort with localeCompare to match validate --all's ordering for
mixed-case change names.
- Extract a shared loadStatus helper so the batch and single-change
payloads cannot drift apart.
- Changeset no longer claims exact validate --all parity (JSON exit
semantics deliberately differ).
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* refactor(status): give the --all failure null-shape a single owner
Simplify pass on the --all diff: hoist the { changes: [] } batch
null-shape into an exported BATCH_STATUS_FAILURE_PAYLOAD constant so
the root-resolution and CLI-wrapper failure paths cannot drift, replace
the conditional spread with the plain ternary the sibling call site
already uses, drop a redundant array copy before sort, and narrow the
text-mode failure counter to the boolean it actually is.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
* fix(status): point the missing-target error at --all, correct the docs
`openspec status` with neither --change nor --all listed the available
changes and named only --change, so the batch path was discoverable
only from --help. The error now offers both.
Also corrects two stale claims in the status section of docs/cli.md
that the new row sits next to: the command never prompts for a change
(it errors), and bare `openspec status` is not an interactive check.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
* test(status): assert --all carries store context like the single-change path
The batch sweep resolves the root once and threads the store id into
every entry. Nothing pinned that: a regression would have shown up only
as a wrong path inside an agent's JSON. Assert the sweep's envelope root
and per-change payload match `status --change` in a registered store.
Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
* fix(status): fail incomplete batch reports
* docs(status): clarify empty and batch output
---------
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
Co-authored-by: Clay Good <hi@claygood.com>
OpenSpec Documentation
Welcome. This is the home for everything OpenSpec.
OpenSpec helps you and your AI coding assistant agree on what to build before any code is written. You describe the change, the AI drafts a short spec and a task list, you both look at the same plan, and then the work happens. No more discovering halfway through that the AI built the wrong thing.
If you read nothing else, read these two pages:
- Getting Started: install, initialize, and ship your first change.
- How Commands Work: where you actually type
/opsx:propose(hint: in your AI chat, not the terminal). This trips up almost everyone once.
That second one matters more than it looks. OpenSpec has two halves: a command line tool you run in your terminal, and slash commands you give to your AI assistant. Knowing which is which saves you the most common moment of confusion.
The best habit to build first: when you're not sure what to build, start with
/opsx:explore. It's a no-stakes thinking partner that reads your code, weighs options, and sharpens a fuzzy idea into a concrete plan before any artifact or code exists. The Explore First guide makes the case.
Pick your path
I'm brand new. Start with Getting Started, then skim the Core Concepts at a Glance. When something feels mysterious, the FAQ and Glossary are nearby.
I have a problem but not a plan. This is the common case, and it has a dedicated answer: Explore First. Use /opsx:explore to think it through with the AI before committing to anything.
I have a big existing codebase. You don't document all of it. Using OpenSpec in an Existing Project shows how to start on real, brownfield code without boiling the ocean.
I just want to get it working. Install, run openspec init, then read How Commands Work so your first slash command lands in the right place. Or hand the setup to your assistant with the AI-assisted install prompt.
I learn by example. The Examples & Recipes page walks through real changes start to finish: a small feature, a bug fix, a refactor, an exploration.
The AI just drafted a plan — now what? Read it. Reviewing a Change shows the two-minute pass that catches a wrong turn while it's still cheap, and Writing Good Specs covers what a plan worth approving is made of.
I work on a team. OpenSpec on a Team shows how a change maps onto a branch and a pull request, and how teammates review a plan before the code.
I'm coming from the old workflow. The Migration Guide explains what changed and why, and promises your existing work is safe.
I want to bend it to my team's process. Customization covers project config, custom schemas, and shared context.
Something's broken. Troubleshooting collects the failures people actually hit, with fixes.
The whole map
Start here
| Doc | What it gives you |
|---|---|
| Getting Started | Install, initialize, and run your first change end to end |
| Explore First | Use /opsx:explore to think through an idea before you commit |
| How Commands Work | Where slash commands run, what "interactive mode" means, terminal vs chat |
| Core Concepts at a Glance | The whole mental model on one page: specs, changes, deltas, archive |
| Installation | npm, pnpm, yarn, bun, Nix, a prompt that hands setup to your AI assistant, and how to verify it worked |
Use it day to day
| Doc | What it gives you |
|---|---|
| Workflows | Common patterns and when to reach for each command |
| Examples & Recipes | Full walkthroughs of real changes, copy-pasteable |
| Writing Good Specs | What a strong requirement and scenario look like, and how to right-size a change |
| Reviewing a Change | The two-minute pass on a drafted plan before any code is written |
| OpenSpec on a Team | How changes fit branches, pull requests, and review |
| Using OpenSpec in an Existing Project | Adopting OpenSpec on a large brownfield codebase |
| Editing & Iterating on a Change | Update artifacts, go back, reconcile manual edits |
| Commands | Reference for every /opsx:* slash command |
| CLI | Reference for every openspec terminal command |
Understand it deeply
| Doc | What it gives you |
|---|---|
| Concepts | The long-form explanation of specs, changes, artifacts, schemas, and archive |
| OPSX Workflow | Why the workflow is fluid instead of phase-locked, plus an architecture deep dive |
| Glossary | Every term defined in one place |
Make it yours
| Doc | What it gives you |
|---|---|
| Customization | Project config, custom schemas, shared context |
| Multi-Language | Generate artifacts in languages other than English |
| Supported Tools | The 30+ AI tools OpenSpec integrates with, and where files land |
When you need help
| Doc | What it gives you |
|---|---|
| FAQ | Quick answers to the questions people ask most |
| Troubleshooting | Concrete fixes for concrete failures |
| Migration Guide | Moving from the legacy workflow to OPSX |
Coordinate across repos (beta)
| Doc | What it gives you |
|---|---|
| Stores: User Guide | Plan in its own repo when your work spans repos or teams |
| Agent Contract | The machine-readable CLI surfaces agents drive |
The thirty-second version
1. Install npm install -g @fission-ai/openspec@latest
2. Initialize cd your-project && openspec init
3. Explore (in your AI chat) /opsx:explore ← optional, but a great habit
4. Propose (in your AI chat) /opsx:propose add-dark-mode
5. Build (in your AI chat) /opsx:apply
6. Archive (in your AI chat) /opsx:archive
Steps 1 and 2 happen in your terminal. The rest happen in your AI assistant's chat. That split is the one thing worth memorizing, and How Commands Work explains exactly why. Step 3 is optional, but starting with /opsx:explore when you're unsure is the habit most worth forming.
Where else to get help
- Discord: discord.gg/YctCnvvshC for questions, ideas, and help.
- GitHub Issues: github.com/Fission-AI/OpenSpec/issues for bugs and feature requests.
openspec feedback "your message"sends feedback straight from your terminal (it opens a GitHub issue).
Found something in these docs that's wrong, stale, or confusing? That's a bug. Open an issue or a PR. Documentation improvements are some of the most valuable contributions you can make.