specweave 0.6.0 → 0.6.4
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/.claude-plugin/README.md +16 -29
- package/.claude-plugin/marketplace.json +5 -5
- package/CLAUDE.md +103 -35
- package/README.md +167 -800
- package/dist/adapters/claude/adapter.d.ts +1 -1
- package/dist/adapters/claude/adapter.js +2 -2
- package/dist/adapters/claude/adapter.js.map +1 -1
- package/dist/cli/commands/init.d.ts.map +1 -1
- package/dist/cli/commands/init.js +239 -92
- package/dist/cli/commands/init.js.map +1 -1
- package/dist/cli/commands/plugin.d.ts +16 -5
- package/dist/cli/commands/plugin.d.ts.map +1 -1
- package/dist/cli/commands/plugin.js +20 -5
- package/dist/cli/commands/plugin.js.map +1 -1
- package/dist/locales/en/cli.json +19 -3
- package/dist/utils/agents-md-compiler.js +1 -1
- package/dist/utils/execFileNoThrow.d.ts +97 -0
- package/dist/utils/execFileNoThrow.d.ts.map +1 -0
- package/dist/utils/execFileNoThrow.js +130 -0
- package/dist/utils/execFileNoThrow.js.map +1 -0
- package/package.json +3 -3
- package/plugins/.specweave/logs/hooks-debug.log +24 -0
- package/plugins/.specweave/logs/last-hook-fire +1 -0
- package/plugins/.specweave/logs/last-todowrite-time +1 -0
- package/plugins/.specweave/logs/tasks.log +6 -0
- package/plugins/specweave/.claude-plugin/plugin.json +22 -0
- package/plugins/{specweave-core/commands/specweave.costs.md → specweave/commands/costs.md} +1 -1
- package/plugins/{specweave-core/commands/specweave.do.md → specweave/commands/do.md} +1 -1
- package/plugins/{specweave-core/commands/specweave.done.md → specweave/commands/done.md} +1 -1
- package/plugins/{specweave-core/commands/specweave.inc.md → specweave/commands/inc.md} +1 -1
- package/plugins/{specweave-core/commands/specweave.increment.md → specweave/commands/increment.md} +1 -1
- package/plugins/{specweave-core/commands/specweave.next.md → specweave/commands/next.md} +1 -1
- package/plugins/{specweave-core/commands/specweave.progress.md → specweave/commands/progress.md} +1 -1
- package/plugins/{specweave-core → specweave}/commands/specweave.md +13 -13
- package/plugins/{specweave-core/commands/specweave.sync-docs.md → specweave/commands/sync-docs.md} +1 -1
- package/plugins/{specweave-core/commands/specweave.translate.md → specweave/commands/translate.md} +1 -1
- package/plugins/{specweave-core/commands/specweave.validate.md → specweave/commands/validate.md} +1 -1
- package/plugins/specweave/hooks/hooks.json +15 -0
- package/plugins/{specweave-core → specweave}/skills/plugin-detector/SKILL.md +1 -1
- package/plugins/{specweave-core → specweave}/skills/tdd-workflow/SKILL.md +1 -1
- package/plugins/specweave-github/.claude-plugin/plugin.json +13 -2
- package/plugins/specweave-ml/.claude-plugin/plugin.json +5 -6
- package/plugins/specweave-ui/.claude-plugin/plugin.json +6 -86
- package/src/adapters/claude/adapter.ts +2 -2
- package/src/templates/.gitignore.template +2 -0
- package/plugins/specweave-core/.claude-plugin/plugin.json +0 -25
- package/plugins/specweave-core/hooks/hooks.json +0 -13
- /package/plugins/{specweave-core → specweave}/agents/architect/AGENT.md +0 -0
- /package/plugins/{specweave-core → specweave}/agents/code-reviewer.md +0 -0
- /package/plugins/{specweave-core → specweave}/agents/docs-writer/AGENT.md +0 -0
- /package/plugins/{specweave-core → specweave}/agents/performance/AGENT.md +0 -0
- /package/plugins/{specweave-core → specweave}/agents/pm/AGENT.md +0 -0
- /package/plugins/{specweave-core → specweave}/agents/qa-lead/AGENT.md +0 -0
- /package/plugins/{specweave-core → specweave}/agents/security/AGENT.md +0 -0
- /package/plugins/{specweave-core → specweave}/agents/tdd-orchestrator/AGENT.md +0 -0
- /package/plugins/{specweave-core → specweave}/agents/tech-lead/AGENT.md +0 -0
- /package/plugins/{specweave-core → specweave}/agents/translator/AGENT.md +0 -0
- /package/plugins/{specweave-core → specweave}/commands/README.md +0 -0
- /package/plugins/{specweave-core/commands/specweave.list-increments.md → specweave/commands/list-increments.md} +0 -0
- /package/plugins/{specweave-core/commands/specweave.tdd-cycle.md → specweave/commands/tdd-cycle.md} +0 -0
- /package/plugins/{specweave-core/commands/specweave.tdd-green.md → specweave/commands/tdd-green.md} +0 -0
- /package/plugins/{specweave-core/commands/specweave.tdd-red.md → specweave/commands/tdd-red.md} +0 -0
- /package/plugins/{specweave-core/commands/specweave.tdd-refactor.md → specweave/commands/tdd-refactor.md} +0 -0
- /package/plugins/{specweave-core → specweave}/hooks/README.md +0 -0
- /package/plugins/{specweave-core → specweave}/hooks/docs-changed.sh +0 -0
- /package/plugins/{specweave-core → specweave}/hooks/human-input-required.sh +0 -0
- /package/plugins/{specweave-core → specweave}/hooks/post-increment-plugin-detect.sh +0 -0
- /package/plugins/{specweave-core → specweave}/hooks/post-task-completion.sh +0 -0
- /package/plugins/{specweave-core → specweave}/hooks/pre-implementation.sh +0 -0
- /package/plugins/{specweave-core → specweave}/hooks/pre-task-plugin-detect.sh +0 -0
- /package/plugins/{specweave-core → specweave}/skills/SKILLS-INDEX.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/brownfield-analyzer/SKILL.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/brownfield-onboarder/SKILL.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/context-loader/SKILL.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/context-optimizer/SKILL.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/docs-updater/README.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/docs-updater/SKILL.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/increment-planner/SKILL.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/increment-planner/scripts/feature-utils.js +0 -0
- /package/plugins/{specweave-core → specweave}/skills/increment-quality-judge/SKILL.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/project-kickstarter/SKILL.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/project-kickstarter/test-cases/test-1-high-confidence-full-product.yaml +0 -0
- /package/plugins/{specweave-core → specweave}/skills/project-kickstarter/test-cases/test-2-medium-confidence-partial.yaml +0 -0
- /package/plugins/{specweave-core → specweave}/skills/project-kickstarter/test-cases/test-3-low-confidence-technical-question.yaml +0 -0
- /package/plugins/{specweave-core → specweave}/skills/project-kickstarter/test-cases/test-4-opt-out-explicit.yaml +0 -0
- /package/plugins/{specweave-core → specweave}/skills/rfc-generator/SKILL.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/role-orchestrator/README.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/role-orchestrator/SKILL.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/specweave-detector/SKILL.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/specweave-framework/SKILL.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/specweave-framework/test-cases/test-1-increment-naming.yaml +0 -0
- /package/plugins/{specweave-core → specweave}/skills/specweave-framework/test-cases/test-2-source-of-truth.yaml +0 -0
- /package/plugins/{specweave-core → specweave}/skills/specweave-framework/test-cases/test-3-increment-discipline.yaml +0 -0
- /package/plugins/{specweave-core → specweave}/skills/specweave-framework/test-cases/test-4-file-placement.yaml +0 -0
- /package/plugins/{specweave-core → specweave}/skills/task-builder/README.md +0 -0
- /package/plugins/{specweave-core → specweave}/skills/translator/SKILL.md +0 -0
package/README.md
CHANGED
|
@@ -1,928 +1,295 @@
|
|
|
1
1
|
# SpecWeave
|
|
2
2
|
|
|
3
|
-
> **Spec-Driven Development Framework** -
|
|
3
|
+
> **Spec-Driven Development Framework for Claude Code** - Replace "vibe coding" with specifications as the source of truth
|
|
4
4
|
|
|
5
5
|
[](https://opensource.org/licenses/MIT)
|
|
6
|
-
[](https://github.com/anton-abyzov/specweave/releases/tag/v0.6.0)
|
|
7
|
-
[]()
|
|
8
|
-
[](https://spec-weave.com)
|
|
9
6
|
|
|
10
7
|
---
|
|
11
8
|
|
|
12
|
-
##
|
|
9
|
+
## What is SpecWeave?
|
|
13
10
|
|
|
14
|
-
**SpecWeave** is an AI development framework that
|
|
11
|
+
**SpecWeave** is an AI development framework that makes specifications your source of truth. Built specifically for **Claude Code**, it replaces guesswork with precision through automated planning, living documentation, and regression prevention.
|
|
15
12
|
|
|
16
|
-
|
|
17
|
-
**📦 npm**: [npmjs.com/package/specweave](https://www.npmjs.com/package/specweave)
|
|
18
|
-
|
|
19
|
-
### 🎯 Core Philosophy
|
|
20
|
-
|
|
21
|
-
1. **Specification Before Implementation** - Define WHAT and WHY before HOW
|
|
22
|
-
2. **Living Documentation** - Specs evolve with code, never diverge
|
|
23
|
-
3. **Regression Prevention** - Document before modifying existing code
|
|
24
|
-
4. **Test-Validated Features** - Every feature proven through automated tests
|
|
25
|
-
5. **Ready Out of the Box** - All components pre-installed, no setup needed
|
|
13
|
+
**Define WHAT and WHY before HOW. Specifications evolve with code, never diverge.**
|
|
26
14
|
|
|
27
15
|
---
|
|
28
16
|
|
|
29
|
-
##
|
|
30
|
-
|
|
31
|
-
- 🤖 **Autonomous & Smart** - Just works! Agents ask clarifying questions, review output, validate quality—minimal interaction required
|
|
32
|
-
- ⚡ **Seamless Workflow** - Auto-resume, auto-close, progress tracking—natural flow without overhead
|
|
33
|
-
- 🔌 **Plugin Architecture** (NEW in v0.4.0) - Modular design with 75%+ context reduction! Core framework (12K tokens) + opt-in plugins only when needed
|
|
34
|
-
- Core: 3 agents + 8 skills (always loaded)
|
|
35
|
-
- Plugins: GitHub sync, tech stacks, domain expertise (load on demand)
|
|
36
|
-
- **Context efficiency**: 50K → 12K tokens for basic projects!
|
|
37
|
-
- 🎯 **Extensible & Scalable** - 10+ agents and 40+ skills via plugins. PM, Architect, DevOps, QA, Security work in parallel
|
|
38
|
-
- 🔧 **Claude Code Native** - Built specifically for Claude Code's native plugin marketplace
|
|
39
|
-
- **Claude Code**: Full native support with auto-activation, hooks, isolated agents
|
|
40
|
-
- **Other tools**: Legacy adapter system (may be removed in future versions)
|
|
41
|
-
- 🧪 **Complete Test Coverage** - 4-level strategy from specs to integration tests (APIs, UIs, CLIs, libraries)
|
|
42
|
-
- 📚 **Living Documentation** - Specs auto-update after every operation and test—always in sync with code
|
|
43
|
-
- 🌍 **Multilingual Support** (NEW in v0.6.0) - Zero-cost LLM-native translation for 9 languages! Framework works in English, Russian, Spanish, Chinese, German, French, Japanese, Korean, and Portuguese
|
|
44
|
-
- **Zero external costs**: Uses current LLM session for translation (no API keys!)
|
|
45
|
-
- **Auto-translation**: Living docs auto-translate after every task
|
|
46
|
-
- **Smart preservation**: Framework terms (increment, spec.md) stay in English
|
|
47
|
-
- **CLI localization**: Commands and output in your language
|
|
48
|
-
- **translator skill**: Batch translation for entire projects
|
|
49
|
-
- 🎨 **Visual Architecture** - C4 Model diagrams (Context, Container, Component)
|
|
50
|
-
- 🔄 **Tool Integration** - GitHub, JIRA, Azure DevOps sync (via plugins)
|
|
51
|
-
- 🏢 **Brownfield Excellence** - The hardest problem solved: merge with existing docs, create complex architecture (ADRs, HLDs, RFCs), maintain living documentation, safe regression prevention
|
|
52
|
-
- 🌐 **Framework Agnostic** - Works with TypeScript, Python, Go, Rust, Java, C#—any tech stack
|
|
53
|
-
|
|
54
|
-
---
|
|
17
|
+
## Why SpecWeave?
|
|
55
18
|
|
|
56
|
-
|
|
19
|
+
Traditional development:
|
|
20
|
+
- ❌ Documentation becomes outdated and ignored
|
|
21
|
+
- ❌ "Vibe coding" - making it up as you go
|
|
22
|
+
- ❌ Breaking existing code during changes
|
|
23
|
+
- ❌ Tribal knowledge scattered across team
|
|
24
|
+
- ❌ Weeks of onboarding new developers
|
|
57
25
|
|
|
58
|
-
|
|
26
|
+
SpecWeave solves this:
|
|
27
|
+
- ✅ **Living Documentation** - Auto-updates after every task via Claude Code hooks
|
|
28
|
+
- ✅ **Specification-First** - Define requirements before implementation
|
|
29
|
+
- ✅ **Regression Prevention** - Document existing code before modifications
|
|
30
|
+
- ✅ **Intelligent Automation** - PM, Architect, and QA agents work autonomously
|
|
31
|
+
- ✅ **Zero Setup** - Works out of the box with Claude Code's native plugin system
|
|
59
32
|
|
|
60
|
-
|
|
61
|
-
- **npm 9+** (`npm --version`)
|
|
62
|
-
- **Claude Code** - SpecWeave is designed specifically for Claude Code
|
|
63
|
-
- Claude Sonnet 4.5 or higher
|
|
64
|
-
- Native plugin support via `/plugin` commands
|
|
33
|
+
---
|
|
65
34
|
|
|
66
|
-
|
|
35
|
+
## Installation
|
|
67
36
|
|
|
68
|
-
**
|
|
37
|
+
**Prerequisites**: Node.js 18+, Claude Code
|
|
69
38
|
|
|
70
39
|
```bash
|
|
71
|
-
# Install
|
|
40
|
+
# Install SpecWeave CLI
|
|
72
41
|
npm install -g specweave
|
|
73
42
|
|
|
74
|
-
#
|
|
75
|
-
specweave init my-
|
|
76
|
-
cd my-
|
|
77
|
-
```
|
|
78
|
-
|
|
79
|
-
**One-time usage (like npx):**
|
|
80
|
-
|
|
81
|
-
```bash
|
|
82
|
-
# No installation required
|
|
83
|
-
npx specweave init my-saas
|
|
84
|
-
cd my-saas
|
|
85
|
-
```
|
|
86
|
-
|
|
87
|
-
**Install from GitHub (current beta.1):**
|
|
88
|
-
|
|
89
|
-
```bash
|
|
90
|
-
# Clone repository
|
|
91
|
-
git clone https://github.com/anton-abyzov/specweave.git
|
|
92
|
-
cd specweave
|
|
93
|
-
|
|
94
|
-
# Install dependencies and build
|
|
95
|
-
npm install
|
|
96
|
-
npm run build
|
|
97
|
-
|
|
98
|
-
# Link globally (makes 'specweave' command available)
|
|
99
|
-
npm link
|
|
43
|
+
# Initialize your project (auto-installs plugins!)
|
|
44
|
+
specweave init my-project
|
|
45
|
+
cd my-project
|
|
100
46
|
|
|
101
|
-
#
|
|
102
|
-
specweave init my-saas
|
|
47
|
+
# Done! Slash commands ready immediately
|
|
103
48
|
```
|
|
104
49
|
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
specweave --version # Show version
|
|
111
|
-
specweave --help # Show help
|
|
112
|
-
```
|
|
113
|
-
|
|
114
|
-
**Note**:
|
|
115
|
-
- **Claude Code**: Core framework (3 agents + 9 skills) installed natively via Claude marketplace
|
|
116
|
-
- **Plugins**: 17+ available plugins for tech stacks, integrations, and domain expertise
|
|
117
|
-
- **Installation**: Via Claude Code's `/plugin` commands (see [Claude Code Plugin Docs](https://docs.claude.com/en/docs/claude-code/plugins))
|
|
50
|
+
**What just happened?**
|
|
51
|
+
1. ✅ Created `.specweave/` structure (increments, docs, logs)
|
|
52
|
+
2. ✅ Auto-installed `specweave` plugin globally via `/plugin install`
|
|
53
|
+
3. ✅ Slash commands like `/specweave:inc` immediately available
|
|
54
|
+
4. ✅ Skills and agents ready to use
|
|
118
55
|
|
|
119
56
|
---
|
|
120
57
|
|
|
121
|
-
##
|
|
58
|
+
## Quick Start
|
|
122
59
|
|
|
123
|
-
**
|
|
60
|
+
**Open Claude Code in your project and use slash commands:**
|
|
124
61
|
|
|
125
62
|
```bash
|
|
126
|
-
#
|
|
127
|
-
|
|
128
|
-
cd my-app
|
|
129
|
-
|
|
130
|
-
# For Claude Code - core framework native and ready immediately:
|
|
131
|
-
# ✅ 3 core agents in .claude/agents/ (PM, Architect, Tech Lead)
|
|
132
|
-
# ✅ 8 core skills in .claude/skills/ (increment lifecycle, living docs)
|
|
133
|
-
# ✅ 7 slash commands in .claude/commands/
|
|
134
|
-
# ✅ Plugins auto-detected and suggested based on project
|
|
135
|
-
# (Other tools get AGENTS.md adapter instead)
|
|
136
|
-
|
|
137
|
-
# Open Claude Code and use slash commands:
|
|
138
|
-
|
|
139
|
-
User: /specweave inc "Next.js authentication with email and OAuth"
|
|
140
|
-
↓
|
|
141
|
-
SpecWeave: 🔷 SpecWeave Active (/specweave:increment)
|
|
142
|
-
|
|
143
|
-
🚀 Creating increment 0001-user-authentication...
|
|
144
|
-
📝 Using nextjs skill (already installed!)
|
|
145
|
-
🤖 PM agent creating requirements...
|
|
146
|
-
🏗️ Architect agent designing system...
|
|
147
|
-
📋 Auto-generating tasks from plan...
|
|
148
|
-
|
|
149
|
-
✅ Increment created: .specweave/increments/0001-user-authentication/
|
|
150
|
-
✅ Files: spec.md, plan.md, tasks.md (auto-generated!), tests.md
|
|
63
|
+
# 1. Plan your first feature (PM-led workflow)
|
|
64
|
+
/specweave:inc "User authentication with JWT"
|
|
151
65
|
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
66
|
+
# SpecWeave creates:
|
|
67
|
+
# ✅ spec.md (WHAT & WHY)
|
|
68
|
+
# ✅ plan.md (HOW - architecture)
|
|
69
|
+
# ✅ tasks.md (auto-generated from plan!)
|
|
70
|
+
# ✅ tests.md (test strategy)
|
|
156
71
|
|
|
157
|
-
|
|
72
|
+
# 2. Implement (auto-resumes from last task)
|
|
73
|
+
/specweave:do
|
|
158
74
|
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
75
|
+
# Hooks run after EVERY task:
|
|
76
|
+
# ✅ Updates living docs automatically
|
|
77
|
+
# ✅ Syncs architectural decisions
|
|
78
|
+
# ✅ Maintains test coverage
|
|
162
79
|
|
|
163
|
-
|
|
164
|
-
|
|
165
|
-
|
|
80
|
+
# 3. Check progress anytime
|
|
81
|
+
/specweave:progress
|
|
82
|
+
# Shows: 73% complete (11/15 tasks), next action: "Implement login API"
|
|
166
83
|
|
|
167
|
-
|
|
168
|
-
|
|
84
|
+
# 4. Start next feature (auto-closes previous)
|
|
85
|
+
/specweave:inc "Payment processing with Stripe"
|
|
86
|
+
# ✅ Auto-closes 0001 if complete
|
|
87
|
+
# ✅ Creates 0002-payment-processing
|
|
88
|
+
# ✅ Detects Stripe keyword → suggests specweave-payments plugin
|
|
169
89
|
```
|
|
170
90
|
|
|
171
|
-
**
|
|
172
|
-
1. `specweave init` → Installs SpecWeave core framework via Claude Code marketplace
|
|
173
|
-
2. **Use `/specweave inc "feature"`** → PM creates specs + plan + auto-generates tasks
|
|
174
|
-
- PM creates specs + plan + auto-generates tasks
|
|
175
|
-
- **Smart**: Auto-detects needed plugins from feature description
|
|
176
|
-
- **Smart**: Auto-closes previous increment if PM gates pass
|
|
177
|
-
3. **Use `/specweave do` or `/specweave do 0001`** → Execute implementation (hooks after EVERY task in Claude)
|
|
178
|
-
- **Smart**: Auto-resumes from next incomplete task
|
|
179
|
-
4. **Use `/specweave progress`** → Check status, task completion %, next action
|
|
180
|
-
5. **Use `/specweave validate 0001`** → Optional quality check (LLM-as-judge)
|
|
181
|
-
6. Repeat: `/specweave inc "next"` → Auto-closes if ready, creates next increment
|
|
182
|
-
|
|
183
|
-
**Why smart workflow?**
|
|
184
|
-
- ✅ No manual `/specweave done` needed (auto-closes on next `/specweave inc`)
|
|
185
|
-
- ✅ No task tracking needed (`/specweave do` auto-resumes)
|
|
186
|
-
- ✅ `/specweave progress` shows exactly where you are
|
|
187
|
-
- ✅ Natural flow: finish → start next
|
|
188
|
-
- ✅ Namespaced commands avoid collisions in brownfield projects
|
|
91
|
+
**That's it.** No manual documentation updates. No outdated specs. No regression.
|
|
189
92
|
|
|
190
93
|
---
|
|
191
94
|
|
|
192
|
-
##
|
|
193
|
-
|
|
194
|
-
SpecWeave uses a **modular agent system** - core agents (always available) + plugin agents (opt-in):
|
|
195
|
-
|
|
196
|
-
### Core Agents (Always Available)
|
|
197
|
-
|
|
198
|
-
| Agent | Role | When It Activates |
|
|
199
|
-
|-------|------|-------------------|
|
|
200
|
-
| **pm** | Product Manager - requirements, user stories | Planning features, creating increments |
|
|
201
|
-
| **architect** | System Architect - design, ADRs, decisions | Technical design, architecture |
|
|
202
|
-
| **tech-lead** | Technical Lead - code review, best practices | Code review, refactoring |
|
|
203
|
-
|
|
204
|
-
### Plugin Agents (Available via Plugins)
|
|
205
|
-
|
|
206
|
-
| Agent | Plugin | Role | When It Activates |
|
|
207
|
-
|-------|--------|------|-------------------|
|
|
208
|
-
| **github-manager** | specweave-github | GitHub CLI specialist | GitHub operations, issue sync |
|
|
209
|
-
| **security** | specweave-security | Security Engineer - threat modeling | Security review, vulnerabilities |
|
|
210
|
-
| **qa-lead** | specweave-qa | QA Lead - test strategy | Testing, quality assurance |
|
|
211
|
-
| **devops** | specweave-kubernetes | DevOps Engineer - K8s, infrastructure | Deployment, infrastructure |
|
|
212
|
-
| **sre** | specweave-observability | SRE - incident response, monitoring | Production incidents |
|
|
213
|
-
| **docs-writer** | specweave-docs | Technical Writer - documentation | Writing docs, API docs |
|
|
214
|
-
| **performance** | specweave-performance | Performance Engineer - optimization | Performance issues |
|
|
215
|
-
| **diagrams-architect** | specweave-diagrams | Diagram Expert - C4 Model, Mermaid | Creating diagrams |
|
|
216
|
-
|
|
217
|
-
**Agent Access**:
|
|
218
|
-
- **Claude Code**: Core agents available natively, plugin agents load via `/plugin install`
|
|
219
|
-
|
|
220
|
-
---
|
|
221
|
-
|
|
222
|
-
## 🎯 Skills
|
|
223
|
-
|
|
224
|
-
SpecWeave uses a **modular skill system** - core skills (always available) + plugin skills (opt-in):
|
|
225
|
-
|
|
226
|
-
### Core Skills (Always Available)
|
|
227
|
-
|
|
228
|
-
**Increment Lifecycle:**
|
|
229
|
-
- **increment-planner** - Plan features via `/specweave inc` command
|
|
230
|
-
- **rfc-generator** - Generate RFCs and technical proposals
|
|
231
|
-
- **context-loader** - Explains progressive disclosure and context efficiency
|
|
232
|
-
- **context-optimizer** - Second-pass context optimization (80%+ token reduction)
|
|
233
|
-
|
|
234
|
-
**Project Management:**
|
|
235
|
-
- **project-kickstarter** - Initialize new projects from descriptions
|
|
236
|
-
- **increment-quality-judge** - AI-powered quality assessment
|
|
237
|
-
|
|
238
|
-
**Brownfield Support:**
|
|
239
|
-
- **brownfield-analyzer** - Analyze existing codebases
|
|
240
|
-
- **brownfield-onboarder** - Merge existing documentation
|
|
241
|
-
|
|
242
|
-
### Plugin Skills (40+ Available via Plugins)
|
|
243
|
-
|
|
244
|
-
**GitHub Integration (specweave-github):**
|
|
245
|
-
- **github-sync** - Bidirectional increment ↔ issue sync
|
|
246
|
-
- **github-issue-tracker** - Task-level progress tracking
|
|
247
|
-
|
|
248
|
-
**Technology Stacks:**
|
|
249
|
-
- **nextjs** - Next.js App Router, Server Components (specweave-frontend-stack)
|
|
250
|
-
- **nodejs-backend** - Node.js, Express, NestJS APIs (specweave-backend-stack)
|
|
251
|
-
- **python-backend** - FastAPI, Django APIs (specweave-backend-stack)
|
|
252
|
-
- **dotnet-backend** - ASP.NET Core APIs (specweave-backend-stack)
|
|
253
|
-
- **frontend** - React, Vue, Angular components (specweave-frontend-stack)
|
|
254
|
-
|
|
255
|
-
**Infrastructure:**
|
|
256
|
-
- **hetzner-provisioner** - Deploy to Hetzner Cloud (specweave-cloud)
|
|
257
|
-
- **cost-optimizer** - Optimize cloud costs (specweave-cloud)
|
|
258
|
-
- **k8s-deployer** - Kubernetes deployment (specweave-kubernetes)
|
|
259
|
-
|
|
260
|
-
**Integrations:**
|
|
261
|
-
- **jira-sync** - Sync with JIRA issues (specweave-jira)
|
|
262
|
-
- **ado-sync** - Sync with Azure DevOps (specweave-ado)
|
|
95
|
+
## How It Works
|
|
263
96
|
|
|
264
|
-
|
|
265
|
-
- **diagrams-generator** - Generate C4 diagrams (specweave-diagrams)
|
|
266
|
-
- **figma-designer** - Create Figma designs (specweave-figma)
|
|
267
|
-
- **figma-implementer** - Convert Figma to code (specweave-figma)
|
|
97
|
+
### Claude Code Native Architecture
|
|
268
98
|
|
|
269
|
-
**
|
|
270
|
-
|
|
271
|
-
### 🔌 Plugin System (NEW in v0.4.0)
|
|
272
|
-
|
|
273
|
-
SpecWeave v0.4.0 introduces **intelligent plugin detection**:
|
|
274
|
-
|
|
275
|
-
1. **Auto-Detection** - Plugins suggested based on:
|
|
276
|
-
- Package.json dependencies (React → frontend-stack)
|
|
277
|
-
- Directory structure (kubernetes/ → kubernetes)
|
|
278
|
-
- Git remote (github.com → github)
|
|
279
|
-
- Environment variables (GITHUB_TOKEN → github)
|
|
280
|
-
|
|
281
|
-
2. **Context Efficiency** - Load only what you need:
|
|
282
|
-
- Basic project: **12K tokens** (core only)
|
|
283
|
-
- React app: **16K tokens** (core + frontend-stack + github)
|
|
284
|
-
- Backend API: **15K tokens** (core + backend-stack + github)
|
|
285
|
-
|
|
286
|
-
3. **Claude Code Native** - Built for Claude's plugin marketplace:
|
|
287
|
-
- **Native `/plugin` commands**: Install plugins directly
|
|
288
|
-
- **Auto-activation**: Skills activate based on context
|
|
289
|
-
- **Isolated agents**: True role separation
|
|
290
|
-
|
|
291
|
-
**How it works**:
|
|
292
|
-
1. **Discovery**: Read `.claude/skills/SKILLS-INDEX.md` (1 file vs 35 files = 97% faster)
|
|
293
|
-
2. **Matching**: Find skills by activation keywords (e.g., "feature planning" → increment-planner)
|
|
294
|
-
3. **Loading**: Load full SKILL.md only when relevant
|
|
295
|
-
4. **Execution**: Follow proven workflows
|
|
296
|
-
|
|
297
|
-
**Benefits**:
|
|
298
|
-
- ✅ **75%+ token savings** - Core framework 12K tokens (vs 50K in v0.3.7)
|
|
299
|
-
- ✅ **Claude Code native** - Full integration with marketplace, hooks, agents
|
|
300
|
-
- ✅ **Context efficient** - Load only needed plugins on demand
|
|
301
|
-
|
|
302
|
-
**Skill Access**:
|
|
303
|
-
- **Claude Code**: Core skills auto-activate based on context, plugin skills via `/plugin install`
|
|
304
|
-
|
|
305
|
-
**See**: [Complete skill list](https://spec-weave.com/docs/skills) on spec-weave.com
|
|
306
|
-
|
|
307
|
-
---
|
|
308
|
-
|
|
309
|
-
## 📁 Project Structure
|
|
99
|
+
SpecWeave is built **100% on Claude Code's native plugin system**:
|
|
310
100
|
|
|
311
101
|
```
|
|
312
|
-
|
|
313
|
-
├──
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
│ │ │ ├── operations/ # Runbooks, SLOs, monitoring
|
|
324
|
-
│ │ │ └── governance/ # Security, compliance
|
|
325
|
-
│ │ └── public/ # Published docs (Docusaurus)
|
|
326
|
-
│ │ ├── overview/
|
|
327
|
-
│ │ ├── guides/
|
|
328
|
-
│ │ ├── api/
|
|
329
|
-
│ │ └── changelog/
|
|
330
|
-
│ ├── increments/ # Auto-numbered features
|
|
331
|
-
│ │ ├── README.md
|
|
332
|
-
│ │ ├── roadmap.md
|
|
333
|
-
│ │ └── 0001-feature-name/
|
|
334
|
-
│ │ ├── spec.md # WHAT & WHY
|
|
335
|
-
│ │ ├── plan.md # HOW (architecture)
|
|
336
|
-
│ │ ├── tasks.md # Executable steps
|
|
337
|
-
│ │ ├── tests.md # Test strategy
|
|
338
|
-
│ │ ├── context-manifest.yaml # Context loading
|
|
339
|
-
│ │ ├── logs/ # Execution logs
|
|
340
|
-
│ │ ├── scripts/ # Helper scripts
|
|
341
|
-
│ │ └── reports/ # Analysis reports
|
|
342
|
-
│ └── tests/ # Centralized test repository
|
|
343
|
-
│
|
|
344
|
-
├── src/ # Source code (TypeScript only)
|
|
345
|
-
│ ├── core/ # Core framework logic
|
|
346
|
-
│ ├── cli/ # CLI commands
|
|
347
|
-
│ ├── adapters/ # Tool adapters (legacy)
|
|
348
|
-
│ ├── templates/ # Project templates
|
|
349
|
-
│ └── utils/ # Utility functions
|
|
350
|
-
│
|
|
351
|
-
├── skills/ # Core skills (root level)
|
|
352
|
-
│ ├── rfc-generator/ # RFC generation
|
|
353
|
-
│ ├── increment-planner/ # Increment planning
|
|
354
|
-
│ └── ... # 8 core skills total
|
|
355
|
-
│
|
|
356
|
-
├── agents/ # Core agents (root level)
|
|
357
|
-
│ ├── pm/ # Product Manager
|
|
358
|
-
│ ├── architect/ # System Architect
|
|
359
|
-
│ └── tech-lead/ # Technical Lead
|
|
360
|
-
│
|
|
361
|
-
├── commands/ # Slash commands (root level)
|
|
362
|
-
│ ├── specweave.inc.md
|
|
363
|
-
│ ├── specweave.do.md
|
|
364
|
-
│ └── ...
|
|
365
|
-
│
|
|
366
|
-
├── plugins/ # Plugins (root level)
|
|
367
|
-
│ ├── specweave-github/ # GitHub integration
|
|
368
|
-
│ ├── specweave-figma/ # Figma design sync
|
|
369
|
-
│ └── ... # 17 plugins total
|
|
370
|
-
│
|
|
371
|
-
├── .claude/ # Pre-installed components (user projects)
|
|
372
|
-
│ ├── agents/ # 10 agents (copied during init)
|
|
373
|
-
│ ├── skills/ # 35+ skills (copied during init)
|
|
374
|
-
│ └── commands/ # 10 slash commands (copied during init)
|
|
375
|
-
│
|
|
376
|
-
├── tests/ # Framework tests
|
|
377
|
-
│ ├── unit/
|
|
378
|
-
│ ├── integration/
|
|
379
|
-
│ └── e2e/
|
|
380
|
-
│
|
|
381
|
-
├── CLAUDE.md # Complete development guide (source of truth)
|
|
382
|
-
├── README.md # This file
|
|
383
|
-
├── INSTALLATION.md # Detailed installation guide
|
|
384
|
-
├── package.json # npm package definition
|
|
385
|
-
└── tsconfig.json # TypeScript configuration
|
|
102
|
+
Core Plugin (always loaded):
|
|
103
|
+
├── Skills (9) → Auto-activate based on context
|
|
104
|
+
├── Agents (22) → PM, Architect, QA work autonomously
|
|
105
|
+
├── Commands (22) → /specweave:inc, /specweave:do, etc.
|
|
106
|
+
└── Hooks (8) → Auto-update docs after every task
|
|
107
|
+
|
|
108
|
+
Optional Plugins (install on demand):
|
|
109
|
+
├── specweave-github → GitHub Issues sync
|
|
110
|
+
├── specweave-figma → Design integration
|
|
111
|
+
├── specweave-frontend → React, Next.js expertise
|
|
112
|
+
└── 15+ more plugins → Load only what you need
|
|
386
113
|
```
|
|
387
114
|
|
|
388
|
-
**
|
|
115
|
+
**Result**: 75%+ context reduction (12K tokens vs 50K in older approaches)
|
|
389
116
|
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
## 🛠️ Development Workflow
|
|
393
|
-
|
|
394
|
-
### For Greenfield Projects
|
|
117
|
+
### The Workflow
|
|
395
118
|
|
|
396
|
-
**
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
# 2. Plan increment (PM-led, auto-closes previous if ready)
|
|
404
|
-
/specweave inc "user authentication"
|
|
405
|
-
# Alias: /specweave increment
|
|
406
|
-
# PM-led: Market research → spec.md → plan.md → auto-generate tasks.md
|
|
407
|
-
# Smart: Auto-closes previous increment if PM gates pass
|
|
408
|
-
|
|
409
|
-
# 3. Execute implementation (smart resume, hooks after EVERY task)
|
|
410
|
-
/specweave do
|
|
411
|
-
# Or: /specweave do 0001
|
|
412
|
-
# Smart: Auto-resumes from next incomplete task
|
|
413
|
-
# Hooks automatically update CLAUDE.md, README.md, CHANGELOG.md
|
|
414
|
-
|
|
415
|
-
# 4. Check progress anytime
|
|
416
|
-
/specweave progress
|
|
417
|
-
# Shows: task completion %, PM gates status, next action
|
|
418
|
-
# No increment ID needed - finds active increment automatically
|
|
419
|
-
|
|
420
|
-
# 5. Validate quality (optional)
|
|
421
|
-
/specweave validate 0001 --quality
|
|
422
|
-
# LLM-as-judge quality assessment
|
|
423
|
-
|
|
424
|
-
# 6. Start next feature (auto-closes previous)
|
|
425
|
-
/specweave inc "payment processing"
|
|
426
|
-
# Auto-closes 0001 if gates pass, creates 0002
|
|
427
|
-
# No manual /done needed!
|
|
428
|
-
|
|
429
|
-
# 7. Sync with tools (optional)
|
|
430
|
-
/specweave sync-github # Sync to GitHub issues
|
|
431
|
-
```
|
|
119
|
+
**1. Specification Phase** (`/specweave:inc`)
|
|
120
|
+
- PM agent does market research
|
|
121
|
+
- Creates `spec.md` (requirements)
|
|
122
|
+
- Architect creates `plan.md` (design)
|
|
123
|
+
- Auto-generates `tasks.md` from plan
|
|
124
|
+
- QA creates test strategy
|
|
432
125
|
|
|
433
|
-
|
|
126
|
+
**2. Implementation Phase** (`/specweave:do`)
|
|
127
|
+
- Auto-resumes from next incomplete task
|
|
128
|
+
- Hooks run after EVERY task completion:
|
|
129
|
+
- Syncs living docs
|
|
130
|
+
- Updates architectural decisions
|
|
131
|
+
- Maintains test coverage
|
|
434
132
|
|
|
435
|
-
**
|
|
133
|
+
**3. Validation Phase** (`/specweave:progress`)
|
|
134
|
+
- Shows task completion percentage
|
|
135
|
+
- Identifies next action
|
|
136
|
+
- Optional quality gates via LLM-as-judge
|
|
436
137
|
|
|
437
|
-
-
|
|
138
|
+
**4. Repeat** - Start next increment (auto-closes previous)
|
|
438
139
|
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
- ❌ Risk of breaking production systems
|
|
442
|
-
|
|
443
|
-
- ❌ Need to merge with existing docs/wikis
|
|
140
|
+
---
|
|
444
141
|
|
|
445
|
-
|
|
142
|
+
## For Brownfield Projects
|
|
446
143
|
|
|
447
|
-
**
|
|
144
|
+
**The hardest challenge in software development**: adding structure to existing codebases.
|
|
448
145
|
|
|
449
146
|
```bash
|
|
450
|
-
#
|
|
147
|
+
# Initialize in existing project
|
|
451
148
|
cd my-existing-project
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
# 2. Merge existing documentation
|
|
455
|
-
"Read brownfield-onboarder skill and merge my existing docs/"
|
|
149
|
+
specweave init .
|
|
456
150
|
|
|
457
|
-
#
|
|
458
|
-
# ✅ Extracts project-specific knowledge from docs, wikis, CLAUDE.md backups
|
|
459
|
-
# ✅ Distributes content to appropriate SpecWeave folders
|
|
460
|
-
# ✅ Preserves historical context and team conventions
|
|
461
|
-
# ✅ No bloat - smart content organization
|
|
462
|
-
|
|
463
|
-
# 3. Analyze and document existing code
|
|
151
|
+
# Analyze and document existing code
|
|
464
152
|
"Analyze my authentication module and create comprehensive documentation"
|
|
465
153
|
|
|
466
|
-
# SpecWeave creates
|
|
467
|
-
#
|
|
468
|
-
#
|
|
469
|
-
#
|
|
470
|
-
#
|
|
471
|
-
#
|
|
472
|
-
|
|
473
|
-
# 4. Create complex architecture documentation
|
|
474
|
-
"Create complete architecture documentation for the auth system"
|
|
475
|
-
|
|
476
|
-
# SpecWeave generates:
|
|
477
|
-
# 📋 High-Level Design (HLD) documents
|
|
478
|
-
# 📋 Architecture Decision Records (ADRs) for key choices
|
|
479
|
-
# 📋 C4 Context diagrams (system boundaries)
|
|
480
|
-
# 📋 C4 Container diagrams (services, databases)
|
|
481
|
-
# 📋 C4 Component diagrams (internal structure)
|
|
482
|
-
# 📋 Sequence diagrams (flows)
|
|
483
|
-
# 📋 ER diagrams (data models)
|
|
484
|
-
|
|
485
|
-
# 5. Establish baseline tests (regression prevention)
|
|
486
|
-
"Create comprehensive tests for current auth behavior"
|
|
487
|
-
|
|
488
|
-
# 🧪 Creates baseline test suite to prevent regression
|
|
489
|
-
|
|
490
|
-
# 6. Set up living documentation
|
|
491
|
-
|
|
492
|
-
# From now on, all changes auto-update documentation:
|
|
493
|
-
# 📚 Specs stay in sync with code
|
|
494
|
-
# 📚 ADRs updated from Proposed → Accepted
|
|
495
|
-
# 📚 Architecture diagrams reflect current state
|
|
496
|
-
# 📚 No documentation drift ever again
|
|
497
|
-
|
|
498
|
-
# 7. Now safe to modify and evolve
|
|
499
|
-
"Add OAuth 2.0 to authentication system"
|
|
500
|
-
|
|
501
|
-
# SpecWeave automatically:
|
|
502
|
-
# 🚀 Updates existing specs with new requirements
|
|
503
|
-
# 🚀 Extends architecture docs (ADRs, HLDs)
|
|
504
|
-
# 🚀 Updates diagrams automatically
|
|
505
|
-
# 🚀 Maintains living documentation
|
|
506
|
-
# 🚀 Prevents regression with baseline tests
|
|
507
|
-
```
|
|
508
|
-
|
|
509
|
-
**The SpecWeave Brownfield Advantage:**
|
|
510
|
-
|
|
511
|
-
- ✅ **Merge existing docs** - Intelligently consolidates wikis, docs, legacy CLAUDE.md files
|
|
512
|
-
|
|
513
|
-
- ✅ **Create complex architecture** - HLDs, ADRs, RFCs, C4 diagrams for existing systems
|
|
514
|
-
|
|
515
|
-
- ✅ **Living documentation** - Auto-updates after every change (via hooks)
|
|
516
|
-
|
|
517
|
-
- ✅ **Structure evolution** - Documentation grows with your codebase
|
|
518
|
-
|
|
519
|
-
- ✅ **Regression prevention** - Baseline tests before any modifications
|
|
520
|
-
|
|
521
|
-
- ✅ **Compliance-ready** - Complete audit trail for regulated industries
|
|
154
|
+
# SpecWeave creates:
|
|
155
|
+
# ✅ Retroactive specifications (WHAT/WHY)
|
|
156
|
+
# ✅ Architecture diagrams (HLDs, C4 Model)
|
|
157
|
+
# ✅ Decision records (ADRs)
|
|
158
|
+
# ✅ Baseline tests (regression prevention)
|
|
159
|
+
# ✅ Living documentation (auto-updates from now on)
|
|
522
160
|
|
|
523
|
-
|
|
161
|
+
# Now safe to modify
|
|
162
|
+
/specweave:inc "Add OAuth to authentication"
|
|
163
|
+
# ✅ Updates existing specs
|
|
164
|
+
# ✅ Extends architecture docs
|
|
165
|
+
# ✅ Prevents regression with baseline tests
|
|
166
|
+
```
|
|
524
167
|
|
|
525
|
-
**
|
|
168
|
+
**Brownfield Excellence**:
|
|
169
|
+
- ✅ Merge existing docs (wikis, legacy CLAUDE.md files)
|
|
170
|
+
- ✅ Create complex architecture (ADRs, HLDs, RFCs, C4 diagrams)
|
|
171
|
+
- ✅ Living documentation from day one
|
|
172
|
+
- ✅ Regression prevention via baseline tests
|
|
173
|
+
- ✅ Knowledge preservation (no more tribal knowledge)
|
|
526
174
|
|
|
527
175
|
---
|
|
528
176
|
|
|
529
|
-
##
|
|
530
|
-
|
|
531
|
-
**CRITICAL**: SpecWeave supports ONLY **root-level** `.specweave/` folders. Nested folders are NOT supported.
|
|
177
|
+
## Multi-Repo & Microservices
|
|
532
178
|
|
|
533
|
-
|
|
179
|
+
**SpecWeave enforces ONE root-level `.specweave/` folder** - nested folders are not supported.
|
|
534
180
|
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
**Solution**: Create a **parent folder** with one `.specweave/` at the root
|
|
181
|
+
For huge projects with multiple repos:
|
|
538
182
|
|
|
539
183
|
```bash
|
|
540
|
-
#
|
|
184
|
+
# Create parent folder
|
|
541
185
|
mkdir my-big-project
|
|
542
186
|
cd my-big-project
|
|
187
|
+
specweave init .
|
|
543
188
|
|
|
544
|
-
#
|
|
545
|
-
npx specweave init .
|
|
546
|
-
|
|
547
|
-
# 3. Clone your repos as subdirectories
|
|
189
|
+
# Clone repos as subdirectories
|
|
548
190
|
git clone https://github.com/myorg/auth-service.git
|
|
549
191
|
git clone https://github.com/myorg/payment-service.git
|
|
550
192
|
git clone https://github.com/myorg/frontend.git
|
|
551
|
-
git clone https://github.com/myorg/infrastructure.git
|
|
552
|
-
```
|
|
553
|
-
|
|
554
|
-
**Result**:
|
|
555
|
-
```
|
|
556
|
-
my-big-project/ ← Parent folder
|
|
557
|
-
├── .specweave/ ← ONE source of truth
|
|
558
|
-
│ ├── increments/
|
|
559
|
-
│ │ ├── 0001-auth-service/
|
|
560
|
-
│ │ ├── 0002-payment-service/
|
|
561
|
-
│ │ ├── 0003-unified-auth/ ← Cross-repo increment!
|
|
562
|
-
│ │ └── 0004-frontend-redesign/
|
|
563
|
-
│ ├── docs/
|
|
564
|
-
│ │ ├── internal/
|
|
565
|
-
│ │ │ ├── strategy/ ← System-wide strategy
|
|
566
|
-
│ │ │ ├── architecture/ ← Cross-service architecture
|
|
567
|
-
│ │ │ └── ...
|
|
568
|
-
│ │ └── public/
|
|
569
|
-
│ └── logs/
|
|
570
|
-
│
|
|
571
|
-
├── auth-service/ ← Separate git repo
|
|
572
|
-
│ ├── .git/
|
|
573
|
-
│ └── src/
|
|
574
|
-
│
|
|
575
|
-
├── payment-service/ ← Separate git repo
|
|
576
|
-
│ ├── .git/
|
|
577
|
-
│ └── src/
|
|
578
|
-
│
|
|
579
|
-
├── frontend/ ← Separate git repo
|
|
580
|
-
│ ├── .git/
|
|
581
|
-
│ └── src/
|
|
582
|
-
│
|
|
583
|
-
└── infrastructure/ ← Separate git repo
|
|
584
|
-
├── .git/
|
|
585
|
-
└── terraform/
|
|
586
|
-
```
|
|
587
|
-
|
|
588
|
-
### Why Root-Level Only?
|
|
589
|
-
|
|
590
|
-
**Single Source of Truth**:
|
|
591
|
-
- ✅ One central location for all specs and increments
|
|
592
|
-
- ✅ No duplication or fragmentation
|
|
593
|
-
- ✅ Cross-cutting features span multiple repos naturally
|
|
594
|
-
- ✅ System-wide architecture in one place
|
|
595
|
-
|
|
596
|
-
**Prevents Chaos**:
|
|
597
|
-
- ❌ No nested `.specweave/` folders (causes conflicts)
|
|
598
|
-
- ❌ No ambiguity about where specs live
|
|
599
|
-
- ❌ No duplicate increment numbers across modules
|
|
600
|
-
|
|
601
|
-
### Enforcement
|
|
602
193
|
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
#
|
|
607
|
-
cd my-big-project/backend
|
|
608
|
-
npx specweave init .
|
|
609
|
-
|
|
610
|
-
# Error: Nested .specweave/ folders are NOT supported!
|
|
611
|
-
# Found parent .specweave/ at: /path/to/my-big-project
|
|
612
|
-
# Use the parent folder for all increments.
|
|
613
|
-
```
|
|
614
|
-
|
|
615
|
-
**Correct Approach**:
|
|
616
|
-
```bash
|
|
617
|
-
# ✅ Use parent folder
|
|
618
|
-
cd my-big-project
|
|
619
|
-
/specweave:inc "0001-backend-api-v2"
|
|
620
|
-
# Creates: .specweave/increments/0001-backend-api-v2/
|
|
621
|
-
# Can reference: backend/, frontend/, etc.
|
|
194
|
+
# Result: ONE .specweave/ for entire system
|
|
195
|
+
# ✅ Cross-service increments natural
|
|
196
|
+
# ✅ System-wide architecture in one place
|
|
197
|
+
# ✅ Each repo keeps its own git history
|
|
622
198
|
```
|
|
623
199
|
|
|
624
|
-
### Benefits
|
|
625
|
-
|
|
626
|
-
- ✅ **One `.specweave/` for entire system** - Single source of truth
|
|
627
|
-
- ✅ **Each repo maintains its own git history** - No monorepo migration needed
|
|
628
|
-
- ✅ **Cross-service increments are natural** - Auth spans auth-service + frontend + API
|
|
629
|
-
- ✅ **System-wide architecture** - ADRs, HLDs apply to all services
|
|
630
|
-
- ✅ **Living docs cover all repos** - Documentation spans the entire system
|
|
631
|
-
|
|
632
|
-
**See [CLAUDE.md#root-level-specweave-folder-mandatory](CLAUDE.md#root-level-specweave-folder-mandatory)** for complete architectural details.
|
|
633
|
-
|
|
634
|
-
---
|
|
635
|
-
|
|
636
|
-
## 🧪 Testing Strategy
|
|
637
|
-
|
|
638
|
-
SpecWeave implements **4 Levels of Testing**:
|
|
639
|
-
|
|
640
|
-
1. **Level 1: Specification** (spec.md)
|
|
641
|
-
- Acceptance criteria with TC-0001 format
|
|
642
|
-
- Business-level validation
|
|
643
|
-
|
|
644
|
-
2. **Level 2: Feature Tests** (tests.md)
|
|
645
|
-
- Test coverage matrix
|
|
646
|
-
- Maps TC-0001 to implementations
|
|
647
|
-
|
|
648
|
-
3. **Level 3: Component Tests** (tests/)
|
|
649
|
-
- Integration tests: `tests/integration/{integration-name}/`
|
|
650
|
-
- Skill tests: `tests/specs/{skill-name}/`
|
|
651
|
-
- **Minimum 3 tests per component** (MANDATORY)
|
|
652
|
-
- **Centralized location** for better organization and CI/CD
|
|
653
|
-
|
|
654
|
-
4. **Level 4: Automated Tests** (tests/)
|
|
655
|
-
- Unit tests (Jest)
|
|
656
|
-
- Integration tests (Jira, GitHub, ADO sync)
|
|
657
|
-
- E2E tests (Playwright) for UI/CLI validation
|
|
658
|
-
|
|
659
|
-
**See [CLAUDE.md#testing-philosophy](CLAUDE.md#testing-philosophy)** for complete testing guide.
|
|
660
|
-
|
|
661
200
|
---
|
|
662
201
|
|
|
202
|
+
## Project Structure
|
|
663
203
|
|
|
664
|
-
## 🎨 Diagram Generation
|
|
665
|
-
|
|
666
|
-
SpecWeave includes **automated C4 diagram generation**:
|
|
667
|
-
|
|
668
|
-
```bash
|
|
669
|
-
# C4 Context (Level 1)
|
|
670
|
-
"Create C4 context diagram for authentication"
|
|
671
|
-
|
|
672
|
-
# C4 Container (Level 2)
|
|
673
|
-
"Create container diagram showing services and databases"
|
|
674
|
-
|
|
675
|
-
# C4 Component (Level 3)
|
|
676
|
-
"Create component diagram for Auth Service"
|
|
677
|
-
|
|
678
|
-
# Sequence diagrams
|
|
679
|
-
"Create sequence diagram for login flow"
|
|
680
|
-
|
|
681
|
-
# ER diagrams
|
|
682
|
-
"Create ER diagram for user and order entities"
|
|
683
|
-
|
|
684
|
-
# Deployment diagrams
|
|
685
|
-
"Create deployment diagram for AWS infrastructure"
|
|
686
204
|
```
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
#
|
|
704
|
-
/sync-jira --increment 0001
|
|
705
|
-
|
|
706
|
-
# Maps: Increment → Epic, Tasks → Stories
|
|
707
|
-
# Configuration auto-detected from environment or prompts
|
|
708
|
-
```
|
|
709
|
-
|
|
710
|
-
### Azure DevOps Integration
|
|
711
|
-
|
|
712
|
-
```bash
|
|
713
|
-
# Sync increment to Azure DevOps
|
|
714
|
-
/sync-ado --increment 0001
|
|
715
|
-
|
|
716
|
-
# Configuration auto-detected from environment or prompts
|
|
717
|
-
```
|
|
718
|
-
|
|
719
|
-
### GitHub Integration
|
|
720
|
-
|
|
721
|
-
```bash
|
|
722
|
-
/sync-github --increment 0001
|
|
723
|
-
|
|
724
|
-
# Creates GitHub issue with:
|
|
725
|
-
# - User stories as description
|
|
726
|
-
# - Tasks as checkable checklist
|
|
205
|
+
my-project/
|
|
206
|
+
├── .specweave/ # Framework directory
|
|
207
|
+
│ ├── increments/ # Feature development
|
|
208
|
+
│ │ ├── 0001-feature-name/
|
|
209
|
+
│ │ │ ├── spec.md # WHAT & WHY
|
|
210
|
+
│ │ │ ├── plan.md # HOW (architecture)
|
|
211
|
+
│ │ │ ├── tasks.md # Auto-generated tasks
|
|
212
|
+
│ │ │ ├── tests.md # Test strategy
|
|
213
|
+
│ │ │ └── reports/ # Analysis, logs, scripts
|
|
214
|
+
│ │ └── 0002-next-feature/
|
|
215
|
+
│ ├── docs/
|
|
216
|
+
│ │ ├── internal/ # Strategy, architecture, ADRs, RFCs
|
|
217
|
+
│ │ └── public/ # User-facing docs
|
|
218
|
+
│ └── logs/
|
|
219
|
+
│
|
|
220
|
+
├── src/ # Your code
|
|
221
|
+
└── tests/ # Your tests
|
|
727
222
|
```
|
|
728
223
|
|
|
729
|
-
**
|
|
224
|
+
**Key Principle**: ALL AI-generated files go in increment folders, NOT in project root.
|
|
730
225
|
|
|
731
226
|
---
|
|
732
227
|
|
|
733
|
-
##
|
|
228
|
+
## Documentation
|
|
734
229
|
|
|
735
|
-
- **[spec-weave.com](https://spec-weave.com)** -
|
|
736
|
-
- **[
|
|
737
|
-
- **[GitHub](https://github.com/anton-abyzov/specweave)** - Source code
|
|
738
|
-
- **
|
|
230
|
+
- 📖 **[spec-weave.com](https://spec-weave.com)** - Complete documentation
|
|
231
|
+
- 📦 **[npmjs.com/package/specweave](https://www.npmjs.com/package/specweave)** - npm package
|
|
232
|
+
- 🐙 **[GitHub](https://github.com/anton-abyzov/specweave)** - Source code
|
|
233
|
+
- 📋 **CLAUDE.md** - Auto-created in your project after `specweave init`
|
|
739
234
|
|
|
740
235
|
---
|
|
741
236
|
|
|
742
|
-
##
|
|
743
|
-
|
|
744
|
-
We welcome contributions!
|
|
237
|
+
## Contributing
|
|
745
238
|
|
|
746
|
-
|
|
239
|
+
**Development Setup:**
|
|
747
240
|
|
|
748
241
|
```bash
|
|
749
|
-
# Clone
|
|
242
|
+
# Clone and setup
|
|
750
243
|
git clone https://github.com/anton-abyzov/specweave.git
|
|
751
244
|
cd specweave
|
|
752
|
-
|
|
753
|
-
# Install dependencies
|
|
754
245
|
npm install
|
|
755
|
-
|
|
756
|
-
# Build TypeScript
|
|
757
246
|
npm run build
|
|
758
247
|
|
|
759
248
|
# Run tests
|
|
760
249
|
npm test
|
|
761
250
|
```
|
|
762
251
|
|
|
763
|
-
**To
|
|
252
|
+
**To Contribute:**
|
|
764
253
|
1. Fork repository
|
|
765
254
|
2. Create feature branch: `git checkout -b features/002-new-feature`
|
|
766
|
-
3. Follow SpecWeave conventions (see CLAUDE.md
|
|
767
|
-
4. Add 3
|
|
255
|
+
3. Follow SpecWeave conventions (see CLAUDE.md)
|
|
256
|
+
4. Add tests (minimum 3 test cases)
|
|
768
257
|
5. Create PR to `develop` branch
|
|
769
258
|
|
|
770
259
|
---
|
|
771
260
|
|
|
772
|
-
##
|
|
773
|
-
|
|
774
|
-
**Version**: 0.1.8
|
|
775
|
-
**Status**: Public Beta
|
|
776
|
-
**License**: MIT
|
|
777
|
-
**Release Date**: 2025-10-28
|
|
778
|
-
**Website**: [spec-weave.com](https://spec-weave.com)
|
|
779
|
-
|
|
780
|
-
### ✅ What Works (v0.1.8)
|
|
781
|
-
|
|
782
|
-
- ✅ **10 Agents** fully implemented and pre-installed
|
|
783
|
-
- ✅ **35+ Skills** fully implemented and pre-installed
|
|
784
|
-
- ✅ **CLI Tool** - `specweave init` with complete component copying
|
|
785
|
-
- ✅ **Ready Out of the Box** - All components installed during init
|
|
786
|
-
- ✅ **Command simplification** - 4-command workflow (0.1.8)
|
|
787
|
-
- ✅ **Diagram generation** (C4 Model with validation)
|
|
788
|
-
- ✅ **4-level testing framework** (spec → feature → component → automated)
|
|
789
|
-
- ✅ **JIRA/ADO/GitHub sync** integration
|
|
790
|
-
- ✅ **Brownfield analyzer** (retroactive specs, regression prevention)
|
|
791
|
-
- ✅ **Increment lifecycle** (5 stages, WIP limits, leftover transfer)
|
|
792
|
-
- ✅ **Increment validation** (120 rules, auto-validation on save)
|
|
793
|
-
- ✅ **Hooks system** (auto-update docs, validations)
|
|
794
|
-
- ✅ **Living Documentation** - Auto-updated via Claude Code hooks
|
|
795
|
-
- ✅ **npm Package** - Published and ready to use
|
|
796
|
-
|
|
797
|
-
### 📅 Planned (v0.2.0+)
|
|
798
|
-
|
|
799
|
-
- 📅 Quality gates and risk scoring
|
|
800
|
-
- 📅 Web UI for planning phase
|
|
801
|
-
- 📅 VS Code extension
|
|
802
|
-
- 📅 Homebrew formula
|
|
803
|
-
- 📅 Additional project templates
|
|
804
|
-
|
|
805
|
-
---
|
|
806
|
-
|
|
807
|
-
## 📖 Quick Start
|
|
261
|
+
## Why Claude Code?
|
|
808
262
|
|
|
809
|
-
|
|
263
|
+
SpecWeave is designed **Claude Code-first** because Claude Code provides industry-leading capabilities:
|
|
810
264
|
|
|
811
|
-
|
|
812
|
-
|
|
813
|
-
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
/plugin install specweave-core@specweave
|
|
817
|
-
|
|
818
|
-
# Optionally install plugins you need
|
|
819
|
-
/plugin install github@specweave # GitHub integration
|
|
820
|
-
/plugin install frontend@specweave # React, Next.js
|
|
821
|
-
/plugin install backend@specweave # Node.js, Python, .NET
|
|
822
|
-
```
|
|
265
|
+
- ✅ **Native Plugin Marketplace** - No compilation, instant installation
|
|
266
|
+
- ✅ **Auto-Activating Skills** - No manual @ mentions needed
|
|
267
|
+
- ✅ **Isolated Agent Contexts** - True role separation
|
|
268
|
+
- ✅ **Pre/Post Lifecycle Hooks** - Automated living docs sync
|
|
269
|
+
- ✅ **MCP Protocol** - Industry standard for context management
|
|
823
270
|
|
|
824
|
-
**
|
|
825
|
-
|
|
826
|
-
```bash
|
|
827
|
-
# Plan your first feature
|
|
828
|
-
/specweave:inc "User authentication with JWT"
|
|
829
|
-
|
|
830
|
-
# Execute the implementation
|
|
831
|
-
/specweave:do
|
|
832
|
-
|
|
833
|
-
# Check progress
|
|
834
|
-
/specweave:progress
|
|
835
|
-
|
|
836
|
-
# Your increment is done automatically, start next feature
|
|
837
|
-
/specweave:inc "Payment processing with Stripe"
|
|
838
|
-
```
|
|
839
|
-
|
|
840
|
-
### For Existing Projects (Brownfield)
|
|
841
|
-
|
|
842
|
-
```bash
|
|
843
|
-
# Navigate to your existing project
|
|
844
|
-
cd my-existing-project
|
|
845
|
-
|
|
846
|
-
# Install SpecWeave marketplace and core
|
|
847
|
-
/plugin marketplace add anton-abyzov/specweave
|
|
848
|
-
/plugin install specweave-core@specweave
|
|
849
|
-
|
|
850
|
-
# Analyze existing code
|
|
851
|
-
"Analyze my authentication module"
|
|
852
|
-
# SpecWeave creates retroactive specifications and architecture docs
|
|
853
|
-
|
|
854
|
-
# Safe to modify
|
|
855
|
-
/specweave:inc "Add OAuth to authentication"
|
|
856
|
-
```
|
|
271
|
+
**Other tools** (Cursor, Copilot) have legacy adapter support but lack automation features.
|
|
857
272
|
|
|
858
273
|
---
|
|
859
274
|
|
|
860
|
-
##
|
|
861
|
-
|
|
862
|
-
### vs Traditional Development
|
|
863
|
-
|
|
864
|
-
| Aspect | Traditional | SpecWeave |
|
|
865
|
-
|--------|-------------|-----------|
|
|
866
|
-
| **Documentation** | Outdated, ignored | Living, auto-updated |
|
|
867
|
-
| **Specifications** | Optional, vague | Source of truth, precise |
|
|
868
|
-
| **Testing** | Manual, incomplete | 4-level, validated |
|
|
869
|
-
| **Components** | Manual setup | Pre-installed (10 agents + 35+ skills) |
|
|
870
|
-
| **Regression** | Frequent breaks | Prevention-first |
|
|
871
|
-
| **Onboarding** | Weeks | Hours (specs explain everything) |
|
|
872
|
-
| **Brownfield** | Risky, undocumented | Safe, documented, living architecture (most complicated solved) |
|
|
873
|
-
| **Architecture** | Scattered tribal knowledge | HLDs, ADRs, C4 diagrams auto-updated |
|
|
874
|
-
| **Doc Maintenance** | Manual, becomes stale | Auto-updated via hooks, always current |
|
|
875
|
-
|
|
876
|
-
### vs Other Frameworks
|
|
275
|
+
## Status & License
|
|
877
276
|
|
|
878
|
-
**
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
- ✅ SpecWeave: **Brownfield analysis** - retroactive spec generation for existing code
|
|
882
|
-
- ✅ SpecWeave: **Tool integration** - JIRA, ADO, GitHub bidirectional sync
|
|
883
|
-
|
|
884
|
-
**vs BMAD-METHOD**:
|
|
885
|
-
- ✅ SpecWeave: **5-pillar documentation** - strategy, architecture, delivery, operations, governance
|
|
886
|
-
- ✅ SpecWeave: **Pre-installed components** - 10 agents + 35+ skills ready immediately
|
|
887
|
-
- ✅ SpecWeave: **Framework agnostic** - TypeScript, Python, Go, Rust, Java, C#
|
|
888
|
-
- ✅ SpecWeave: **Diagram generation** - C4 Model diagrams with validation
|
|
889
|
-
- ✅ SpecWeave: **Tool integration** - JIRA/ADO/GitHub sync built-in
|
|
890
|
-
|
|
891
|
-
**Both frameworks**:
|
|
892
|
-
- ✅ Specification-first development
|
|
893
|
-
- ✅ Automated testing
|
|
894
|
-
- ✅ Quality gates and validation
|
|
895
|
-
|
|
896
|
-
**Learn more**: See `bmad-method-expert` and `spec-kit-expert` skills for detailed comparisons
|
|
897
|
-
|
|
898
|
-
---
|
|
899
|
-
|
|
900
|
-
## 📞 Support & Community
|
|
901
|
-
|
|
902
|
-
- **Website**: [spec-weave.com](https://spec-weave.com)
|
|
903
|
-
- **npm Package**: [npmjs.com/package/specweave](https://www.npmjs.com/package/specweave)
|
|
904
|
-
- **GitHub**: [github.com/anton-abyzov/specweave](https://github.com/anton-abyzov/specweave)
|
|
905
|
-
- **Issues**: [github.com/anton-abyzov/specweave/issues](https://github.com/anton-abyzov/specweave/issues)
|
|
906
|
-
- **Documentation**: See [CLAUDE.md](CLAUDE.md) after running `specweave init`
|
|
907
|
-
|
|
908
|
-
---
|
|
909
|
-
|
|
910
|
-
## 📄 License
|
|
911
|
-
|
|
912
|
-
MIT License - see [LICENSE](LICENSE) for details.
|
|
277
|
+
**Status**: Beta - Ready for testing and contributions
|
|
278
|
+
**License**: MIT
|
|
279
|
+
**Repository**: [github.com/anton-abyzov/specweave](https://github.com/anton-abyzov/specweave)
|
|
913
280
|
|
|
914
281
|
---
|
|
915
282
|
|
|
916
|
-
##
|
|
283
|
+
## Acknowledgments
|
|
917
284
|
|
|
918
|
-
SpecWeave is inspired by
|
|
285
|
+
SpecWeave is inspired by:
|
|
919
286
|
- [spec-kit](https://github.com/github/spec-kit) - GitHub's specification toolkit
|
|
920
287
|
- [BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) - Agentic agile framework
|
|
921
|
-
- [Claude Code
|
|
288
|
+
- [Claude Code](https://claude.com/claude-code) - Anthropic's native plugin system
|
|
922
289
|
- [C4 Model](https://c4model.com/) - Software architecture diagrams
|
|
923
290
|
|
|
924
291
|
---
|
|
925
292
|
|
|
926
293
|
**SpecWeave** - Replace vibe coding with spec-driven development.
|
|
927
294
|
|
|
928
|
-
**Get started**:
|
|
295
|
+
**Get started**: `npm install -g specweave` → `specweave init my-project`
|