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
@@ -1,142 +0,0 @@
1
- # BMAD Method Guide for Roo Code
2
-
3
- This guide walks you through the complete BMAD workflow using Roo Code as your AI-powered IDE.
4
-
5
- ## Step 1: Install BMAD in Your Project
6
-
7
- 1. Navigate to your project directory
8
- 2. Run the BMAD installer:
9
-
10
- ```bash
11
- npx bmad-method install
12
- ```
13
-
14
- 3. When prompted:
15
- - **Installation Type**: Choose "Complete installation (recommended)"
16
- - **IDE**: Select "Roo Code"
17
-
18
- This creates a `.bmad-core` folder with all agents and a `.roomodes` file (in the project root) with custom modes.
19
-
20
- ## Step 2: Set Up Team Fullstack in Gemini
21
-
22
- For ideation and planning, use Google's Gemini Custom Gem with the team-fullstack configuration:
23
-
24
- 1. Open [Google gems](https://gemini.google.com/gems/view)
25
- 2. Create a new Gem - give it a title and description
26
- 3. Copy the contents of `.<install location>/<web-bundles>/teams/team-fullstack.txt` (location can vary if you chose a non default installation location for the bundles) - or just use the bundle premade from the repo dist folder.
27
- 4. Paste this content into Gemini to set up the team
28
-
29
- ### Gemini Planning Phase
30
-
31
- In Gemini, ask the BMAD team to help you:
32
-
33
- - **Ideate** your project concept
34
- - **Brainstorm** features and requirements
35
- - **Create a PRD** (Product Requirements Document)
36
- - **Design the architecture**
37
-
38
- Ask questions like:
39
-
40
- - "Help me brainstorm a [type of application] that does [core functionality]"
41
- - "Create a comprehensive PRD for this concept"
42
- - "Design the technical architecture for this system"
43
-
44
- Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
45
-
46
- - `docs/prd.md`
47
- - `docs/architecture.md`
48
-
49
- ## Step 3: Back to Roo Code - Document Sharding
50
-
51
- Once you have your PRD and architecture documents in the `docs/` folder:
52
-
53
- 1. **Open your project in Roo Code**
54
- 2. **Select the bmad-master mode** from the mode selector (usually in status bar)
55
- 3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
56
- 4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
57
-
58
- This creates organized folders:
59
-
60
- - `docs/prd/` - Contains broken down PRD sections
61
- - `docs/architecture/` - Contains broken down architecture sections
62
-
63
- ## Step 4: Story Development Cycle
64
-
65
- Now begin the iterative development cycle:
66
-
67
- ### Create Stories (Scrum Master)
68
-
69
- 1. **Start a new chat or conversation**
70
- 2. **Switch to SM mode**: Select `bmad-sm` from the mode selector
71
- 3. **Create story**: Type `*create` (this runs the create-next-story task)
72
- 4. **Review the generated story**
73
- 5. **If approved**: Set story status to "Approved" in the story file
74
-
75
- ### Implement Stories (Developer)
76
-
77
- 1. **Start a new conversation**
78
- 2. **Switch to Dev mode**: Select `bmad-dev` from the mode selector
79
- 3. **The agent will ask which story to implement**
80
- 4. **Follow the development tasks** the agent provides
81
- 5. **When story is complete**: Mark status as "Done"
82
-
83
- ### Repeat the Cycle
84
-
85
- 1. **Switch to SM mode** (`bmad-sm`)
86
- 2. **Create next story**: Type `*create`
87
- 3. **Review and approve**
88
- 4. **Switch to Dev mode** (`bmad-dev`)
89
- 5. **Implement the story**
90
- 6. **Repeat until project complete**
91
-
92
- ## Available Custom Modes in Roo Code
93
-
94
- All BMAD agents are available as custom modes:
95
-
96
- - `bmad-bmad-master` - 🧙 Universal task executor
97
- - `bmad-sm` - 🏃 Scrum Master for story creation
98
- - `bmad-dev` - 💻 Full-stack developer for implementation
99
- - `bmad-architect` - 🏗️ Solution architect for design
100
- - `bmad-pm` - 📋 Product manager for planning
101
- - `bmad-analyst` - 📊 Business analyst for requirements
102
- - `bmad-qa` - 🧪 QA specialist for testing
103
- - `bmad-po` - 🎯 Product owner for prioritization
104
- - `bmad-ux-expert` - 🎨 UX specialist for design
105
-
106
- ## Roo Code-Specific Features
107
-
108
- - **Custom modes are stored in**: `.roomodes` file (in the project root)
109
- - **Mode switching**: Use the mode selector in Roo Code's interface
110
- - **File permissions**: Each agent has specific file access permissions
111
- - **Documentation agents** (SM, PM, PO, Analyst): Limited to `.md` and `.txt` files
112
- - **Technical agents** (Dev, Architect, Master): Full file access
113
- - **QA agents**: Access to test files and documentation
114
- - **UX agents**: Access to design-related files
115
- - **Context preservation**: Modes maintain context within conversations
116
-
117
- ## Key Workflow Principles
118
-
119
- 1. **Switch modes instead of starting new chats** - Roo Code handles context better with mode switching
120
- 2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
121
- 3. **Use bmad-master mode for document management** (sharding, templates, etc.)
122
- 4. **Follow the SM → Dev mode cycle** for consistent story development
123
- 5. **Review and approve stories** before implementation begins
124
-
125
- ## Tips for Success
126
-
127
- - **Use mode selector effectively**: Switch modes as needed for different tasks
128
- - **Respect file permissions**: Agents can only edit files they have permission for
129
- - **Use \*help command**: Every mode supports `*help` to see available commands
130
- - **Review generated content**: Always review and approve stories before marking them ready
131
- - **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
132
- - **Leverage Roo's context**: Modes can maintain context across the conversation
133
-
134
- ## File Permission Summary
135
-
136
- - **bmad-analyst, bmad-pm, bmad-po, bmad-sm**: `.md`, `.txt` files only
137
- - **bmad-architect**: `.md`, `.txt`, `.yml`, `.yaml`, `.json` files
138
- - **bmad-qa**: Test files (`.test.js`, `.spec.ts`, etc.) and `.md` files
139
- - **bmad-ux-expert**: `.md`, `.css`, `.scss`, `.html`, `.jsx`, `.tsx` files
140
- - **bmad-dev, bmad-bmad-master, bmad-orchestrator**: Full file access
141
-
142
- This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.
@@ -1,129 +0,0 @@
1
- # BMAD Method Guide for Windsurf
2
-
3
- This guide walks you through the complete BMAD workflow using Windsurf as your AI-powered IDE.
4
-
5
- ## Step 1: Install BMAD in Your Project
6
-
7
- 1. Navigate to your project directory
8
- 2. Run the BMAD installer:
9
-
10
- ```bash
11
- npx bmad-method install
12
- ```
13
-
14
- 3. When prompted:
15
- - **Installation Type**: Choose "Complete installation (recommended)"
16
- - **IDE**: Select "Windsurf"
17
-
18
- This creates a `.bmad-core` folder with all agents and a `.windsurf/rules` folder with agent rules.
19
-
20
- ## Step 2: Set Up Team Fullstack in Gemini
21
-
22
- For ideation and planning, use Google's Gemini Custom Gem with the team-fullstack configuration:
23
-
24
- 1. Open [Google gems](https://gemini.google.com/gems/view)
25
- 2. Create a new Gem - give it a title and description
26
- 3. Copy the contents of `.<install location>/<web-bundles>/teams/team-fullstack.txt` (location can vary if you chose a non default installation location for the bundles) - or just use the bundle premade from the repo dist folder.
27
- 4. Paste this content into Gemini to set up the team
28
-
29
- ### Gemini Planning Phase
30
-
31
- In Gemini, ask the BMAD team to help you:
32
-
33
- - **Ideate** your project concept
34
- - **Brainstorm** features and requirements
35
- - **Create a PRD** (Product Requirements Document)
36
- - **Design the architecture**
37
-
38
- Ask questions like:
39
-
40
- - "Help me brainstorm a [type of application] that does [core functionality]"
41
- - "Create a comprehensive PRD for this concept"
42
- - "Design the technical architecture for this system"
43
-
44
- Copy the PRD and architecture documents that Gemini creates into your project's `docs/` folder:
45
-
46
- - `docs/prd.md`
47
- - `docs/architecture.md`
48
-
49
- ## Step 3: Back to Windsurf - Document Sharding
50
-
51
- Once you have your PRD and architecture documents in the `docs/` folder:
52
-
53
- 1. **Start a new chat in Windsurf**
54
- 2. **Load the bmad-master agent**: Type `@bmad-master`
55
- 3. **Shard the PRD**: Type `*shard-doc docs/prd.md prd`
56
- 4. **Shard the architecture**: Type `*shard-doc docs/architecture.md architecture`
57
-
58
- This creates organized folders:
59
-
60
- - `docs/prd/` - Contains broken down PRD sections
61
- - `docs/architecture/` - Contains broken down architecture sections
62
-
63
- ## Step 4: Story Development Cycle
64
-
65
- Now begin the iterative development cycle:
66
-
67
- ### Create Stories (Scrum Master)
68
-
69
- 1. **Start a new chat**
70
- 2. **Load SM agent**: Type `@sm`
71
- 3. **Create story**: Type `*create` (this runs the create-next-story task)
72
- 4. **Review the generated story**
73
- 5. **If approved**: Set story status to "Approved" in the story file
74
-
75
- ### Implement Stories (Developer)
76
-
77
- 1. **Start a new chat**
78
- 2. **Load Dev agent**: Type `@dev`
79
- 3. **The agent will ask which story to implement**
80
- 4. **Follow the development tasks** the agent provides
81
- 5. **When story is complete**: Mark status as "Done"
82
-
83
- ### Repeat the Cycle
84
-
85
- 1. **Start a new chat with SM agent** (`@sm`)
86
- 2. **Create next story**: Type `*create`
87
- 3. **Review and approve**
88
- 4. **Start new chat with Dev agent** (`@dev`)
89
- 5. **Implement the story**
90
- 6. **Repeat until project complete**
91
-
92
- ## Available Agent Rules in Windsurf
93
-
94
- All BMAD agents are available as Windsurf rules (use `@` prefix):
95
-
96
- - `@bmad-master` - Universal task executor
97
- - `@sm` - Scrum Master for story creation
98
- - `@dev` - Full-stack developer for implementation
99
- - `@architect` - Solution architect for design
100
- - `@pm` - Product manager for planning
101
- - `@analyst` - Business analyst for requirements
102
- - `@qa` - QA specialist for testing
103
- - `@po` - Product owner for prioritization
104
- - `@ux-expert` - UX specialist for design
105
-
106
- ## Windsurf-Specific Features
107
-
108
- - **Agent rules are stored in**: `.windsurf/rules/` as `.md` files
109
- - **Rule activation**: Rules activate when you mention `@agent-name` in chat
110
- - **Collaborative workflow**: Windsurf's collaborative features work well with BMAD's agent-switching pattern
111
- - **Context awareness**: Agents have access to your project context
112
-
113
- ## Key Workflow Principles
114
-
115
- 1. **Always start new chats** when switching agents to avoid context confusion
116
- 2. **Use Gemini for initial planning** and ideation with the team-fullstack bundle
117
- 3. **Use bmad-master for document management** (sharding, templates, etc.)
118
- 4. **Follow the SM → Dev cycle** for consistent story development
119
- 5. **Review and approve stories** before implementation begins
120
-
121
- ## Tips for Success
122
-
123
- - **Keep chats focused**: Each chat should have one agent and one primary task
124
- - **Use \*help command**: Every agent supports `*help` to see available commands
125
- - **Review generated content**: Always review and approve stories before marking them ready
126
- - **Maintain status updates**: Keep story statuses current (Draft → Approved → InProgress → Done)
127
- - **Leverage Windsurf's collaboration**: Use the collaborative features for team reviews
128
-
129
- This workflow ensures systematic, AI-assisted development following agile principles with clear handoffs between planning, story creation, and implementation phases.