specweave 0.9.1 → 0.10.0
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.md +100 -13
- package/README.md +97 -251
- package/bin/install-agents.sh +1 -1
- package/bin/install-commands.sh +1 -1
- package/bin/install-hooks.sh +1 -1
- package/bin/install-skills.sh +1 -1
- package/bin/specweave.js +32 -0
- package/dist/cli/commands/validate-jira.d.ts +35 -0
- package/dist/cli/commands/validate-jira.d.ts.map +1 -0
- package/dist/cli/commands/validate-jira.js +112 -0
- package/dist/cli/commands/validate-jira.js.map +1 -0
- package/dist/cli/commands/validate-plugins.d.ts +41 -0
- package/dist/cli/commands/validate-plugins.d.ts.map +1 -0
- package/dist/cli/commands/validate-plugins.js +171 -0
- package/dist/cli/commands/validate-plugins.js.map +1 -0
- package/dist/core/types/sync-profile.d.ts +177 -29
- package/dist/core/types/sync-profile.d.ts.map +1 -1
- package/dist/core/types/sync-profile.js +48 -1
- package/dist/core/types/sync-profile.js.map +1 -1
- package/dist/hooks/lib/translate-living-docs.d.ts.map +1 -1
- package/dist/hooks/lib/translate-living-docs.js +16 -7
- package/dist/hooks/lib/translate-living-docs.js.map +1 -1
- package/dist/metrics/dora-calculator.d.ts +7 -3
- package/dist/metrics/dora-calculator.d.ts.map +1 -1
- package/dist/metrics/dora-calculator.js +19 -6
- package/dist/metrics/dora-calculator.js.map +1 -1
- package/dist/metrics/report-generator.d.ts +17 -0
- package/dist/metrics/report-generator.d.ts.map +1 -0
- package/dist/metrics/report-generator.js +403 -0
- package/dist/metrics/report-generator.js.map +1 -0
- package/dist/utils/external-resource-validator.d.ts +102 -0
- package/dist/utils/external-resource-validator.d.ts.map +1 -0
- package/dist/utils/external-resource-validator.js +381 -0
- package/dist/utils/external-resource-validator.js.map +1 -0
- package/dist/utils/plugin-validator.d.ts +161 -0
- package/dist/utils/plugin-validator.d.ts.map +1 -0
- package/dist/utils/plugin-validator.js +565 -0
- package/dist/utils/plugin-validator.js.map +1 -0
- package/package.json +2 -1
- package/plugins/specweave/commands/specweave-do.md +47 -0
- package/plugins/specweave/commands/specweave-increment.md +82 -0
- package/plugins/specweave/commands/specweave-next.md +47 -0
- package/plugins/specweave/hooks/post-increment-planning.sh +117 -38
- package/plugins/specweave/hooks/pre-tool-use.sh +133 -0
- package/plugins/specweave/plugin.json +22 -0
- package/plugins/specweave/skills/plugin-validator/SKILL.md +427 -0
- package/plugins/specweave-ado/.claude-plugin/plugin.json +2 -4
- package/plugins/specweave-ado/lib/ado-board-resolver.ts +328 -0
- package/plugins/specweave-ado/lib/ado-hierarchical-sync.ts +484 -0
- package/plugins/specweave-ado/plugin.json +20 -0
- package/plugins/specweave-alternatives/.claude-plugin/plugin.json +15 -2
- package/plugins/specweave-backend/.claude-plugin/plugin.json +15 -2
- package/plugins/specweave-cost-optimizer/.claude-plugin/plugin.json +14 -2
- package/plugins/specweave-diagrams/.claude-plugin/plugin.json +14 -2
- package/plugins/specweave-docs/.claude-plugin/plugin.json +13 -2
- package/plugins/specweave-figma/.claude-plugin/plugin.json +14 -2
- package/plugins/specweave-frontend/.claude-plugin/plugin.json +15 -2
- package/plugins/specweave-github/lib/github-board-resolver.ts +164 -0
- package/plugins/specweave-github/lib/github-hierarchical-sync.ts +344 -0
- package/plugins/specweave-github/plugin.json +19 -0
- package/plugins/specweave-infrastructure/.claude-plugin/plugin.json +15 -2
- package/plugins/specweave-jira/.claude-plugin/plugin.json +14 -2
- package/plugins/specweave-jira/lib/jira-board-resolver.ts +127 -0
- package/plugins/specweave-jira/lib/jira-hierarchical-sync.ts +283 -0
- package/plugins/specweave-jira/plugin.json +20 -0
- package/plugins/specweave-jira/skills/jira-resource-validator/SKILL.md +584 -0
- package/plugins/specweave-kubernetes/.claude-plugin/plugin.json +14 -2
- package/plugins/specweave-payments/.claude-plugin/plugin.json +14 -2
- package/plugins/specweave-testing/.claude-plugin/plugin.json +14 -2
- package/plugins/specweave-tooling/.claude-plugin/plugin.json +13 -2
package/CLAUDE.md
CHANGED
|
@@ -1981,6 +1981,35 @@ Solution: Inactivity-based detection
|
|
|
1981
1981
|
- `INACTIVITY_THRESHOLD=15` - Seconds of inactivity to assume session ending (adjustable)
|
|
1982
1982
|
- `DEBOUNCE_SECONDS=2` - Prevents duplicate hook fires
|
|
1983
1983
|
|
|
1984
|
+
**Pre-Tool-Use Hook** (`.claude/hooks/pre-tool-use.sh`):
|
|
1985
|
+
|
|
1986
|
+
**Purpose**: Detect when Claude asks questions BEFORE task completion
|
|
1987
|
+
|
|
1988
|
+
**The Problem**: The post-task-completion hook only fires after TodoWrite events. If Claude asks a question via AskUserQuestion WITHOUT completing any tasks first, no sound plays and the user doesn't know Claude is waiting for input.
|
|
1989
|
+
|
|
1990
|
+
**The Solution**: The pre-tool-use hook fires BEFORE every tool call, allowing us to detect AskUserQuestion immediately.
|
|
1991
|
+
|
|
1992
|
+
**How It Works**:
|
|
1993
|
+
```
|
|
1994
|
+
Scenario 1: Question after task completion
|
|
1995
|
+
- 10:00:00 - Task completed (TodoWrite) → post-task-completion hook fires
|
|
1996
|
+
- 10:00:15 - Inactivity threshold reached → SOUND! ✅
|
|
1997
|
+
|
|
1998
|
+
Scenario 2: Question WITHOUT task completion (NEW!)
|
|
1999
|
+
- 10:00:00 - Claude calls AskUserQuestion → pre-tool-use hook fires
|
|
2000
|
+
- 10:00:00 - Detects tool_name="AskUserQuestion" → SOUND! ✅
|
|
2001
|
+
- User is notified IMMEDIATELY, not after 15s
|
|
2002
|
+
```
|
|
2003
|
+
|
|
2004
|
+
**Key Features**:
|
|
2005
|
+
- ✅ Fires BEFORE any tool call (PreToolUse event)
|
|
2006
|
+
- ✅ Filters for AskUserQuestion specifically
|
|
2007
|
+
- ✅ Plays distinctive sound (Tink.aiff on macOS, dialog-question.oga on Linux)
|
|
2008
|
+
- ✅ Non-blocking and fast (<10ms overhead)
|
|
2009
|
+
- ✅ Complements post-task-completion hook (both work together)
|
|
2010
|
+
|
|
2011
|
+
**Result**: Users are ALWAYS notified when Claude needs input, regardless of whether tasks have been completed or not.
|
|
2012
|
+
|
|
1984
2013
|
**Manual Actions** (Claude MUST do after each task):
|
|
1985
2014
|
- Update `CLAUDE.md` when structure changes
|
|
1986
2015
|
- Update `README.md` for user-facing changes
|
|
@@ -2713,30 +2742,54 @@ Your choice [1]:
|
|
|
2713
2742
|
|
|
2714
2743
|
### Translation Workflow (Multilingual Support)
|
|
2715
2744
|
|
|
2716
|
-
**SpecWeave supports multilingual development** via post-generation translation (Increment 0006).
|
|
2745
|
+
**SpecWeave supports multilingual development** via two-phase post-generation translation (Increment 0006).
|
|
2717
2746
|
|
|
2718
2747
|
**Key Concept**: Users work in their native language (great UX), system auto-translates to English (maintainable docs).
|
|
2719
2748
|
|
|
2749
|
+
**Two-Phase Translation Architecture**:
|
|
2750
|
+
|
|
2751
|
+
| Phase | Hook | What Gets Translated | When | Coverage |
|
|
2752
|
+
|-------|------|---------------------|------|----------|
|
|
2753
|
+
| **Phase 1** | post-increment-planning | Increment files + Living docs specs | After `/specweave:increment` | 80% of docs |
|
|
2754
|
+
| **Phase 2** | post-task-completion | ADRs, HLDs, diagrams | After each task completion | 20% of docs |
|
|
2755
|
+
|
|
2720
2756
|
**Workflow**:
|
|
2721
2757
|
|
|
2722
2758
|
```bash
|
|
2723
2759
|
# 1. User creates increment in Russian
|
|
2724
2760
|
/specweave:increment "Добавить пользовательскую аутентификацию"
|
|
2725
2761
|
|
|
2726
|
-
# 2. PM agent generates spec.md in Russian (natural, user-friendly)
|
|
2762
|
+
# 2. PM agent generates spec.md, plan.md, tasks.md in Russian (natural, user-friendly)
|
|
2727
2763
|
|
|
2728
|
-
# 3. post-increment-planning hook fires automatically
|
|
2729
|
-
#
|
|
2730
|
-
#
|
|
2731
|
-
#
|
|
2764
|
+
# 3. post-increment-planning hook fires automatically (PHASE 1)
|
|
2765
|
+
# Phase A: Translates increment files (spec.md, plan.md, tasks.md) to English
|
|
2766
|
+
# Phase B: Translates living docs specs to English (NEW!)
|
|
2767
|
+
# - .specweave/docs/internal/specs/spec-*.md
|
|
2768
|
+
# - .specweave/docs/internal/strategy/**/*.md
|
|
2769
|
+
# Cost: ~$0.02 total
|
|
2732
2770
|
|
|
2733
2771
|
# User sees:
|
|
2734
2772
|
# ✅ Increment created
|
|
2735
|
-
# 🌐 Detected Russian content. Translating to English...
|
|
2773
|
+
# 🌐 Detected Russian content. Translating increment files to English...
|
|
2736
2774
|
# 📄 spec.md... ✅
|
|
2737
2775
|
# 📄 plan.md... ✅
|
|
2738
2776
|
# 📄 tasks.md... ✅
|
|
2739
|
-
#
|
|
2777
|
+
# 🌐 Checking living docs for translation...
|
|
2778
|
+
# 📄 Living docs detected: spec-0001-user-auth.md
|
|
2779
|
+
# ✅ Translated 1 living docs file(s) to English
|
|
2780
|
+
# ✅ Translation complete!
|
|
2781
|
+
# Increment files: 3/3
|
|
2782
|
+
# Living docs: 1 file(s)
|
|
2783
|
+
# Estimated cost: ~$0.01-0.02 (using Haiku)
|
|
2784
|
+
|
|
2785
|
+
# 4. During implementation, architect creates ADRs in Russian
|
|
2786
|
+
|
|
2787
|
+
# 5. post-task-completion hook fires after each task (PHASE 2)
|
|
2788
|
+
# - Translates newly created ADRs to English
|
|
2789
|
+
# - Translates HLDs/diagrams to English
|
|
2790
|
+
# Cost: ~$0.01 per file
|
|
2791
|
+
|
|
2792
|
+
# Result: ALL documentation in English (100% coverage)
|
|
2740
2793
|
```
|
|
2741
2794
|
|
|
2742
2795
|
**Configuration** (`.specweave/config.json`):
|
|
@@ -2747,7 +2800,7 @@ Your choice [1]:
|
|
|
2747
2800
|
"translation": {
|
|
2748
2801
|
"enabled": true,
|
|
2749
2802
|
"autoTranslateInternalDocs": true,
|
|
2750
|
-
"autoTranslateLivingDocs":
|
|
2803
|
+
"autoTranslateLivingDocs": true,
|
|
2751
2804
|
"keepFrameworkTerms": true,
|
|
2752
2805
|
"keepTechnicalTerms": true,
|
|
2753
2806
|
"translationModel": "haiku"
|
|
@@ -2757,8 +2810,8 @@ Your choice [1]:
|
|
|
2757
2810
|
|
|
2758
2811
|
**Key Settings**:
|
|
2759
2812
|
- `language`: Primary language (en, ru, es, zh, de, fr, ja, ko, pt)
|
|
2760
|
-
- `autoTranslateInternalDocs`: Auto-translate
|
|
2761
|
-
- `autoTranslateLivingDocs`: Auto-translate ADRs/HLDs after task completion (default:
|
|
2813
|
+
- `autoTranslateInternalDocs`: Auto-translate increment files + living docs specs to English (default: true)
|
|
2814
|
+
- `autoTranslateLivingDocs`: Auto-translate ADRs/HLDs after task completion (default: true)
|
|
2762
2815
|
- `translationModel`: Model to use (haiku/sonnet/opus, default: haiku)
|
|
2763
2816
|
|
|
2764
2817
|
**Supported Languages**:
|
|
@@ -2772,7 +2825,9 @@ Your choice [1]:
|
|
|
2772
2825
|
- Korean (ko)
|
|
2773
2826
|
- Portuguese (pt)
|
|
2774
2827
|
|
|
2775
|
-
**Cost**: ~$0.
|
|
2828
|
+
**Cost**: ~$0.02 per increment (5-7 files, Haiku model)
|
|
2829
|
+
|
|
2830
|
+
**Coverage**: 100% (no gaps! All living docs translated)
|
|
2776
2831
|
|
|
2777
2832
|
**Implementation Details**:
|
|
2778
2833
|
- Language detection: Heuristic-based (<1ms, zero cost)
|
|
@@ -2792,10 +2847,42 @@ npm test -- tests/unit/i18n/translation.test.ts
|
|
|
2792
2847
|
**Files**:
|
|
2793
2848
|
- Utilities: `src/utils/translation.ts` (673 lines, 11 languages)
|
|
2794
2849
|
- CLI Script: `src/hooks/lib/translate-file.ts` (398 lines)
|
|
2795
|
-
- Hook: `plugins/specweave/hooks/post-increment-planning.sh` (
|
|
2850
|
+
- Hook (Phase 1): `plugins/specweave/hooks/post-increment-planning.sh` (~420 lines)
|
|
2851
|
+
- Hook (Phase 2): `src/hooks/lib/translate-living-docs.ts` (217 lines)
|
|
2796
2852
|
- Tests: `tests/unit/i18n/translation.test.ts` (705 lines, 67 tests)
|
|
2853
|
+
- E2E Tests: `tests/e2e/i18n/living-docs-translation.spec.ts` (6 test cases)
|
|
2797
2854
|
- Schema: `src/core/schemas/specweave-config.schema.json`
|
|
2798
2855
|
|
|
2856
|
+
**Migrating Existing Non-English Living Docs**:
|
|
2857
|
+
|
|
2858
|
+
For projects with existing non-English living docs, use the one-time migration script:
|
|
2859
|
+
|
|
2860
|
+
```bash
|
|
2861
|
+
# One-time migration (translates all living docs to English)
|
|
2862
|
+
bash scripts/migrate-living-docs-to-english.sh
|
|
2863
|
+
|
|
2864
|
+
# What it does:
|
|
2865
|
+
# - Scans .specweave/docs/internal/ for non-English files
|
|
2866
|
+
# - Translates each file to English (preserves code blocks, links, framework terms)
|
|
2867
|
+
# - Skips files already in English
|
|
2868
|
+
# - Non-blocking (continues even if some files fail)
|
|
2869
|
+
|
|
2870
|
+
# Estimated time: 1-2 minutes per 100 files
|
|
2871
|
+
# Estimated cost: ~$0.01 per file (using Haiku)
|
|
2872
|
+
```
|
|
2873
|
+
|
|
2874
|
+
**After migration**:
|
|
2875
|
+
```bash
|
|
2876
|
+
# Review translated files
|
|
2877
|
+
git diff .specweave/docs/internal/
|
|
2878
|
+
|
|
2879
|
+
# Commit changes
|
|
2880
|
+
git add . && git commit -m "docs: translate living docs to English"
|
|
2881
|
+
|
|
2882
|
+
# Future increments will auto-translate
|
|
2883
|
+
/specweave:increment "Добавить новую функцию" # Auto-translates!
|
|
2884
|
+
```
|
|
2885
|
+
|
|
2799
2886
|
---
|
|
2800
2887
|
|
|
2801
2888
|
## Troubleshooting
|
package/README.md
CHANGED
|
@@ -10,347 +10,193 @@
|
|
|
10
10
|
|
|
11
11
|
---
|
|
12
12
|
|
|
13
|
-
## The Problem
|
|
13
|
+
## The Problem
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
AI coding assistants made us **10x faster at shipping**, but **100x worse at maintaining**.
|
|
16
16
|
|
|
17
|
-
You spend 3 days updating
|
|
18
|
-
|
|
19
|
-
By day 4, the code has changed again.
|
|
17
|
+
Your AI writes features in 30 minutes. You spend 3 days updating docs. By day 4, the code changed again.
|
|
20
18
|
|
|
21
19
|
**The docs? Already wrong.**
|
|
22
20
|
|
|
23
21
|
---
|
|
24
22
|
|
|
25
|
-
## The
|
|
26
|
-
|
|
27
|
-
AI coding assistants made us:
|
|
28
|
-
- ✅ **10x faster at shipping**
|
|
29
|
-
- ❌ **100x worse at maintaining**
|
|
30
|
-
|
|
31
|
-
We're all "vibe coding" now. Fast. Fun. Chaotic.
|
|
32
|
-
|
|
33
|
-
No structure. No boundaries. No memory of why we built it this way.
|
|
34
|
-
|
|
35
|
-
New developers? Lost in 1 hour.
|
|
36
|
-
|
|
37
|
-
**This is not sustainable.**
|
|
38
|
-
|
|
39
|
-
---
|
|
40
|
-
|
|
41
|
-
## The Fortune 500 Gap
|
|
42
|
-
|
|
43
|
-
Big companies don't have this problem.
|
|
44
|
-
|
|
45
|
-
They have systems:
|
|
46
|
-
- **PRDs** (Product Requirements) - What and why
|
|
47
|
-
- **HLDs** (High-Level Design) - Architecture decisions
|
|
48
|
-
- **ADRs** (Architecture Decision Records) - Why we chose X over Y
|
|
49
|
-
- **Runbooks** (Operations) - How to actually run this
|
|
50
|
-
- **Glossaries** (Terms) - What these acronyms mean
|
|
51
|
-
|
|
52
|
-
Their docs stay updated because there's a team, a process, a **discipline**.
|
|
53
|
-
|
|
54
|
-
But for solo developers and small teams?
|
|
55
|
-
|
|
56
|
-
**Impossible to maintain manually.**
|
|
57
|
-
|
|
58
|
-
---
|
|
59
|
-
|
|
60
|
-
## What is SpecWeave?
|
|
23
|
+
## The Solution
|
|
61
24
|
|
|
62
25
|
**Fortune 500 discipline. Zero overhead. AI-native.**
|
|
63
26
|
|
|
64
|
-
SpecWeave
|
|
65
|
-
|
|
66
|
-
It's not just a tool. **It's a movement.**
|
|
27
|
+
SpecWeave brings enterprise-grade processes (PRDs, HLDs, ADRs, runbooks) to developers of any size—without the bureaucracy.
|
|
67
28
|
|
|
68
29
|
> *"Dad, AI writes your code but you update docs MANUALLY?"*
|
|
69
30
|
> — My 14-year-old daughter (who was absolutely right)
|
|
70
31
|
|
|
71
|
-
**
|
|
72
|
-
- Living docs that ACTUALLY stay synced (automatically)
|
|
73
|
-
- Complete knowledge system (PRDs, HLDs, ADRs, glossaries, runbooks)
|
|
74
|
-
- Tests embedded in tasks (BDD format, full traceability)
|
|
75
|
-
- Enterprise structure without enterprise overhead
|
|
76
|
-
- **Vibe coding... but with boundaries**
|
|
32
|
+
**Living docs that ACTUALLY stay synced** - Automatically updated after every task. No manual intervention.
|
|
77
33
|
|
|
78
34
|
---
|
|
79
35
|
|
|
80
|
-
##
|
|
36
|
+
## Works for Both
|
|
81
37
|
|
|
82
|
-
**
|
|
83
|
-
-
|
|
84
|
-
-
|
|
85
|
-
-
|
|
86
|
-
- New developer: **Lost in 1 hour**
|
|
38
|
+
**🌱 Greenfield** (New Projects)
|
|
39
|
+
- Start with best practices from day one
|
|
40
|
+
- Spec-driven development from the beginning
|
|
41
|
+
- Clean, documented, maintainable
|
|
87
42
|
|
|
88
|
-
**
|
|
89
|
-
-
|
|
90
|
-
-
|
|
91
|
-
-
|
|
92
|
-
- New developer: **Productive in 1 hour**
|
|
43
|
+
**🏭 Brownfield** (Existing Projects)
|
|
44
|
+
- Import docs from Notion, Confluence, Wiki
|
|
45
|
+
- AI-powered classification (85%+ accuracy)
|
|
46
|
+
- Gradual migration without disruption
|
|
93
47
|
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
## 📊 Engineering Metrics (DORA)
|
|
97
|
-
|
|
98
|
-
[](https://spec-weave.com/docs/metrics)
|
|
99
|
-
[](https://spec-weave.com/docs/metrics)
|
|
100
|
-
[](https://spec-weave.com/docs/metrics)
|
|
101
|
-
[](https://spec-weave.com/docs/metrics)
|
|
102
|
-
|
|
103
|
-
[View detailed metrics dashboard →](https://spec-weave.com/docs/metrics)
|
|
104
|
-
|
|
105
|
-
---
|
|
106
|
-
|
|
107
|
-
## 📖 Full Documentation
|
|
108
|
-
|
|
109
|
-
**For complete guides, tutorials, and API reference:**
|
|
110
|
-
|
|
111
|
-
### **[spec-weave.com](https://spec-weave.com)**
|
|
48
|
+
**[→ Brownfield Import Guide](https://spec-weave.com/docs/workflows/brownfield)**
|
|
112
49
|
|
|
113
50
|
---
|
|
114
51
|
|
|
115
52
|
## Quick Start
|
|
116
53
|
|
|
54
|
+
### Greenfield (New Project)
|
|
117
55
|
```bash
|
|
118
|
-
# Install SpecWeave
|
|
56
|
+
# Install SpecWeave
|
|
119
57
|
npm install -g specweave
|
|
120
58
|
|
|
121
|
-
# Initialize
|
|
59
|
+
# Initialize new project
|
|
122
60
|
specweave init my-project
|
|
123
61
|
cd my-project
|
|
124
62
|
|
|
125
|
-
# Start building
|
|
63
|
+
# Start building
|
|
126
64
|
/specweave:increment "User authentication" # Plan increment
|
|
127
|
-
/specweave:do # Implement tasks
|
|
65
|
+
/specweave:do # Implement tasks
|
|
128
66
|
/specweave:done 0001 # Complete increment
|
|
129
67
|
```
|
|
130
68
|
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
### 🧪 Test-Aware Planning
|
|
138
|
-
Embedded test plans in every task with BDD format (Given/When/Then) for clarity
|
|
139
|
-
|
|
140
|
-
### 🎯 Disciplined Progress
|
|
141
|
-
Cannot start increment N+1 until N is DONE - enforces completion before moving forward
|
|
142
|
-
|
|
143
|
-
### ⏸️ Intelligent Status Management
|
|
144
|
-
Automatically detects when you're blocked (missing API keys, waiting for approval), pauses work with clear context, and resumes when ready - no manual intervention needed
|
|
145
|
-
|
|
146
|
-
### 📚 Living Documentation
|
|
147
|
-
Auto-updates after every task via Claude Code hooks - never outdated
|
|
148
|
-
|
|
149
|
-
### 🤖 Intelligent Agents
|
|
150
|
-
PM Agent, Architect, test-aware-planner, Quality Judge - specialized AI agents guide you
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
### 🌍 Multilingual Support ($0 Cost!)
|
|
69
|
+
### Brownfield (Existing Project)
|
|
70
|
+
```bash
|
|
71
|
+
# Initialize SpecWeave in existing project
|
|
72
|
+
cd my-existing-project
|
|
73
|
+
specweave init .
|
|
154
74
|
|
|
155
|
-
|
|
75
|
+
# Import existing docs
|
|
76
|
+
/specweave:import-docs ~/Downloads/notion-export --source=notion
|
|
156
77
|
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
- **Any Model**: Claude, GPT-4, Gemini, DeepSeek, and more
|
|
161
|
-
- **Any Tool**: Claude Code, Cursor, Copilot, ChatGPT
|
|
78
|
+
# Continue normally
|
|
79
|
+
/specweave:increment "Add dark mode"
|
|
80
|
+
```
|
|
162
81
|
|
|
163
|
-
**
|
|
82
|
+
**[→ Complete Quickstart Guide](https://spec-weave.com/docs/guides/getting-started/quickstart)**
|
|
164
83
|
|
|
165
84
|
---
|
|
166
85
|
|
|
167
|
-
##
|
|
168
|
-
|
|
169
|
-
### 🏢 Multi-Project Support (v0.8.0+)
|
|
170
|
-
|
|
171
|
-
Organize documentation by team, repo, or microservice:
|
|
172
|
-
|
|
173
|
-
- **Team-Based Organization**: Frontend, Backend, Mobile, Platform teams with separate documentation
|
|
174
|
-
- **Microservices Architecture**: Each service gets its own specs, modules, and team playbooks
|
|
175
|
-
- **Per-Project Sync**: Link projects to different GitHub repos, JIRA projects, or ADO boards
|
|
176
|
-
- **Unified Architecture**: Single project = multi-project with 1 project (NO special cases!)
|
|
177
|
-
|
|
178
|
-
**Five Documentation Types Per Project**:
|
|
179
|
-
1. **specs/** - Living documentation specs (user stories, AC)
|
|
180
|
-
2. **modules/** - Module/component documentation (architecture, APIs)
|
|
181
|
-
3. **team/** - Team playbooks (onboarding, conventions, workflows)
|
|
182
|
-
4. **architecture/** - Project-specific ADRs (optional)
|
|
183
|
-
5. **legacy/** - Brownfield imports (temporary)
|
|
86
|
+
## Real-World Example
|
|
184
87
|
|
|
185
|
-
**
|
|
88
|
+
**Scenario**: Building authentication for SaaS app
|
|
186
89
|
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
#### **GitHub - 3 Strategies**
|
|
192
|
-
|
|
193
|
-
1. **Repository-per-team** (Most Common)
|
|
194
|
-
```bash
|
|
195
|
-
GITHUB_STRATEGY=repository-per-team
|
|
196
|
-
GITHUB_REPOS=frontend-app,backend-api,mobile-app
|
|
197
|
-
```
|
|
198
|
-
Best for: Microservices, independent deployments
|
|
199
|
-
|
|
200
|
-
2. **Team-based** (Monorepo)
|
|
201
|
-
```bash
|
|
202
|
-
GITHUB_STRATEGY=team-based
|
|
203
|
-
GITHUB_REPO=main-product
|
|
204
|
-
GITHUB_TEAMS=frontend-team,backend-team
|
|
205
|
-
```
|
|
206
|
-
Best for: Monorepos (Nx, Turborepo, Lerna)
|
|
90
|
+
```bash
|
|
91
|
+
# 1. Plan increment (PM Agent creates spec with user stories)
|
|
92
|
+
/specweave:increment "User authentication with OAuth"
|
|
207
93
|
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
```
|
|
213
|
-
Best for: Platform teams owning multiple services
|
|
94
|
+
# Result:
|
|
95
|
+
# ✅ spec.md - User stories, acceptance criteria
|
|
96
|
+
# ✅ plan.md - Architecture, implementation steps
|
|
97
|
+
# ✅ tasks.md - Tasks with embedded tests (BDD format)
|
|
214
98
|
|
|
215
|
-
|
|
99
|
+
# 2. Implement (auto-pauses if blocked, resumes when ready)
|
|
100
|
+
/specweave:do
|
|
216
101
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
|
|
102
|
+
# While you work:
|
|
103
|
+
# - Living docs sync automatically after each task
|
|
104
|
+
# - Tests embedded in tasks guide implementation
|
|
105
|
+
# - ADRs document "why we chose X over Y"
|
|
106
|
+
# - GitHub issues auto-sync (optional)
|
|
220
107
|
|
|
221
|
-
|
|
108
|
+
# 3. Complete (Quality Judge validates)
|
|
109
|
+
/specweave:done 0001
|
|
222
110
|
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
111
|
+
# Result:
|
|
112
|
+
# ✅ Code implemented
|
|
113
|
+
# ✅ Tests passing (90% coverage)
|
|
114
|
+
# ✅ Docs synced (ADRs, HLDs, runbooks)
|
|
115
|
+
# ✅ GitHub issues updated
|
|
116
|
+
# ✅ New dev can onboard in 1 hour (not 1 week!)
|
|
227
117
|
```
|
|
228
118
|
|
|
229
|
-
|
|
119
|
+
---
|
|
120
|
+
|
|
121
|
+
## 📊 Engineering Metrics (DORA)
|
|
230
122
|
|
|
231
|
-
|
|
123
|
+
[](https://github.com/anton-abyzov/specweave/blob/develop/.specweave/docs/internal/delivery/dora-metrics.md)
|
|
124
|
+
[](https://github.com/anton-abyzov/specweave/blob/develop/.specweave/docs/internal/delivery/dora-metrics.md)
|
|
125
|
+
[](https://github.com/anton-abyzov/specweave/blob/develop/.specweave/docs/internal/delivery/dora-metrics.md)
|
|
126
|
+
[](https://github.com/anton-abyzov/specweave/blob/develop/.specweave/docs/internal/delivery/dora-metrics.md)
|
|
232
127
|
|
|
233
|
-
|
|
128
|
+
**[→ Live Dashboard](https://spec-weave.com/docs/metrics)** | **[→ Detailed Report](https://github.com/anton-abyzov/specweave/blob/develop/metrics/dora-report.md)**
|
|
234
129
|
|
|
235
|
-
|
|
236
|
-
- **Supported Sources**: Notion, Confluence, GitHub Wiki, custom markdown folders
|
|
237
|
-
- **Smart Organization**: Classifies into specs, modules, team docs, or legacy
|
|
238
|
-
- **Migration Reports**: Complete audit trail with confidence scores and manual review checklist
|
|
130
|
+
---
|
|
239
131
|
|
|
240
|
-
|
|
241
|
-
```bash
|
|
242
|
-
# Import Notion export to web-app project
|
|
243
|
-
/specweave:import-docs ~/Downloads/notion-export --source=notion --project=web-app
|
|
132
|
+
## Key Features
|
|
244
133
|
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
134
|
+
- 🧪 **Test-Aware Planning** - Embedded tests in BDD format (Given/When/Then)
|
|
135
|
+
- 🎯 **Disciplined Progress** - Can't start increment N+1 until N is DONE
|
|
136
|
+
- ⏸️ **Intelligent Pausing** - Auto-detects blockers, pauses with context, resumes when ready
|
|
137
|
+
- 📚 **Living Documentation** - Auto-updates after every task (no manual sync!)
|
|
138
|
+
- 🤖 **AI Agents** - PM, Architect, Quality Judge guide your work
|
|
139
|
+
- 🌍 **Multilingual** - Work in 11 languages (FREE translation)
|
|
140
|
+
- 🏢 **Multi-Project** - Organize by team/repo/microservice
|
|
141
|
+
- 🔗 **Issue Tracker Sync** - GitHub, Jira, Azure DevOps integration
|
|
252
142
|
|
|
253
|
-
**[→
|
|
143
|
+
**[→ Complete Feature List](https://spec-weave.com/docs/overview/features)**
|
|
254
144
|
|
|
255
145
|
---
|
|
256
146
|
|
|
257
|
-
## Documentation
|
|
147
|
+
## 📖 Documentation
|
|
258
148
|
|
|
259
|
-
**
|
|
260
|
-
- 📘 [What is SpecWeave?](https://spec-weave.com/docs/overview/introduction)
|
|
261
|
-
- 🚀 [Quickstart Guide](https://spec-weave.com/docs/guides/getting-started/quickstart)
|
|
262
|
-
- 🏗️ [Complete Workflow Journey](https://spec-weave.com/docs/workflows/overview)
|
|
263
|
-
- ❓ [FAQ - Common Questions](https://spec-weave.com/docs/faq)
|
|
149
|
+
**Complete guides, tutorials, and API reference:**
|
|
264
150
|
|
|
265
|
-
**
|
|
266
|
-
- 📋 [Commands Reference](https://spec-weave.com/docs/commands/status-management)
|
|
267
|
-
- 🔧 [API Documentation](https://spec-weave.com/docs/api)
|
|
151
|
+
### **[spec-weave.com](https://spec-weave.com)**
|
|
268
152
|
|
|
269
|
-
**
|
|
270
|
-
-
|
|
271
|
-
-
|
|
272
|
-
-
|
|
273
|
-
-
|
|
153
|
+
**Start here:**
|
|
154
|
+
- 🚀 [Quickstart Guide](https://spec-weave.com/docs/guides/getting-started/quickstart) - 5-minute setup
|
|
155
|
+
- 📘 [Complete Workflow](https://spec-weave.com/docs/workflows/overview) - End-to-end journey
|
|
156
|
+
- 📋 [Commands Reference](https://spec-weave.com/docs/commands/status-management) - All commands
|
|
157
|
+
- ❓ [FAQ](https://spec-weave.com/docs/faq) - Common questions
|
|
274
158
|
|
|
275
159
|
---
|
|
276
160
|
|
|
277
|
-
## Community
|
|
278
|
-
|
|
279
|
-
**Join the Community:**
|
|
161
|
+
## Community
|
|
280
162
|
|
|
281
|
-
- 💬 **[Discord
|
|
282
|
-
- 🎥 **[YouTube
|
|
283
|
-
-
|
|
284
|
-
-
|
|
285
|
-
- 💡 **[GitHub Discussions](https://github.com/anton-abyzov/specweave/discussions)** - Q&A and community discussions
|
|
286
|
-
|
|
287
|
-
**Need Help?**
|
|
288
|
-
1. Check the **[FAQ](https://spec-weave.com/docs/faq)** first
|
|
289
|
-
2. Ask in **[Discord](https://discord.gg/UYg4BGJ65V)** for quick answers
|
|
290
|
-
3. Create a **[GitHub Discussion](https://github.com/anton-abyzov/specweave/discussions)** for detailed questions
|
|
163
|
+
- 💬 **[Discord](https://discord.gg/UYg4BGJ65V)** - Get help, share tips
|
|
164
|
+
- 🎥 **[YouTube](https://www.youtube.com/@antonabyzov)** - Tutorials, demos
|
|
165
|
+
- 🐛 **[GitHub Issues](https://github.com/anton-abyzov/specweave/issues)** - Report bugs
|
|
166
|
+
- 💡 **[Discussions](https://github.com/anton-abyzov/specweave/discussions)** - Q&A, feature requests
|
|
291
167
|
|
|
292
168
|
---
|
|
293
169
|
|
|
294
170
|
## Contributing
|
|
295
171
|
|
|
296
|
-
**Development Setup:**
|
|
297
|
-
|
|
298
172
|
```bash
|
|
299
|
-
#
|
|
173
|
+
# Setup
|
|
300
174
|
git clone https://github.com/anton-abyzov/specweave.git
|
|
301
175
|
cd specweave
|
|
302
|
-
npm install
|
|
303
|
-
npm run build
|
|
176
|
+
npm install && npm run build
|
|
304
177
|
|
|
305
|
-
#
|
|
178
|
+
# Test
|
|
306
179
|
npm test
|
|
307
180
|
```
|
|
308
181
|
|
|
309
|
-
**To Contribute:**
|
|
310
|
-
1. Fork repository
|
|
311
|
-
2. Create feature branch: `git checkout -b features/002-new-feature`
|
|
312
|
-
3. Follow SpecWeave conventions (see CLAUDE.md)
|
|
313
|
-
4. Add tests (minimum 3 test cases)
|
|
314
|
-
5. Create PR to `develop` branch
|
|
315
|
-
|
|
316
182
|
**[→ Contributor Guide](https://spec-weave.com/docs/guides/contributing)**
|
|
317
183
|
|
|
318
184
|
---
|
|
319
185
|
|
|
320
|
-
## Best
|
|
186
|
+
## Best with Claude Code
|
|
321
187
|
|
|
322
|
-
SpecWeave
|
|
188
|
+
SpecWeave works best with **[Claude Code](https://claude.com/claude-code)** (native plugins, auto-activating skills, lifecycle hooks).
|
|
323
189
|
|
|
324
|
-
|
|
325
|
-
- ✅ **Auto-Activating Skills** - Context-aware activation (no @ mentions)
|
|
326
|
-
- ✅ **Isolated Agent Contexts** - True multi-agent role separation
|
|
327
|
-
- ✅ **Pre/Post Lifecycle Hooks** - Automated living docs sync after every task
|
|
328
|
-
- ✅ **MCP Protocol** - Industry standard for context management
|
|
329
|
-
|
|
330
|
-
**Also works with**: Cursor, GitHub Copilot, ChatGPT (with manual workflow, reduced automation)
|
|
190
|
+
Also works with: Cursor, GitHub Copilot, ChatGPT (manual workflow).
|
|
331
191
|
|
|
332
192
|
**[→ Tool Comparison](https://spec-weave.com/docs/overview/features#claude-code-native)**
|
|
333
193
|
|
|
334
194
|
---
|
|
335
195
|
|
|
336
|
-
##
|
|
196
|
+
## License
|
|
337
197
|
|
|
338
|
-
|
|
339
|
-
**License**: MIT
|
|
340
|
-
**Repository**: [github.com/anton-abyzov/specweave](https://github.com/anton-abyzov/specweave)
|
|
198
|
+
MIT - [github.com/anton-abyzov/specweave](https://github.com/anton-abyzov/specweave)
|
|
341
199
|
|
|
342
200
|
---
|
|
343
201
|
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
SpecWeave is inspired by:
|
|
347
|
-
- [spec-kit](https://github.com/github/spec-kit) - GitHub's specification toolkit
|
|
348
|
-
- [BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) - Agentic agile framework
|
|
349
|
-
- [Claude Code](https://claude.com/claude-code) - Anthropic's native plugin system
|
|
350
|
-
- [C4 Model](https://c4model.com/) - Software architecture diagrams
|
|
351
|
-
|
|
352
|
-
---
|
|
353
|
-
|
|
354
|
-
**SpecWeave** - AI made us fast. SpecWeave makes us sustainable.
|
|
355
|
-
|
|
356
|
-
**Get started**: `npm install -g specweave` → `specweave init my-project` → **[Read the Docs](https://spec-weave.com)**
|
|
202
|
+
**Get started**: `npm install -g specweave` → **[Read the Docs](https://spec-weave.com)**
|
package/bin/install-agents.sh
CHANGED
package/bin/install-commands.sh
CHANGED
package/bin/install-hooks.sh
CHANGED