You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You: "The proposal looks good. Let's implement it."
106
+
107
+
AI: "Following the tasks in openspec/changes/add-user-profile-api/tasks.md:
108
+
Task 1.1: Create user profile model..."
109
+
*Implements each task systematically*
134
110
```
135
111
136
-
### 4. Track and Complete Changes
112
+
### 3. Track Your Work
137
113
138
114
```bash
139
115
# View active changes (what's being worked on)
@@ -150,12 +126,18 @@ openspec archive add-2fa
150
126
# This moves the change to archive/ and updates specs/
151
127
```
152
128
153
-
### Key Points
129
+
##Common Commands
154
130
155
-
-**You don't write spec files manually** - Your AI assistant creates them
156
-
-**Specs are living documentation** - They evolve with your code
157
-
-**Changes are proposals** - They show what will be modified before implementation
158
-
-**AI follows the specs** - Ensuring consistent, documented development
131
+
```bash
132
+
# Most used:
133
+
openspec list # See what changes you're working on
134
+
openspec archive <change># Mark a change as complete after deployment
135
+
136
+
# Also useful:
137
+
openspec diff <change># See what specs will change
138
+
openspec validate <change># Check formatting before committing
139
+
openspec show <change># View change details
140
+
```
159
141
160
142
## Example: How AI Creates OpenSpec Files
161
143
@@ -226,77 +208,42 @@ The system MUST require a second factor during login.
226
208
227
209
**Important:** You don't create these files manually. Your AI assistant generates them based on your requirements and the existing codebase.
228
210
229
-
###Understanding Delta Format
211
+
## Understanding OpenSpec Files
230
212
231
-
Deltas describe how specifications change using operation headers:
213
+
### Delta Format
232
214
233
-
-**`## ADDED Requirements`** - New capabilities being introduced
234
-
-**`## MODIFIED Requirements`** - Changes to existing behavior (include the complete modified text)
235
-
-**`## REMOVED Requirements`** - Features being deprecated (include reason and migration path)
236
-
-**`## RENAMED Requirements`** - Simple name changes
215
+
Deltas are "patches" that show how specs change:
237
216
238
-
Each delta operation contains complete requirement blocks that will be merged into the main spec. Think of deltas as "patches" that transform your current specifications into the desired state.
-**`## REMOVED Requirements`** - Deprecated features
239
220
240
-
**Critical formatting rules:**
241
-
- Use `### Requirement: <name>` for requirement headers
242
-
- Every requirement MUST include at least one `#### Scenario:` block
243
-
- Use SHALL/MUST in ADDED/MODIFIED requirement text
244
-
- MODIFIED sections must contain the complete updated requirement, not just the changes
221
+
**Format requirements:**
222
+
- Use `### Requirement: <name>` for headers
223
+
- Every requirement needs at least one `#### Scenario:` block
224
+
- Use SHALL/MUST in requirement text
245
225
246
226
247
-
## AI Integration
227
+
## Why OpenSpec Works
248
228
249
-
OpenSpec is built for AI-driven development. Your AI assistant creates and manages all specs and changes.
250
-
251
-
### The AI Workflow
252
-
253
-
1.**You describe what you want** - "Add user authentication" or "Improve performance"
254
-
2.**AI creates the change proposal** - Generates proposal.md, tasks.md, and spec deltas
255
-
3.**AI implements following specs** - Works through tasks.md systematically
256
-
4.**You deploy and archive** - Once deployed, archive the change to update specs
257
-
258
-
### How Your AI Assistant Works with OpenSpec
259
-
260
-
```markdown
261
-
// Starting a new feature:
262
-
You: "Add password reset functionality"
263
-
264
-
AI: "I'll create an OpenSpec change proposal. Let me check the current auth specs first..."
265
-
*Runs: openspec list --specs*
266
-
*Reads: openspec/specs/auth/spec.md*
267
-
*Creates: openspec/changes/add-password-reset/*
268
-
269
-
// AI automatically:
270
-
- Checks existing specs to understand current state
271
-
- Creates properly structured change proposals
272
-
- Generates spec deltas showing what's being added/modified
273
-
- Implements code following the tasks checklist
274
-
- Validates changes with openspec validate
275
-
```
276
-
277
-
### Setting Up Your AI Assistant
278
-
279
-
```bash
280
-
# After running 'openspec init', your AI is configured
281
-
# The init command:
282
-
# 1. Asks which AI tool you use (Claude Code, Cursor, etc.)
283
-
# 2. Creates the appropriate configuration files
284
-
# 3. Sets up AI-specific instructions
285
-
286
-
# To update AI configurations later:
287
-
openspec update
288
-
```
229
+
OpenSpec creates **alignment** between you and your AI coding assistant:
289
230
231
+
1.**You describe** what you want to build
232
+
2.**AI creates specs** before writing any code
233
+
3.**You review and adjust** the specifications
234
+
4.**AI implements** exactly what was specified
235
+
5.**Everyone understands** what's being built through clear specs
290
236
291
-
## Comparison with Kiro.dev
237
+
No API keys needed - OpenSpec works by adding context rules to your existing AI tools (Claude Code, Cursor, etc.).
292
238
293
-
The key difference between OpenSpec and Kiro is **change management**:
294
239
295
-
-**OpenSpec**: Groups all changes for a feature in one place (`openspec/changes/feature-name/`). You can see exactly what specs, tasks, and code need to be modified for a single feature.
240
+
## How OpenSpec Compares
296
241
297
-
-**Kiro**: Changes affect multiple specs and create tasks across different folders. When implementing a feature that touches multiple capabilities, it's harder to track what needs to be done to complete that specific feature.
242
+
### vs. Kiro.dev
243
+
OpenSpec groups all changes for a feature in one place (`openspec/changes/feature-name/`), making it easy to track what needs to be done. Kiro spreads changes across multiple spec folders, making feature tracking harder.
298
244
299
-
This makes OpenSpec better for tracking feature completion and understanding the full scope of changes.
245
+
### vs. No Specs
246
+
Without specs, AI coding assistants generate code based on vague prompts, often missing requirements or adding unwanted features. OpenSpec ensures alignment before any code is written.
0 commit comments