specweave 0.1.5 โ 0.1.7
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 +189 -255
- package/SPECWEAVE.md +95 -52
- package/package.json +1 -1
- package/src/commands/README.md +173 -0
- package/src/commands/at.md +114 -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/pi.md +65 -0
- package/src/commands/si.md +83 -0
- package/src/commands/vi.md +89 -0
- package/src/skills/specweave-detector/SKILL.md +270 -443
- package/src/templates/CLAUDE.md.template +59 -19
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,133 @@ 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
|
|
|
104
|
+
**CRITICAL**: SpecWeave uses **EXPLICIT SLASH COMMANDS** - type them to activate the framework!
|
|
105
|
+
|
|
103
106
|
```bash
|
|
104
|
-
#
|
|
107
|
+
# Initialize project - ALL components pre-installed!
|
|
108
|
+
npx specweave init my-app
|
|
109
|
+
cd my-app
|
|
105
110
|
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
111
|
+
# Everything ready immediately:
|
|
112
|
+
# โ
10 agents in .claude/agents/
|
|
113
|
+
# โ
35+ skills in .claude/skills/
|
|
114
|
+
# โ
10 slash commands in .claude/commands/
|
|
109
115
|
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
โ
Installed architect agent
|
|
116
|
+
# Open Claude Code and use slash commands:
|
|
117
|
+
|
|
118
|
+
User: /pi "Next.js authentication with email and OAuth"
|
|
119
|
+
โ
|
|
120
|
+
SpecWeave: ๐ท SpecWeave Active (/create-increment)
|
|
116
121
|
|
|
117
122
|
๐ Creating increment 0001-user-authentication...
|
|
123
|
+
๐ Using nextjs skill (already installed!)
|
|
124
|
+
๐ค PM agent creating requirements...
|
|
125
|
+
๐๏ธ Architect agent designing system...
|
|
118
126
|
|
|
119
127
|
โ
Increment created: .specweave/increments/0001-user-authentication/
|
|
120
128
|
โ
Files: spec.md, plan.md, tasks.md, tests.md
|
|
121
129
|
|
|
122
|
-
User: "Create C4 context diagram for authentication"
|
|
130
|
+
User: "Create C4 context diagram for authentication" # Regular conversation for implementation
|
|
123
131
|
โ
|
|
124
|
-
SpecWeave:
|
|
132
|
+
SpecWeave: ๐จ Using diagrams-generator skill
|
|
133
|
+
๐ค Coordinating with diagrams-architect agent
|
|
134
|
+
|
|
125
135
|
โ
Diagram saved: .specweave/docs/internal/architecture/diagrams/auth.c4-context.mmd
|
|
126
136
|
|
|
127
|
-
User: "Implement authentication"
|
|
137
|
+
User: "Implement authentication based on plan.md" # Regular conversation
|
|
128
138
|
โ
|
|
129
|
-
SpecWeave:
|
|
139
|
+
SpecWeave: ๐ค Implementing based on specifications
|
|
140
|
+
|
|
130
141
|
โ
Code: src/auth/
|
|
131
142
|
โ
Tests: tests/auth/
|
|
132
143
|
โ
Docs: Updated automatically
|
|
144
|
+
|
|
145
|
+
User: /done 0001 # Close increment with slash command
|
|
146
|
+
โ
Increment 0001 closed successfully
|
|
133
147
|
```
|
|
134
148
|
|
|
135
149
|
**How it works**:
|
|
136
|
-
1.
|
|
137
|
-
2. **
|
|
138
|
-
3.
|
|
139
|
-
4.
|
|
140
|
-
5.
|
|
150
|
+
1. `specweave init` โ ALL components pre-installed (10 agents + 35+ skills)
|
|
151
|
+
2. **Use `/pi "feature"`** โ Creates increment with specs (spec.md, plan.md, tasks.md, tests.md)
|
|
152
|
+
3. **Regular conversation** โ Implement code based on specifications
|
|
153
|
+
4. **Use `/done 0001`** โ Close increment when complete
|
|
154
|
+
5. All components ready - no waiting, no installation
|
|
155
|
+
|
|
156
|
+
**Why slash commands?** Auto-activation doesn't work reliably - slash commands ensure SpecWeave ALWAYS activates when you want it.
|
|
141
157
|
|
|
142
158
|
---
|
|
143
159
|
|
|
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.
|
|
160
|
+
## ๐ค Agents (10 Total - All Pre-Installed!)
|
|
161
|
+
|
|
162
|
+
SpecWeave includes **10 specialized AI agents** that work with slash commands and during implementation:
|
|
163
|
+
|
|
164
|
+
| Agent | Role | When It Activates |
|
|
165
|
+
|-------|------|-------------------|
|
|
166
|
+
| **pm** | Product Manager - requirements, user stories | Planning features, creating increments |
|
|
167
|
+
| **architect** | System Architect - design, ADRs, decisions | Technical design, architecture |
|
|
168
|
+
| **security** | Security Engineer - threat modeling, OWASP | Security review, vulnerability assessment |
|
|
169
|
+
| **qa-lead** | QA Lead - test strategy, quality gates | Testing, quality assurance |
|
|
170
|
+
| **devops** | DevOps Engineer - CI/CD, infrastructure | Deployment, infrastructure needs |
|
|
171
|
+
| **tech-lead** | Technical Lead - code review, best practices | Code review, refactoring |
|
|
172
|
+
| **sre** | SRE - incident response, monitoring | Production incidents, troubleshooting |
|
|
173
|
+
| **docs-writer** | Technical Writer - documentation | Writing docs, API documentation |
|
|
174
|
+
| **performance** | Performance Engineer - optimization | Performance issues, profiling |
|
|
175
|
+
| **diagrams-architect** | Diagram Expert - C4 Model, Mermaid | Creating diagrams (via diagrams-generator skill) |
|
|
176
|
+
|
|
177
|
+
**All agents pre-installed** in `.claude/agents/` after `specweave init` - ready to use immediately!
|
|
188
178
|
|
|
189
179
|
---
|
|
190
180
|
|
|
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.
|
|
181
|
+
## ๐ฏ Skills (35+ Total - All Pre-Installed!)
|
|
182
|
+
|
|
183
|
+
SpecWeave includes **35+ AI skills** that work with slash commands:
|
|
184
|
+
|
|
185
|
+
### Core Framework Skills
|
|
186
|
+
- **specweave-detector** - Slash command documentation
|
|
187
|
+
- **increment-planner** - Plan features via `/pi` command
|
|
188
|
+
- **skill-router** - Route requests to appropriate skills
|
|
189
|
+
- **context-loader** - Load relevant specifications
|
|
190
|
+
- **role-orchestrator** - Coordinate multiple agents
|
|
191
|
+
|
|
192
|
+
### Technology Stack Skills
|
|
193
|
+
- **nextjs** - Next.js App Router, Server Components
|
|
194
|
+
- **nodejs-backend** - Node.js, Express, NestJS APIs
|
|
195
|
+
- **python-backend** - FastAPI, Django APIs
|
|
196
|
+
- **dotnet-backend** - ASP.NET Core APIs
|
|
197
|
+
- **frontend** - React, Vue, Angular components
|
|
198
|
+
|
|
199
|
+
### Integration Skills
|
|
200
|
+
- **jira-sync** - Sync with JIRA issues
|
|
201
|
+
- **ado-sync** - Sync with Azure DevOps
|
|
202
|
+
- **github-sync** - Sync with GitHub issues
|
|
203
|
+
|
|
204
|
+
### Design & Diagram Skills
|
|
205
|
+
- **diagrams-generator** - Generate C4 diagrams
|
|
206
|
+
- **figma-designer** - Create Figma designs
|
|
207
|
+
- **figma-implementer** - Convert Figma to code
|
|
208
|
+
|
|
209
|
+
### Infrastructure Skills
|
|
210
|
+
- **hetzner-provisioner** - Deploy to Hetzner Cloud
|
|
211
|
+
- **cost-optimizer** - Optimize cloud costs
|
|
212
|
+
|
|
213
|
+
### Brownfield Skills
|
|
214
|
+
- **brownfield-analyzer** - Analyze existing codebases
|
|
215
|
+
- **brownfield-onboarder** - Merge existing documentation
|
|
216
|
+
|
|
217
|
+
**And many more!** All skills pre-installed in `.claude/skills/` after `specweave init`.
|
|
218
|
+
|
|
219
|
+
**See**: [Complete skill list](https://spec-weave.com/docs/skills) on spec-weave.com
|
|
256
220
|
|
|
257
221
|
---
|
|
258
222
|
|
|
@@ -299,11 +263,10 @@ specweave/
|
|
|
299
263
|
โ โโโ hooks/ # Claude Code hooks
|
|
300
264
|
โ โโโ templates/ # Project templates
|
|
301
265
|
โ
|
|
302
|
-
โโโ .claude/ #
|
|
303
|
-
โ โโโ agents/ #
|
|
304
|
-
โ โโโ skills/ #
|
|
305
|
-
โ
|
|
306
|
-
โ โโโ hooks/ # Symlinks to src/hooks/
|
|
266
|
+
โโโ .claude/ # Pre-installed components (user projects)
|
|
267
|
+
โ โโโ agents/ # 10 agents (copied during init)
|
|
268
|
+
โ โโโ skills/ # 35+ skills (copied during init)
|
|
269
|
+
โ โโโ commands/ # 10 slash commands (copied during init)
|
|
307
270
|
โ
|
|
308
271
|
โโโ tests/ # Framework tests
|
|
309
272
|
โ โโโ unit/
|
|
@@ -325,22 +288,30 @@ specweave/
|
|
|
325
288
|
|
|
326
289
|
### For Greenfield Projects
|
|
327
290
|
|
|
291
|
+
**IMPORTANT**: Use slash commands to activate SpecWeave!
|
|
292
|
+
|
|
328
293
|
```bash
|
|
329
294
|
# 1. Create specifications (optional: comprehensive upfront or incremental)
|
|
330
295
|
# Option A: Comprehensive (Enterprise) - 500-600+ pages upfront
|
|
331
296
|
# Option B: Incremental (Startup) - Build as you go
|
|
332
297
|
|
|
333
|
-
# 2. Create increment
|
|
334
|
-
/
|
|
298
|
+
# 2. Create increment with slash command
|
|
299
|
+
/pi "user authentication"
|
|
300
|
+
# Short alias for /create-increment
|
|
301
|
+
# SpecWeave orchestrates: PM โ Architect โ QA agents
|
|
302
|
+
# Creates: spec.md, plan.md, tasks.md, tests.md
|
|
335
303
|
|
|
336
|
-
# 3. Implement with
|
|
337
|
-
"Implement user authentication"
|
|
338
|
-
#
|
|
304
|
+
# 3. Implement with regular conversation (no slash command needed)
|
|
305
|
+
"Implement user authentication based on plan.md"
|
|
306
|
+
# Claude implements based on specifications
|
|
339
307
|
|
|
340
|
-
# 4. Generate diagrams
|
|
308
|
+
# 4. Generate diagrams (regular conversation)
|
|
341
309
|
"Create C4 context diagram for authentication"
|
|
342
310
|
|
|
343
|
-
# 5.
|
|
311
|
+
# 5. Close increment with slash command
|
|
312
|
+
/done 0001
|
|
313
|
+
|
|
314
|
+
# 6. Sync with tools (optional)
|
|
344
315
|
/sync-github # Sync to GitHub issues
|
|
345
316
|
```
|
|
346
317
|
|
|
@@ -390,38 +361,6 @@ SpecWeave implements **4 Levels of Testing**:
|
|
|
390
361
|
|
|
391
362
|
---
|
|
392
363
|
|
|
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
364
|
|
|
426
365
|
## ๐จ Diagram Generation
|
|
427
366
|
|
|
@@ -502,24 +441,22 @@ sync:
|
|
|
502
441
|
|
|
503
442
|
## ๐ Documentation
|
|
504
443
|
|
|
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
|
|
444
|
+
- **[spec-weave.com](https://spec-weave.com)** - **START HERE** - Complete documentation website
|
|
445
|
+
- **[npm Package](https://www.npmjs.com/package/specweave)** - Installation and quick start
|
|
446
|
+
- **[GitHub](https://github.com/anton-abyzov/specweave)** - Source code and examples
|
|
447
|
+
- **[CLAUDE.md](CLAUDE.md)** - Complete development guide (created after `specweave init`)
|
|
511
448
|
|
|
512
449
|
---
|
|
513
450
|
|
|
514
451
|
## ๐ค Contributing
|
|
515
452
|
|
|
516
|
-
We welcome contributions!
|
|
453
|
+
We welcome contributions!
|
|
517
454
|
|
|
518
455
|
### Development Setup
|
|
519
456
|
|
|
520
457
|
```bash
|
|
521
458
|
# Clone repository
|
|
522
|
-
git clone https://github.com/
|
|
459
|
+
git clone https://github.com/anton-abyzov/specweave.git
|
|
523
460
|
cd specweave
|
|
524
461
|
|
|
525
462
|
# Install dependencies
|
|
@@ -528,19 +465,14 @@ npm install
|
|
|
528
465
|
# Build TypeScript
|
|
529
466
|
npm run build
|
|
530
467
|
|
|
531
|
-
# Install components
|
|
532
|
-
npm run install:all
|
|
533
|
-
|
|
534
468
|
# Run tests
|
|
535
469
|
npm test
|
|
536
|
-
|
|
537
|
-
# Restart Claude Code
|
|
538
470
|
```
|
|
539
471
|
|
|
540
472
|
**To contribute**:
|
|
541
473
|
1. Fork repository
|
|
542
|
-
2. Create feature branch: `git checkout -b features/
|
|
543
|
-
3. Follow
|
|
474
|
+
2. Create feature branch: `git checkout -b features/002-new-feature`
|
|
475
|
+
3. Follow SpecWeave conventions (see CLAUDE.md after init)
|
|
544
476
|
4. Add 3+ test cases (MANDATORY)
|
|
545
477
|
5. Create PR to `develop` branch
|
|
546
478
|
|
|
@@ -548,75 +480,72 @@ npm test
|
|
|
548
480
|
|
|
549
481
|
## ๐ท๏ธ Project Status
|
|
550
482
|
|
|
551
|
-
**Version**: 0.1.
|
|
483
|
+
**Version**: 0.1.6
|
|
552
484
|
**Status**: Public Beta
|
|
553
485
|
**License**: MIT
|
|
554
|
-
**Release Date**: 2025-10-
|
|
486
|
+
**Release Date**: 2025-10-28
|
|
487
|
+
**Website**: [spec-weave.com](https://spec-weave.com)
|
|
555
488
|
|
|
556
|
-
### โ
What Works (v0.1.
|
|
489
|
+
### โ
What Works (v0.1.6)
|
|
557
490
|
|
|
558
|
-
- โ
**
|
|
559
|
-
- โ
**
|
|
560
|
-
- โ
**CLI Tool** - `specweave`
|
|
561
|
-
- โ
**
|
|
562
|
-
- โ
**
|
|
491
|
+
- โ
**10 Agents** fully implemented and pre-installed
|
|
492
|
+
- โ
**35+ Skills** fully implemented and pre-installed
|
|
493
|
+
- โ
**CLI Tool** - `specweave init` with complete component copying
|
|
494
|
+
- โ
**Ready Out of the Box** - All components installed during init
|
|
495
|
+
- โ
**Auto-detection** and intelligent routing (fixed in 0.1.6!)
|
|
563
496
|
- โ
**Diagram generation** (C4 Model with validation)
|
|
564
|
-
- โ
**Install scripts** (selective installation based on tech stack)
|
|
565
497
|
- โ
**4-level testing framework** (spec โ feature โ component โ automated)
|
|
566
|
-
- โ
**JIRA/ADO/GitHub sync**
|
|
498
|
+
- โ
**JIRA/ADO/GitHub sync** integration
|
|
567
499
|
- โ
**Brownfield analyzer** (retroactive specs, regression prevention)
|
|
568
500
|
- โ
**Increment lifecycle** (5 stages, WIP limits, leftover transfer)
|
|
569
501
|
- โ
**Increment validation** (120 rules, auto-validation on save)
|
|
570
502
|
- โ
**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
|
|
503
|
+
- โ
**Living Documentation** - Auto-updated via Claude Code hooks
|
|
504
|
+
- โ
**npm Package** - Published and ready to use
|
|
580
505
|
|
|
581
506
|
### ๐
Planned (v0.2.0+)
|
|
582
507
|
|
|
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.)
|
|
508
|
+
- ๐
Quality gates and risk scoring
|
|
588
509
|
- ๐
Web UI for planning phase
|
|
589
510
|
- ๐
VS Code extension
|
|
590
511
|
- ๐
Homebrew formula
|
|
591
|
-
- ๐
|
|
512
|
+
- ๐
Additional project templates
|
|
592
513
|
|
|
593
514
|
---
|
|
594
515
|
|
|
595
|
-
## ๐
|
|
516
|
+
## ๐ Quick Start
|
|
596
517
|
|
|
597
|
-
###
|
|
518
|
+
### Initialize New Project
|
|
598
519
|
|
|
599
520
|
```bash
|
|
600
|
-
|
|
521
|
+
# Create new project (all components pre-installed!)
|
|
522
|
+
npx specweave init my-saas
|
|
601
523
|
cd my-saas
|
|
602
|
-
npm install && npm run install:all
|
|
603
524
|
|
|
604
|
-
#
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
525
|
+
# Everything ready:
|
|
526
|
+
# โ
10 agents in .claude/agents/
|
|
527
|
+
# โ
35+ skills in .claude/skills/
|
|
528
|
+
# โ
10 slash commands in .claude/commands/
|
|
608
529
|
|
|
609
|
-
#
|
|
610
|
-
"
|
|
530
|
+
# Open Claude Code and start building:
|
|
531
|
+
# "Create user authentication with JWT"
|
|
532
|
+
# "Add subscription billing with Stripe"
|
|
533
|
+
# "Build admin dashboard with analytics"
|
|
611
534
|
```
|
|
612
535
|
|
|
613
|
-
###
|
|
536
|
+
### For Existing Projects
|
|
614
537
|
|
|
615
538
|
```bash
|
|
616
|
-
#
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
539
|
+
# Add SpecWeave to existing project
|
|
540
|
+
cd my-existing-project
|
|
541
|
+
npx specweave init .
|
|
542
|
+
|
|
543
|
+
# Analyze existing code
|
|
544
|
+
# "Analyze my authentication module"
|
|
545
|
+
# SpecWeave creates retroactive specifications
|
|
546
|
+
|
|
547
|
+
# Safe to modify
|
|
548
|
+
# "Add OAuth to authentication"
|
|
620
549
|
```
|
|
621
550
|
|
|
622
551
|
---
|
|
@@ -630,7 +559,7 @@ npm install && npm run install:all
|
|
|
630
559
|
| **Documentation** | Outdated, ignored | Living, auto-updated |
|
|
631
560
|
| **Specifications** | Optional, vague | Source of truth, precise |
|
|
632
561
|
| **Testing** | Manual, incomplete | 4-level, validated |
|
|
633
|
-
| **
|
|
562
|
+
| **Components** | Manual setup | Pre-installed (10 agents + 35+ skills) |
|
|
634
563
|
| **Regression** | Frequent breaks | Prevention-first |
|
|
635
564
|
| **Onboarding** | Weeks | Hours (specs explain everything) |
|
|
636
565
|
| **Brownfield** | Risky | Safe (document first) |
|
|
@@ -638,29 +567,34 @@ npm install && npm run install:all
|
|
|
638
567
|
### vs Other Frameworks
|
|
639
568
|
|
|
640
569
|
**vs spec-kit** (GitHub):
|
|
641
|
-
- โ
SpecWeave:
|
|
642
|
-
- โ
SpecWeave: Living documentation via hooks
|
|
643
|
-
- โ
SpecWeave: Brownfield analysis
|
|
644
|
-
- โ
SpecWeave:
|
|
570
|
+
- โ
SpecWeave: **Pre-installed agents** (10) and skills (35+) - spec-kit requires manual setup
|
|
571
|
+
- โ
SpecWeave: **Living documentation** via Claude Code hooks - auto-updates on changes
|
|
572
|
+
- โ
SpecWeave: **Brownfield analysis** - retroactive spec generation for existing code
|
|
573
|
+
- โ
SpecWeave: **Tool integration** - JIRA, ADO, GitHub bidirectional sync
|
|
645
574
|
|
|
646
575
|
**vs BMAD-METHOD**:
|
|
647
|
-
- โ
SpecWeave:
|
|
648
|
-
- โ
SpecWeave:
|
|
649
|
-
- โ
SpecWeave:
|
|
650
|
-
- โ
SpecWeave: Diagram generation
|
|
576
|
+
- โ
SpecWeave: **5-pillar documentation** - strategy, architecture, delivery, operations, governance
|
|
577
|
+
- โ
SpecWeave: **Pre-installed components** - 10 agents + 35+ skills ready immediately
|
|
578
|
+
- โ
SpecWeave: **Framework agnostic** - TypeScript, Python, Go, Rust, Java, C#
|
|
579
|
+
- โ
SpecWeave: **Diagram generation** - C4 Model diagrams with validation
|
|
580
|
+
- โ
SpecWeave: **Tool integration** - JIRA/ADO/GitHub sync built-in
|
|
581
|
+
|
|
582
|
+
**Both frameworks**:
|
|
583
|
+
- โ
Specification-first development
|
|
584
|
+
- โ
Automated testing
|
|
585
|
+
- โ
Quality gates and validation
|
|
651
586
|
|
|
652
|
-
**See skills
|
|
653
|
-
- `bmad-method-expert` - Dynamic gap analysis vs BMAD
|
|
654
|
-
- `spec-kit-expert` - Dynamic gap analysis vs spec-kit
|
|
587
|
+
**Learn more**: See `bmad-method-expert` and `spec-kit-expert` skills for detailed comparisons
|
|
655
588
|
|
|
656
589
|
---
|
|
657
590
|
|
|
658
591
|
## ๐ Support & Community
|
|
659
592
|
|
|
660
|
-
- **
|
|
661
|
-
- **
|
|
662
|
-
- **
|
|
663
|
-
- **
|
|
593
|
+
- **Website**: [spec-weave.com](https://spec-weave.com)
|
|
594
|
+
- **npm Package**: [npmjs.com/package/specweave](https://www.npmjs.com/package/specweave)
|
|
595
|
+
- **GitHub**: [github.com/anton-abyzov/specweave](https://github.com/anton-abyzov/specweave)
|
|
596
|
+
- **Issues**: [github.com/anton-abyzov/specweave/issues](https://github.com/anton-abyzov/specweave/issues)
|
|
597
|
+
- **Documentation**: See [CLAUDE.md](CLAUDE.md) after running `specweave init`
|
|
664
598
|
|
|
665
599
|
---
|
|
666
600
|
|
|
@@ -682,4 +616,4 @@ SpecWeave is inspired by and learns from:
|
|
|
682
616
|
|
|
683
617
|
**SpecWeave** - Replace vibe coding with spec-driven development.
|
|
684
618
|
|
|
685
|
-
**Get started**:
|
|
619
|
+
**Get started**: [spec-weave.com](https://spec-weave.com) | [npm install](https://www.npmjs.com/package/specweave) | [GitHub](https://github.com/anton-abyzov/specweave)
|