Skip to content

Commit d7d1860

Browse files
authored
docs: realign defaults, profile workflows, and tool references (Fission-AI#746)
* docs: realign defaults, workflows, and tool references * docs: resolve Trae wording and opsx diagram alignment * chore: ignore codex workspace directory
1 parent 6a3a126 commit d7d1860

10 files changed

Lines changed: 268 additions & 153 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -153,3 +153,6 @@ result
153153
# OpenCode
154154
.opencode/
155155
opencode.json
156+
157+
# Codex
158+
.codex/

README.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Our philosophy:
3636
> [!TIP]
3737
> **New workflow now available!** We've rebuilt OpenSpec with a new artifact-guided workflow.
3838
>
39-
> Run `/opsx:onboard` to get started. → [Learn more here](docs/opsx.md)
39+
> Run `/opsx:propose "your idea"` to get started. → [Learn more here](docs/opsx.md)
4040
4141
<p align="center">
4242
Follow <a href="https://x.com/0xTab">@0xTab on X</a> for updates · Join the <a href="https://discord.gg/YctCnvvshC">OpenSpec Discord</a> for help and questions.
@@ -46,17 +46,14 @@ Our philosophy:
4646

4747
Using OpenSpec in a team? [Email here](mailto:teams@openspec.dev) for access to our Slack channel.
4848

49-
<!-- TODO: Add GIF demo of /opsx:new → /opsx:archive workflow -->
49+
<!-- TODO: Add GIF demo of /opsx:propose → /opsx:archive workflow -->
5050

5151
## See it in action
5252

5353
```text
54-
You: /opsx:new add-dark-mode
54+
You: /opsx:propose add-dark-mode
5555
AI: Created openspec/changes/add-dark-mode/
56-
Ready to create: proposal
57-
58-
You: /opsx:ff # "fast-forward" - generate all planning docs
59-
AI: ✓ proposal.md — why we're doing this, what's changing
56+
✓ proposal.md — why we're doing this, what's changing
6057
✓ specs/ — requirements and scenarios
6158
✓ design.md — technical approach
6259
✓ tasks.md — implementation checklist
@@ -101,7 +98,9 @@ cd your-project
10198
openspec init
10299
```
103100

104-
Now tell your AI: `/opsx:new <what-you-want-to-build>`
101+
Now tell your AI: `/opsx:propose <what-you-want-to-build>`
102+
103+
If you want the expanded workflow (`/opsx:new`, `/opsx:continue`, `/opsx:ff`, `/opsx:verify`, `/opsx:sync`, `/opsx:bulk-archive`, `/opsx:onboard`), select it with `openspec config profile` and apply with `openspec update`.
105104

106105
> [!NOTE]
107106
> Not sure if your tool is supported? [View the full list](docs/supported-tools.md) – we support 20+ tools and growing.

docs/cli.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CLI Reference
22

3-
The OpenSpec CLI (`openspec`) provides terminal commands for project setup, validation, status inspection, and management. These commands complement the AI slash commands (like `/opsx:new`) documented in [Commands](commands.md).
3+
The OpenSpec CLI (`openspec`) provides terminal commands for project setup, validation, status inspection, and management. These commands complement the AI slash commands (like `/opsx:propose`) documented in [Commands](commands.md).
44

55
## Summary
66

@@ -67,6 +67,8 @@ These options work with all commands:
6767

6868
Initialize OpenSpec in your project. Creates the folder structure and configures AI tool integrations.
6969

70+
Default behavior uses global config defaults: profile `core`, delivery `both`, workflows `propose, explore, apply, archive`.
71+
7072
```
7173
openspec init [path] [options]
7274
```
@@ -83,8 +85,11 @@ openspec init [path] [options]
8385
|--------|-------------|
8486
| `--tools <list>` | Configure AI tools non-interactively. Use `all`, `none`, or comma-separated list |
8587
| `--force` | Auto-cleanup legacy files without prompting |
88+
| `--profile <profile>` | Override global profile for this init run (`core` or `custom`) |
89+
90+
`--profile custom` uses whatever workflows are currently selected in global config (`openspec config profile`).
8691

87-
**Supported tools:** `amazon-q`, `antigravity`, `auggie`, `claude`, `cline`, `codex`, `codebuddy`, `continue`, `costrict`, `crush`, `cursor`, `factory`, `gemini`, `github-copilot`, `iflow`, `kilocode`, `opencode`, `qoder`, `qwen`, `roocode`, `windsurf`
92+
**Supported tool IDs (`--tools`):** `amazon-q`, `antigravity`, `auggie`, `claude`, `cline`, `codex`, `codebuddy`, `continue`, `costrict`, `crush`, `cursor`, `factory`, `gemini`, `github-copilot`, `iflow`, `kilocode`, `kiro`, `opencode`, `pi`, `qoder`, `qwen`, `roocode`, `trae`, `windsurf`
8893

8994
**Examples:**
9095

@@ -101,6 +106,9 @@ openspec init --tools claude,cursor
101106
# Configure for all supported tools
102107
openspec init --tools all
103108

109+
# Override profile for this run
110+
openspec init --profile core
111+
104112
# Skip prompts and auto-cleanup legacy files
105113
openspec init --force
106114
```
@@ -113,16 +121,17 @@ openspec/
113121
├── changes/ # Proposed changes
114122
└── config.yaml # Project configuration
115123
116-
.claude/skills/ # Claude Code skill files (if claude selected)
117-
.cursor/rules/ # Cursor rules (if cursor selected)
124+
.claude/skills/ # Claude Code skills (if claude selected)
125+
.cursor/skills/ # Cursor skills (if cursor selected)
126+
.cursor/commands/ # Cursor OPSX commands (if delivery includes commands)
118127
... (other tool configs)
119128
```
120129

121130
---
122131

123132
### `openspec update`
124133

125-
Update OpenSpec instruction files after upgrading the CLI. Re-generates AI tool configuration files.
134+
Update OpenSpec instruction files after upgrading the CLI. Re-generates AI tool configuration files using your current global profile, selected workflows, and delivery mode.
126135

127136
```
128137
openspec update [path] [options]
@@ -920,7 +929,7 @@ openspec completion uninstall
920929

921930
## Related Documentation
922931

923-
- [Commands](commands.md) - AI slash commands (`/opsx:new`, `/opsx:apply`, etc.)
932+
- [Commands](commands.md) - AI slash commands (`/opsx:propose`, `/opsx:apply`, etc.)
924933
- [Workflows](workflows.md) - Common patterns and when to use each command
925934
- [Customization](customization.md) - Create custom schemas and templates
926935
- [Getting Started](getting-started.md) - First-time setup guide

docs/commands.md

Lines changed: 61 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,70 @@ For workflow patterns and when to use each command, see [Workflows](workflows.md
66

77
## Quick Reference
88

9+
### Default Quick Path (`core` profile)
10+
911
| Command | Purpose |
1012
|---------|---------|
13+
| `/opsx:propose` | Create a change and generate planning artifacts in one step |
1114
| `/opsx:explore` | Think through ideas before committing to a change |
12-
| `/opsx:new` | Start a new change |
15+
| `/opsx:apply` | Implement tasks from the change |
16+
| `/opsx:archive` | Archive a completed change |
17+
18+
### Expanded Workflow Commands (custom workflow selection)
19+
20+
| Command | Purpose |
21+
|---------|---------|
22+
| `/opsx:new` | Start a new change scaffold |
1323
| `/opsx:continue` | Create the next artifact based on dependencies |
1424
| `/opsx:ff` | Fast-forward: create all planning artifacts at once |
15-
| `/opsx:apply` | Implement tasks from the change |
1625
| `/opsx:verify` | Validate implementation matches artifacts |
1726
| `/opsx:sync` | Merge delta specs into main specs |
18-
| `/opsx:archive` | Archive a completed change |
1927
| `/opsx:bulk-archive` | Archive multiple changes at once |
2028
| `/opsx:onboard` | Guided tutorial through the complete workflow |
2129

30+
The default global profile is `core`. To enable expanded workflow commands, run `openspec config profile`, select workflows, then run `openspec update` in your project.
31+
2232
---
2333

2434
## Command Reference
2535

36+
### `/opsx:propose`
37+
38+
Create a new change and generate planning artifacts in one step. This is the default start command in the `core` profile.
39+
40+
**Syntax:**
41+
```text
42+
/opsx:propose [change-name-or-description]
43+
```
44+
45+
**Arguments:**
46+
| Argument | Required | Description |
47+
|----------|----------|-------------|
48+
| `change-name-or-description` | No | Kebab-case name or plain-language change description |
49+
50+
**What it does:**
51+
- Creates `openspec/changes/<change-name>/`
52+
- Generates artifacts needed before implementation (for `spec-driven`: proposal, specs, design, tasks)
53+
- Stops when the change is ready for `/opsx:apply`
54+
55+
**Example:**
56+
```text
57+
You: /opsx:propose add-dark-mode
58+
59+
AI: Created openspec/changes/add-dark-mode/
60+
✓ proposal.md
61+
✓ specs/ui/spec.md
62+
✓ design.md
63+
✓ tasks.md
64+
Ready for implementation. Run /opsx:apply.
65+
```
66+
67+
**Tips:**
68+
- Use this for the fastest end-to-end path
69+
- If you want step-by-step artifact control, enable expanded workflows and use `/opsx:new` + `/opsx:continue`
70+
71+
---
72+
2673
### `/opsx:explore`
2774

2875
Think through ideas, investigate problems, and clarify requirements before committing to a change.
@@ -42,7 +89,7 @@ Think through ideas, investigate problems, and clarify requirements before commi
4289
- Investigates the codebase to answer questions
4390
- Compares options and approaches
4491
- Creates visual diagrams to clarify thinking
45-
- Can transition to `/opsx:new` when insights crystallize
92+
- Can transition to `/opsx:propose` (default) or `/opsx:new` (expanded workflow) when insights crystallize
4693

4794
**Example:**
4895
```text
@@ -66,7 +113,7 @@ AI: Let me investigate your current auth setup...
66113
67114
You: Let's go with JWT. Can we start a change for that?
68115
69-
AI: Ready when you are. Run /opsx:new add-jwt-auth to begin.
116+
AI: Ready when you are. Run /opsx:propose add-jwt-auth to begin.
70117
```
71118

72119
**Tips:**
@@ -79,7 +126,9 @@ AI: Ready when you are. Run /opsx:new add-jwt-auth to begin.
79126

80127
### `/opsx:new`
81128

82-
Start a new change. Creates the change folder structure and scaffolds it with the selected schema.
129+
Start a new change scaffold. Creates the change folder and waits for you to generate artifacts with `/opsx:continue` or `/opsx:ff`.
130+
131+
This command is part of the expanded workflow set (not included in the default `core` profile).
83132

84133
**Syntax:**
85134
```
@@ -565,13 +614,13 @@ Different AI tools use slightly different command syntax. Use the format that ma
565614

566615
| Tool | Syntax Example |
567616
|------|----------------|
568-
| Claude Code | `/opsx:new`, `/opsx:apply` |
569-
| Cursor | `/opsx-new`, `/opsx-apply` |
570-
| Windsurf | `/opsx-new`, `/opsx-apply` |
571-
| Copilot (IDE) | `/opsx-new`, `/opsx-apply` |
572-
| Trae | `/openspec-new-change`, `/openspec-apply-change` |
617+
| Claude Code | `/opsx:propose`, `/opsx:apply` |
618+
| Cursor | `/opsx-propose`, `/opsx-apply` |
619+
| Windsurf | `/opsx-propose`, `/opsx-apply` |
620+
| Copilot (IDE) | `/opsx-propose`, `/opsx-apply` |
621+
| Trae | Skill-based invocations such as `/openspec-propose`, `/openspec-apply-change` (no generated `opsx-*` command files) |
573622

574-
The functionality is identical regardless of syntax.
623+
The intent is the same across tools, but how commands are surfaced can differ by integration.
575624

576625
> **Note:** GitHub Copilot commands (`.github/prompts/*.prompt.md`) are only available in IDE extensions (VS Code, JetBrains, Visual Studio). GitHub Copilot CLI does not currently support custom prompt files — see [Supported Tools](supported-tools.md) for details and workarounds.
577626

docs/concepts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -562,13 +562,13 @@ openspec/
562562
│ OPENSPEC FLOW │
563563
│ │
564564
│ ┌────────────────┐ │
565-
│ │ 1. START │ /opsx:new creates a change folder
565+
│ │ 1. START │ /opsx:propose (core) or /opsx:new (expanded)
566566
│ │ CHANGE │ │
567567
│ └───────┬────────┘ │
568568
│ │ │
569569
│ ▼ │
570570
│ ┌────────────────┐ │
571-
│ │ 2. CREATE │ /opsx:ff or /opsx:continue
571+
│ │ 2. CREATE │ /opsx:ff or /opsx:continue (expanded workflow)
572572
│ │ ARTIFACTS │ Creates proposal → specs → design → tasks │
573573
│ │ │ (based on schema dependencies) │
574574
│ └───────┬────────┘ │

docs/getting-started.md

Lines changed: 20 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -4,33 +4,22 @@ This guide explains how OpenSpec works after you've installed and initialized it
44

55
## How It Works
66

7-
OpenSpec helps you and your AI coding assistant agree on what to build before any code is written. The workflow follows a simple pattern:
7+
OpenSpec helps you and your AI coding assistant agree on what to build before any code is written.
88

9+
**Default quick path (core profile):**
10+
11+
```text
12+
/opsx:propose ──► /opsx:apply ──► /opsx:archive
913
```
10-
┌────────────────────┐
11-
│ Start a Change │ /opsx:new
12-
└────────┬───────────┘
13-
14-
15-
┌────────────────────┐
16-
│ Create Artifacts │ /opsx:ff or /opsx:continue
17-
│ (proposal, specs, │
18-
│ design, tasks) │
19-
└────────┬───────────┘
20-
21-
22-
┌────────────────────┐
23-
│ Implement Tasks │ /opsx:apply
24-
│ (AI writes code) │
25-
└────────┬───────────┘
26-
27-
28-
┌────────────────────┐
29-
│ Archive & Merge │ /opsx:archive
30-
│ Specs │
31-
└────────────────────┘
14+
15+
**Expanded path (custom workflow selection):**
16+
17+
```text
18+
/opsx:new ──► /opsx:ff or /opsx:continue ──► /opsx:apply ──► /opsx:verify ──► /opsx:archive
3219
```
3320

21+
The default global profile is `core`, which includes `propose`, `explore`, `apply`, and `archive`. You can enable the expanded workflow commands with `openspec config profile` and then `openspec update`.
22+
3423
## What OpenSpec Creates
3524

3625
After running `openspec init`, your project has this structure:
@@ -131,31 +120,22 @@ The change folder moves to `openspec/changes/archive/` for audit history.
131120

132121
Let's walk through adding dark mode to an application.
133122

134-
### 1. Start the Change
123+
### 1. Start the Change (Default)
135124

136-
```
137-
You: /opsx:new add-dark-mode
125+
```text
126+
You: /opsx:propose add-dark-mode
138127
139128
AI: Created openspec/changes/add-dark-mode/
140-
Ready to create: proposal
141-
```
142-
143-
### 2. Create Artifacts
144-
145-
Use `/opsx:ff` (fast-forward) to create all planning artifacts at once:
146-
147-
```
148-
You: /opsx:ff
149-
150-
AI: Creating artifacts for add-dark-mode...
151129
✓ proposal.md — why we're doing this, what's changing
152130
✓ specs/ — requirements and scenarios
153131
✓ design.md — technical approach
154132
✓ tasks.md — implementation checklist
155133
Ready for implementation!
156134
```
157135

158-
### 3. What Gets Created
136+
If you've enabled the expanded workflow profile, you can also do this as two steps: `/opsx:new` then `/opsx:ff` (or `/opsx:continue` incrementally).
137+
138+
### 2. What Gets Created
159139

160140
**proposal.md** - Captures the intent:
161141

@@ -218,7 +198,7 @@ The system SHALL allow users to choose between light and dark themes.
218198
- [ ] 3.2 Update components to use CSS variables
219199
```
220200

221-
### 4. Implement
201+
### 3. Implement
222202

223203
```
224204
You: /opsx:apply
@@ -234,7 +214,7 @@ AI: Working through tasks...
234214

235215
During implementation, if you discover the design needs adjustment, just update the artifact and continue.
236216

237-
### 5. Archive
217+
### 4. Archive
238218

239219
```
240220
You: /opsx:archive

0 commit comments

Comments
 (0)