specweave 0.1.5 โ 0.1.6
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 +162 -243
- package/SPECWEAVE.md +14 -12
- package/package.json +1 -1
- package/src/commands/README.md +171 -0
- package/src/commands/at.md +114 -0
- package/src/commands/ci.md +63 -0
- package/src/commands/done.md +103 -0
- package/src/commands/init.md +123 -0
- package/src/commands/ls.md +100 -0
- package/src/commands/si.md +83 -0
- package/src/commands/vi.md +89 -0
- package/src/skills/specweave-detector/SKILL.md +137 -178
package/README.md
CHANGED
|
@@ -3,14 +3,18 @@
|
|
|
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.6)
|
|
7
7
|
[]()
|
|
8
|
+
[](https://spec-weave.com)
|
|
8
9
|
|
|
9
10
|
---
|
|
10
11
|
|
|
11
12
|
## Overview
|
|
12
13
|
|
|
13
|
-
**SpecWeave** is an AI development framework that replaces "vibe coding" with **specification-first development**. Built on the principle that **specifications are the source of truth**, SpecWeave enables building software from solo projects to enterprise systems with confidence
|
|
14
|
+
**SpecWeave** is an AI development framework that replaces "vibe coding" with **specification-first development**. Built on the principle that **specifications are the source of truth**, SpecWeave enables building software from solo projects to enterprise systems with confidence and precision.
|
|
15
|
+
|
|
16
|
+
**๐ Website**: [spec-weave.com](https://spec-weave.com)
|
|
17
|
+
**๐ฆ npm**: [npmjs.com/package/specweave](https://www.npmjs.com/package/specweave)
|
|
14
18
|
|
|
15
19
|
### ๐ฏ Core Philosophy
|
|
16
20
|
|
|
@@ -18,16 +22,15 @@
|
|
|
18
22
|
2. **Living Documentation** - Specs evolve with code, never diverge
|
|
19
23
|
3. **Regression Prevention** - Document before modifying existing code
|
|
20
24
|
4. **Test-Validated Features** - Every feature proven through automated tests
|
|
21
|
-
5. **
|
|
22
|
-
6. **Auto-Role Routing** - Skills detect and delegate automatically
|
|
25
|
+
5. **Ready Out of the Box** - All components pre-installed, no setup needed
|
|
23
26
|
|
|
24
27
|
---
|
|
25
28
|
|
|
26
29
|
## โจ Key Features
|
|
27
30
|
|
|
28
|
-
- ๐ค **
|
|
29
|
-
- ๐ฏ **
|
|
30
|
-
-
|
|
31
|
+
- ๐ค **10 Specialized Agents** - PM, Architect, DevOps, QA, Security, SRE, Tech Lead, and more (all pre-installed!)
|
|
32
|
+
- ๐ฏ **35+ AI Skills** - Technology stacks, integrations, utilities (all pre-installed!)
|
|
33
|
+
- ๐ฆ **Pre-Installed Components** - Everything ready immediately after `specweave init`
|
|
31
34
|
- ๐งช **4-Level Testing** - Specification โ Feature โ Component โ Automated tests
|
|
32
35
|
- ๐ **Living Documentation** - Auto-updates via Claude Code hooks
|
|
33
36
|
- ๐จ **Diagram Generation** - C4 Model diagrams (Context, Container, Component)
|
|
@@ -87,172 +90,126 @@ specweave init my-saas
|
|
|
87
90
|
### Available Commands
|
|
88
91
|
|
|
89
92
|
```bash
|
|
90
|
-
specweave init [project] # Create new project
|
|
91
|
-
specweave list # List all available components
|
|
92
|
-
specweave list --installed # Show auto-installed components
|
|
93
|
+
specweave init [project] # Create new project with ALL components
|
|
93
94
|
specweave --version # Show version
|
|
94
95
|
specweave --help # Show help
|
|
95
96
|
```
|
|
96
97
|
|
|
97
|
-
**Note**:
|
|
98
|
+
**Note**: All 10 agents and 35+ skills are copied to your project during `init` - ready to use immediately!
|
|
98
99
|
|
|
99
100
|
---
|
|
100
101
|
|
|
101
102
|
## ๐ Quick Example
|
|
102
103
|
|
|
103
104
|
```bash
|
|
104
|
-
#
|
|
105
|
+
# Initialize project - ALL components pre-installed!
|
|
106
|
+
npx specweave init my-app
|
|
107
|
+
cd my-app
|
|
108
|
+
|
|
109
|
+
# Everything ready immediately:
|
|
110
|
+
# โ
10 agents in .claude/agents/
|
|
111
|
+
# โ
35+ skills in .claude/skills/
|
|
112
|
+
# โ
10 slash commands in .claude/commands/
|
|
113
|
+
|
|
114
|
+
# Open Claude Code and start building:
|
|
105
115
|
|
|
106
116
|
User: "Create Next.js authentication with email and OAuth"
|
|
107
117
|
โ
|
|
108
118
|
SpecWeave: ๐ท SpecWeave Active
|
|
109
119
|
|
|
110
|
-
๐ฆ Installing required components...
|
|
111
|
-
โ
Installed nextjs skill
|
|
112
|
-
โ
Installed nodejs-backend skill
|
|
113
|
-
โ
Installed security agent
|
|
114
|
-
โ
Installed pm agent
|
|
115
|
-
โ
Installed architect agent
|
|
116
|
-
|
|
117
120
|
๐ Creating increment 0001-user-authentication...
|
|
121
|
+
๐ Using nextjs skill (already installed!)
|
|
122
|
+
๐ค PM agent creating requirements...
|
|
123
|
+
๐๏ธ Architect agent designing system...
|
|
118
124
|
|
|
119
125
|
โ
Increment created: .specweave/increments/0001-user-authentication/
|
|
120
126
|
โ
Files: spec.md, plan.md, tasks.md, tests.md
|
|
121
127
|
|
|
122
128
|
User: "Create C4 context diagram for authentication"
|
|
123
129
|
โ
|
|
124
|
-
SpecWeave:
|
|
130
|
+
SpecWeave: ๐จ Using diagrams-generator skill
|
|
131
|
+
๐ค Coordinating with diagrams-architect agent
|
|
132
|
+
|
|
125
133
|
โ
Diagram saved: .specweave/docs/internal/architecture/diagrams/auth.c4-context.mmd
|
|
126
134
|
|
|
127
135
|
User: "Implement authentication"
|
|
128
136
|
โ
|
|
129
|
-
SpecWeave:
|
|
137
|
+
SpecWeave: ๐ค Orchestrating: PM โ Architect โ Backend โ QA โ Docs
|
|
138
|
+
|
|
130
139
|
โ
Code: src/auth/
|
|
131
140
|
โ
Tests: tests/auth/
|
|
132
141
|
โ
Docs: Updated automatically
|
|
133
142
|
```
|
|
134
143
|
|
|
135
144
|
**How it works**:
|
|
136
|
-
1.
|
|
137
|
-
2.
|
|
138
|
-
3.
|
|
145
|
+
1. `specweave init` โ ALL components pre-installed (10 agents + 35+ skills)
|
|
146
|
+
2. `.specweave/` detected โ `specweave-detector` activates automatically
|
|
147
|
+
3. User request parsed โ routed to appropriate pre-installed skills
|
|
139
148
|
4. Skills coordinate agents โ artifacts generated
|
|
140
|
-
5.
|
|
149
|
+
5. All components ready - no waiting, no installation
|
|
141
150
|
|
|
142
151
|
---
|
|
143
152
|
|
|
144
|
-
## ๐ค Agents (
|
|
145
|
-
|
|
146
|
-
SpecWeave includes **
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
| **
|
|
152
|
-
| **
|
|
153
|
-
| **
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
|
157
|
-
|
|
158
|
-
| **
|
|
159
|
-
| **
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
| **nextjs** | Next.js App Router specialist | โ
Implemented |
|
|
163
|
-
|
|
164
|
-
### Quality & Operations
|
|
165
|
-
| Agent | Role | Status |
|
|
166
|
-
|-------|------|--------|
|
|
167
|
-
| **qa-lead** | QA Lead - test strategy, test cases, quality gates | โ
Implemented |
|
|
168
|
-
| **security** | Security Engineer - threat modeling, OWASP, compliance | โ
Implemented |
|
|
169
|
-
| **devops** | DevOps - CI/CD, infrastructure, deployment | โ
Implemented |
|
|
170
|
-
| **sre** | SRE - monitoring, incidents, reliability | โ
Implemented |
|
|
171
|
-
| **performance** | Performance Engineer - profiling, optimization | โ
Implemented |
|
|
172
|
-
|
|
173
|
-
### Documentation & Design
|
|
174
|
-
| Agent | Role | Status |
|
|
175
|
-
|-------|------|--------|
|
|
176
|
-
| **docs-writer** | Technical Writer - API docs, guides, tutorials | โ
Implemented |
|
|
177
|
-
| **diagrams-architect** | Diagram generation - C4 Model, Mermaid, architecture | โ
Implemented |
|
|
178
|
-
| **figma-designer** | Figma designer - design systems, UI/UX | โ
Implemented |
|
|
179
|
-
| **figma-implementer** | Figma to code - React/Angular components | โ
Implemented |
|
|
180
|
-
|
|
181
|
-
### Integration
|
|
182
|
-
| Agent | Role | Status |
|
|
183
|
-
|-------|------|--------|
|
|
184
|
-
| **specweave-jira-mapper** | JIRA โ SpecWeave bidirectional sync | โ
Implemented |
|
|
185
|
-
| **specweave-ado-mapper** | Azure DevOps โ SpecWeave bidirectional sync | โ
Implemented |
|
|
186
|
-
|
|
187
|
-
**All agents** have AGENT.md with YAML frontmatter and 3+ test cases.
|
|
153
|
+
## ๐ค Agents (10 Total - All Pre-Installed!)
|
|
154
|
+
|
|
155
|
+
SpecWeave includes **10 specialized AI agents** that activate automatically based on your request:
|
|
156
|
+
|
|
157
|
+
| Agent | Role | When It Activates |
|
|
158
|
+
|-------|------|-------------------|
|
|
159
|
+
| **pm** | Product Manager - requirements, user stories | Planning features, creating increments |
|
|
160
|
+
| **architect** | System Architect - design, ADRs, decisions | Technical design, architecture |
|
|
161
|
+
| **security** | Security Engineer - threat modeling, OWASP | Security review, vulnerability assessment |
|
|
162
|
+
| **qa-lead** | QA Lead - test strategy, quality gates | Testing, quality assurance |
|
|
163
|
+
| **devops** | DevOps Engineer - CI/CD, infrastructure | Deployment, infrastructure needs |
|
|
164
|
+
| **tech-lead** | Technical Lead - code review, best practices | Code review, refactoring |
|
|
165
|
+
| **sre** | SRE - incident response, monitoring | Production incidents, troubleshooting |
|
|
166
|
+
| **docs-writer** | Technical Writer - documentation | Writing docs, API documentation |
|
|
167
|
+
| **performance** | Performance Engineer - optimization | Performance issues, profiling |
|
|
168
|
+
| **diagrams-architect** | Diagram Expert - C4 Model, Mermaid | Creating diagrams (via diagrams-generator skill) |
|
|
169
|
+
|
|
170
|
+
**All agents pre-installed** in `.claude/agents/` after `specweave init` - ready to use immediately!
|
|
188
171
|
|
|
189
172
|
---
|
|
190
173
|
|
|
191
|
-
## ๐ฏ Skills (
|
|
192
|
-
|
|
193
|
-
SpecWeave includes **
|
|
194
|
-
|
|
195
|
-
### Core
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
###
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
| Skill | Purpose | Status |
|
|
231
|
-
|-------|---------|--------|
|
|
232
|
-
| **diagrams-generator** | Generate C4 diagrams (coordinates with diagrams-architect) | โ
Implemented |
|
|
233
|
-
| **design-system-architect** | Design system creation (Atomic Design) | โ
Implemented |
|
|
234
|
-
| **figma-mcp-connector** | Connect to Figma MCP servers | โ
Implemented |
|
|
235
|
-
| **figma-to-code** | Convert Figma designs to code | โ
Implemented |
|
|
236
|
-
|
|
237
|
-
### Product Features
|
|
238
|
-
| Skill | Purpose | Status |
|
|
239
|
-
|-------|---------|--------|
|
|
240
|
-
| **calendar-system** | Calendar and scheduling features | โ
Implemented |
|
|
241
|
-
| **notification-system** | Email, push, SMS, in-app notifications | โ
Implemented |
|
|
242
|
-
| **stripe-integrator** | Stripe payment integration | โ
Implemented |
|
|
243
|
-
|
|
244
|
-
### Framework Comparison
|
|
245
|
-
| Skill | Purpose | Status |
|
|
246
|
-
|-------|---------|--------|
|
|
247
|
-
| **bmad-method-expert** | BMAD-METHOD comparison and gap analysis | โ
Implemented |
|
|
248
|
-
| **spec-kit-expert** | spec-kit comparison and gap analysis | โ
Implemented |
|
|
249
|
-
|
|
250
|
-
### Meta
|
|
251
|
-
| Skill | Purpose | Status |
|
|
252
|
-
|-------|---------|--------|
|
|
253
|
-
| **skill-creator** | Guide for creating new skills | โ
Implemented |
|
|
254
|
-
|
|
255
|
-
**All skills** have SKILL.md with YAML frontmatter and 3+ test cases.
|
|
174
|
+
## ๐ฏ Skills (35+ Total - All Pre-Installed!)
|
|
175
|
+
|
|
176
|
+
SpecWeave includes **35+ AI skills** that activate automatically based on your request:
|
|
177
|
+
|
|
178
|
+
### Core Framework Skills
|
|
179
|
+
- **specweave-detector** - Auto-detect SpecWeave projects
|
|
180
|
+
- **increment-planner** - Plan features and create specifications
|
|
181
|
+
- **skill-router** - Route requests to appropriate skills
|
|
182
|
+
- **context-loader** - Load relevant specifications
|
|
183
|
+
- **role-orchestrator** - Coordinate multiple agents
|
|
184
|
+
|
|
185
|
+
### Technology Stack Skills
|
|
186
|
+
- **nextjs** - Next.js App Router, Server Components
|
|
187
|
+
- **nodejs-backend** - Node.js, Express, NestJS APIs
|
|
188
|
+
- **python-backend** - FastAPI, Django APIs
|
|
189
|
+
- **dotnet-backend** - ASP.NET Core APIs
|
|
190
|
+
- **frontend** - React, Vue, Angular components
|
|
191
|
+
|
|
192
|
+
### Integration Skills
|
|
193
|
+
- **jira-sync** - Sync with JIRA issues
|
|
194
|
+
- **ado-sync** - Sync with Azure DevOps
|
|
195
|
+
- **github-sync** - Sync with GitHub issues
|
|
196
|
+
|
|
197
|
+
### Design & Diagram Skills
|
|
198
|
+
- **diagrams-generator** - Generate C4 diagrams
|
|
199
|
+
- **figma-designer** - Create Figma designs
|
|
200
|
+
- **figma-implementer** - Convert Figma to code
|
|
201
|
+
|
|
202
|
+
### Infrastructure Skills
|
|
203
|
+
- **hetzner-provisioner** - Deploy to Hetzner Cloud
|
|
204
|
+
- **cost-optimizer** - Optimize cloud costs
|
|
205
|
+
|
|
206
|
+
### Brownfield Skills
|
|
207
|
+
- **brownfield-analyzer** - Analyze existing codebases
|
|
208
|
+
- **brownfield-onboarder** - Merge existing documentation
|
|
209
|
+
|
|
210
|
+
**And many more!** All skills pre-installed in `.claude/skills/` after `specweave init`.
|
|
211
|
+
|
|
212
|
+
**See**: [Complete skill list](https://spec-weave.com/docs/skills) on spec-weave.com
|
|
256
213
|
|
|
257
214
|
---
|
|
258
215
|
|
|
@@ -299,11 +256,10 @@ specweave/
|
|
|
299
256
|
โ โโโ hooks/ # Claude Code hooks
|
|
300
257
|
โ โโโ templates/ # Project templates
|
|
301
258
|
โ
|
|
302
|
-
โโโ .claude/ #
|
|
303
|
-
โ โโโ agents/ #
|
|
304
|
-
โ โโโ skills/ #
|
|
305
|
-
โ
|
|
306
|
-
โ โโโ hooks/ # Symlinks to src/hooks/
|
|
259
|
+
โโโ .claude/ # Pre-installed components (user projects)
|
|
260
|
+
โ โโโ agents/ # 10 agents (copied during init)
|
|
261
|
+
โ โโโ skills/ # 35+ skills (copied during init)
|
|
262
|
+
โ โโโ commands/ # 10 slash commands (copied during init)
|
|
307
263
|
โ
|
|
308
264
|
โโโ tests/ # Framework tests
|
|
309
265
|
โ โโโ unit/
|
|
@@ -390,38 +346,6 @@ SpecWeave implements **4 Levels of Testing**:
|
|
|
390
346
|
|
|
391
347
|
---
|
|
392
348
|
|
|
393
|
-
## ๐ Context Precision (70%+ Reduction)
|
|
394
|
-
|
|
395
|
-
SpecWeave uses **context manifests** to load only relevant specifications:
|
|
396
|
-
|
|
397
|
-
**Without context manifests** (traditional):
|
|
398
|
-
- Load entire spec/ folder
|
|
399
|
-
- 100,000+ tokens
|
|
400
|
-
- Slow, expensive, context pollution
|
|
401
|
-
|
|
402
|
-
**With context manifests** (SpecWeave):
|
|
403
|
-
- Load only relevant sections
|
|
404
|
-
- 10,000-30,000 tokens
|
|
405
|
-
- **70%+ reduction**
|
|
406
|
-
- Fast, efficient, focused
|
|
407
|
-
|
|
408
|
-
**Example**:
|
|
409
|
-
```yaml
|
|
410
|
-
# .specweave/increments/0001-auth/context-manifest.yaml
|
|
411
|
-
spec_sections:
|
|
412
|
-
- .specweave/docs/internal/strategy/auth/authentication-spec.md
|
|
413
|
-
- .specweave/docs/internal/strategy/auth/authorization-spec.md
|
|
414
|
-
|
|
415
|
-
documentation:
|
|
416
|
-
- .specweave/docs/internal/architecture/auth-hld.md
|
|
417
|
-
- CLAUDE.md#authentication
|
|
418
|
-
|
|
419
|
-
max_context_tokens: 10000
|
|
420
|
-
```
|
|
421
|
-
|
|
422
|
-
**See [CLAUDE.md#context-precision](CLAUDE.md#scalable-directory-structure)** for details.
|
|
423
|
-
|
|
424
|
-
---
|
|
425
349
|
|
|
426
350
|
## ๐จ Diagram Generation
|
|
427
351
|
|
|
@@ -502,24 +426,22 @@ sync:
|
|
|
502
426
|
|
|
503
427
|
## ๐ Documentation
|
|
504
428
|
|
|
505
|
-
- **[
|
|
506
|
-
- **[
|
|
507
|
-
- **[
|
|
508
|
-
- **[
|
|
509
|
-
- **[Tool Concept Mapping](.specweave/docs/internal/delivery/guides/tool-concept-mapping.md)** - Tool mappings
|
|
510
|
-
- **[.specweave/increments/README.md](.specweave/increments/README.md)** - Increments guide
|
|
429
|
+
- **[spec-weave.com](https://spec-weave.com)** - **START HERE** - Complete documentation website
|
|
430
|
+
- **[npm Package](https://www.npmjs.com/package/specweave)** - Installation and quick start
|
|
431
|
+
- **[GitHub](https://github.com/anton-abyzov/specweave)** - Source code and examples
|
|
432
|
+
- **[CLAUDE.md](CLAUDE.md)** - Complete development guide (created after `specweave init`)
|
|
511
433
|
|
|
512
434
|
---
|
|
513
435
|
|
|
514
436
|
## ๐ค Contributing
|
|
515
437
|
|
|
516
|
-
We welcome contributions!
|
|
438
|
+
We welcome contributions!
|
|
517
439
|
|
|
518
440
|
### Development Setup
|
|
519
441
|
|
|
520
442
|
```bash
|
|
521
443
|
# Clone repository
|
|
522
|
-
git clone https://github.com/
|
|
444
|
+
git clone https://github.com/anton-abyzov/specweave.git
|
|
523
445
|
cd specweave
|
|
524
446
|
|
|
525
447
|
# Install dependencies
|
|
@@ -528,19 +450,14 @@ npm install
|
|
|
528
450
|
# Build TypeScript
|
|
529
451
|
npm run build
|
|
530
452
|
|
|
531
|
-
# Install components
|
|
532
|
-
npm run install:all
|
|
533
|
-
|
|
534
453
|
# Run tests
|
|
535
454
|
npm test
|
|
536
|
-
|
|
537
|
-
# Restart Claude Code
|
|
538
455
|
```
|
|
539
456
|
|
|
540
457
|
**To contribute**:
|
|
541
458
|
1. Fork repository
|
|
542
|
-
2. Create feature branch: `git checkout -b features/
|
|
543
|
-
3. Follow
|
|
459
|
+
2. Create feature branch: `git checkout -b features/002-new-feature`
|
|
460
|
+
3. Follow SpecWeave conventions (see CLAUDE.md after init)
|
|
544
461
|
4. Add 3+ test cases (MANDATORY)
|
|
545
462
|
5. Create PR to `develop` branch
|
|
546
463
|
|
|
@@ -548,75 +465,72 @@ npm test
|
|
|
548
465
|
|
|
549
466
|
## ๐ท๏ธ Project Status
|
|
550
467
|
|
|
551
|
-
**Version**: 0.1.
|
|
468
|
+
**Version**: 0.1.6
|
|
552
469
|
**Status**: Public Beta
|
|
553
470
|
**License**: MIT
|
|
554
|
-
**Release Date**: 2025-10-
|
|
471
|
+
**Release Date**: 2025-10-28
|
|
472
|
+
**Website**: [spec-weave.com](https://spec-weave.com)
|
|
555
473
|
|
|
556
|
-
### โ
What Works (v0.1.
|
|
474
|
+
### โ
What Works (v0.1.6)
|
|
557
475
|
|
|
558
|
-
- โ
**
|
|
559
|
-
- โ
**
|
|
560
|
-
- โ
**CLI Tool** - `specweave`
|
|
561
|
-
- โ
**
|
|
562
|
-
- โ
**
|
|
476
|
+
- โ
**10 Agents** fully implemented and pre-installed
|
|
477
|
+
- โ
**35+ Skills** fully implemented and pre-installed
|
|
478
|
+
- โ
**CLI Tool** - `specweave init` with complete component copying
|
|
479
|
+
- โ
**Ready Out of the Box** - All components installed during init
|
|
480
|
+
- โ
**Auto-detection** and intelligent routing (fixed in 0.1.6!)
|
|
563
481
|
- โ
**Diagram generation** (C4 Model with validation)
|
|
564
|
-
- โ
**Install scripts** (selective installation based on tech stack)
|
|
565
482
|
- โ
**4-level testing framework** (spec โ feature โ component โ automated)
|
|
566
|
-
- โ
**JIRA/ADO/GitHub sync**
|
|
483
|
+
- โ
**JIRA/ADO/GitHub sync** integration
|
|
567
484
|
- โ
**Brownfield analyzer** (retroactive specs, regression prevention)
|
|
568
485
|
- โ
**Increment lifecycle** (5 stages, WIP limits, leftover transfer)
|
|
569
486
|
- โ
**Increment validation** (120 rules, auto-validation on save)
|
|
570
487
|
- โ
**Hooks system** (auto-update docs, validations)
|
|
571
|
-
- โ
**Documentation**
|
|
572
|
-
|
|
573
|
-
### โณ In Progress (v0.1.0-beta.2)
|
|
574
|
-
|
|
575
|
-
- โณ NPM package publishing (beta.1 installable via GitHub only)
|
|
576
|
-
- โณ Additional CLI commands (`audit`, `cleanup`)
|
|
577
|
-
- โณ More project templates (currently: saas, api, fullstack)
|
|
578
|
-
- โณ GitHub Actions CI/CD integration
|
|
579
|
-
- โณ MkDocs documentation site deployment
|
|
488
|
+
- โ
**Living Documentation** - Auto-updated via Claude Code hooks
|
|
489
|
+
- โ
**npm Package** - Published and ready to use
|
|
580
490
|
|
|
581
491
|
### ๐
Planned (v0.2.0+)
|
|
582
492
|
|
|
583
|
-
- ๐
Quality gates
|
|
584
|
-
- ๐
Risk scoring (inspired by BMAD `@qa *risk`)
|
|
585
|
-
- ๐
Clarification workflow (inspired by spec-kit `/speckit.clarify`)
|
|
586
|
-
- ๐
Dependency tracking in tasks (inspired by spec-kit)
|
|
587
|
-
- ๐
Agent-agnostic support (Copilot, Cursor, Gemini, etc.)
|
|
493
|
+
- ๐
Quality gates and risk scoring
|
|
588
494
|
- ๐
Web UI for planning phase
|
|
589
495
|
- ๐
VS Code extension
|
|
590
496
|
- ๐
Homebrew formula
|
|
591
|
-
- ๐
|
|
497
|
+
- ๐
Additional project templates
|
|
592
498
|
|
|
593
499
|
---
|
|
594
500
|
|
|
595
|
-
## ๐
|
|
501
|
+
## ๐ Quick Start
|
|
596
502
|
|
|
597
|
-
###
|
|
503
|
+
### Initialize New Project
|
|
598
504
|
|
|
599
505
|
```bash
|
|
600
|
-
|
|
506
|
+
# Create new project (all components pre-installed!)
|
|
507
|
+
npx specweave init my-saas
|
|
601
508
|
cd my-saas
|
|
602
|
-
npm install && npm run install:all
|
|
603
509
|
|
|
604
|
-
#
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
510
|
+
# Everything ready:
|
|
511
|
+
# โ
10 agents in .claude/agents/
|
|
512
|
+
# โ
35+ skills in .claude/skills/
|
|
513
|
+
# โ
10 slash commands in .claude/commands/
|
|
608
514
|
|
|
609
|
-
#
|
|
610
|
-
"
|
|
515
|
+
# Open Claude Code and start building:
|
|
516
|
+
# "Create user authentication with JWT"
|
|
517
|
+
# "Add subscription billing with Stripe"
|
|
518
|
+
# "Build admin dashboard with analytics"
|
|
611
519
|
```
|
|
612
520
|
|
|
613
|
-
###
|
|
521
|
+
### For Existing Projects
|
|
614
522
|
|
|
615
523
|
```bash
|
|
616
|
-
#
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
524
|
+
# Add SpecWeave to existing project
|
|
525
|
+
cd my-existing-project
|
|
526
|
+
npx specweave init .
|
|
527
|
+
|
|
528
|
+
# Analyze existing code
|
|
529
|
+
# "Analyze my authentication module"
|
|
530
|
+
# SpecWeave creates retroactive specifications
|
|
531
|
+
|
|
532
|
+
# Safe to modify
|
|
533
|
+
# "Add OAuth to authentication"
|
|
620
534
|
```
|
|
621
535
|
|
|
622
536
|
---
|
|
@@ -630,7 +544,7 @@ npm install && npm run install:all
|
|
|
630
544
|
| **Documentation** | Outdated, ignored | Living, auto-updated |
|
|
631
545
|
| **Specifications** | Optional, vague | Source of truth, precise |
|
|
632
546
|
| **Testing** | Manual, incomplete | 4-level, validated |
|
|
633
|
-
| **
|
|
547
|
+
| **Components** | Manual setup | Pre-installed (10 agents + 35+ skills) |
|
|
634
548
|
| **Regression** | Frequent breaks | Prevention-first |
|
|
635
549
|
| **Onboarding** | Weeks | Hours (specs explain everything) |
|
|
636
550
|
| **Brownfield** | Risky | Safe (document first) |
|
|
@@ -638,29 +552,34 @@ npm install && npm run install:all
|
|
|
638
552
|
### vs Other Frameworks
|
|
639
553
|
|
|
640
554
|
**vs spec-kit** (GitHub):
|
|
641
|
-
- โ
SpecWeave:
|
|
642
|
-
- โ
SpecWeave: Living documentation via hooks
|
|
643
|
-
- โ
SpecWeave: Brownfield analysis
|
|
644
|
-
- โ
SpecWeave:
|
|
555
|
+
- โ
SpecWeave: **Pre-installed agents** (10) and skills (35+) - spec-kit requires manual setup
|
|
556
|
+
- โ
SpecWeave: **Living documentation** via Claude Code hooks - auto-updates on changes
|
|
557
|
+
- โ
SpecWeave: **Brownfield analysis** - retroactive spec generation for existing code
|
|
558
|
+
- โ
SpecWeave: **Tool integration** - JIRA, ADO, GitHub bidirectional sync
|
|
645
559
|
|
|
646
560
|
**vs BMAD-METHOD**:
|
|
647
|
-
- โ
SpecWeave:
|
|
648
|
-
- โ
SpecWeave:
|
|
649
|
-
- โ
SpecWeave:
|
|
650
|
-
- โ
SpecWeave: Diagram generation
|
|
561
|
+
- โ
SpecWeave: **5-pillar documentation** - strategy, architecture, delivery, operations, governance
|
|
562
|
+
- โ
SpecWeave: **Pre-installed components** - 10 agents + 35+ skills ready immediately
|
|
563
|
+
- โ
SpecWeave: **Framework agnostic** - TypeScript, Python, Go, Rust, Java, C#
|
|
564
|
+
- โ
SpecWeave: **Diagram generation** - C4 Model diagrams with validation
|
|
565
|
+
- โ
SpecWeave: **Tool integration** - JIRA/ADO/GitHub sync built-in
|
|
566
|
+
|
|
567
|
+
**Both frameworks**:
|
|
568
|
+
- โ
Specification-first development
|
|
569
|
+
- โ
Automated testing
|
|
570
|
+
- โ
Quality gates and validation
|
|
651
571
|
|
|
652
|
-
**See skills
|
|
653
|
-
- `bmad-method-expert` - Dynamic gap analysis vs BMAD
|
|
654
|
-
- `spec-kit-expert` - Dynamic gap analysis vs spec-kit
|
|
572
|
+
**Learn more**: See `bmad-method-expert` and `spec-kit-expert` skills for detailed comparisons
|
|
655
573
|
|
|
656
574
|
---
|
|
657
575
|
|
|
658
576
|
## ๐ Support & Community
|
|
659
577
|
|
|
660
|
-
- **
|
|
661
|
-
- **
|
|
662
|
-
- **
|
|
663
|
-
- **
|
|
578
|
+
- **Website**: [spec-weave.com](https://spec-weave.com)
|
|
579
|
+
- **npm Package**: [npmjs.com/package/specweave](https://www.npmjs.com/package/specweave)
|
|
580
|
+
- **GitHub**: [github.com/anton-abyzov/specweave](https://github.com/anton-abyzov/specweave)
|
|
581
|
+
- **Issues**: [github.com/anton-abyzov/specweave/issues](https://github.com/anton-abyzov/specweave/issues)
|
|
582
|
+
- **Documentation**: See [CLAUDE.md](CLAUDE.md) after running `specweave init`
|
|
664
583
|
|
|
665
584
|
---
|
|
666
585
|
|
|
@@ -682,4 +601,4 @@ SpecWeave is inspired by and learns from:
|
|
|
682
601
|
|
|
683
602
|
**SpecWeave** - Replace vibe coding with spec-driven development.
|
|
684
603
|
|
|
685
|
-
**Get started**:
|
|
604
|
+
**Get started**: [spec-weave.com](https://spec-weave.com) | [npm install](https://www.npmjs.com/package/specweave) | [GitHub](https://github.com/anton-abyzov/specweave)
|
package/SPECWEAVE.md
CHANGED
|
@@ -179,21 +179,23 @@ npx specweave list --installed # See what's installed
|
|
|
179
179
|
|
|
180
180
|
## Quick Reference: Slash Commands
|
|
181
181
|
|
|
182
|
-
| Command | Purpose | Example |
|
|
183
|
-
|
|
184
|
-
| `/create-project` | Bootstrap new SpecWeave project | `/
|
|
185
|
-
| `/create-increment` | Create new feature/increment | `/
|
|
186
|
-
| `/start-increment` | Start working on an increment | `/
|
|
187
|
-
| `/add-tasks` | Add tasks to existing increment | `/
|
|
188
|
-
| `/validate-increment` | Validate with rule-based + optional AI quality | `/
|
|
189
|
-
| `/close-increment` | Close increment with leftover transfer | `/
|
|
190
|
-
| `/list-increments` | List all increments with status | `/
|
|
191
|
-
| `/review-docs` | Review strategic docs vs code | `/review-docs --increment=0003` |
|
|
192
|
-
| `/generate-docs` | Generate documentation site | `/generate-docs` |
|
|
193
|
-
| `/sync-github` | Sync increment to GitHub issues | `/sync-github` |
|
|
182
|
+
| Command | Alias | Purpose | Example |
|
|
183
|
+
|---------|-------|---------|---------|
|
|
184
|
+
| `/create-project` | `/init` | Bootstrap new SpecWeave project | `/init my-saas --type python` |
|
|
185
|
+
| `/create-increment` | `/ci` | Create new feature/increment | `/ci "user authentication"` |
|
|
186
|
+
| `/start-increment` | `/si` | Start working on an increment | `/si 0001` |
|
|
187
|
+
| `/add-tasks` | `/at` | Add tasks to existing increment | `/at 0001 "implement login"` |
|
|
188
|
+
| `/validate-increment` | `/vi` | Validate with rule-based + optional AI quality | `/vi 0001 --quality` |
|
|
189
|
+
| `/close-increment` | `/done` | Close increment with leftover transfer | `/done 0001` |
|
|
190
|
+
| `/list-increments` | `/ls` | List all increments with status | `/ls --status=in-progress` |
|
|
191
|
+
| `/review-docs` | - | Review strategic docs vs code | `/review-docs --increment=0003` |
|
|
192
|
+
| `/generate-docs` | - | Generate documentation site | `/generate-docs` |
|
|
193
|
+
| `/sync-github` | - | Sync increment to GitHub issues | `/sync-github` |
|
|
194
194
|
|
|
195
195
|
**All commands are framework-agnostic** (adapt to detected tech stack)
|
|
196
196
|
|
|
197
|
+
**๐ก Pro Tip**: Use short aliases (`/ci`, `/vi`, `/si`, `/done`, `/ls`, `/at`, `/init`) for speed during active development!
|
|
198
|
+
|
|
197
199
|
**See**: [Command Reference](.claude/commands/) for all available commands
|
|
198
200
|
|
|
199
201
|
---
|