@dccxx/auggiegw 1.0.25 → 1.0.26
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.opencode/command/opsx-apply.md +149 -0
- package/.opencode/command/opsx-archive.md +154 -0
- package/.opencode/command/opsx-bulk-archive.md +239 -0
- package/.opencode/command/opsx-continue.md +111 -0
- package/.opencode/command/opsx-explore.md +171 -0
- package/.opencode/command/opsx-ff.md +91 -0
- package/.opencode/command/opsx-new.md +66 -0
- package/.opencode/command/opsx-onboard.md +522 -0
- package/.opencode/command/opsx-sync.md +131 -0
- package/.opencode/command/opsx-verify.md +161 -0
- package/.opencode/skills/openspec-apply-change/SKILL.md +156 -0
- package/.opencode/skills/openspec-archive-change/SKILL.md +114 -0
- package/.opencode/skills/openspec-bulk-archive-change/SKILL.md +246 -0
- package/.opencode/skills/openspec-continue-change/SKILL.md +118 -0
- package/.opencode/skills/openspec-explore/SKILL.md +290 -0
- package/.opencode/skills/openspec-ff-change/SKILL.md +101 -0
- package/.opencode/skills/openspec-new-change/SKILL.md +74 -0
- package/.opencode/skills/openspec-onboard/SKILL.md +529 -0
- package/.opencode/skills/openspec-sync-specs/SKILL.md +138 -0
- package/.opencode/skills/openspec-verify-change/SKILL.md +168 -0
- package/dist/cli.js +1171 -71
- package/openspec/changes/archive/2026-02-01-add-kit-install-prompts/.openspec.yaml +2 -0
- package/openspec/changes/archive/2026-02-01-add-kit-install-prompts/design.md +113 -0
- package/openspec/changes/archive/2026-02-01-add-kit-install-prompts/proposal.md +28 -0
- package/openspec/changes/archive/2026-02-01-add-kit-install-prompts/specs/kit-command/spec.md +107 -0
- package/openspec/changes/archive/2026-02-01-add-kit-install-prompts/specs/kit-install-prompts/spec.md +90 -0
- package/openspec/changes/archive/2026-02-01-add-kit-install-prompts/tasks.md +62 -0
- package/openspec/changes/archive/2026-02-01-add-opencode-agent-support/.openspec.yaml +2 -0
- package/openspec/changes/archive/2026-02-01-add-opencode-agent-support/design.md +131 -0
- package/openspec/changes/archive/2026-02-01-add-opencode-agent-support/proposal.md +35 -0
- package/openspec/changes/archive/2026-02-01-add-opencode-agent-support/specs/kit-command/spec.md +157 -0
- package/openspec/changes/archive/2026-02-01-add-opencode-agent-support/specs/opencode-agent-support/spec.md +65 -0
- package/openspec/changes/archive/2026-02-01-add-opencode-agent-support/tasks.md +54 -0
- package/openspec/config.yaml +20 -0
- package/package.json +2 -1
- package/specs/kit-command/spec.md +157 -0
- package/specs/kit-install-prompts/spec.md +90 -0
- package/specs/opencode-agent-support/spec.md +65 -0
|
@@ -0,0 +1,529 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: openspec-onboard
|
|
3
|
+
description: Guided onboarding for OpenSpec - walk through a complete workflow cycle with narration and real codebase work.
|
|
4
|
+
license: MIT
|
|
5
|
+
compatibility: Requires openspec CLI.
|
|
6
|
+
metadata:
|
|
7
|
+
author: openspec
|
|
8
|
+
version: "1.0"
|
|
9
|
+
generatedBy: "1.1.1"
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
Guide the user through their first complete OpenSpec workflow cycle. This is a teaching experience—you'll do real work in their codebase while explaining each step.
|
|
13
|
+
|
|
14
|
+
---
|
|
15
|
+
|
|
16
|
+
## Preflight
|
|
17
|
+
|
|
18
|
+
Before starting, check if OpenSpec is initialized:
|
|
19
|
+
|
|
20
|
+
```bash
|
|
21
|
+
openspec status --json 2>&1 || echo "NOT_INITIALIZED"
|
|
22
|
+
```
|
|
23
|
+
|
|
24
|
+
**If not initialized:**
|
|
25
|
+
> OpenSpec isn't set up in this project yet. Run `openspec init` first, then come back to `/opsx-onboard`.
|
|
26
|
+
|
|
27
|
+
Stop here if not initialized.
|
|
28
|
+
|
|
29
|
+
---
|
|
30
|
+
|
|
31
|
+
## Phase 1: Welcome
|
|
32
|
+
|
|
33
|
+
Display:
|
|
34
|
+
|
|
35
|
+
```
|
|
36
|
+
## Welcome to OpenSpec!
|
|
37
|
+
|
|
38
|
+
I'll walk you through a complete change cycle—from idea to implementation—using a real task in your codebase. Along the way, you'll learn the workflow by doing it.
|
|
39
|
+
|
|
40
|
+
**What we'll do:**
|
|
41
|
+
1. Pick a small, real task in your codebase
|
|
42
|
+
2. Explore the problem briefly
|
|
43
|
+
3. Create a change (the container for our work)
|
|
44
|
+
4. Build the artifacts: proposal → specs → design → tasks
|
|
45
|
+
5. Implement the tasks
|
|
46
|
+
6. Archive the completed change
|
|
47
|
+
|
|
48
|
+
**Time:** ~15-20 minutes
|
|
49
|
+
|
|
50
|
+
Let's start by finding something to work on.
|
|
51
|
+
```
|
|
52
|
+
|
|
53
|
+
---
|
|
54
|
+
|
|
55
|
+
## Phase 2: Task Selection
|
|
56
|
+
|
|
57
|
+
### Codebase Analysis
|
|
58
|
+
|
|
59
|
+
Scan the codebase for small improvement opportunities. Look for:
|
|
60
|
+
|
|
61
|
+
1. **TODO/FIXME comments** - Search for `TODO`, `FIXME`, `HACK`, `XXX` in code files
|
|
62
|
+
2. **Missing error handling** - `catch` blocks that swallow errors, risky operations without try-catch
|
|
63
|
+
3. **Functions without tests** - Cross-reference `src/` with test directories
|
|
64
|
+
4. **Type issues** - `any` types in TypeScript files (`: any`, `as any`)
|
|
65
|
+
5. **Debug artifacts** - `console.log`, `console.debug`, `debugger` statements in non-debug code
|
|
66
|
+
6. **Missing validation** - User input handlers without validation
|
|
67
|
+
|
|
68
|
+
Also check recent git activity:
|
|
69
|
+
```bash
|
|
70
|
+
git log --oneline -10 2>/dev/null || echo "No git history"
|
|
71
|
+
```
|
|
72
|
+
|
|
73
|
+
### Present Suggestions
|
|
74
|
+
|
|
75
|
+
From your analysis, present 3-4 specific suggestions:
|
|
76
|
+
|
|
77
|
+
```
|
|
78
|
+
## Task Suggestions
|
|
79
|
+
|
|
80
|
+
Based on scanning your codebase, here are some good starter tasks:
|
|
81
|
+
|
|
82
|
+
**1. [Most promising task]**
|
|
83
|
+
Location: `src/path/to/file.ts:42`
|
|
84
|
+
Scope: ~1-2 files, ~20-30 lines
|
|
85
|
+
Why it's good: [brief reason]
|
|
86
|
+
|
|
87
|
+
**2. [Second task]**
|
|
88
|
+
Location: `src/another/file.ts`
|
|
89
|
+
Scope: ~1 file, ~15 lines
|
|
90
|
+
Why it's good: [brief reason]
|
|
91
|
+
|
|
92
|
+
**3. [Third task]**
|
|
93
|
+
Location: [location]
|
|
94
|
+
Scope: [estimate]
|
|
95
|
+
Why it's good: [brief reason]
|
|
96
|
+
|
|
97
|
+
**4. Something else?**
|
|
98
|
+
Tell me what you'd like to work on.
|
|
99
|
+
|
|
100
|
+
Which task interests you? (Pick a number or describe your own)
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
**If nothing found:** Fall back to asking what the user wants to build:
|
|
104
|
+
> I didn't find obvious quick wins in your codebase. What's something small you've been meaning to add or fix?
|
|
105
|
+
|
|
106
|
+
### Scope Guardrail
|
|
107
|
+
|
|
108
|
+
If the user picks or describes something too large (major feature, multi-day work):
|
|
109
|
+
|
|
110
|
+
```
|
|
111
|
+
That's a valuable task, but it's probably larger than ideal for your first OpenSpec run-through.
|
|
112
|
+
|
|
113
|
+
For learning the workflow, smaller is better—it lets you see the full cycle without getting stuck in implementation details.
|
|
114
|
+
|
|
115
|
+
**Options:**
|
|
116
|
+
1. **Slice it smaller** - What's the smallest useful piece of [their task]? Maybe just [specific slice]?
|
|
117
|
+
2. **Pick something else** - One of the other suggestions, or a different small task?
|
|
118
|
+
3. **Do it anyway** - If you really want to tackle this, we can. Just know it'll take longer.
|
|
119
|
+
|
|
120
|
+
What would you prefer?
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
Let the user override if they insist—this is a soft guardrail.
|
|
124
|
+
|
|
125
|
+
---
|
|
126
|
+
|
|
127
|
+
## Phase 3: Explore Demo
|
|
128
|
+
|
|
129
|
+
Once a task is selected, briefly demonstrate explore mode:
|
|
130
|
+
|
|
131
|
+
```
|
|
132
|
+
Before we create a change, let me quickly show you **explore mode**—it's how you think through problems before committing to a direction.
|
|
133
|
+
```
|
|
134
|
+
|
|
135
|
+
Spend 1-2 minutes investigating the relevant code:
|
|
136
|
+
- Read the file(s) involved
|
|
137
|
+
- Draw a quick ASCII diagram if it helps
|
|
138
|
+
- Note any considerations
|
|
139
|
+
|
|
140
|
+
```
|
|
141
|
+
## Quick Exploration
|
|
142
|
+
|
|
143
|
+
[Your brief analysis—what you found, any considerations]
|
|
144
|
+
|
|
145
|
+
┌─────────────────────────────────────────┐
|
|
146
|
+
│ [Optional: ASCII diagram if helpful] │
|
|
147
|
+
└─────────────────────────────────────────┘
|
|
148
|
+
|
|
149
|
+
Explore mode (`/opsx-explore`) is for this kind of thinking—investigating before implementing. You can use it anytime you need to think through a problem.
|
|
150
|
+
|
|
151
|
+
Now let's create a change to hold our work.
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
**PAUSE** - Wait for user acknowledgment before proceeding.
|
|
155
|
+
|
|
156
|
+
---
|
|
157
|
+
|
|
158
|
+
## Phase 4: Create the Change
|
|
159
|
+
|
|
160
|
+
**EXPLAIN:**
|
|
161
|
+
```
|
|
162
|
+
## Creating a Change
|
|
163
|
+
|
|
164
|
+
A "change" in OpenSpec is a container for all the thinking and planning around a piece of work. It lives in `openspec/changes/<name>/` and holds your artifacts—proposal, specs, design, tasks.
|
|
165
|
+
|
|
166
|
+
Let me create one for our task.
|
|
167
|
+
```
|
|
168
|
+
|
|
169
|
+
**DO:** Create the change with a derived kebab-case name:
|
|
170
|
+
```bash
|
|
171
|
+
openspec new change "<derived-name>"
|
|
172
|
+
```
|
|
173
|
+
|
|
174
|
+
**SHOW:**
|
|
175
|
+
```
|
|
176
|
+
Created: `openspec/changes/<name>/`
|
|
177
|
+
|
|
178
|
+
The folder structure:
|
|
179
|
+
```
|
|
180
|
+
openspec/changes/<name>/
|
|
181
|
+
├── proposal.md ← Why we're doing this (empty, we'll fill it)
|
|
182
|
+
├── design.md ← How we'll build it (empty)
|
|
183
|
+
├── specs/ ← Detailed requirements (empty)
|
|
184
|
+
└── tasks.md ← Implementation checklist (empty)
|
|
185
|
+
```
|
|
186
|
+
|
|
187
|
+
Now let's fill in the first artifact—the proposal.
|
|
188
|
+
```
|
|
189
|
+
|
|
190
|
+
---
|
|
191
|
+
|
|
192
|
+
## Phase 5: Proposal
|
|
193
|
+
|
|
194
|
+
**EXPLAIN:**
|
|
195
|
+
```
|
|
196
|
+
## The Proposal
|
|
197
|
+
|
|
198
|
+
The proposal captures **why** we're making this change and **what** it involves at a high level. It's the "elevator pitch" for the work.
|
|
199
|
+
|
|
200
|
+
I'll draft one based on our task.
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
**DO:** Draft the proposal content (don't save yet):
|
|
204
|
+
|
|
205
|
+
```
|
|
206
|
+
Here's a draft proposal:
|
|
207
|
+
|
|
208
|
+
---
|
|
209
|
+
|
|
210
|
+
## Why
|
|
211
|
+
|
|
212
|
+
[1-2 sentences explaining the problem/opportunity]
|
|
213
|
+
|
|
214
|
+
## What Changes
|
|
215
|
+
|
|
216
|
+
[Bullet points of what will be different]
|
|
217
|
+
|
|
218
|
+
## Capabilities
|
|
219
|
+
|
|
220
|
+
### New Capabilities
|
|
221
|
+
- `<capability-name>`: [brief description]
|
|
222
|
+
|
|
223
|
+
### Modified Capabilities
|
|
224
|
+
<!-- If modifying existing behavior -->
|
|
225
|
+
|
|
226
|
+
## Impact
|
|
227
|
+
|
|
228
|
+
- `src/path/to/file.ts`: [what changes]
|
|
229
|
+
- [other files if applicable]
|
|
230
|
+
|
|
231
|
+
---
|
|
232
|
+
|
|
233
|
+
Does this capture the intent? I can adjust before we save it.
|
|
234
|
+
```
|
|
235
|
+
|
|
236
|
+
**PAUSE** - Wait for user approval/feedback.
|
|
237
|
+
|
|
238
|
+
After approval, save the proposal:
|
|
239
|
+
```bash
|
|
240
|
+
openspec instructions proposal --change "<name>" --json
|
|
241
|
+
```
|
|
242
|
+
Then write the content to `openspec/changes/<name>/proposal.md`.
|
|
243
|
+
|
|
244
|
+
```
|
|
245
|
+
Proposal saved. This is your "why" document—you can always come back and refine it as understanding evolves.
|
|
246
|
+
|
|
247
|
+
Next up: specs.
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
---
|
|
251
|
+
|
|
252
|
+
## Phase 6: Specs
|
|
253
|
+
|
|
254
|
+
**EXPLAIN:**
|
|
255
|
+
```
|
|
256
|
+
## Specs
|
|
257
|
+
|
|
258
|
+
Specs define **what** we're building in precise, testable terms. They use a requirement/scenario format that makes expected behavior crystal clear.
|
|
259
|
+
|
|
260
|
+
For a small task like this, we might only need one spec file.
|
|
261
|
+
```
|
|
262
|
+
|
|
263
|
+
**DO:** Create the spec file:
|
|
264
|
+
```bash
|
|
265
|
+
mkdir -p openspec/changes/<name>/specs/<capability-name>
|
|
266
|
+
```
|
|
267
|
+
|
|
268
|
+
Draft the spec content:
|
|
269
|
+
|
|
270
|
+
```
|
|
271
|
+
Here's the spec:
|
|
272
|
+
|
|
273
|
+
---
|
|
274
|
+
|
|
275
|
+
## ADDED Requirements
|
|
276
|
+
|
|
277
|
+
### Requirement: <Name>
|
|
278
|
+
|
|
279
|
+
<Description of what the system should do>
|
|
280
|
+
|
|
281
|
+
#### Scenario: <Scenario name>
|
|
282
|
+
|
|
283
|
+
- **WHEN** <trigger condition>
|
|
284
|
+
- **THEN** <expected outcome>
|
|
285
|
+
- **AND** <additional outcome if needed>
|
|
286
|
+
|
|
287
|
+
---
|
|
288
|
+
|
|
289
|
+
This format—WHEN/THEN/AND—makes requirements testable. You can literally read them as test cases.
|
|
290
|
+
```
|
|
291
|
+
|
|
292
|
+
Save to `openspec/changes/<name>/specs/<capability>/spec.md`.
|
|
293
|
+
|
|
294
|
+
---
|
|
295
|
+
|
|
296
|
+
## Phase 7: Design
|
|
297
|
+
|
|
298
|
+
**EXPLAIN:**
|
|
299
|
+
```
|
|
300
|
+
## Design
|
|
301
|
+
|
|
302
|
+
The design captures **how** we'll build it—technical decisions, tradeoffs, approach.
|
|
303
|
+
|
|
304
|
+
For small changes, this might be brief. That's fine—not every change needs deep design discussion.
|
|
305
|
+
```
|
|
306
|
+
|
|
307
|
+
**DO:** Draft design.md:
|
|
308
|
+
|
|
309
|
+
```
|
|
310
|
+
Here's the design:
|
|
311
|
+
|
|
312
|
+
---
|
|
313
|
+
|
|
314
|
+
## Context
|
|
315
|
+
|
|
316
|
+
[Brief context about the current state]
|
|
317
|
+
|
|
318
|
+
## Goals / Non-Goals
|
|
319
|
+
|
|
320
|
+
**Goals:**
|
|
321
|
+
- [What we're trying to achieve]
|
|
322
|
+
|
|
323
|
+
**Non-Goals:**
|
|
324
|
+
- [What's explicitly out of scope]
|
|
325
|
+
|
|
326
|
+
## Decisions
|
|
327
|
+
|
|
328
|
+
### Decision 1: [Key decision]
|
|
329
|
+
|
|
330
|
+
[Explanation of approach and rationale]
|
|
331
|
+
|
|
332
|
+
---
|
|
333
|
+
|
|
334
|
+
For a small task, this captures the key decisions without over-engineering.
|
|
335
|
+
```
|
|
336
|
+
|
|
337
|
+
Save to `openspec/changes/<name>/design.md`.
|
|
338
|
+
|
|
339
|
+
---
|
|
340
|
+
|
|
341
|
+
## Phase 8: Tasks
|
|
342
|
+
|
|
343
|
+
**EXPLAIN:**
|
|
344
|
+
```
|
|
345
|
+
## Tasks
|
|
346
|
+
|
|
347
|
+
Finally, we break the work into implementation tasks—checkboxes that drive the apply phase.
|
|
348
|
+
|
|
349
|
+
These should be small, clear, and in logical order.
|
|
350
|
+
```
|
|
351
|
+
|
|
352
|
+
**DO:** Generate tasks based on specs and design:
|
|
353
|
+
|
|
354
|
+
```
|
|
355
|
+
Here are the implementation tasks:
|
|
356
|
+
|
|
357
|
+
---
|
|
358
|
+
|
|
359
|
+
## 1. [Category or file]
|
|
360
|
+
|
|
361
|
+
- [ ] 1.1 [Specific task]
|
|
362
|
+
- [ ] 1.2 [Specific task]
|
|
363
|
+
|
|
364
|
+
## 2. Verify
|
|
365
|
+
|
|
366
|
+
- [ ] 2.1 [Verification step]
|
|
367
|
+
|
|
368
|
+
---
|
|
369
|
+
|
|
370
|
+
Each checkbox becomes a unit of work in the apply phase. Ready to implement?
|
|
371
|
+
```
|
|
372
|
+
|
|
373
|
+
**PAUSE** - Wait for user to confirm they're ready to implement.
|
|
374
|
+
|
|
375
|
+
Save to `openspec/changes/<name>/tasks.md`.
|
|
376
|
+
|
|
377
|
+
---
|
|
378
|
+
|
|
379
|
+
## Phase 9: Apply (Implementation)
|
|
380
|
+
|
|
381
|
+
**EXPLAIN:**
|
|
382
|
+
```
|
|
383
|
+
## Implementation
|
|
384
|
+
|
|
385
|
+
Now we implement each task, checking them off as we go. I'll announce each one and occasionally note how the specs/design informed the approach.
|
|
386
|
+
```
|
|
387
|
+
|
|
388
|
+
**DO:** For each task:
|
|
389
|
+
|
|
390
|
+
1. Announce: "Working on task N: [description]"
|
|
391
|
+
2. Implement the change in the codebase
|
|
392
|
+
3. Reference specs/design naturally: "The spec says X, so I'm doing Y"
|
|
393
|
+
4. Mark complete in tasks.md: `- [ ]` → `- [x]`
|
|
394
|
+
5. Brief status: "✓ Task N complete"
|
|
395
|
+
|
|
396
|
+
Keep narration light—don't over-explain every line of code.
|
|
397
|
+
|
|
398
|
+
After all tasks:
|
|
399
|
+
|
|
400
|
+
```
|
|
401
|
+
## Implementation Complete
|
|
402
|
+
|
|
403
|
+
All tasks done:
|
|
404
|
+
- [x] Task 1
|
|
405
|
+
- [x] Task 2
|
|
406
|
+
- [x] ...
|
|
407
|
+
|
|
408
|
+
The change is implemented! One more step—let's archive it.
|
|
409
|
+
```
|
|
410
|
+
|
|
411
|
+
---
|
|
412
|
+
|
|
413
|
+
## Phase 10: Archive
|
|
414
|
+
|
|
415
|
+
**EXPLAIN:**
|
|
416
|
+
```
|
|
417
|
+
## Archiving
|
|
418
|
+
|
|
419
|
+
When a change is complete, we archive it. This moves it from `openspec/changes/` to `openspec/changes/archive/YYYY-MM-DD-<name>/`.
|
|
420
|
+
|
|
421
|
+
Archived changes become your project's decision history—you can always find them later to understand why something was built a certain way.
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
**DO:**
|
|
425
|
+
```bash
|
|
426
|
+
openspec archive "<name>"
|
|
427
|
+
```
|
|
428
|
+
|
|
429
|
+
**SHOW:**
|
|
430
|
+
```
|
|
431
|
+
Archived to: `openspec/changes/archive/YYYY-MM-DD-<name>/`
|
|
432
|
+
|
|
433
|
+
The change is now part of your project's history. The code is in your codebase, the decision record is preserved.
|
|
434
|
+
```
|
|
435
|
+
|
|
436
|
+
---
|
|
437
|
+
|
|
438
|
+
## Phase 11: Recap & Next Steps
|
|
439
|
+
|
|
440
|
+
```
|
|
441
|
+
## Congratulations!
|
|
442
|
+
|
|
443
|
+
You just completed a full OpenSpec cycle:
|
|
444
|
+
|
|
445
|
+
1. **Explore** - Thought through the problem
|
|
446
|
+
2. **New** - Created a change container
|
|
447
|
+
3. **Proposal** - Captured WHY
|
|
448
|
+
4. **Specs** - Defined WHAT in detail
|
|
449
|
+
5. **Design** - Decided HOW
|
|
450
|
+
6. **Tasks** - Broke it into steps
|
|
451
|
+
7. **Apply** - Implemented the work
|
|
452
|
+
8. **Archive** - Preserved the record
|
|
453
|
+
|
|
454
|
+
This same rhythm works for any size change—a small fix or a major feature.
|
|
455
|
+
|
|
456
|
+
---
|
|
457
|
+
|
|
458
|
+
## Command Reference
|
|
459
|
+
|
|
460
|
+
| Command | What it does |
|
|
461
|
+
|---------|--------------|
|
|
462
|
+
| `/opsx-explore` | Think through problems before/during work |
|
|
463
|
+
| `/opsx-new` | Start a new change, step through artifacts |
|
|
464
|
+
| `/opsx-ff` | Fast-forward: create all artifacts at once |
|
|
465
|
+
| `/opsx-continue` | Continue working on an existing change |
|
|
466
|
+
| `/opsx-apply` | Implement tasks from a change |
|
|
467
|
+
| `/opsx-verify` | Verify implementation matches artifacts |
|
|
468
|
+
| `/opsx-archive` | Archive a completed change |
|
|
469
|
+
|
|
470
|
+
---
|
|
471
|
+
|
|
472
|
+
## What's Next?
|
|
473
|
+
|
|
474
|
+
Try `/opsx-new` or `/opsx-ff` on something you actually want to build. You've got the rhythm now!
|
|
475
|
+
```
|
|
476
|
+
|
|
477
|
+
---
|
|
478
|
+
|
|
479
|
+
## Graceful Exit Handling
|
|
480
|
+
|
|
481
|
+
### User wants to stop mid-way
|
|
482
|
+
|
|
483
|
+
If the user says they need to stop, want to pause, or seem disengaged:
|
|
484
|
+
|
|
485
|
+
```
|
|
486
|
+
No problem! Your change is saved at `openspec/changes/<name>/`.
|
|
487
|
+
|
|
488
|
+
To pick up where we left off later:
|
|
489
|
+
- `/opsx-continue <name>` - Resume artifact creation
|
|
490
|
+
- `/opsx-apply <name>` - Jump to implementation (if tasks exist)
|
|
491
|
+
|
|
492
|
+
The work won't be lost. Come back whenever you're ready.
|
|
493
|
+
```
|
|
494
|
+
|
|
495
|
+
Exit gracefully without pressure.
|
|
496
|
+
|
|
497
|
+
### User just wants command reference
|
|
498
|
+
|
|
499
|
+
If the user says they just want to see the commands or skip the tutorial:
|
|
500
|
+
|
|
501
|
+
```
|
|
502
|
+
## OpenSpec Quick Reference
|
|
503
|
+
|
|
504
|
+
| Command | What it does |
|
|
505
|
+
|---------|--------------|
|
|
506
|
+
| `/opsx-explore` | Think through problems (no code changes) |
|
|
507
|
+
| `/opsx-new <name>` | Start a new change, step by step |
|
|
508
|
+
| `/opsx-ff <name>` | Fast-forward: all artifacts at once |
|
|
509
|
+
| `/opsx-continue <name>` | Continue an existing change |
|
|
510
|
+
| `/opsx-apply <name>` | Implement tasks |
|
|
511
|
+
| `/opsx-verify <name>` | Verify implementation |
|
|
512
|
+
| `/opsx-archive <name>` | Archive when done |
|
|
513
|
+
|
|
514
|
+
Try `/opsx-new` to start your first change, or `/opsx-ff` if you want to move fast.
|
|
515
|
+
```
|
|
516
|
+
|
|
517
|
+
Exit gracefully.
|
|
518
|
+
|
|
519
|
+
---
|
|
520
|
+
|
|
521
|
+
## Guardrails
|
|
522
|
+
|
|
523
|
+
- **Follow the EXPLAIN → DO → SHOW → PAUSE pattern** at key transitions (after explore, after proposal draft, after tasks, after archive)
|
|
524
|
+
- **Keep narration light** during implementation—teach without lecturing
|
|
525
|
+
- **Don't skip phases** even if the change is small—the goal is teaching the workflow
|
|
526
|
+
- **Pause for acknowledgment** at marked points, but don't over-pause
|
|
527
|
+
- **Handle exits gracefully**—never pressure the user to continue
|
|
528
|
+
- **Use real codebase tasks**—don't simulate or use fake examples
|
|
529
|
+
- **Adjust scope gently**—guide toward smaller tasks but respect user choice
|
|
@@ -0,0 +1,138 @@
|
|
|
1
|
+
---
|
|
2
|
+
name: openspec-sync-specs
|
|
3
|
+
description: Sync delta specs from a change to main specs. Use when the user wants to update main specs with changes from a delta spec, without archiving the change.
|
|
4
|
+
license: MIT
|
|
5
|
+
compatibility: Requires openspec CLI.
|
|
6
|
+
metadata:
|
|
7
|
+
author: openspec
|
|
8
|
+
version: "1.0"
|
|
9
|
+
generatedBy: "1.1.1"
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
Sync delta specs from a change to main specs.
|
|
13
|
+
|
|
14
|
+
This is an **agent-driven** operation - you will read delta specs and directly edit main specs to apply the changes. This allows intelligent merging (e.g., adding a scenario without copying the entire requirement).
|
|
15
|
+
|
|
16
|
+
**Input**: Optionally specify a change name. If omitted, check if it can be inferred from conversation context. If vague or ambiguous you MUST prompt for available changes.
|
|
17
|
+
|
|
18
|
+
**Steps**
|
|
19
|
+
|
|
20
|
+
1. **If no change name provided, prompt for selection**
|
|
21
|
+
|
|
22
|
+
Run `openspec list --json` to get available changes. Use the **AskUserQuestion tool** to let the user select.
|
|
23
|
+
|
|
24
|
+
Show changes that have delta specs (under `specs/` directory).
|
|
25
|
+
|
|
26
|
+
**IMPORTANT**: Do NOT guess or auto-select a change. Always let the user choose.
|
|
27
|
+
|
|
28
|
+
2. **Find delta specs**
|
|
29
|
+
|
|
30
|
+
Look for delta spec files in `openspec/changes/<name>/specs/*/spec.md`.
|
|
31
|
+
|
|
32
|
+
Each delta spec file contains sections like:
|
|
33
|
+
- `## ADDED Requirements` - New requirements to add
|
|
34
|
+
- `## MODIFIED Requirements` - Changes to existing requirements
|
|
35
|
+
- `## REMOVED Requirements` - Requirements to remove
|
|
36
|
+
- `## RENAMED Requirements` - Requirements to rename (FROM:/TO: format)
|
|
37
|
+
|
|
38
|
+
If no delta specs found, inform user and stop.
|
|
39
|
+
|
|
40
|
+
3. **For each delta spec, apply changes to main specs**
|
|
41
|
+
|
|
42
|
+
For each capability with a delta spec at `openspec/changes/<name>/specs/<capability>/spec.md`:
|
|
43
|
+
|
|
44
|
+
a. **Read the delta spec** to understand the intended changes
|
|
45
|
+
|
|
46
|
+
b. **Read the main spec** at `openspec/specs/<capability>/spec.md` (may not exist yet)
|
|
47
|
+
|
|
48
|
+
c. **Apply changes intelligently**:
|
|
49
|
+
|
|
50
|
+
**ADDED Requirements:**
|
|
51
|
+
- If requirement doesn't exist in main spec → add it
|
|
52
|
+
- If requirement already exists → update it to match (treat as implicit MODIFIED)
|
|
53
|
+
|
|
54
|
+
**MODIFIED Requirements:**
|
|
55
|
+
- Find the requirement in main spec
|
|
56
|
+
- Apply the changes - this can be:
|
|
57
|
+
- Adding new scenarios (don't need to copy existing ones)
|
|
58
|
+
- Modifying existing scenarios
|
|
59
|
+
- Changing the requirement description
|
|
60
|
+
- Preserve scenarios/content not mentioned in the delta
|
|
61
|
+
|
|
62
|
+
**REMOVED Requirements:**
|
|
63
|
+
- Remove the entire requirement block from main spec
|
|
64
|
+
|
|
65
|
+
**RENAMED Requirements:**
|
|
66
|
+
- Find the FROM requirement, rename to TO
|
|
67
|
+
|
|
68
|
+
d. **Create new main spec** if capability doesn't exist yet:
|
|
69
|
+
- Create `openspec/specs/<capability>/spec.md`
|
|
70
|
+
- Add Purpose section (can be brief, mark as TBD)
|
|
71
|
+
- Add Requirements section with the ADDED requirements
|
|
72
|
+
|
|
73
|
+
4. **Show summary**
|
|
74
|
+
|
|
75
|
+
After applying all changes, summarize:
|
|
76
|
+
- Which capabilities were updated
|
|
77
|
+
- What changes were made (requirements added/modified/removed/renamed)
|
|
78
|
+
|
|
79
|
+
**Delta Spec Format Reference**
|
|
80
|
+
|
|
81
|
+
```markdown
|
|
82
|
+
## ADDED Requirements
|
|
83
|
+
|
|
84
|
+
### Requirement: New Feature
|
|
85
|
+
The system SHALL do something new.
|
|
86
|
+
|
|
87
|
+
#### Scenario: Basic case
|
|
88
|
+
- **WHEN** user does X
|
|
89
|
+
- **THEN** system does Y
|
|
90
|
+
|
|
91
|
+
## MODIFIED Requirements
|
|
92
|
+
|
|
93
|
+
### Requirement: Existing Feature
|
|
94
|
+
#### Scenario: New scenario to add
|
|
95
|
+
- **WHEN** user does A
|
|
96
|
+
- **THEN** system does B
|
|
97
|
+
|
|
98
|
+
## REMOVED Requirements
|
|
99
|
+
|
|
100
|
+
### Requirement: Deprecated Feature
|
|
101
|
+
|
|
102
|
+
## RENAMED Requirements
|
|
103
|
+
|
|
104
|
+
- FROM: `### Requirement: Old Name`
|
|
105
|
+
- TO: `### Requirement: New Name`
|
|
106
|
+
```
|
|
107
|
+
|
|
108
|
+
**Key Principle: Intelligent Merging**
|
|
109
|
+
|
|
110
|
+
Unlike programmatic merging, you can apply **partial updates**:
|
|
111
|
+
- To add a scenario, just include that scenario under MODIFIED - don't copy existing scenarios
|
|
112
|
+
- The delta represents *intent*, not a wholesale replacement
|
|
113
|
+
- Use your judgment to merge changes sensibly
|
|
114
|
+
|
|
115
|
+
**Output On Success**
|
|
116
|
+
|
|
117
|
+
```
|
|
118
|
+
## Specs Synced: <change-name>
|
|
119
|
+
|
|
120
|
+
Updated main specs:
|
|
121
|
+
|
|
122
|
+
**<capability-1>**:
|
|
123
|
+
- Added requirement: "New Feature"
|
|
124
|
+
- Modified requirement: "Existing Feature" (added 1 scenario)
|
|
125
|
+
|
|
126
|
+
**<capability-2>**:
|
|
127
|
+
- Created new spec file
|
|
128
|
+
- Added requirement: "Another Feature"
|
|
129
|
+
|
|
130
|
+
Main specs are now updated. The change remains active - archive when implementation is complete.
|
|
131
|
+
```
|
|
132
|
+
|
|
133
|
+
**Guardrails**
|
|
134
|
+
- Read both delta and main specs before making changes
|
|
135
|
+
- Preserve existing content not mentioned in delta
|
|
136
|
+
- If something is unclear, ask for clarification
|
|
137
|
+
- Show what you're changing as you go
|
|
138
|
+
- The operation should be idempotent - running twice should give same result
|