bmad-method 4.19.2 → 4.20.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.
Files changed (118) hide show
  1. package/.github/FUNDING.yml +15 -0
  2. package/.github/ISSUE_TEMPLATE/bug_report.md +32 -0
  3. package/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
  4. package/.vscode/settings.json +6 -76
  5. package/CHANGELOG.md +7 -0
  6. package/CONTRIBUTING.md +1 -1
  7. package/GUIDING-PRINCIPLES.md +2 -2
  8. package/LICENSE +1 -1
  9. package/README.md +178 -220
  10. package/bmad-core/agents/dev.md +1 -1
  11. package/bmad-core/data/bmad-kb.md +1 -1
  12. package/dist/agents/analyst.txt +1 -1
  13. package/dist/agents/bmad-master.txt +1 -1
  14. package/dist/agents/bmad-orchestrator.txt +1 -1
  15. package/dist/teams/team-all.txt +39 -39
  16. package/dist/teams/team-fullstack.txt +39 -39
  17. package/dist/teams/team-ide-minimal.txt +1 -1
  18. package/dist/teams/team-no-ui.txt +13 -13
  19. package/docs/agentic-tools/claude-code-guide.md +36 -0
  20. package/docs/agentic-tools/cline-guide.md +42 -0
  21. package/docs/agentic-tools/cursor-guide.md +37 -0
  22. package/docs/agentic-tools/gemini-cli-guide.md +46 -0
  23. package/docs/agentic-tools/roo-code-guide.md +46 -0
  24. package/docs/agentic-tools/windsurf-guide.md +37 -0
  25. package/docs/core-architecture.md +174 -6
  26. package/docs/expansion-packs.md +15 -0
  27. package/docs/user-guide.md +283 -36
  28. package/docs/versioning-and-releases.md +2 -10
  29. package/docs/versions.md +0 -1
  30. package/docs/working-in-the-brownfield.md +4 -8
  31. package/package.json +1 -1
  32. package/tools/installer/bin/bmad.js +2 -2
  33. package/tools/installer/package.json +1 -1
  34. package/.claude/commands/analyst.md +0 -68
  35. package/.claude/commands/architect.md +0 -68
  36. package/.claude/commands/bmad-master.md +0 -105
  37. package/.claude/commands/bmad-orchestrator.md +0 -130
  38. package/.claude/commands/bmad-the-creator.md +0 -57
  39. package/.claude/commands/dev.md +0 -69
  40. package/.claude/commands/game-designer.md +0 -62
  41. package/.claude/commands/game-developer.md +0 -70
  42. package/.claude/commands/game-sm.md +0 -55
  43. package/.claude/commands/infra-devops-platform.md +0 -63
  44. package/.claude/commands/pm.md +0 -65
  45. package/.claude/commands/po.md +0 -67
  46. package/.claude/commands/qa.md +0 -54
  47. package/.claude/commands/sm.md +0 -55
  48. package/.claude/commands/ux-expert.md +0 -67
  49. package/.clinerules/01-bmad-master.md +0 -116
  50. package/.clinerules/02-bmad-orchestrator.md +0 -141
  51. package/.clinerules/03-pm.md +0 -76
  52. package/.clinerules/04-analyst.md +0 -79
  53. package/.clinerules/05-architect.md +0 -79
  54. package/.clinerules/06-po.md +0 -78
  55. package/.clinerules/07-sm.md +0 -66
  56. package/.clinerules/08-dev.md +0 -80
  57. package/.clinerules/09-qa.md +0 -65
  58. package/.clinerules/10-ux-expert.md +0 -78
  59. package/.clinerules/11-bmad-the-creator.md +0 -68
  60. package/.clinerules/12-game-designer.md +0 -73
  61. package/.clinerules/13-game-developer.md +0 -81
  62. package/.clinerules/14-game-sm.md +0 -66
  63. package/.clinerules/15-infra-devops-platform.md +0 -74
  64. package/.cursor/rules/analyst.mdc +0 -82
  65. package/.cursor/rules/architect.mdc +0 -82
  66. package/.cursor/rules/bmad-master.mdc +0 -119
  67. package/.cursor/rules/bmad-orchestrator.mdc +0 -144
  68. package/.cursor/rules/bmad-the-creator.mdc +0 -71
  69. package/.cursor/rules/dev.mdc +0 -83
  70. package/.cursor/rules/game-designer.mdc +0 -76
  71. package/.cursor/rules/game-developer.mdc +0 -84
  72. package/.cursor/rules/game-sm.mdc +0 -69
  73. package/.cursor/rules/infra-devops-platform.mdc +0 -77
  74. package/.cursor/rules/pm.mdc +0 -79
  75. package/.cursor/rules/po.mdc +0 -81
  76. package/.cursor/rules/qa.mdc +0 -68
  77. package/.cursor/rules/sm.mdc +0 -69
  78. package/.cursor/rules/ux-expert.mdc +0 -81
  79. package/.gemini/agents/analyst.md +0 -64
  80. package/.gemini/agents/architect.md +0 -64
  81. package/.gemini/agents/bmad-master.md +0 -101
  82. package/.gemini/agents/bmad-orchestrator.md +0 -126
  83. package/.gemini/agents/bmad-the-creator.md +0 -53
  84. package/.gemini/agents/dev.md +0 -65
  85. package/.gemini/agents/game-designer.md +0 -58
  86. package/.gemini/agents/game-developer.md +0 -66
  87. package/.gemini/agents/game-sm.md +0 -51
  88. package/.gemini/agents/infra-devops-platform.md +0 -59
  89. package/.gemini/agents/pm.md +0 -61
  90. package/.gemini/agents/po.md +0 -63
  91. package/.gemini/agents/qa.md +0 -50
  92. package/.gemini/agents/sm.md +0 -51
  93. package/.gemini/agents/ux-expert.md +0 -63
  94. package/.gemini/settings.json +0 -20
  95. package/.roomodes +0 -139
  96. package/.vscode/extensions.json +0 -6
  97. package/.vscode/tasks.json +0 -41
  98. package/.windsurf/rules/analyst.md +0 -76
  99. package/.windsurf/rules/architect.md +0 -76
  100. package/.windsurf/rules/bmad-master.md +0 -113
  101. package/.windsurf/rules/bmad-orchestrator.md +0 -138
  102. package/.windsurf/rules/bmad-the-creator.md +0 -65
  103. package/.windsurf/rules/dev.md +0 -77
  104. package/.windsurf/rules/game-designer.md +0 -70
  105. package/.windsurf/rules/game-developer.md +0 -78
  106. package/.windsurf/rules/game-sm.md +0 -63
  107. package/.windsurf/rules/infra-devops-platform.md +0 -71
  108. package/.windsurf/rules/pm.md +0 -73
  109. package/.windsurf/rules/po.md +0 -75
  110. package/.windsurf/rules/qa.md +0 -62
  111. package/.windsurf/rules/sm.md +0 -63
  112. package/.windsurf/rules/ux-expert.md +0 -75
  113. package/docs/claude-code-guide.md +0 -121
  114. package/docs/cursor-guide.md +0 -131
  115. package/docs/expansion-pack-ideas.md +0 -121
  116. package/docs/roo-code-guide.md +0 -142
  117. package/docs/windsurf-guide.md +0 -129
  118. /package/dist/expansion-packs/{expansion-creator → bmad-creator-tools}/agents/bmad-the-creator.txt +0 -0
