specweave 0.1.7 → 0.1.9
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/README.md +50 -32
- package/SPECWEAVE.md +97 -63
- package/package.json +2 -2
- package/src/agents/pm/AGENT.md +286 -0
- package/src/commands/build.md +474 -0
- package/src/commands/done.md +544 -56
- package/src/commands/inc.md +85 -0
- package/src/commands/increment.md +316 -0
- package/src/commands/progress.md +258 -0
- package/src/commands/{validate-increment.md → validate.md} +1 -1
- package/src/templates/CLAUDE.md.template +11 -10
- package/src/commands/add-tasks.md +0 -176
- package/src/commands/at.md +0 -114
- package/src/commands/close-increment.md +0 -347
- package/src/commands/create-increment.md +0 -223
- package/src/commands/init.md +0 -123
- package/src/commands/ls.md +0 -100
- package/src/commands/pi.md +0 -65
- package/src/commands/si.md +0 -83
- package/src/commands/start-increment.md +0 -139
- package/src/commands/vi.md +0 -89
package/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
> **Spec-Driven Development Framework** - Where specifications and documentation are the source of truth
|
|
4
4
|
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
|
-
[](https://github.com/anton-abyzov/specweave/releases/tag/v0.1.9)
|
|
7
7
|
[]()
|
|
8
8
|
[](https://spec-weave.com)
|
|
9
9
|
|
|
@@ -115,17 +115,18 @@ cd my-app
|
|
|
115
115
|
|
|
116
116
|
# Open Claude Code and use slash commands:
|
|
117
117
|
|
|
118
|
-
User: /
|
|
118
|
+
User: /inc "Next.js authentication with email and OAuth"
|
|
119
119
|
↓
|
|
120
|
-
SpecWeave: 🔷 SpecWeave Active (/
|
|
120
|
+
SpecWeave: 🔷 SpecWeave Active (/increment)
|
|
121
121
|
|
|
122
122
|
🚀 Creating increment 0001-user-authentication...
|
|
123
123
|
📝 Using nextjs skill (already installed!)
|
|
124
124
|
🤖 PM agent creating requirements...
|
|
125
125
|
🏗️ Architect agent designing system...
|
|
126
|
+
📋 Auto-generating tasks from plan...
|
|
126
127
|
|
|
127
128
|
✅ Increment created: .specweave/increments/0001-user-authentication/
|
|
128
|
-
✅ Files: spec.md, plan.md, tasks.md, tests.md
|
|
129
|
+
✅ Files: spec.md, plan.md, tasks.md (auto-generated!), tests.md
|
|
129
130
|
|
|
130
131
|
User: "Create C4 context diagram for authentication" # Regular conversation for implementation
|
|
131
132
|
↓
|
|
@@ -146,14 +147,21 @@ User: /done 0001 # Close increment with slash command
|
|
|
146
147
|
✅ Increment 0001 closed successfully
|
|
147
148
|
```
|
|
148
149
|
|
|
149
|
-
**How it works
|
|
150
|
+
**How it works** (smart append-only workflow: 0001 → 0002 → 0003):
|
|
150
151
|
1. `specweave init` → ALL components pre-installed (10 agents + 35+ skills)
|
|
151
|
-
2. **Use `/
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
**
|
|
152
|
+
2. **Use `/inc "feature"`** → PM creates specs + plan + auto-generates tasks
|
|
153
|
+
- **Smart**: Auto-closes previous increment if PM gates pass
|
|
154
|
+
3. **Use `/build` or `/build 0001`** → Execute implementation (hooks after EVERY task)
|
|
155
|
+
- **Smart**: Auto-resumes from next incomplete task
|
|
156
|
+
4. **Use `/progress`** → Check status, task completion %, next action
|
|
157
|
+
5. **Use `/validate 0001`** → Optional quality check (LLM-as-judge)
|
|
158
|
+
6. Repeat: `/inc "next feature"` → Auto-closes if ready, creates next increment
|
|
159
|
+
|
|
160
|
+
**Why smart workflow?**
|
|
161
|
+
- ✅ No manual `/done` needed (auto-closes on next `/inc`)
|
|
162
|
+
- ✅ No task tracking needed (`/build` auto-resumes)
|
|
163
|
+
- ✅ `/progress` shows exactly where you are
|
|
164
|
+
- ✅ Natural flow: finish → start next
|
|
157
165
|
|
|
158
166
|
---
|
|
159
167
|
|
|
@@ -184,7 +192,7 @@ SpecWeave includes **35+ AI skills** that work with slash commands:
|
|
|
184
192
|
|
|
185
193
|
### Core Framework Skills
|
|
186
194
|
- **specweave-detector** - Slash command documentation
|
|
187
|
-
- **increment-planner** - Plan features via `/
|
|
195
|
+
- **increment-planner** - Plan features via `/inc` or `/increment` command
|
|
188
196
|
- **skill-router** - Route requests to appropriate skills
|
|
189
197
|
- **context-loader** - Load relevant specifications
|
|
190
198
|
- **role-orchestrator** - Coordinate multiple agents
|
|
@@ -295,23 +303,33 @@ specweave/
|
|
|
295
303
|
# Option A: Comprehensive (Enterprise) - 500-600+ pages upfront
|
|
296
304
|
# Option B: Incremental (Startup) - Build as you go
|
|
297
305
|
|
|
298
|
-
# 2.
|
|
299
|
-
/
|
|
300
|
-
#
|
|
301
|
-
#
|
|
302
|
-
#
|
|
303
|
-
|
|
304
|
-
# 3.
|
|
305
|
-
|
|
306
|
-
#
|
|
307
|
-
|
|
308
|
-
#
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
306
|
+
# 2. Plan increment (PM-led, auto-closes previous if ready)
|
|
307
|
+
/inc "user authentication"
|
|
308
|
+
# Alias for /increment
|
|
309
|
+
# PM-led: Market research → spec.md → plan.md → auto-generate tasks.md
|
|
310
|
+
# Smart: Auto-closes previous increment if PM gates pass
|
|
311
|
+
|
|
312
|
+
# 3. Build it (smart resume, hooks after EVERY task)
|
|
313
|
+
/build
|
|
314
|
+
# Or: /build 0001
|
|
315
|
+
# Smart: Auto-resumes from next incomplete task
|
|
316
|
+
# Hooks automatically update CLAUDE.md, README.md, CHANGELOG.md
|
|
317
|
+
|
|
318
|
+
# 4. Check progress anytime
|
|
319
|
+
/progress
|
|
320
|
+
# Shows: task completion %, PM gates status, next action
|
|
321
|
+
# No increment ID needed - finds active increment automatically
|
|
322
|
+
|
|
323
|
+
# 5. Validate quality (optional)
|
|
324
|
+
/validate 0001 --quality
|
|
325
|
+
# LLM-as-judge quality assessment
|
|
326
|
+
|
|
327
|
+
# 6. Start next feature (auto-closes previous)
|
|
328
|
+
/inc "payment processing"
|
|
329
|
+
# Auto-closes 0001 if gates pass, creates 0002
|
|
330
|
+
# No manual /done needed!
|
|
331
|
+
|
|
332
|
+
# 7. Sync with tools (optional)
|
|
315
333
|
/sync-github # Sync to GitHub issues
|
|
316
334
|
```
|
|
317
335
|
|
|
@@ -480,19 +498,19 @@ npm test
|
|
|
480
498
|
|
|
481
499
|
## 🏷️ Project Status
|
|
482
500
|
|
|
483
|
-
**Version**: 0.1.
|
|
501
|
+
**Version**: 0.1.8
|
|
484
502
|
**Status**: Public Beta
|
|
485
503
|
**License**: MIT
|
|
486
504
|
**Release Date**: 2025-10-28
|
|
487
505
|
**Website**: [spec-weave.com](https://spec-weave.com)
|
|
488
506
|
|
|
489
|
-
### ✅ What Works (v0.1.
|
|
507
|
+
### ✅ What Works (v0.1.8)
|
|
490
508
|
|
|
491
509
|
- ✅ **10 Agents** fully implemented and pre-installed
|
|
492
510
|
- ✅ **35+ Skills** fully implemented and pre-installed
|
|
493
511
|
- ✅ **CLI Tool** - `specweave init` with complete component copying
|
|
494
512
|
- ✅ **Ready Out of the Box** - All components installed during init
|
|
495
|
-
- ✅ **
|
|
513
|
+
- ✅ **Command simplification** - 4-command workflow (0.1.8)
|
|
496
514
|
- ✅ **Diagram generation** (C4 Model with validation)
|
|
497
515
|
- ✅ **4-level testing framework** (spec → feature → component → automated)
|
|
498
516
|
- ✅ **JIRA/ADO/GitHub sync** integration
|
package/SPECWEAVE.md
CHANGED
|
@@ -21,50 +21,83 @@ This file contains quick reference for developing with SpecWeave:
|
|
|
21
21
|
|
|
22
22
|
SpecWeave follows the **spec-kit approach**: You MUST use slash commands explicitly.
|
|
23
23
|
|
|
24
|
-
**To use SpecWeave**: Type a slash command (e.g., `/
|
|
24
|
+
**To use SpecWeave**: Type a slash command (e.g., `/inc "Feature description"`)
|
|
25
25
|
|
|
26
26
|
### Quick Command Reference
|
|
27
27
|
|
|
28
|
+
**Core Workflow** (Smart Commands):
|
|
29
|
+
|
|
28
30
|
| Alias | Full Command | Purpose | Example |
|
|
29
31
|
|-------|--------------|---------|---------|
|
|
30
|
-
| `/
|
|
31
|
-
|
|
|
32
|
-
|
|
|
33
|
-
|
|
|
34
|
-
| `/
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
-
|
|
40
|
-
-
|
|
41
|
-
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
32
|
+
| `/inc` | `/increment` | **Plan Increment** (PM-led, auto-closes previous) | `/inc "User auth"` |
|
|
33
|
+
| - | `/build` | Execute (smart resume, hooks after every task) | `/build` or `/build 0001` |
|
|
34
|
+
| - | `/progress` | **Show status** (task %, PM gates, next action) | `/progress` |
|
|
35
|
+
| - | `/validate` | Validate quality (optional LLM judge) | `/validate 0001 --quality` |
|
|
36
|
+
| `/done` | `/done` | Close explicitly (optional, /inc auto-closes) | `/done 0001` |
|
|
37
|
+
|
|
38
|
+
**Supporting Commands**:
|
|
39
|
+
- `/create-project` - Initialize SpecWeave project
|
|
40
|
+
- `/list-increments` - List all increments
|
|
41
|
+
- `/review-docs` - Review docs vs code
|
|
42
|
+
- `/generate-docs` - Generate doc site
|
|
43
|
+
- `/sync-github` - Sync to GitHub
|
|
44
|
+
|
|
45
|
+
**Smart Workflow Features**:
|
|
46
|
+
- ✅ `/inc` suggests options if previous incomplete (never forces closure)
|
|
47
|
+
- ✅ `/inc` auto-closes previous only if PM gates pass (seamless happy path)
|
|
48
|
+
- ✅ `/build` auto-resumes from next incomplete task
|
|
49
|
+
- ✅ `/progress` shows exactly where you are
|
|
50
|
+
- ✅ `/done` is optional (use when explicit closure needed)
|
|
51
|
+
- ✅ Natural flow: finish → start next (with user control)
|
|
52
|
+
|
|
53
|
+
### Typical Workflow (Smart & Natural)
|
|
45
54
|
|
|
46
55
|
```bash
|
|
47
56
|
# 1. Initialize project
|
|
48
57
|
npx specweave init my-saas
|
|
49
58
|
|
|
50
|
-
# 2. Plan your first increment
|
|
51
|
-
/
|
|
59
|
+
# 2. Plan your first increment
|
|
60
|
+
/inc "User authentication with JWT and RBAC"
|
|
61
|
+
# PM-led: market research → spec → plan → auto-generate tasks
|
|
62
|
+
|
|
63
|
+
# 3. Review generated docs
|
|
64
|
+
# spec.md, plan.md, tasks.md (auto-generated!), tests.md
|
|
65
|
+
|
|
66
|
+
# 4. Build it (smart resume, hooks after EVERY task)
|
|
67
|
+
/build
|
|
68
|
+
# Auto-resumes from next incomplete task
|
|
69
|
+
# No need to track which task you're on!
|
|
70
|
+
|
|
71
|
+
# 5. Check progress anytime
|
|
72
|
+
/progress
|
|
73
|
+
# Shows: 5/12 tasks (42%), next: T006, PM gates status
|
|
74
|
+
|
|
75
|
+
# 6. Continue building
|
|
76
|
+
/build
|
|
77
|
+
# Picks up where you left off
|
|
52
78
|
|
|
53
|
-
#
|
|
54
|
-
/
|
|
79
|
+
# 7. Validate quality (optional)
|
|
80
|
+
/validate 0001 --quality
|
|
55
81
|
|
|
56
|
-
#
|
|
57
|
-
/
|
|
82
|
+
# 8. Start next feature (auto-closes previous!)
|
|
83
|
+
/inc "Payment processing"
|
|
84
|
+
# Smart: Auto-closes 0001 if PM gates pass
|
|
85
|
+
# No manual /done needed!
|
|
58
86
|
|
|
59
|
-
#
|
|
60
|
-
|
|
61
|
-
|
|
87
|
+
# 9. Keep building
|
|
88
|
+
/build
|
|
89
|
+
# Auto-finds active increment 0002
|
|
62
90
|
|
|
63
|
-
#
|
|
64
|
-
/done 0001
|
|
91
|
+
# Repeat: /inc → /build → /progress → /inc (auto-closes) → /build...
|
|
65
92
|
```
|
|
66
93
|
|
|
67
|
-
**
|
|
94
|
+
**Key Insight**: Natural flow without administrative overhead!
|
|
95
|
+
- No manual tracking (`/build` auto-resumes)
|
|
96
|
+
- No manual closure (`/inc` auto-closes if ready)
|
|
97
|
+
- Check progress anytime (`/progress`)
|
|
98
|
+
- Focus on building, not project management
|
|
99
|
+
|
|
100
|
+
**Remember**: Type `/inc` first, THEN build! Otherwise you lose all SpecWeave benefits (specs, architecture, auto-generated tasks, test strategy).
|
|
68
101
|
|
|
69
102
|
---
|
|
70
103
|
|
|
@@ -193,25 +226,30 @@ npx specweave list --installed # See what's installed
|
|
|
193
226
|
|
|
194
227
|
**CRITICAL**: SpecWeave uses **EXPLICIT SLASH COMMANDS** - type them to activate the framework!
|
|
195
228
|
|
|
229
|
+
### Core Workflow (Smart Commands)
|
|
230
|
+
|
|
196
231
|
| Command | Alias | Purpose | Example |
|
|
197
232
|
|---------|-------|---------|---------|
|
|
198
|
-
| `/
|
|
199
|
-
| `/
|
|
200
|
-
| `/
|
|
201
|
-
| `/
|
|
202
|
-
| `/
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
233
|
+
| `/increment` | `/inc` | Plan Increment (PM-led, auto-closes previous if ready) | `/inc "user authentication"` |
|
|
234
|
+
| `/build` | - | Execute (smart resume from next incomplete task) | `/build` or `/build 0001` |
|
|
235
|
+
| `/progress` | - | Show status (task %, PM gates, next action) | `/progress` |
|
|
236
|
+
| `/validate` | - | Validate quality (optional LLM judge) | `/validate 0001 --quality` |
|
|
237
|
+
| `/done` | - | Close explicitly (optional, /inc auto-closes) | `/done 0001` |
|
|
238
|
+
|
|
239
|
+
**Smart Features**:
|
|
240
|
+
- `/inc` suggests options if previous incomplete, auto-closes if PM gates pass
|
|
241
|
+
- `/build` auto-resumes from next incomplete task (no task ID needed)
|
|
242
|
+
- `/progress` auto-finds active increment (no ID needed)
|
|
243
|
+
- `/done` optional in happy path (use for explicit closure only)
|
|
244
|
+
|
|
245
|
+
### Supporting Commands
|
|
246
|
+
|
|
247
|
+
| Command | Purpose | Example |
|
|
248
|
+
|---------|---------|---------|
|
|
249
|
+
| `/create-project` | Bootstrap new SpecWeave project | `/create-project --type python` |
|
|
250
|
+
| `/list-increments` | List all increments with status | `/list-increments` |
|
|
209
251
|
**All commands are framework-agnostic** (adapt to detected tech stack)
|
|
210
252
|
|
|
211
|
-
**💡 Pro Tip**: Use short aliases (`/pi`, `/vi`, `/si`, `/done`, `/ls`, `/at`, `/init`) for speed during active development!
|
|
212
|
-
- **PI** = Product Increment (standard Agile terminology)
|
|
213
|
-
- **Why explicit?** Auto-activation doesn't work reliably - slash commands ensure SpecWeave ALWAYS activates
|
|
214
|
-
|
|
215
253
|
**See**: [Command Reference](.claude/commands/) for all available commands
|
|
216
254
|
|
|
217
255
|
---
|
|
@@ -246,7 +284,7 @@ npx specweave list --installed # See what's installed
|
|
|
246
284
|
| Skill | Purpose | Activates When |
|
|
247
285
|
|-------|---------|----------------|
|
|
248
286
|
| `specweave-detector` | Slash command documentation | User asks about SpecWeave commands |
|
|
249
|
-
| `increment-planner` | Plan features with context | `/
|
|
287
|
+
| `increment-planner` | Plan features with context | `/inc` or `/increment` command |
|
|
250
288
|
| `skill-router` | Route to appropriate skills | Ambiguous requests |
|
|
251
289
|
| `context-loader` | Load context selectively | Working on increments |
|
|
252
290
|
| `diagrams-generator` | Coordinate diagram creation | "create diagram", "draw diagram", C4, sequence, ER |
|
|
@@ -302,17 +340,12 @@ backlog → planned → in-progress → completed → closed
|
|
|
302
340
|
|
|
303
341
|
**Naming Convention**: 4-digit format (0001-9999), e.g., `0001-feature-name`, `0042-user-auth`, `0123-payment-flow`
|
|
304
342
|
|
|
305
|
-
**Commands
|
|
343
|
+
**Commands**:
|
|
306
344
|
```bash
|
|
307
|
-
#
|
|
308
|
-
/
|
|
309
|
-
/
|
|
310
|
-
/done 0001 # Close
|
|
311
|
-
|
|
312
|
-
# Or full commands
|
|
313
|
-
/create-increment "feature name" # Same as /pi
|
|
314
|
-
/add-tasks 0001 "task description" # Same as /at
|
|
315
|
-
/close-increment 0001 # Same as /done
|
|
345
|
+
/inc "feature name" # Plan increment (PM-led, auto-generates tasks)
|
|
346
|
+
/build 0001 # Execute implementation (hooks after EVERY task)
|
|
347
|
+
/validate 0001 --quality # Validate quality (optional)
|
|
348
|
+
/done 0001 # Close increment (PM validates 3 gates)
|
|
316
349
|
```
|
|
317
350
|
|
|
318
351
|
**See**: [Increment Lifecycle Guide](.specweave/docs/internal/delivery/guides/increment-lifecycle.md) for complete lifecycle management
|
|
@@ -685,24 +718,25 @@ Attempt 2/3: Refining with feedback...
|
|
|
685
718
|
|
|
686
719
|
**Quick Start**:
|
|
687
720
|
|
|
688
|
-
**CRITICAL**: SpecWeave uses **EXPLICIT SLASH COMMANDS** - type `/
|
|
721
|
+
**CRITICAL**: SpecWeave uses **EXPLICIT SLASH COMMANDS** - type `/inc` to activate!
|
|
689
722
|
|
|
690
723
|
```bash
|
|
691
724
|
# Initialize project
|
|
692
725
|
npx specweave init my-project
|
|
693
726
|
|
|
694
|
-
#
|
|
695
|
-
/
|
|
727
|
+
# Plan your first increment (use slash command!)
|
|
728
|
+
/inc "feature description"
|
|
696
729
|
|
|
697
|
-
# Typical workflow
|
|
698
|
-
1. /
|
|
699
|
-
2.
|
|
700
|
-
3. /
|
|
730
|
+
# Typical workflow (append-only increments: 0001 → 0002 → 0003)
|
|
731
|
+
1. /inc "feature" → PM creates specs + plan + auto-generates tasks
|
|
732
|
+
2. /build 0001 → Execute implementation (hooks after EVERY task)
|
|
733
|
+
3. /validate 0001 --quality → Optional quality check
|
|
734
|
+
4. /done 0001 → PM validates 3 gates (tasks ✅ + tests ✅ + docs ✅)
|
|
701
735
|
```
|
|
702
736
|
|
|
703
|
-
**Remember**: Type `/
|
|
737
|
+
**Remember**: Type `/inc` first to plan, THEN `/build` to implement! Otherwise you lose all SpecWeave benefits (specs, architecture, test strategy).
|
|
704
738
|
|
|
705
|
-
**Need help?**: Type `/
|
|
739
|
+
**Need help?**: Type `/inc` to see examples, or ask about specific workflows.
|
|
706
740
|
|
|
707
741
|
**SpecWeave Documentation**: https://spec-weave.com
|
|
708
742
|
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "specweave",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "0.1.9",
|
|
4
|
+
"description": "Replace vibe coding with spec-driven development. Smart workflow: /inc auto-closes previous, /build auto-resumes, /progress shows status. PM-led planning, 10 agents, 35+ skills. spec-weave.com",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"bin": {
|
|
7
7
|
"specweave": "./bin/specweave.js"
|