Skip to content

Commit 847aa81

Browse files
authored
revert: undo README update from init merge (premature) (Fission-AI#567)
Reverts the README documentation changes that were included in PR Fission-AI#565. These changes document features that aren't released yet. A separate PR will be opened to re-apply these changes when the package is released.
1 parent 39bebef commit 847aa81

1 file changed

Lines changed: 110 additions & 126 deletions

File tree

README.md

Lines changed: 110 additions & 126 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
</p>
2828

2929
<p align="center">
30-
<sub>🧪 <strong>OPSX Workflow</strong> — schema-driven, hackable, fluid. See <a href="docs/experimental-workflow.md">workflow docs</a> for details.</sub>
30+
<sub>🧪 <strong>New:</strong> <a href="docs/experimental-workflow.md">Experimental Workflow (OPSX)</a> — schema-driven, hackable, fluid. Iterate on workflows without code changes.</sub>
3131
</p>
3232

3333
# OpenSpec
@@ -89,26 +89,43 @@ See the full comparison in [How OpenSpec Compares](#how-openspec-compares).
8989

9090
### Supported AI Tools
9191

92-
OpenSpec generates **Agent Skills** and **/opsx:\* slash commands** for supported tools during `openspec init`.
93-
9492
<details>
95-
<summary><strong>Tools with Agent Skills + Slash Commands</strong> (click to expand)</summary>
96-
97-
These tools support the full OpenSpec workflow with skills and commands:
98-
99-
| Tool | Skills Location | Commands |
100-
|------|-----------------|----------|
101-
| **Claude Code** | `.claude/skills/` | `/opsx:new`, `/opsx:apply`, `/opsx:archive`, etc. |
102-
| **Cursor** | `.cursor/skills/` | `/opsx:*` commands via prompts |
103-
104-
Run `openspec init` and select the tools you use. Skills and commands are generated automatically.
93+
<summary><strong>Native Slash Commands</strong> (click to expand)</summary>
94+
95+
These tools have built-in OpenSpec commands. Select the OpenSpec integration when prompted.
96+
97+
| Tool | Commands |
98+
|------|----------|
99+
| **Amazon Q Developer** | `@openspec-proposal`, `@openspec-apply`, `@openspec-archive` (`.amazonq/prompts/`) |
100+
| **Antigravity** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` (`.agent/workflows/`) |
101+
| **Auggie (Augment CLI)** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` (`.augment/commands/`) |
102+
| **Claude Code** | `/openspec:proposal`, `/openspec:apply`, `/openspec:archive` |
103+
| **Cline** | Workflows in `.clinerules/workflows/` directory (`.clinerules/workflows/openspec-*.md`) |
104+
| **CodeBuddy Code (CLI)** | `/openspec:proposal`, `/openspec:apply`, `/openspec:archive` (`.codebuddy/commands/`) — see [docs](https://www.codebuddy.ai/cli) |
105+
| **Codex** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` (global: `~/.codex/prompts`, auto-installed) |
106+
| **Continue** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` (`.continue/prompts/`) |
107+
| **CoStrict** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` (`.cospec/openspec/commands/`) — see [docs](https://costrict.ai)|
108+
| **Crush** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` (`.crush/commands/openspec/`) |
109+
| **Cursor** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` |
110+
| **Factory Droid** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` (`.factory/commands/`) |
111+
| **Gemini CLI** | `/openspec:proposal`, `/openspec:apply`, `/openspec:archive` (`.gemini/commands/openspec/`) |
112+
| **GitHub Copilot** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` (`.github/prompts/`) |
113+
| **iFlow (iflow-cli)** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` (`.iflow/commands/`) |
114+
| **Kilo Code** | `/openspec-proposal.md`, `/openspec-apply.md`, `/openspec-archive.md` (`.kilocode/workflows/`) |
115+
| **OpenCode** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` |
116+
| **Qoder** | `/openspec:proposal`, `/openspec:apply`, `/openspec:archive` (`.qoder/commands/openspec/`) — see [docs](https://qoder.com) |
117+
| **Qwen Code** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` (`.qwen/commands/`) |
118+
| **RooCode** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` (`.roo/commands/`) |
119+
| **Windsurf** | `/openspec-proposal`, `/openspec-apply`, `/openspec-archive` (`.windsurf/workflows/`) |
120+
121+
Kilo Code discovers team workflows automatically. Save the generated files under `.kilocode/workflows/` and trigger them from the command palette with `/openspec-proposal.md`, `/openspec-apply.md`, or `/openspec-archive.md`.
105122

106123
</details>
107124

108125
<details>
109126
<summary><strong>AGENTS.md Compatible</strong> (click to expand)</summary>
110127

111-
Tools that support AGENTS.md can follow OpenSpec workflows by reading `openspec/AGENTS.md`. Ask them to follow the OpenSpec workflow if they need a reminder. Learn more about the [AGENTS.md convention](https://agents.md/).
128+
These tools automatically read workflow instructions from `openspec/AGENTS.md`. Ask them to follow the OpenSpec workflow if they need a reminder. Learn more about the [AGENTS.md convention](https://agents.md/).
112129

113130
| Tools |
114131
|-------|
@@ -180,139 +197,102 @@ openspec init
180197
```
181198

182199
**What happens during initialization:**
183-
- You'll see an interactive tool selector to pick AI tools (Claude Code, Cursor, etc.)
184-
- OpenSpec generates **Agent Skills** in tool-specific directories (e.g., `.claude/skills/`)
185-
- **/opsx:\* slash commands** are created for each selected tool
186-
- A `openspec/config.yaml` file is created for project configuration
187-
- The `openspec/` directory structure is created (specs, changes, archive)
188-
189-
**Legacy upgrade:** If you have files from an older OpenSpec version, init will detect them and offer to clean up automatically. Use `--force` to skip the confirmation prompt.
190-
191-
**Non-interactive mode:** For CI or scripted setups:
192-
```bash
193-
openspec init --tools claude,cursor # Specific tools
194-
openspec init --tools all # All supported tools
195-
openspec init --tools none # Skip tool setup
196-
```
200+
- You'll be prompted to pick any natively supported AI tools (Claude Code, CodeBuddy, Cursor, OpenCode, Qoder,etc.); other assistants always rely on the shared `AGENTS.md` stub
201+
- OpenSpec automatically configures slash commands for the tools you choose and always writes a managed `AGENTS.md` hand-off at the project root
202+
- A new `openspec/` directory structure is created in your project
197203

198204
**After setup:**
199-
- Run `/opsx:new` to start your first change
205+
- Primary AI tools can trigger `/openspec` workflows without additional configuration
200206
- Run `openspec list` to verify the setup and view any active changes
201-
- Restart your IDE for slash commands to take effect
202-
203-
### Optional: Configure Project Context
207+
- If your coding assistant doesn't surface the new slash commands right away, restart it. Slash commands are loaded at startup,
208+
so a fresh launch ensures they appear
204209

205-
After `openspec init`, you can customize `openspec/config.yaml` to inject project-specific context into all artifacts:
210+
### Optional: Populate Project Context
206211

207-
```yaml
208-
# openspec/config.yaml
209-
schema: spec-driven
212+
After `openspec init` completes, you'll receive a suggested prompt to help populate your project context:
210213

211-
context: |
212-
Tech stack: TypeScript, React, Node.js
213-
Testing: Vitest for unit tests
214-
Style: ESLint with Prettier
215-
216-
rules:
217-
proposal:
218-
- Include rollback plan
219-
specs:
220-
- Use Given/When/Then format for scenarios
214+
```text
215+
Populate your project context:
216+
"Please read openspec/project.md and help me fill it out with details about my project, tech stack, and conventions"
221217
```
222218

223-
This context is automatically included in artifact instructions, helping the AI understand your project's conventions.
219+
Use `openspec/project.md` to define project-level conventions, standards, architectural patterns, and other guidelines that should be followed across all changes.
224220

225221
### Create Your First Change
226222

227-
Here's a real example showing the complete OpenSpec workflow using `/opsx:*` commands.
223+
Here's a real example showing the complete OpenSpec workflow. This works with any AI tool. Those with native slash commands will recognize the shortcuts automatically.
228224

229-
#### 1. Start a New Change
230-
```text
231-
You: /opsx:new
225+
#### 1. Draft the Proposal
226+
Start by asking your AI to create a change proposal:
232227

233-
AI: What do you want to build?
234-
You: Add profile search filters by role and team
228+
```text
229+
You: Create an OpenSpec change proposal for adding profile search filters by role and team
230+
(Shortcut for tools with slash commands: /openspec:proposal Add profile search filters)
235231
236-
AI: I'll create a new change for profile filters.
237-
*Creates openspec/changes/add-profile-filters/ with proposal.md*
232+
AI: I'll create an OpenSpec change proposal for profile filters.
233+
*Scaffolds openspec/changes/add-profile-filters/ with proposal.md, tasks.md, spec deltas.*
238234
```
239235

240-
#### 2. Build Out Artifacts
241-
Use `/opsx:continue` to create artifacts one at a time, or `/opsx:ff` to fast-forward through all planning artifacts:
242-
243-
```text
244-
You: /opsx:continue
245-
246-
AI: Proposal is done. Ready to create: specs, design
247-
Which artifact should I create?
248-
You: specs
236+
#### 2. Verify & Review
237+
Check that the change was created correctly and review the proposal:
249238

250-
AI: *Creates specs with requirements and scenarios*
239+
```bash
240+
$ openspec list # Confirm the change folder exists
241+
$ openspec validate add-profile-filters # Validate spec formatting
242+
$ openspec show add-profile-filters # Review proposal, tasks, and spec delta
251243
```
252244

253-
Or fast-forward through everything:
254-
```text
255-
You: /opsx:ff add-profile-filters
245+
#### 3. Refine the Specs
246+
Iterate on the specifications until they match your needs:
256247

257-
AI: *Creates proposal → specs → design → tasks in sequence*
258-
```
248+
```text
249+
You: Can you add acceptance criteria for the role and team filters?
259250
260-
#### 3. Verify & Review
261-
```bash
262-
openspec list # Confirm the change folder exists
263-
openspec validate add-profile-filters # Validate spec formatting
264-
openspec show add-profile-filters # Review proposal, tasks, and spec delta
251+
AI: I'll update the spec delta with scenarios for role and team filters.
252+
*Edits openspec/changes/add-profile-filters/specs/profile/spec.md and tasks.md.*
265253
```
266254

267255
#### 4. Implement the Change
256+
Once specs look good, start implementation:
257+
268258
```text
269-
You: /opsx:apply
259+
You: The specs look good. Let's implement this change.
260+
(Shortcut for tools with slash commands: /openspec:apply add-profile-filters)
270261
271262
AI: I'll work through the tasks in the add-profile-filters change.
272-
*Implements tasks, marking them complete as it goes*
263+
*Implements tasks from openspec/changes/add-profile-filters/tasks.md*
264+
*Marks tasks complete: Task 1.1 ✓, Task 1.2 ✓, Task 2.1 ✓...*
273265
```
274266

275-
**Key feature:** If you discover issues during implementation, you can update specs, design, or tasks — then continue. No phase gates.
276-
277267
#### 5. Archive the Completed Change
268+
After implementation is complete, archive the change:
269+
278270
```text
279-
You: /opsx:archive
271+
AI: All tasks are complete. The implementation is ready.
272+
273+
You: Please archive the change
274+
(Shortcut for tools with slash commands: /openspec:archive add-profile-filters)
280275
281276
AI: I'll archive the add-profile-filters change.
282-
*Runs: openspec archive add-profile-filters --yes*
283-
✓ Change archived. Specs updated. Ready for the next feature!
277+
*Runs: openspec archive add-profile-filters --yes*
278+
✓ Change archived successfully. Specs updated. Ready for the next feature!
284279
```
285280

286-
Or run directly in terminal:
281+
Or run the command yourself in terminal:
287282
```bash
288-
openspec archive add-profile-filters --yes
283+
$ openspec archive add-profile-filters --yes # Archive the completed change without prompts
289284
```
290285

291-
## Command Reference
292-
293-
### Slash Commands (in your AI tool)
294-
295-
| Command | What it does |
296-
|---------|--------------|
297-
| `/opsx:explore` | Think through ideas, investigate problems, clarify requirements |
298-
| `/opsx:new` | Start a new change |
299-
| `/opsx:continue` | Create the next artifact (based on what's ready) |
300-
| `/opsx:ff` | Fast-forward — create all planning artifacts at once |
301-
| `/opsx:apply` | Implement tasks, updating artifacts as needed |
302-
| `/opsx:sync` | Sync delta specs to main specs |
303-
| `/opsx:archive` | Archive when done |
304-
| `/opsx:verify` | Verify implementation matches change artifacts |
286+
**Note:** Tools with native slash commands (Claude Code, CodeBuddy, Cursor, Codex, Qoder, RooCode) can use the shortcuts shown. All other tools work with natural language requests to "create an OpenSpec proposal", "apply the OpenSpec change", or "archive the change".
305287

306-
### CLI Commands (in terminal)
288+
## Command Reference
307289

308290
```bash
309-
openspec init # Initialize OpenSpec with skills and commands
310291
openspec list # View active change folders
311292
openspec view # Interactive dashboard of specs and changes
312293
openspec show <change> # Display change details (proposal, tasks, spec updates)
313294
openspec validate <change> # Check spec formatting and structure
314-
openspec archive <change> [--yes|-y] # Move a completed change into archive/
315-
openspec update # Refresh skills and commands for configured tools
295+
openspec archive <change> [--yes|-y] # Move a completed change into archive/ (non-interactive with --yes)
316296
```
317297

318298
## Example: How AI Creates OpenSpec Files
@@ -412,51 +392,55 @@ Without specs, AI coding assistants generate code from vague prompts, often miss
412392

413393
## Team Adoption
414394

415-
1. **Initialize OpenSpec** – Run `openspec init` in your repo and select your team's tools.
416-
2. **Start with new features** – Use `/opsx:new` to capture upcoming work as change proposals.
395+
1. **Initialize OpenSpec** – Run `openspec init` in your repo.
396+
2. **Start with new features**Ask your AI to capture upcoming work as change proposals.
417397
3. **Grow incrementally** – Each change archives into living specs that document your system.
418-
4. **Stay flexible** – Different teammates can use Claude Code, Cursor, or any AGENTS.md-compatible tool while sharing the same specs.
398+
4. **Stay flexible** – Different teammates can use Claude Code, CodeBuddy, Cursor, or any AGENTS.md-compatible tool while sharing the same specs.
419399

420-
Run `openspec update` to refresh skills and commands when upgrading OpenSpec or adding new tools.
400+
Run `openspec update` whenever someone switches tools so your agents pick up the latest instructions and slash-command bindings.
421401

422402
## Updating OpenSpec
423403

424404
1. **Upgrade the package**
425405
```bash
426406
npm install -g @fission-ai/openspec@latest
427407
```
428-
2. **Refresh skills and commands**
429-
```bash
430-
openspec update
431-
```
432-
This regenerates skills and slash commands for all configured tools.
433-
434-
3. **Restart your IDE** for slash commands to take effect.
408+
2. **Refresh agent instructions**
409+
- Run `openspec update` inside each project to regenerate AI guidance and ensure the latest slash commands are active.
435410

436-
## Workflow Customization
411+
## Experimental Features
437412

438413
<details>
439-
<summary><strong>Custom Schemas & Templates</strong></summary>
414+
<summary><strong>🧪 OPSX: Fluid, Iterative Workflow</strong> (Claude Code only)</summary>
440415

441-
OpenSpec uses a **schema-driven workflow** that you can customize:
416+
**Why this exists:**
417+
- Standard workflow is locked down — you can't tweak instructions or customize
418+
- When AI output is bad, you can't improve the prompts yourself
419+
- Same workflow for everyone, no way to match how your team works
442420

443-
**Why customize:**
421+
**What's different:**
444422
- **Hackable** — edit templates and schemas yourself, test immediately, no rebuild
445423
- **Granular** — each artifact has its own instructions, test and tweak individually
446424
- **Customizable** — define your own workflows, artifacts, and dependencies
425+
- **Fluid** — no phase gates, update any artifact anytime
447426

448-
**Built-in schemas:**
449-
- `spec-driven` (default): proposal → specs → design → tasks
450-
- `tdd`: tests → implementation → docs
427+
```
428+
You can always go back:
451429
452-
**Create custom schemas:**
453-
```bash
454-
openspec schema init my-workflow # Create new schema interactively
455-
openspec schema fork spec-driven my-workflow # Fork existing schema
456-
openspec schemas # List available schemas
430+
proposal ──→ specs ──→ design ──→ tasks ──→ implement
431+
▲ ▲ ▲ │
432+
└───────────┴──────────┴────────────────────┘
457433
```
458434

459-
Schemas are stored in `openspec/schemas/` (project) or `~/.local/share/openspec/schemas/` (global).
435+
| Command | What it does |
436+
|---------|--------------|
437+
| `/opsx:new` | Start a new change |
438+
| `/opsx:continue` | Create the next artifact (based on what's ready) |
439+
| `/opsx:ff` | Fast-forward (all planning artifacts at once) |
440+
| `/opsx:apply` | Implement tasks, updating artifacts as needed |
441+
| `/opsx:archive` | Archive when done |
442+
443+
**Setup:** `openspec experimental`
460444

461445
[Full documentation →](docs/experimental-workflow.md)
462446

0 commit comments

Comments
 (0)