@@ -0,0 +1,46 @@
1
+ # BMAD Method Guide for Roo Code
2
+
3
+ This guide covers Roo Code-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
4
+
5
+ ## Installation
6
+
7
+ When running `npx bmad-method install`, select **Roo Code** as your IDE. This creates:
8
+
9
+ - `.bmad-core/` folder with all agents
10
+ - `.roomodes` file in project root with custom modes
11
+
12
+ ## Using BMAD Agents in Roo Code
13
+
14
+ Select mode from the mode selector (usually in status bar):
15
+
16
+ - `bmad-bmad-master` - 🧙 Universal task executor
17
+ - `bmad-sm` - 🏃 Scrum Master
18
+ - `bmad-dev` - 💻 Full-stack developer
19
+ - `bmad-architect` - 🏗️ Solution architect
20
+ - `bmad-pm` - 📋 Product manager
21
+ - `bmad-analyst` - 📊 Business analyst
22
+ - `bmad-qa` - 🧪 QA specialist
23
+ - `bmad-po` - 🎯 Product owner
24
+ - `bmad-ux-expert` - 🎨 UX specialist
25
+
26
+ ## Roo Code-Specific Features
27
+
28
+ - **Mode file**: `.roomodes` in project root
29
+ - **Mode switching**: Use mode selector instead of starting new chats
30
+ - **Context preservation**: Maintains context across mode switches
31
+ - **File permissions**: Each agent has specific file access:
32
+
33
+ ### File Permission Summary
34
+
35
+ - **Documentation agents** (analyst, pm, po, sm): `.md`, `.txt` only
36
+ - **bmad-architect**: `.md`, `.txt`, `.yml`, `.yaml`, `.json`
37
+ - **bmad-qa**: Test files (`.test.*`, `.spec.*`) and `.md`
38
+ - **bmad-ux-expert**: `.md`, `.css`, `.scss`, `.html`, `.jsx`, `.tsx`
39
+ - **Full access**: `bmad-dev`, `bmad-bmad-master`, `bmad-orchestrator`
40
+
41
+ ## Tips for Roo Code Users
42
+
43
+ - Switch modes instead of starting new chats
44
+ - Each mode supports `*help` to see available commands
45
+ - Agents respect file permission boundaries
46
+ - Context persists across mode switches
@@ -0,0 +1,37 @@
1
+ # BMAD Method Guide for Windsurf
2
+
3
+ This guide covers Windsurf-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
4
+
5
+ ## Installation
6
+
7
+ When running `npx bmad-method install`, select **Windsurf** as your IDE. This creates:
8
+
9
+ - `.bmad-core/` folder with all agents
10
+ - `.windsurf/rules/` folder with agent rule files (`.md`)
11
+
12
+ ## Using BMAD Agents in Windsurf
13
+
14
+ Type `@agent-name` in chat to activate an agent:
15
+
16
+ - `@bmad-master` - Universal task executor
17
+ - `@sm` - Scrum Master
18
+ - `@dev` - Full-stack developer
19
+ - `@architect` - Solution architect
20
+ - `@pm` - Product manager
21
+ - `@analyst` - Business analyst
22
+ - `@qa` - QA specialist
23
+ - `@po` - Product owner
24
+ - `@ux-expert` - UX specialist
25
+
26
+ ## Windsurf-Specific Features
27
+
28
+ - **Rule files**: Stored in `.windsurf/rules/` as `.md` files
29
+ - **Activation**: Use `@` prefix to mention agents
30
+ - **Collaborative features**: Works well with BMAD's agent-switching pattern
31
+ - **Project context**: Agents have access to your full project context
32
+
33
+ ## Tips for Windsurf Users
34
+
35
+ - Start new chats when switching agents
36
+ - Each agent supports `*help` to see available commands
37
+ - Leverage Windsurf's collaboration features for team reviews
@@ -204,12 +204,180 @@ graph TD
204
204
  F -->|Approved| G["Dev: Implement Story"]
