squad-station 0.5.2 → 0.5.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/.squad/sdd/bmad-playbook.md +303 -114
- package/.squad/sdd/gsd-playbook.md +229 -285
- package/.squad/sdd/superpowers-playbook.md +158 -104
- package/bin/run.js +1 -1
- package/package.json +1 -1
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# BMad Method — Playbook v6.0
|
|
1
|
+
# BMad Method — Playbook v6.2.0
|
|
2
2
|
|
|
3
3
|
> Comprehensive operational guide for BMad Method — installation, Day 1 workflow, cheat sheet, troubleshooting, best practices.
|
|
4
4
|
|
|
@@ -12,19 +12,26 @@
|
|
|
12
12
|
|---|---|---|
|
|
13
13
|
| **Node.js** | ≥ 20.0.0 | Required |
|
|
14
14
|
| **Git** | Latest | Recommended |
|
|
15
|
-
| **AI IDE** | Latest | Claude Code, Cursor,
|
|
15
|
+
| **AI IDE** | Latest | Claude Code, Cursor, Gemini CLI, Codex CLI, +16 other platforms |
|
|
16
16
|
| **npm** | Bundled with Node.js | Needed for `npx` |
|
|
17
17
|
|
|
18
18
|
### Installation — Interactive Mode
|
|
19
19
|
|
|
20
20
|
```bash
|
|
21
|
+
# Install BMad Method (interactive — stable version)
|
|
21
22
|
npx bmad-method install
|
|
22
|
-
|
|
23
|
+
|
|
24
|
+
# Get the latest from tip of main (prerelease)
|
|
25
|
+
npx bmad-method@next install
|
|
26
|
+
|
|
27
|
+
# Specify exact version if stuck on stale cache
|
|
28
|
+
npx bmad-method@6.2.0 install
|
|
23
29
|
```
|
|
24
30
|
|
|
25
31
|
**Steps the installer will ask:**
|
|
26
|
-
|
|
27
|
-
|
|
32
|
+
|
|
33
|
+
1. **Select modules** — Choose modules to install (BMM, BMB, TEA, GDS, CIS, WDS)
|
|
34
|
+
2. **Select IDE** — Choose your AI IDE (20+ platforms: Claude Code, Cursor, Gemini CLI...)
|
|
28
35
|
3. **Configure paths** — Output artifacts path
|
|
29
36
|
4. **Project name** — Project name
|
|
30
37
|
5. **Skill level** — beginner / intermediate / expert
|
|
@@ -33,65 +40,120 @@ npx bmad-method@6.0.4 install # If stuck on stale beta version
|
|
|
33
40
|
### Installation — Non-Interactive Mode (CI/CD)
|
|
34
41
|
|
|
35
42
|
```bash
|
|
43
|
+
# Basic installation
|
|
36
44
|
npx bmad-method install --directory /path/to/project --modules bmm --tools claude-code --yes
|
|
45
|
+
|
|
46
|
+
# Install multiple modules
|
|
37
47
|
npx bmad-method install --directory ./my-project --modules bmm,tea,bmb --tools cursor --yes
|
|
48
|
+
|
|
49
|
+
# With custom content
|
|
50
|
+
npx bmad-method install --directory ./my-project --modules bmm --tools claude-code --custom-content ./custom --yes
|
|
38
51
|
```
|
|
39
52
|
|
|
40
53
|
| Flag | Description |
|
|
41
54
|
|---|---|
|
|
42
55
|
| `--directory <path>` | Project path |
|
|
43
|
-
| `--modules <list>` | Modules: `bmm`, `bmb`, `tea`, `gds`, `cis` |
|
|
44
|
-
| `--tools <ide>` | IDE: `claude-code`, `cursor`, `
|
|
56
|
+
| `--modules <list>` | Modules to install (comma-separated: `bmm`, `bmb`, `tea`, `gds`, `cis`, `wds`) |
|
|
57
|
+
| `--tools <ide>` | IDE target: `claude-code`, `cursor`, `gemini`, `codex`, `windsurf`, `opencode`, +14 others |
|
|
45
58
|
| `--yes` | Skip confirmation |
|
|
59
|
+
| `--custom-content <path>` | Custom content directory |
|
|
46
60
|
|
|
47
61
|
### Post-Installation Result
|
|
48
62
|
|
|
49
63
|
```
|
|
50
64
|
your-project/
|
|
51
65
|
├── _bmad/ # BMad configuration
|
|
52
|
-
│ ├──
|
|
53
|
-
│ ├──
|
|
54
|
-
│ ├──
|
|
55
|
-
│
|
|
66
|
+
│ ├── bmm/ # BMM module
|
|
67
|
+
│ │ ├── config.yaml # Resolved settings
|
|
68
|
+
│ │ ├── agents/ # Agent persona skill dirs
|
|
69
|
+
│ │ ├── skills/ # Workflow skill dirs
|
|
70
|
+
│ │ └── data/ # Reference data
|
|
71
|
+
│ └── core/ # Core skills
|
|
56
72
|
├── _bmad-output/
|
|
57
73
|
│ ├── planning-artifacts/ # PRD, Architecture, Epics
|
|
58
74
|
│ ├── implementation-artifacts/ # Sprint status, Stories
|
|
59
75
|
│ └── project-context.md # (optional) Implementation rules
|
|
60
|
-
├── .claude/skills/ #
|
|
76
|
+
├── .claude/skills/ # Installed skills (depends on IDE)
|
|
77
|
+
│ ├── bmad-help/SKILL.md
|
|
78
|
+
│ ├── bmad-create-prd/SKILL.md
|
|
79
|
+
│ └── ... # 44 SKILL.md files total
|
|
61
80
|
└── docs/ # Project knowledge
|
|
62
81
|
```
|
|
63
82
|
|
|
83
|
+
### Uninstall
|
|
84
|
+
|
|
85
|
+
```bash
|
|
86
|
+
# Interactive uninstall
|
|
87
|
+
npx bmad-method uninstall
|
|
88
|
+
|
|
89
|
+
# Or remove manually
|
|
90
|
+
rm -rf _bmad/ _bmad-output/ .claude/skills/bmad-*
|
|
91
|
+
```
|
|
92
|
+
|
|
93
|
+
### Upgrade from 6.0.x → 6.2
|
|
94
|
+
|
|
95
|
+
```bash
|
|
96
|
+
# 1. Backup current artifacts
|
|
97
|
+
cp -r _bmad-output/ _bmad-output-backup/
|
|
98
|
+
|
|
99
|
+
# 2. Re-run installer
|
|
100
|
+
npx bmad-method@6.2.0 install
|
|
101
|
+
|
|
102
|
+
# 3. Verify skills have regenerated
|
|
103
|
+
ls .claude/skills/
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
> ⚠️ **Breaking changes V6.1:** The entire system has migrated to **skills-based architecture**. Legacy YAML/XML workflow engine has been completely removed. Path variables changed from `@` prefix to `{project-root}` syntax. Terminology: "commands" → "skills".
|
|
107
|
+
|
|
64
108
|
---
|
|
65
109
|
|
|
66
110
|
## Day 1 Workflow
|
|
67
111
|
|
|
68
112
|
### Greenfield Project (New Project)
|
|
69
113
|
|
|
70
|
-
```
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
114
|
+
```mermaid
|
|
115
|
+
flowchart TD
|
|
116
|
+
A["Install BMad"] --> B["Open AI IDE"]
|
|
117
|
+
B --> C["Run bmad-help"]
|
|
118
|
+
C --> D{"Choose Planning Track"}
|
|
119
|
+
D -->|"Bug fix"| QF["Quick Flow"]
|
|
120
|
+
D -->|"Product"| BM["BMad Method"]
|
|
121
|
+
D -->|"Enterprise"| ENT["Enterprise"]
|
|
122
|
+
|
|
123
|
+
QF --> QD["bmad-quick-dev<br/>(unified workflow)"]
|
|
124
|
+
QD --> DONE["Done!"]
|
|
125
|
+
|
|
126
|
+
BM --> BS["bmad-brainstorming"]
|
|
127
|
+
BS --> PBR["bmad-product-brief-preview<br/>(NEW — guided/yolo/autonomous)"]
|
|
128
|
+
PBR --> PRD["bmad-create-prd"]
|
|
129
|
+
PRD --> UX["bmad-create-ux-design"]
|
|
130
|
+
UX --> ARCH["bmad-create-architecture"]
|
|
131
|
+
ARCH --> EPC["bmad-create-epics-and-stories"]
|
|
132
|
+
EPC --> IRC["bmad-check-implementation-readiness"]
|
|
133
|
+
IRC --> SP["bmad-sprint-planning"]
|
|
134
|
+
SP --> BUILD["Build Cycle"]
|
|
135
|
+
|
|
136
|
+
ENT --> BS
|
|
75
137
|
```
|
|
76
138
|
|
|
77
139
|
### Brownfield Project (Existing Project)
|
|
78
140
|
|
|
79
141
|
1. **Install BMad** — `npx bmad-method install` in the existing project folder
|
|
80
142
|
2. **Run `/bmad-help`** — BMad-Help will detect project state
|
|
81
|
-
3. **Create Project Context** — `/bmad-generate-project-context`
|
|
143
|
+
3. **Create Project Context** — `/bmad-generate-project-context` to document technical preferences
|
|
82
144
|
4. **Choose track** — Quick Flow for small changes, BMad Method for major features
|
|
83
|
-
5. **Start from the appropriate phase**
|
|
145
|
+
5. **Start from the appropriate phase** — Can skip Phase 1 if direction is already clear
|
|
84
146
|
|
|
85
147
|
### Build Cycle (Repeat for each story)
|
|
86
148
|
|
|
87
|
-
| Step | Agent | Command | Description |
|
|
88
|
-
|
|
89
|
-
| 1 | Scrum Master | `/bmad-create-story` | Create story file from epic |
|
|
90
|
-
| 2 | Developer | `/bmad-dev-story` | Implement story (new chat!) |
|
|
91
|
-
| 3 | Developer | `/bmad-code-review` | Review code
|
|
92
|
-
| 4 | Scrum Master | `/bmad-retrospective` | After completing an epic |
|
|
149
|
+
| Step | Agent | Skill | Command | Description |
|
|
150
|
+
|---|---|---|---|---|
|
|
151
|
+
| 1 | Scrum Master | `bmad-create-story` | `/bmad-create-story` | Create story file from epic |
|
|
152
|
+
| 2 | Developer | `bmad-dev-story` | `/bmad-dev-story` | Implement story (new chat!) |
|
|
153
|
+
| 3 | Developer | `bmad-code-review` | `/bmad-code-review` | Review code (sharded: 4-step parallel review) |
|
|
154
|
+
| 4 | Scrum Master | `bmad-retrospective` | `/bmad-retrospective` | After completing an epic |
|
|
93
155
|
|
|
94
|
-
⚡ **IMPORTANT:** Always use a **fresh chat** for each workflow!
|
|
156
|
+
> ⚡ **IMPORTANT:** Always use a **fresh chat** for each workflow!
|
|
95
157
|
|
|
96
158
|
---
|
|
97
159
|
|
|
@@ -99,6 +161,8 @@ Install BMad → Open AI IDE → Run bmad-help → Choose Planning Track:
|
|
|
99
161
|
|
|
100
162
|
### Daily Operations Checklist
|
|
101
163
|
|
|
164
|
+
```markdown
|
|
165
|
+
## Every day when starting work:
|
|
102
166
|
1. Open AI IDE in project folder
|
|
103
167
|
2. Run `/bmad-help` → view project state and next steps
|
|
104
168
|
3. Run `/bmad-create-story` for the next story (new chat)
|
|
@@ -106,110 +170,211 @@ Install BMad → Open AI IDE → Run bmad-help → Choose Planning Track:
|
|
|
106
170
|
5. Run `/bmad-code-review` when finished (new chat)
|
|
107
171
|
6. Commit code frequently
|
|
108
172
|
|
|
109
|
-
When an epic is completed:
|
|
110
|
-
|
|
173
|
+
## When an epic is completed:
|
|
174
|
+
1. Run `/bmad-retrospective` (new chat)
|
|
175
|
+
2. Review sprint-status.yaml
|
|
176
|
+
3. Continue to the next epic
|
|
177
|
+
|
|
178
|
+
## When scope changes:
|
|
179
|
+
1. Run `/bmad-correct-course` with SM agent (new chat)
|
|
180
|
+
2. Update PRD if needed
|
|
181
|
+
3. Re-plan epics
|
|
182
|
+
```
|
|
183
|
+
|
|
184
|
+
### Creating Project Context (Recommended)
|
|
185
|
+
|
|
186
|
+
Project Context helps AI agents understand your technical preferences:
|
|
187
|
+
|
|
188
|
+
```bash
|
|
189
|
+
# Method 1: Auto-generate after having architecture
|
|
190
|
+
/bmad-generate-project-context
|
|
191
|
+
|
|
192
|
+
# Method 2: Create manually
|
|
193
|
+
# Create file _bmad-output/project-context.md with content:
|
|
194
|
+
```
|
|
195
|
+
|
|
196
|
+
```markdown
|
|
197
|
+
# Project Context
|
|
198
|
+
|
|
199
|
+
## Technology Stack
|
|
200
|
+
- Frontend: React 18 + TypeScript
|
|
201
|
+
- Backend: Node.js + Express
|
|
202
|
+
- Database: PostgreSQL
|
|
203
|
+
- ORM: Prisma
|
|
204
|
+
|
|
205
|
+
## Implementation Rules
|
|
206
|
+
- Use TypeScript strict mode
|
|
207
|
+
- All API responses must follow REST conventions
|
|
208
|
+
- Error handling with custom error classes
|
|
209
|
+
- Unit test coverage minimum 80%
|
|
210
|
+
```
|
|
111
211
|
|
|
112
212
|
---
|
|
113
213
|
|
|
114
214
|
## Strategic Configuration
|
|
115
215
|
|
|
116
|
-
### Presets by
|
|
216
|
+
### Presets by Project Type
|
|
117
217
|
|
|
118
|
-
| Project Type | Modules | Track |
|
|
119
|
-
|
|
120
|
-
| **Side project / MVP** | `bmm` | Quick Flow |
|
|
121
|
-
| **Startup product** | `bmm` + `cis` | BMad Method |
|
|
122
|
-
| **Enterprise app** | `bmm` + `tea` | Enterprise |
|
|
123
|
-
| **Game** | `bmm` + `gds` | BMad Method |
|
|
124
|
-
| **Custom agents** | `bmm` + `bmb` | BMad Method |
|
|
218
|
+
| Project Type | Modules | Skill Level | Track |
|
|
219
|
+
|---|---|---|---|
|
|
220
|
+
| **Side project / MVP** | `bmm` | intermediate | Quick Flow |
|
|
221
|
+
| **Startup product** | `bmm` + `cis` | intermediate | BMad Method |
|
|
222
|
+
| **Enterprise app** | `bmm` + `tea` | expert | Enterprise |
|
|
223
|
+
| **Game** | `bmm` + `gds` | intermediate | BMad Method |
|
|
224
|
+
| **Custom agents** | `bmm` + `bmb` | expert | BMad Method |
|
|
225
|
+
| **Design-heavy** | `bmm` + `wds` | intermediate | BMad Method |
|
|
226
|
+
| **Full suite** | `bmm` + `bmb` + `tea` + `cis` | expert | Enterprise |
|
|
125
227
|
|
|
126
|
-
### When to
|
|
228
|
+
### When to Use Each Agent?
|
|
127
229
|
|
|
128
230
|
| Situation | Agent | Skill |
|
|
129
231
|
|---|---|---|
|
|
130
|
-
|
|
|
131
|
-
|
|
|
132
|
-
|
|
|
133
|
-
|
|
|
134
|
-
|
|
|
232
|
+
| Have a new idea to explore | Analyst (Mary) | `/bmad-brainstorming` |
|
|
233
|
+
| Need market research | Analyst (Mary) | `/bmad-market-research` |
|
|
234
|
+
| Need domain research | Analyst (Mary) | `/bmad-domain-research` |
|
|
235
|
+
| Need technical research | Analyst (Mary) | `/bmad-technical-research` |
|
|
236
|
+
| Create product brief (new) | Analyst (Mary) | `/bmad-product-brief-preview` |
|
|
237
|
+
| Write requirements | PM (John) | `/bmad-create-prd` |
|
|
238
|
+
| Validate PRD | PM (John) | `/bmad-validate-prd` |
|
|
239
|
+
| Design UI/UX | UX Designer (Sally) | `/bmad-create-ux-design` |
|
|
240
|
+
| Design architecture | Architect (Winston) | `/bmad-create-architecture` |
|
|
135
241
|
| Sprint planning | Scrum Master (Bob) | `/bmad-sprint-planning` |
|
|
136
|
-
|
|
|
137
|
-
|
|
|
138
|
-
|
|
|
242
|
+
| View sprint status | Scrum Master (Bob) | `/bmad-sprint-status` |
|
|
243
|
+
| Implement code | Developer (Amelia) | `/bmad-dev-story` |
|
|
244
|
+
| Review code | Developer (Amelia) | `/bmad-code-review` |
|
|
245
|
+
| E2E tests | QA (Quinn) | `/bmad-qa-generate-e2e-tests` |
|
|
246
|
+
| Bug fix / small change | Quick Flow (Barry) | `/bmad-quick-dev` |
|
|
247
|
+
| Group discussion | Party Mode | `/bmad-party-mode` |
|
|
139
248
|
| Don't know what to do next | BMad-Help | `/bmad-help` |
|
|
140
249
|
|
|
141
250
|
---
|
|
142
251
|
|
|
143
252
|
## Cheat Sheet
|
|
144
253
|
|
|
145
|
-
### Core Skills
|
|
254
|
+
### Core Skills (available in all modules)
|
|
146
255
|
|
|
147
256
|
| Skill | Phase | Description |
|
|
148
257
|
|---|---|---|
|
|
149
|
-
| `/bmad-help` | Any | Intelligent guide |
|
|
150
|
-
| `/bmad-brainstorming` |
|
|
151
|
-
| `/bmad-
|
|
152
|
-
| `/bmad-
|
|
153
|
-
| `/bmad-
|
|
154
|
-
| `/bmad-
|
|
155
|
-
| `/bmad-
|
|
156
|
-
| `/bmad-
|
|
157
|
-
| `/bmad-
|
|
158
|
-
| `/bmad-
|
|
159
|
-
| `/bmad-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
163
|
-
|
|
|
164
|
-
|
|
165
|
-
| `/bmad-
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
|
258
|
+
| `/bmad-help` | Any | 🌟 Intelligent guide — ask anything |
|
|
259
|
+
| `/bmad-brainstorming` | Any | Guided ideation session |
|
|
260
|
+
| `/bmad-party-mode` | Any | Multi-agent collaboration |
|
|
261
|
+
| `/bmad-review-adversarial-general` | Any | Adversarial content review |
|
|
262
|
+
| `/bmad-review-edge-case-hunter` | Any | Edge case analysis for code |
|
|
263
|
+
| `/bmad-distillator` | Any | Lossless LLM-optimized document compression |
|
|
264
|
+
| `/bmad-editorial-review-prose` | Any | Review prose quality |
|
|
265
|
+
| `/bmad-editorial-review-structure` | Any | Review document structure |
|
|
266
|
+
| `/bmad-advanced-elicitation` | Any | Advanced questioning techniques |
|
|
267
|
+
| `/bmad-index-docs` | Any | Create doc index for LLM scanning |
|
|
268
|
+
| `/bmad-shard-doc` | Any | Split large markdown file |
|
|
269
|
+
|
|
270
|
+
### BMM Phase 1: Analysis Skills
|
|
271
|
+
|
|
272
|
+
| Skill | Agent | Description |
|
|
273
|
+
|---|---|---|
|
|
274
|
+
| `/bmad-product-brief-preview` | Analyst | 🆕 Guided/Yolo/Autonomous product brief creation |
|
|
275
|
+
| `/bmad-create-product-brief` | Analyst | Foundation document |
|
|
276
|
+
| `/bmad-market-research` | Analyst | Market analysis, competitive landscape |
|
|
277
|
+
| `/bmad-domain-research` | Analyst | Industry domain deep dive |
|
|
278
|
+
| `/bmad-technical-research` | Analyst | Technical feasibility analysis |
|
|
279
|
+
| `/bmad-document-project` | Analyst | Analyze existing project for docs |
|
|
280
|
+
|
|
281
|
+
### BMM Phase 2: Planning Skills
|
|
282
|
+
|
|
283
|
+
| Skill | Agent | Description |
|
|
284
|
+
|---|---|---|
|
|
285
|
+
| `/bmad-create-prd` | PM | Product Requirements Document |
|
|
286
|
+
| `/bmad-validate-prd` | PM | Validate PRD completeness |
|
|
287
|
+
| `/bmad-edit-prd` | PM | Improve existing PRD |
|
|
288
|
+
| `/bmad-create-ux-design` | UX | UX Design document |
|
|
289
|
+
|
|
290
|
+
### BMM Phase 3: Solutioning Skills
|
|
291
|
+
|
|
292
|
+
| Skill | Agent | Description |
|
|
293
|
+
|---|---|---|
|
|
294
|
+
| `/bmad-create-architecture` | Architect | Architecture document |
|
|
295
|
+
| `/bmad-create-epics-and-stories` | PM | Break PRD → epics |
|
|
296
|
+
| `/bmad-check-implementation-readiness` | Architect | Validate planning cohesion |
|
|
297
|
+
| `/bmad-generate-project-context` | Analyst | Generate project context from codebase |
|
|
298
|
+
|
|
299
|
+
### BMM Phase 4: Implementation Skills
|
|
300
|
+
|
|
301
|
+
| Skill | Agent | Description |
|
|
302
|
+
|---|---|---|
|
|
303
|
+
| `/bmad-sprint-planning` | SM | Initialize sprint tracking |
|
|
304
|
+
| `/bmad-sprint-status` | SM | 🆕 Summarize sprint status |
|
|
305
|
+
| `/bmad-create-story` | SM | Create story file |
|
|
306
|
+
| `/bmad-dev-story` | Developer | Implement story |
|
|
307
|
+
| `/bmad-quick-dev` | Barry | 🆕 Unified quick flow (clarify → plan → implement → review → present) |
|
|
308
|
+
| `/bmad-code-review` | Developer | 🆕 Sharded parallel code review (4 steps) |
|
|
309
|
+
| `/bmad-qa-generate-e2e-tests` | QA | Generate E2E tests |
|
|
310
|
+
| `/bmad-correct-course` | SM | Handle scope changes |
|
|
311
|
+
| `/bmad-retrospective` | SM | Epic retrospective |
|
|
312
|
+
|
|
313
|
+
### Agent Skills (Load persona)
|
|
314
|
+
|
|
315
|
+
| Skill | Agent Persona |
|
|
170
316
|
|---|---|
|
|
171
|
-
| `/bmad-analyst` | Mary — Analyst |
|
|
172
|
-
| `/bmad-pm` | John — Product Manager |
|
|
173
|
-
| `/bmad-architect` | Winston — Architect |
|
|
174
|
-
| `/bmad-sm` | Bob — Scrum Master |
|
|
175
|
-
| `/bmad-dev` | Amelia — Developer |
|
|
176
|
-
| `/bmad-qa` | Quinn — QA Engineer |
|
|
177
|
-
| `/bmad-
|
|
178
|
-
| `/bmad-ux-designer` | Sally — UX Designer |
|
|
179
|
-
| `/bmad-tech-writer` | Paige — Technical Writer |
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
| Skill | Description |
|
|
317
|
+
| `/bmad-agent-analyst` | Mary — Analyst |
|
|
318
|
+
| `/bmad-agent-pm` | John — Product Manager |
|
|
319
|
+
| `/bmad-agent-architect` | Winston — Architect |
|
|
320
|
+
| `/bmad-agent-sm` | Bob — Scrum Master |
|
|
321
|
+
| `/bmad-agent-dev` | Amelia — Developer |
|
|
322
|
+
| `/bmad-agent-qa` | Quinn — QA Engineer |
|
|
323
|
+
| `/bmad-agent-quick-flow-solo-dev` | Barry — Quick Flow Solo Dev |
|
|
324
|
+
| `/bmad-agent-ux-designer` | Sally — UX Designer |
|
|
325
|
+
| `/bmad-agent-tech-writer` | Paige — Technical Writer |
|
|
326
|
+
|
|
327
|
+
### CLI Commands
|
|
328
|
+
|
|
329
|
+
| Command | Description |
|
|
185
330
|
|---|---|
|
|
186
|
-
|
|
|
187
|
-
|
|
|
188
|
-
|
|
|
331
|
+
| `npx bmad-method install` | Interactive install |
|
|
332
|
+
| `npx bmad-method@next install` | Install latest prerelease |
|
|
333
|
+
| `npx bmad-method install --directory <path> --modules <m> --tools <ide> --yes` | Non-interactive |
|
|
334
|
+
| `npx bmad-method uninstall` | Remove components |
|
|
335
|
+
| `npx bmad-method@<version> install` | Install specific version |
|
|
189
336
|
|
|
190
337
|
---
|
|
191
338
|
|
|
192
339
|
## Troubleshooting
|
|
193
340
|
|
|
194
|
-
| Error | Fix |
|
|
195
|
-
|
|
196
|
-
| Skills not showing |
|
|
197
|
-
|
|
|
198
|
-
| Old skills
|
|
199
|
-
| Nested install | Install at project root |
|
|
200
|
-
|
|
|
201
|
-
|
|
|
202
|
-
|
|
|
203
|
-
|
|
|
341
|
+
| Error | Cause | Fix |
|
|
342
|
+
|---|---|---|
|
|
343
|
+
| **Skills not showing in IDE** | IDE hasn't enabled skills or needs restart | Check IDE settings → enable skills → restart/reload |
|
|
344
|
+
| **`npx bmad-method` gives old version** | npm cache is stale | `npx bmad-method@6.2.0 install` or `@next` |
|
|
345
|
+
| **Old module skills still present** | Installer doesn't auto-delete | Remove manually: `rm -rf .claude/skills/bmad-*` → re-install |
|
|
346
|
+
| **Nested install rejected** | Ancestor directory already has BMAD | Install at project root, no nesting |
|
|
347
|
+
| **Workflow context errors** | Running multiple workflows in same chat | **Always use fresh chat** for each workflow |
|
|
348
|
+
| **Brainstorming overwrites old session** | Bug v6.0.3 and below | Update to v6.0.4+ |
|
|
349
|
+
| **Agent responds with wrong role** | Context noise from previous workflow | Fresh chat + invoke correct agent skill |
|
|
350
|
+
| **Quick Dev scope creep** | Feature larger than expected | Quick Dev auto-detect → split or escalate |
|
|
351
|
+
| **Code Review infinite loop** | Old bug: mandatory minimum findings | Fixed v6.1+ — removed mandatory minimum |
|
|
352
|
+
| **PRD loses brainstorming ideas** | Silent loss bug | Fixed v6.1+ — added reconciliation step |
|
|
353
|
+
| **Cannot find module** | Node.js version < 20 | Upgrade Node.js: `nvm install 20` |
|
|
354
|
+
| **Skill validation errors** | Naming/path/variable issues | Run skill-validator.md on skill directory |
|
|
204
355
|
|
|
205
356
|
### Debug Steps
|
|
206
357
|
|
|
207
358
|
```bash
|
|
208
|
-
|
|
359
|
+
# 1. Verify Node.js version
|
|
360
|
+
node --version # Must be >= 20
|
|
361
|
+
|
|
362
|
+
# 2. Clear npm cache
|
|
209
363
|
npm cache clean --force
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
364
|
+
|
|
365
|
+
# 3. Re-install with specific version or @next
|
|
366
|
+
npx bmad-method@6.2.0 install
|
|
367
|
+
# or
|
|
368
|
+
npx bmad-method@next install
|
|
369
|
+
|
|
370
|
+
# 4. Verify skills directory
|
|
371
|
+
ls -la .claude/skills/ # or .cursor/skills/
|
|
372
|
+
|
|
373
|
+
# 5. Check installed config
|
|
374
|
+
cat _bmad/bmm/config.yaml
|
|
375
|
+
|
|
376
|
+
# 6. Report bug if still failing
|
|
377
|
+
# https://github.com/bmad-code-org/BMAD-METHOD/issues
|
|
213
378
|
```
|
|
214
379
|
|
|
215
380
|
---
|
|
@@ -218,23 +383,47 @@ cat _bmad/module.yaml
|
|
|
218
383
|
|
|
219
384
|
### ✅ Gold Rules
|
|
220
385
|
|
|
221
|
-
|
|
222
|
-
|
|
223
|
-
|
|
224
|
-
|
|
225
|
-
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
386
|
+
| # | Rule | Why |
|
|
387
|
+
|---|---|---|
|
|
388
|
+
| 1 | **Always use fresh chat** for each workflow | Avoid context pollution, each agent needs clean context |
|
|
389
|
+
| 2 | **Start with `/bmad-help`** | BMad-Help inspects project state → recommends exact next step |
|
|
390
|
+
| 3 | **Create Project Context early** | Agents understand tech preferences → higher quality output |
|
|
391
|
+
| 4 | **Choose the right planning track** | Quick Flow for small, BMad Method for medium, Enterprise for complex |
|
|
392
|
+
| 5 | **Run Implementation Readiness** before coding | Validate cohesion between PRD, Architecture, Epics |
|
|
393
|
+
| 6 | **Code Review every story** | Sharded parallel review catches bugs early (Blind Hunter + Edge Case Hunter + Acceptance Auditor) |
|
|
394
|
+
| 7 | **Retrospective every epic** | Continuous improvement, adjust sprint |
|
|
395
|
+
| 8 | **Commit code frequently** | Keep diffs small, easy to review |
|
|
396
|
+
| 9 | **Git ignore planning artifacts** if containing sensitive info | PRD/Architecture may contain business logic |
|
|
397
|
+
| 10 | **Upgrade BMad regularly** | Bug fixes, new features, better agent behavior. Use `@next` for cutting edge |
|
|
230
398
|
|
|
231
399
|
### ❌ Anti-Patterns
|
|
232
400
|
|
|
233
|
-
| Anti-Pattern | Solution |
|
|
401
|
+
| Anti-Pattern | Problem | Solution |
|
|
402
|
+
|---|---|---|
|
|
403
|
+
| **Running multiple workflows in same chat** | Context noise, agent confused | Fresh chat for each workflow |
|
|
404
|
+
| **Skip PRD and go straight to code** (for medium+ projects) | Missing requirements → excessive rework | At minimum need PRD or tech-spec |
|
|
405
|
+
| **Vibe-coding instead of following process** | Inconsistent output | Use structured workflows |
|
|
406
|
+
| **Ignore `bmad-help` recommendations** | Miss important steps | Trust bmad-help, it inspects project state |
|
|
407
|
+
| **Not creating Project Context** | Agents don't understand conventions | Create `project-context.md` early |
|
|
408
|
+
| **Nested BMAD install** | Duplicate commands, confusion | Install at root project only |
|
|
409
|
+
| **Using Quick Flow for complex features** | Under-planned, scope creep | Escalate to BMad Method when scope is large |
|
|
410
|
+
| **Not running Code Review** | Bugs slip through | Always `/bmad-code-review` after every story |
|
|
411
|
+
| **Reference files across skills** | Breaking encapsulation (PATH-05) | Use `skill:skill-name` syntax instead of file paths |
|
|
412
|
+
|
|
413
|
+
---
|
|
414
|
+
|
|
415
|
+
## Resources
|
|
416
|
+
|
|
417
|
+
| Resource | Link |
|
|
234
418
|
|---|---|
|
|
235
|
-
|
|
|
236
|
-
|
|
|
237
|
-
|
|
|
238
|
-
|
|
|
239
|
-
|
|
|
240
|
-
|
|
|
419
|
+
| **Documentation** | [docs.bmad-method.org](https://docs.bmad-method.org) |
|
|
420
|
+
| **Getting Started** | [Tutorial](https://docs.bmad-method.org/tutorials/getting-started/) |
|
|
421
|
+
| **Upgrade to V6** | [Guide](https://docs.bmad-method.org/how-to/upgrade-to-v6/) |
|
|
422
|
+
| **GitHub** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) |
|
|
423
|
+
| **Discord** | [Join Community](https://discord.gg/gk8jAdXWmj) |
|
|
424
|
+
| **YouTube** | [BMadCode Channel](https://www.youtube.com/@BMadCode) |
|
|
425
|
+
| **npm** | [bmad-method](https://www.npmjs.com/package/bmad-method) |
|
|
426
|
+
| **Issues** | [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) |
|
|
427
|
+
| **Discussions** | [GitHub Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) |
|
|
428
|
+
| **Roadmap** | [docs.bmad-method.org/roadmap](https://docs.bmad-method.org/roadmap/) |
|
|
429
|
+
| **Chinese Docs** | [README_CN.md](https://github.com/bmad-code-org/BMAD-METHOD/blob/main/README_CN.md) |
|