205
205
  F -->|Needs Changes| E
206
206
  G --> H["Dev: Complete story Tasks"]
207
- H --> I{"User Verification"}
208
- I -->|Verified Complete| J["Mark Story as Done"]
209
- I -->|Needs Fixes| G
210
- J --> E
207
+ H --> I["Dev: Mark Ready for Review"]
208
+ I --> J{"User Verification"}
209
+ J -->|Request QA Review| K["QA: Run review-story task"]
210
+ J -->|Approve Without QA| M["Mark Story as Done"]
211
+ K --> L{"QA Review Results"}
212
+ L -->|Needs Work| G
213
+ L -->|Approved| M["Mark Story as Done"]
214
+ J -->|Needs Fixes| G
215
+ M --> E
216
+
217
+ style M fill:#34a853,color:#fff
218
+ style K fill:#f9ab00,color:#fff
219
+ ```
211
220
 
212
- style J fill:#34a853,color:#fff
221
+ This cycle continues, with the Scrum Master, Developer, and optionally QA agents working together. The QA agent provides senior developer review capabilities through the `review-story` task, offering code refactoring, quality improvements, and knowledge transfer. This ensures high code quality while maintaining development velocity.
222
+
223
+ ## 8. Complete Source Tree
224
+
225
+ The BMAD-METHOD project structure is designed for clarity, modularity, and extensibility. Here's the complete source tree with explanations:
226
+
227
+ ```plaintext
228
+ bmad-method/
229
+ ├── .bmad-core/ # Core framework (installed in user projects)
230
+ │ ├── agents/ # Individual agent definitions
231
+ │ │ ├── analyst.md # Business analyst agent
232
+ │ │ ├── architect.md # Solution architect agent
233
+ │ │ ├── bmad-master.md # Universal expert agent
234
+ │ │ ├── bmad-orchestrator.md # Multi-agent coordinator
235
+ │ │ ├── dev.md # Full-stack developer agent
236
+ │ │ ├── pm.md # Product manager agent
237
+ │ │ ├── po.md # Product owner agent
238
+ │ │ ├── qa.md # QA specialist agent
239
+ │ │ ├── sm.md # Scrum master agent
240
+ │ │ └── ux-expert.md # UX designer agent
241
+ │ ├── agent-teams/ # Pre-configured agent teams
242
+ │ │ ├── team-all.yml # All agents bundle
243
+ │ │ ├── team-fullstack.yml # Full-stack development team
244
+ │ │ ├── team-ide-minimal.yml # Minimal IDE-focused team
245
+ │ │ └── team-no-ui.yml # Backend-only team
246
+ │ ├── checklists/ # Quality assurance checklists
247
+ │ │ ├── architect-checklist.md
248
+ │ │ ├── po-master-checklist.md
249
+ │ │ └── story-dod-checklist.md
250
+ │ ├── data/ # Knowledge base and preferences
251
+ │ │ ├── bmad-kb.md # Core knowledge base
252
+ │ │ └── technical-preferences.md # User tech preferences
253
+ │ ├── tasks/ # Reusable task definitions
254
+ │ │ ├── advanced-elicitation.md # Deep diving techniques
255
+ │ │ ├── create-doc.md # Document creation task
256
+ │ │ ├── create-next-story.md # Story generation task
257
+ │ │ ├── doc-migration-task.md # V3 to V4 migration
258
+ │ │ ├── execute-checklist.md # Checklist runner
259
+ │ │ └── shard-doc.md # Document sharding task
260
+ │ ├── templates/ # Document templates
261
+ │ │ ├── full-stack-architecture-tmpl.md
262
+ │ │ ├── prd-tmpl.md
263
+ │ │ ├── project-brief-tmpl.md
264
+ │ │ ├── story-tmpl.md
265
+ │ │ └── [other templates...]
266
+ │ ├── utils/ # Utility components
267
+ │ │ ├── agent-switcher.web # Web UI agent switching
268
+ │ │ ├── template-format.md # Template markup spec
269
+ │ │ └── workflow-management.md # Workflow helpers
270
+ │ ├── workflows/ # Development workflows
271
+ │ │ ├── brownfield-enhancement.yml
272
+ │ │ ├── greenfield-fullstack.yml
273
+ │ │ ├── greenfield-service.yml
274
+ │ │ └── greenfield-simple.yml
275
+ │ └── core-config.yml # V4 configuration system
276
+
277
+ ├── dist/ # Pre-built bundles (generated)
278
+ │ ├── agents/ # Individual agent bundles
279
+ │ │ ├── analyst.txt
280
+ │ │ ├── architect.txt
281
+ │ │ └── [other agents...]
282
+ │ ├── teams/ # Team bundles for web UI
283
+ │ │ ├── team-all.txt
284
+ │ │ ├── team-fullstack.txt
285
+ │ │ └── [other teams...]
286
+ │ └── expansion-packs/ # Expansion pack bundles
287
+
288
+ ├── docs/ # Documentation
289
+ │ ├── agentic-tools/ # IDE-specific guides
290
+ │ │ ├── claude-code-guide.md
291
+ │ │ ├── cursor-guide.md
292
+ │ │ ├── cline-guide.md
293
+ │ │ ├── gemini-cli-guide.md
294
+ │ │ ├── roo-code-guide.md
295
+ │ │ └── windsurf-guide.md
296
+ │ ├── bmad-workflow-guide.md # Universal workflow guide
297
+ │ ├── core-architecture.md # This document
298
+ │ ├── expansion-packs.md # Expansion pack guide
299
+ │ ├── user-guide.md # Comprehensive user guide
300
+ │ └── [other docs...]
301
+
302
+ ├── expansion-packs/ # Domain-specific extensions
303
+ │ ├── bmad-2d-phaser-game-dev/ # Game development pack
304
+ │ ├── bmad-creator-tools/ # Agent creation tools
305
+ │ ├── bmad-infrastructure-devops/ # DevOps pack
306
+ │ └── README.md
307
+
308
+ ├── tools/ # Build and installation tools
309
+ │ ├── builders/ # Build system
310
+ │ │ └── web-builder.js # Bundle generator
311
+ │ ├── cli.js # Main CLI tool
312
+ │ ├── installer/ # NPX installer
313
+ │ │ ├── index.js # Installer entry point
314
+ │ │ ├── config/ # Installation configs
315
+ │ │ ├── lib/ # Installer utilities
316
+ │ │ └── templates/ # IDE template files
317
+ │ └── lib/ # Shared libraries
318
+ │ ├── bundle-utils.js
319
+ │ ├── dependency-resolver.js
320
+ │ └── file-processor.js
321
+
322
+ ├── .github/ # GitHub configuration
323
+ │ ├── workflows/ # GitHub Actions
324
+ │ └── ISSUE_TEMPLATE/ # Issue templates
325
+
326
+ ├── common/ # Shared resources
327
+ │ ├── tasks/ # Common tasks
328
+ │ └── utils/ # Common utilities
329
+
330
+ ├── bmad-core/ # Source for .bmad-core
331
+ │ └── [mirrors .bmad-core structure]
332
+
333
+ ├── package.json # Node.js configuration
334
+ ├── README.md # Project readme
335
+ ├── CONTRIBUTING.md # Contribution guidelines
336
+ ├── GUIDING-PRINCIPLES.md # Core principles
337
+ └── LICENSE # MIT license
213
338
  ```
214
339
 
215
- This cycle continues, with the Scrum Master and Developer agents working in tandem, until all stories in the epic are completed.
340
+ ### Directory Purposes
341
+
342
+ #### Core Framework (.bmad-core/)
343
+
344
+ - **agents/**: Individual AI agent personalities and capabilities
345
+ - **agent-teams/**: Bundles of agents for specific workflows
346
+ - **checklists/**: Quality assurance and validation steps
347
+ - **data/**: Knowledge base and user preferences
348
+ - **tasks/**: Reusable procedures agents can execute
349
+ - **templates/**: Document templates with embedded AI instructions
350
+ - **utils/**: Helper components for agents
351
+ - **workflows/**: Structured development processes
352
+
353
+ #### Generated Bundles (dist/)
354
+
355
+ - Pre-built text files ready for web UI upload
356
+ - Automatically generated by the build system
357
+ - Includes resolved dependencies for each agent/team
358
+
359
+ #### Tools (tools/)
360
+
361
+ - **cli.js**: Main build tool for creating bundles
362
+ - **installer/**: NPX-based installer for projects
363
+ - **builders/**: Bundle generation logic
364
+ - **lib/**: Shared utilities for build system
365
+
366
+ #### Expansion Packs (expansion-packs/)
367
+
368
+ - Domain-specific agent collections
369
+ - Extend BMAD beyond software development
370
+ - Each pack is self-contained with its own agents, tasks, and templates
371
+
372
+ #### Documentation (docs/)
373
+
374
+ - Comprehensive guides for users
375
+ - Technical architecture documentation
376
+ - IDE-specific setup instructions
377
+
378
+ ### Key Files
379
+
380
+ - **core-config.yml**: V4's flexible configuration system
381
+ - **bmad-kb.md**: Central knowledge base loaded by most agents
382
+ - **template-format.md**: Specification for BMAD's template markup
383
+ - **dependency-resolver.js**: Manages agent resource loading
@@ -132,6 +132,21 @@ Property investment and management:
132
132
  - **Flip Strategist**: Renovation ROI, project planning
133
133
  - **Agent Assistant**: Listing optimization, showing prep
134
134
 
135
+ ### Personal Development Pack
136
+
137
+ Complete personal growth system:
138
+
139
+ - **Life Coach**: Guides personal growth and transformation
140
+ - **Goal Strategist**: Helps achieve objectives with SMART goals
141
+ - **Habit Builder**: Creates lasting habits with accountability
142
+ - **Mindset Mentor**: Develops positive thinking patterns
143
+
144
+ Key tasks include:
145
+
146
+ - `goal-setting`: Defines SMART goals with action plans
147
+ - `habit-tracking`: Monitors habit formation progress
148
+ - `reflection-exercise`: Facilitates deep self-reflection
149
+
135
150
  ## Unique & Innovative Packs
136
151
 
137
152
  ### Role-Playing Game Master Pack