bmad-method 4.26.0 → 4.27.1

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 (109) hide show
  1. package/.vscode/settings.json +2 -0
  2. package/CHANGELOG.md +22 -0
  3. package/README.md +29 -282
  4. package/bmad-core/agent-teams/team-all.yaml +6 -6
  5. package/bmad-core/agent-teams/team-fullstack.yaml +6 -6
  6. package/bmad-core/agent-teams/team-no-ui.yaml +2 -2
  7. package/bmad-core/agents/analyst.md +17 -18
  8. package/bmad-core/agents/architect.md +15 -18
  9. package/bmad-core/agents/bmad-master.md +56 -53
  10. package/bmad-core/agents/bmad-orchestrator.md +24 -23
  11. package/bmad-core/agents/dev.md +10 -10
  12. package/bmad-core/agents/pm.md +17 -20
  13. package/bmad-core/agents/po.md +12 -15
  14. package/bmad-core/agents/qa.md +7 -8
  15. package/bmad-core/agents/sm.md +8 -13
  16. package/bmad-core/agents/ux-expert.md +7 -11
  17. package/bmad-core/core-config.yaml +1 -1
  18. package/bmad-core/data/bmad-kb.md +74 -15
  19. package/bmad-core/data/brainstorming-techniques.md +36 -0
  20. package/bmad-core/data/elicitation-methods.md +134 -0
  21. package/bmad-core/tasks/advanced-elicitation.md +82 -57
  22. package/bmad-core/tasks/facilitate-brainstorming-session.md +136 -0
  23. package/bmad-core/templates/architecture-tmpl.yaml +658 -0
  24. package/bmad-core/templates/brainstorming-output-tmpl.yaml +156 -0
  25. package/bmad-core/templates/brownfield-architecture-tmpl.yaml +476 -0
  26. package/bmad-core/templates/brownfield-prd-tmpl.yaml +280 -0
  27. package/bmad-core/templates/competitor-analysis-tmpl.yaml +293 -0
  28. package/bmad-core/templates/front-end-architecture-tmpl.yaml +206 -0
  29. package/bmad-core/templates/front-end-spec-tmpl.yaml +349 -0
  30. package/bmad-core/templates/fullstack-architecture-tmpl.yaml +805 -0
  31. package/bmad-core/templates/market-research-tmpl.yaml +252 -0
  32. package/bmad-core/templates/prd-tmpl.yaml +202 -0
  33. package/bmad-core/templates/project-brief-tmpl.yaml +221 -0
  34. package/bmad-core/templates/story-tmpl.yaml +137 -0
  35. package/bmad-core/utils/plan-management.md +9 -13
  36. package/bmad-core/workflows/greenfield-service.yaml +1 -1
  37. package/common/tasks/create-doc.md +55 -67
  38. package/common/utils/bmad-doc-template.md +325 -0
  39. package/dist/agents/analyst.txt +1312 -1193
  40. package/dist/agents/architect.txt +2484 -2895
  41. package/dist/agents/bmad-master.txt +4680 -4897
  42. package/dist/agents/bmad-orchestrator.txt +400 -195
  43. package/dist/agents/dev.txt +21 -24
  44. package/dist/agents/pm.txt +590 -619
  45. package/dist/agents/po.txt +178 -130
  46. package/dist/agents/qa.txt +159 -48
  47. package/dist/agents/sm.txt +166 -120
  48. package/dist/agents/ux-expert.txt +436 -544
  49. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +1283 -1260
  50. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +642 -591
  51. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +284 -268
  52. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +9258 -4977
  53. package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +388 -325
  54. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +1144 -1165
  55. package/dist/teams/team-all.txt +4885 -4967
  56. package/dist/teams/team-fullstack.txt +5621 -5693
  57. package/dist/teams/team-ide-minimal.txt +604 -333
  58. package/dist/teams/team-no-ui.txt +5209 -5213
  59. package/docs/agentic-tools/github-copilot-guide.md +29 -9
  60. package/docs/bmad-workflow-guide.md +2 -2
  61. package/expansion-packs/bmad-2d-phaser-game-dev/agent-teams/phaser-2d-nodejs-game-team.yaml +2 -2
  62. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.md +17 -15
  63. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +13 -11
  64. package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +13 -11
  65. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
  66. package/expansion-packs/bmad-2d-phaser-game-dev/tasks/create-game-story.md +2 -2
  67. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.yaml +613 -0
  68. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.yaml +356 -0
  69. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.yaml +343 -0
  70. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.yaml +253 -0
  71. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.yaml +484 -0
  72. package/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.md +14 -12
  73. package/expansion-packs/bmad-creator-tools/config.yaml +1 -1
  74. package/expansion-packs/bmad-creator-tools/templates/agent-teams-tmpl.yaml +178 -0
  75. package/expansion-packs/bmad-creator-tools/templates/agent-tmpl.yaml +154 -0
  76. package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.yaml +120 -0
  77. package/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.md +14 -14
  78. package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
  79. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.yaml +424 -0
  80. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.yaml +629 -0
  81. package/package.json +1 -1
  82. package/tools/builders/web-builder.js +170 -95
  83. package/tools/installer/config/install.config.yaml +2 -2
  84. package/tools/installer/lib/ide-setup.js +2 -2
  85. package/tools/installer/package.json +1 -1
  86. package/tools/lib/dependency-resolver.js +11 -22
  87. package/tools/md-assets/web-agent-startup-instructions.md +10 -10
  88. package/bmad-core/tasks/brainstorming-techniques.md +0 -238
  89. package/bmad-core/templates/architecture-tmpl.md +0 -776
  90. package/bmad-core/templates/brownfield-architecture-tmpl.md +0 -544
  91. package/bmad-core/templates/brownfield-prd-tmpl.md +0 -266
  92. package/bmad-core/templates/competitor-analysis-tmpl.md +0 -291
  93. package/bmad-core/templates/front-end-architecture-tmpl.md +0 -175
  94. package/bmad-core/templates/front-end-spec-tmpl.md +0 -413
  95. package/bmad-core/templates/fullstack-architecture-tmpl.md +0 -1018
  96. package/bmad-core/templates/market-research-tmpl.md +0 -263
  97. package/bmad-core/templates/prd-tmpl.md +0 -202
  98. package/bmad-core/templates/project-brief-tmpl.md +0 -232
  99. package/bmad-core/templates/story-tmpl.md +0 -58
  100. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-architecture-tmpl.md +0 -560
  101. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-brief-tmpl.md +0 -345
  102. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-design-doc-tmpl.md +0 -331
  103. package/expansion-packs/bmad-2d-phaser-game-dev/templates/game-story-tmpl.md +0 -235
  104. package/expansion-packs/bmad-2d-phaser-game-dev/templates/level-design-doc-tmpl.md +0 -470
  105. package/expansion-packs/bmad-creator-tools/templates/agent-teams-tmpl.md +0 -154
  106. package/expansion-packs/bmad-creator-tools/templates/agent-tmpl.md +0 -143
  107. package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.md +0 -91
  108. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.md +0 -415
  109. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-platform-from-arch-tmpl.md +0 -0
@@ -32,6 +32,7 @@
32
32
  "playtesting",
33
33
  "pointerdown",
34
34
  "pointerup",
35
+ "Polyrepo",
35
36
  "replayability",
36
37
  "roguelike",
37
38
  "roomodes",
@@ -43,6 +44,7 @@
43
44
  "tekton",
44
45
  "tilemap",
45
46
  "tileset",
47
+ "Trae",
46
48
  "VNET"
47
49
  ]
48
50
  }
package/CHANGELOG.md CHANGED
@@ -1,3 +1,25 @@
1
+ ## [4.27.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.27.0...v4.27.1) (2025-07-07)
2
+
3
+
4
+ ### Bug Fixes
5
+
6
+ * build web bundles with new file extension includsion ([92201ae](https://github.com/bmadcode/BMAD-METHOD/commit/92201ae7ede620ec09b4764edaed97be42a3b78f))
7
+
8
+ # [4.27.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.26.0...v4.27.0) (2025-07-06)
9
+
10
+
11
+ ### Bug Fixes
12
+
13
+ * readme consolidation and version bumps ([0a61d3d](https://github.com/bmadcode/BMAD-METHOD/commit/0a61d3de4af880f6e3bf934a92b1827754ed8ce6))
14
+
15
+
16
+ ### Features
17
+
18
+ * big improvement to advanced elicitation ([1bc9960](https://github.com/bmadcode/BMAD-METHOD/commit/1bc9960808098fba6b43850311799022319df841))
19
+ * experimental doc creator v2 and template system ([b785371](https://github.com/bmadcode/BMAD-METHOD/commit/b78537115da06b01e140833fd1d73950c7f2e41f))
20
+ * Massive improvement to the brainstorming task! ([9f53caf](https://github.com/bmadcode/BMAD-METHOD/commit/9f53caf4c6f9c67195b1aae14d54987f81d76e07))
21
+ * WIP create-docv2 ([c107af0](https://github.com/bmadcode/BMAD-METHOD/commit/c107af05984718c1af2cf80118353e8d2e6f906f))
22
+
1
23
  # [4.26.0](https://github.com/bmadcode/BMAD-METHOD/compare/v4.25.1...v4.26.0) (2025-07-06)
2
24
 
3
25
 
package/README.md CHANGED
@@ -13,9 +13,21 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
13
13
 
14
14
  ⭐ **If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover BMad-Method and you will be notified of updates!
15
15
 
16
+ ## Overview
17
+
18
+ **BMad Method's Two Key Innovations:**
19
+
20
+ **1. Agentic Planning:** Dedicated agents (Analyst, PM, Architect) collaborate with you to create detailed, consistent PRDs and Architecture documents. Through advanced prompt engineering and human-in-the-loop refinement, these planning agents produce comprehensive specifications that go far beyond generic AI task generation.
21
+
22
+ **2. Context-Engineered Development:** The Scrum Master agent then transforms these detailed plans into hyper-detailed development stories that contain everything the Dev agent needs - full context, implementation details, and architectural guidance embedded directly in story files.
23
+
24
+ This two-phase approach eliminates both **planning inconsistency** and **context loss** - the biggest problems in AI-assisted development. Your Dev agent opens a story file with complete understanding of what to build, how to build it, and why.
25
+
26
+ **📖 [See the complete workflow in the User Guide](docs/user-guide.md)** - Planning phase, development cycle, and all agent roles
27
+
16
28
  ## Quick Navigation
17
29
 
18
- ### 🚨 MUST READ: Understanding the BMad Workflow
30
+ ### Understanding the BMad Workflow
19
31
 
20
32
  **Before diving in, review these critical workflow diagrams that explain how BMad works:**
21
33
 
@@ -26,7 +38,7 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
26
38
 
27
39
  ### What would you like to do?
28
40
 
29
- - **[Build software with Full Stack Agile AI Team](quick-start)** → Quick Start Instruction
41
+ - **[Install and Build software with Full Stack Agile AI Team](#quick-start)** → Quick Start Instruction
30
42
  - **[Learn how to use BMad](docs/user-guide.md)** → Complete user guide and walkthrough
31
43
  - **[See available AI agents](#available-agents)** → Specialized roles for your team
32
44
  - **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
@@ -35,21 +47,6 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
35
47
  - **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
36
48
  - **[Join the community](https://discord.gg/g6ypHytrCB)** → Get help and share ideas
37
49
 
38
- ### Popular Use Cases
39
-
40
- - **Software Development** - [Quick Start](quick-start) | [User Guide](docs/user-guide.md) | [Workflow Guides](#documentation--guides)
41
- - **Game Development** - [2D Phaser Pack](expansion-packs/bmad-2d-phaser-game-dev/)
42
- - **Business Strategy** - [Full Guide](docs/expansion-packs.md#business-strategy-pack)
43
- - **Creative Writing** - [Full Guide](docs/expansion-packs.md#creative-writing-pack)
44
- - **DevOps/Infrastructure** - [Infrastructure Pack](expansion-packs/bmad-infrastructure-devops/)
45
-
46
- ### Quick Links
47
-
48
- - **[Installation](#installation)** → Get started in minutes
49
- - **[Documentation](#documentation--guides)** → All guides and references
50
- - **[Contributing](#contributing)** → Help improve BMad
51
- - **[Support](#support)** → Get help and connect
52
-
53
50
  ## Important: Keep Your BMad Installation Updated
54
51
 
55
52
  **Stay up-to-date effortlessly!** If you already have BMad-Method installed in your project, simply run:
@@ -68,7 +65,7 @@ This will:
68
65
  - ✅ Create `.bak` backup files for any custom modifications you've made
69
66
  - ✅ Preserve your project-specific configurations
70
67
 
71
- This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations! If for some reason this fails, you can rename or remove your .bmad-code folder and run the install again. The main thing to look out for is if you have set up custom modes that are not file driven (Cursor is the only one at this time that is not done through project files lagging behind) - you will want to ensure your sm and dev custom modes especially are kept up to date.
68
+ This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!
72
69
 
73
70
  ## Quick Start
74
71
 
@@ -93,14 +90,14 @@ This single command handles:
93
90
 
94
91
  **Prerequisites**: [Node.js](https://nodejs.org) v20+ required
95
92
 
96
- ### Fastest Start: Web UI (2 minutes)
93
+ ### Fastest Start: Web UI Full Stack Team at your disposal (2 minutes)
97
94
 
98
- 1. **Get the bundle**: Copy `dist/teams/team-fullstack.txt` (from this repository)
95
+ 1. **Get the bundle**: Save or clone the [full stack team file](dist/teams/team-fullstack.txt) or choose another team
99
96
  2. **Create AI agent**: Create a new Gemini Gem or CustomGPT
100
97
  3. **Upload & configure**: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
101
98
  4. **Start Ideating and Planning**: Start chatting! Type `*help` to see available commands or pick an agent like `*analyst` to start right in on creating a brief.
102
-
103
- > **All pre-built bundles are in the `dist/` folder** - ready to copy and use immediately!
99
+ 5. **CRITICAL**: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!
100
+ 6. **When to moved to the IDE**: Once you have your PRD, Architecture, optional UX and Briefs - its time to switch over to the IDE to shard your docs, and start implementing the actual code! See the [User guide](docs/user-guide.md) for more details
104
101
 
105
102
  ### Alternative: Clone and Build
106
103
 
@@ -109,284 +106,34 @@ git clone https://github.com/bmadcode/bmad-method.git
109
106
  npm run install:bmad # build and install all to a destination folder
110
107
  ```
111
108
 
112
- ## Overview
113
-
114
- The BMad Method (Breakthrough Method of Agile Agentic-Driven Development) elevates 'Vibe Coding' by utilizing advanced prompt engineering techniques and critical context management at the most critical stages of development implementation. By providing specialized AI agents for every role in an Agile team, each agent has deep expertise in their domain helping you really plan and execute on your vision while keeping the agents on the rails even through complex application plans.
115
-
116
- Unlike systems like Task Master, or inbuilt Task tools, the BMad Methods agile flow does so much more. With most systems, you give your idea, and the system churns out a plan, task list, lets you review it and then starts executing. Where the BMad agile flow is different is you can choose to have more upfront planning and architecture specification to ensure the system is built in a sustainable way, not a vibe coded spaghetti mess. When producing the PRD and Architectures (full stack, front end and or backend), the Agents work with you back and forth using advanced proven LLM prompt engineering advanced techniques to produce anything beyond what the average slop LLMs and Task generators will produce on their own. This truly is a system of Human in the Loop producing markedly better results.
117
-
118
- ## Installation
119
-
120
- ### Method 1: CLI Installer (For IDEs)
121
-
122
- **Just run one command:**
123
-
124
- ```bash
125
- npx bmad-method install
126
- # OR if you already have BMad installed:
127
- npm run install:bmad
128
- ```
129
-
130
- **This single command does everything:**
131
-
132
- - Installs BMad for the first time
133
- - Updates existing installations
134
- - Adds any expansion packs from your package.json
135
-
136
- **Prerequisites**: Install [Node.js](https://nodejs.org) v20+ first
137
-
138
- ### Method 2: Pre-Built Web Bundles (For Web UI)
139
-
140
- For ChatGPT, Claude, or Gemini web interfaces:
141
-
142
- 1. Choose a bundle:
143
- - **Recommended**: `dist/teams/team-fullstack.txt` (complete development team)
144
- - Or pick from individual agents in `dist/agents/`
145
- 2. Upload to your AI platform (Gemini Gem, CustomGPT, or directly in chat)
146
- 3. Set instructions: "Your critical operating instructions are attached, do not break character as directed"
147
- 4. Type `/help` to see available commands
148
-
149
- **Supported IDEs:**
150
-
151
- The BMad Method works with any IDE, but has built-in integration for:
152
-
153
- - `cursor` - Cursor IDE with manual rule @agent commands
154
- - `claude-code` - Claude Code with /agent commands
155
- - `cline` - Cline Rules integration
156
- - `gemini-cli` - Gemini with @agent commands
157
- - `windsurf` - Windsurf with manual rule @agent commands
158
- - `trae` - Trae with manual rule @agent commands
159
- - `roo` - Roo Code with custom modes (see `.roomodes`)
160
- - `github-copilot` - GitHub Copilot agent mode integration
161
-
162
- ## Available Agents
163
-
164
- ### Core Development Team
165
-
166
- | Agent | Role | Specialty |
167
- | ----------- | ------------------ | -------------------------------------------------------------------------------------------- |
168
- | `analyst` | Business Analyst | market analysis, brainstorming, project brief creation |
169
- | `pm` | Product Manager | Product strategy, MVP Decisioning, PRD creation with Epics |
170
- | `architect` | Solution Architect | System design, technical full stack, front end or backend architecture |
171
- | `ux-expert` | UX Designer | User experience, UI design, prompts for V0, Lovable, and others |
172
- | `po` | Product Owner | Ensure PRD and Architecture are aligned, and changes from architecture end up in PRD stories |
173
- | `sm` | Scrum Master | High level epics and stories transformed into detailed dev stories with tasks and subtasks |
174
- | `dev` | Developer | Code implementation across all technologies - follows the detailed SM created story |
175
- | `qa` | QA Specialist | Detailed review of the devs ready for review story, refactor and propose issues and changes |
176
-
177
- ### BMad Agents
178
-
179
- | Agent | Role | Specialty |
180
- | ------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ |
181
- | `bmad-orchestrator` | Team Coordinator | Helps guide you and answers your questions with its massive knowledge base, and guides you through Multi-agent workflows |
182
- | `bmad-master` | Universal Expert | All capabilities without switching (Except Dev) |
183
-
184
- ## Advanced Features
185
-
186
- ### Dynamic Dependencies
187
-
188
- Each agent only loads the resources it needs, keeping context windows lean.
189
-
190
- ### Template System
191
-
192
- Rich templates for all document types:
193
-
194
- - Product Requirements (PRD)
195
- - Architecture Documents
196
- - User Stories
197
- - Test Plans
198
- - And more...
199
-
200
- Templates are unique in that they are embedded with the LLM instructions also for further working with you to prompt and elicit the best from you and your agile agent team member - allowing for unique coaching and customization options. While there is a single create-doc task, the possibilities are endless when you expand the templates into more doc types, or customize with your own docs embedded with the templating markup and LLM instruction framework that is core to the BMad Method.
201
-
202
- ### Slash Star Commands
203
-
204
- Ask the agent you are using for help with /help (in the web) or \*help in the ide to see what commands are available!
205
-
206
- ### Advanced Elicitation
207
-
208
- Many of the Agents and Templates for docs, and some tasks, include Advanced Elicitation directives based on the latest in LLM interactions and pro level prompt engineering guidance. With this, you can push the Agents further than ever before. If an agent proposes an idea, or an architecture - you can push it further with optional elicitations where it will have to really expand on, defend, or produce other options and prove its suggestion was better. This is a necessary step if you want the absolute best beyond accepting the generated average responses the LLMs think you want to hear for their first response. Some of this is interactive, and some of this is baked into the core prompting engine that powers the LLM progression through various tasks and template flows.
209
-
210
- ## Usage
211
-
212
- The BMad Method follows a structured Agile workflow with specialized AI agents. For complete usage instructions and walkthroughs, see the **[User Guide](docs/user-guide.md)**.
213
-
214
- ### Quick Start Examples
215
-
216
- #### With IDE Integration
217
-
218
- ```bash
219
- # In Cursor
220
- @pm Create a PRD for a task management app
221
-
222
- # In Claude Code
223
- /architect Design a microservices architecture
224
-
225
- # In Windsurf
226
- @dev Implement story 1.3
227
- ```
228
-
229
- #### With Web UI
230
-
231
- After uploading a bundle, type `/help` to see available commands.
232
-
233
- ### Key Resources
234
-
235
- - **[Complete User Guide](docs/user-guide.md)** - Full walkthrough from project inception to completion
236
- - **[CLI Commands](docs/user-guide.md#cli-commands)** - Installation, updates, and management
237
- - **[Upgrading from V3](docs/user-guide.md#upgrading-from-v3-to-v4)** - Migration instructions
238
- - **[Core Configuration](docs/user-guide.md#core-configuration)** - V4's flexible project structure support
239
- - **[Teams & Workflows](docs/user-guide.md#team-configurations)** - Pre-configured agent teams
240
-
241
- ## Project Structure
242
-
243
- See the **[Core Architecture](docs/core-architecture.md)** for the complete source tree and detailed explanations of each component.
244
-
245
- ### Key Directories
246
-
247
- - **`.bmad-core/`** - Heart of the framework (agents, templates, workflows)
248
- - **`dist/`** - Pre-built bundles ready for web UI use
249
- - **`expansion-packs/`** - Domain-specific extensions
250
- - **`tools/`** - Build and installation utilities
251
- - **`docs/`** - Your project documentation (PRD, architecture, stories)
252
-
253
- ### 📦 Pre-Built Bundles (dist/ folder)
254
-
255
- **All ready-to-use bundles are in the `dist/` directory!**
256
-
257
- - **Teams**: `dist/teams/` - Complete team configurations
258
-
259
- - `team-fullstack.txt` - Full-stack development team
260
- - `team-ide-minimal.txt` - Minimal IDE workflow team
261
- - `team-no-ui.txt` - Backend-only team
262
- - `team-all.txt` - All agents included
263
-
264
- - **Individual Agents**: `dist/agents/` - Single agent files
265
-
266
- - One `.txt` file per agent (analyst, architect, dev, etc.)
267
-
268
- - **Expansion Packs**: `dist/expansion-packs/` - Specialized domains
269
- - Game development, DevOps, etc.
270
-
271
- **For Web UI usage**: Simply copy any `.txt` file from `dist/` and upload to your AI platform!`
272
-
273
- ## Documentation & Guides
274
-
275
- ### Architecture & Technical
276
-
277
- - 🏗️ [Core Architecture](docs/core-architecture.md) - Complete technical architecture and system design
278
- - 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMad-Method effectively
279
- - 🚀 [Expansion Packs Guide](docs/expansion-packs.md) - Extend BMad to any domain beyond software development
280
-
281
- ### Workflow Guides
282
-
283
- - 📚 [Universal BMad Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
284
- - 🏗️ [Working in the Brownfield Guide](docs/working-in-the-brownfield.md) - Complete guide for enhancing existing projects
285
-
286
- ### IDE-Specific Guides
287
-
288
- - 🎯 [Cursor Guide](docs/agentic-tools/cursor-guide.md) - Setup and usage for Cursor
289
- - 🤖 [Claude Code Guide](docs/agentic-tools/claude-code-guide.md) - Setup and usage for Claude Code
290
- - 🌊 [Windsurf Guide](docs/agentic-tools/windsurf-guide.md) - Setup and usage for Windsurf
291
- - 🌊 [Trae Guide](docs/agentic-tools/trae-guide.md) - Setup and usage for Trae
292
- - 🦘 [Roo Code Guide](docs/agentic-tools/roo-code-guide.md) - Setup and usage for Roo Code
293
- - 🔧 [Cline Guide](docs/agentic-tools/cline-guide.md) - Setup and usage for Cline (VS Code)
294
- - ✨ [Gemini CLI Guide](docs/agentic-tools/gemini-cli-guide.md) - Setup and usage for Gemini CLI
295
- - 💻 [Github Copilot Guide](docs/agentic-tools/github-copilot-guide.md) - Setup and usage for VS Code with GitHub Copilot
296
-
297
109
  ## 🌟 Beyond Software Development - Expansion Packs
298
110
 
299
- While BMad excels at software development, its natural language framework can structure expertise in ANY domain. Expansion packs transform BMad into a universal AI agent system for creative writing, business strategy, health & wellness, education, and much more.
300
-
301
- ### Available Expansion Packs
111
+ BMad's natural language framework works in ANY domain. Expansion packs provide specialized AI agents for creative writing, business strategy, health & wellness, education, and more. Also expansion packs can expand the core BMad-Method with specific functionality that is not generic for all cases. [See the Expansion Packs Guide](docs/expansion-packs.md) and learn to create your own!
302
112
 
303
- #### Technical Domains
113
+ ## Documentation & Resources
304
114
 
305
- - 🎮 **[Game Development](expansion-packs/bmad-2d-phaser-game-dev/)** - Complete game studio team with designers, developers, and narrative writers
306
- - 🏗️ **[Infrastructure/DevOps](expansion-packs/bmad-infrastructure-devops/)** - Cloud architects, security specialists, SRE experts
307
- - 📱 **Mobile Development** - iOS/Android specialists, mobile UX designers
308
- - 🔗 **Blockchain/Web3** - Smart contract developers, DeFi architects
115
+ ### Essential Guides
309
116
 
310
- #### Non-Technical Domains
311
-
312
- - 💼 **Business Strategy** - Strategic planners, market analysts, business coaches
313
- - 💪 **Health & Wellness** - Fitness coaches, nutrition advisors, meditation guides
314
- - 🎨 **Creative Arts** - Story writers, world builders, character developers
315
- - 📚 **Education** - Curriculum designers, tutors, learning coaches
316
- - 🧠 **Personal Development** - Life coaches, goal setters, habit builders
317
- - 🏢 **Professional Services** - Legal advisors, content creators, research assistants
318
-
319
- ### Creating Your Own Expansion Pack
320
-
321
- Transform your expertise into AI agents:
322
-
323
- 1. **Identify your domain** - What knowledge do you want to share?
324
- 2. **Design specialized agents** - Each with unique expertise and personality
325
- 3. **Create reusable tasks** - Standard procedures in your field
326
- 4. **Build professional templates** - Structured outputs for consistency
327
- 5. **Share with the community** - Help others benefit from your expertise
328
-
329
- 📖 **[Read the full Expansion Packs Guide](docs/expansion-packs.md)** - Detailed examples, inspiration, and technical details
117
+ - 📖 **[User Guide](docs/user-guide.md)** - Complete walkthrough from project inception to completion
118
+ - 🏗️ **[Core Architecture](docs/core-architecture.md)** - Technical deep dive and system design
119
+ - 🚀 **[Expansion Packs Guide](docs/expansion-packs.md)** - Extend BMad to any domain beyond software development
120
+ - [IDE Specific Guides available in this folder](docs/agentic-tools/)
330
121
 
331
122
  ## Support
332
123
 
333
124
  - 💬 [Discord Community](https://discord.gg/g6ypHytrCB)
334
- - 📖 [Documentation](docs/)
335
125
  - 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
336
126
  - 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)
337
127
 
338
- ## License
339
-
340
- MIT License - see [LICENSE](LICENSE) for details.
341
-
342
- ## Version History
343
-
344
- - **Current**: [v4](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
345
- - **Previous Versions**:
346
- - [Version 3](https://github.com/bmadcode/BMad-Method/tree/V3) - Introduced the unified BMad Agent and Gemini optimization
347
- - [Version 2](https://github.com/bmadcode/BMad-Method/tree/V2) - Added web agents and template separation
348
- - [Version 1](https://github.com/bmadcode/BMad-Method/tree/V1) - Original 7-file proof of concept
349
-
350
- See [versions.md](docs/versions.md) for detailed version history and migration guides.
351
-
352
- ## Author
353
-
354
- Created by Brian (BMad) Madison
355
-
356
128
  ## Contributing
357
129
 
358
130
  **We're excited about contributions and welcome your ideas, improvements, and expansion packs!** 🎉
359
131
 
360
- ### Before Contributing - MUST READ
132
+ 📋 **[Read CONTRIBUTING.md](CONTRIBUTING.md)** - Complete guide to contributing, including guidelines, process, and requirements
361
133
 
362
- To ensure your contribution aligns with the BMad Method and gets merged smoothly:
363
-
364
- 1. 📋 **Read [CONTRIBUTING.md](CONTRIBUTING.md)** - Our contribution guidelines, PR requirements, and process
365
- 2. 🎯 **Read [GUIDING-PRINCIPLES.md](GUIDING-PRINCIPLES.md)** - Core principles that keep BMad powerful through simplicity
366
- 3. 🆕 **New to GitHub?** Start with our [Pull Request Guide](docs/how-to-contribute-with-pull-requests.md)
367
-
368
- ### Key Points to Remember
369
-
370
- - Keep dev agents lean (save context for coding!)
371
- - Use small, focused files over large branching ones
372
- - Reuse existing tasks (like `create-doc`) instead of creating duplicates
373
- - Consider expansion packs for domain-specific features and not improvements to the core system (those belong in the core system)
374
- - All contributions must follow our natural language, markdown-based templating approach with template embedded LLM instructions and elicitations
375
-
376
- We're building something amazing together - let's keep it simple, powerful, and focused! 💪
377
-
378
- ### Development Setup
379
-
380
- Want to help improve the BMad Method. Fork n' Clone the repo
381
-
382
- ```bash
383
- git clone https://github.com/bmadcode/bmad-method.git
384
- cd bmad-method
134
+ ## License
385
135
 
386
- npm install
387
- npm run build # rebuild the dist folder
388
- npm run install:bmad # build and install all to a destination folder
389
- ```
136
+ MIT License - see [LICENSE](LICENSE) for details.
390
137
 
391
138
  [![Contributors](https://contrib.rocks/image?repo=bmadcode/bmad-method)](https://github.com/bmadcode/bmad-method/graphs/contributors)
392
139
 
@@ -6,9 +6,9 @@ agents:
6
6
  - bmad-orchestrator
7
7
  - '*'
8
8
  workflows:
9
- - brownfield-fullstack
10
- - brownfield-service
11
- - brownfield-ui
12
- - greenfield-fullstack
13
- - greenfield-service
14
- - greenfield-ui
9
+ - brownfield-fullstack.yaml
10
+ - brownfield-service.yaml
11
+ - brownfield-ui.yaml
12
+ - greenfield-fullstack.yaml
13
+ - greenfield-service.yaml
14
+ - greenfield-ui.yaml
@@ -10,9 +10,9 @@ agents:
10
10
  - architect
11
11
  - po
12
12
  workflows:
13
- - brownfield-fullstack
14
- - brownfield-service
15
- - brownfield-ui
16
- - greenfield-fullstack
17
- - greenfield-service
18
- - greenfield-ui
13
+ - brownfield-fullstack.yaml
14
+ - brownfield-service.yaml
15
+ - brownfield-ui.yaml
16
+ - greenfield-fullstack.yaml
17
+ - greenfield-service.yaml
18
+ - greenfield-ui.yaml
@@ -9,5 +9,5 @@ agents:
9
9
  - architect
10
10
  - po
11
11
  workflows:
12
- - greenfield-service
13
- - brownfield-service
12
+ - greenfield-service.yaml
13
+ - brownfield-service.yaml
@@ -4,13 +4,14 @@ CRITICAL: Read the full YAML, start activation to alter your state of being, fol
4
4
 
5
5
  ```yaml
6
6
  root: .bmad-core
7
- IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
7
+ IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
8
8
  REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
9
9
  activation-instructions:
10
10
  - Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
11
11
  - Only read the files/tasks listed here when user selects them for execution to minimize context usage
12
- - The customization field ALWAYS takes precedence over any conflicting instructions
12
+ - The agent.customization field ALWAYS takes precedence over any conflicting instructions
13
13
  - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
14
+ - Greet the user with your name and role, and inform of the *help command.
14
15
  agent:
15
16
  name: Mary
16
17
  id: analyst
@@ -35,33 +36,31 @@ persona:
35
36
  - Maintaining a Broad Perspective - Stay aware of market trends and dynamics
36
37
  - Integrity of Information - Ensure accurate sourcing and representation
37
38
  - Numbered Options Protocol - Always use numbered lists for selections
38
- startup:
39
- - Greet the user with your name and role, and inform of the *help command.
40
39
  # All commands require * prefix when used (e.g., *help)
41
40
  commands:
42
41
  - help: Show numbered list of the following commands to allow selection
43
42
  - create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
44
- - yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
43
+ - yolo: Toggle Yolo Mode
45
44
  - doc-out: Output full document to current destination file
46
45
  - execute-checklist {checklist}: Run task execute-checklist (default->architect-checklist)
47
- - research {topic}: execute task create-deep-research-prompt for architectural decisions
46
+ - research-prompt {topic}: execute task create-deep-research-prompt for architectural decisions
48
47
  - brainstorm {topic}: Facilitate structured brainstorming session
49
- - elicit: list the options under output set of information
48
+ - elicit: run the task advanced-elicitation
50
49
  - document-project: Analyze and document existing project structure comprehensively
51
50
  - exit: Say goodbye as the Business Analyst, and then abandon inhabiting this persona
52
51
  dependencies:
53
52
  tasks:
54
- - brainstorming-techniques
55
- - create-deep-research-prompt
56
- - create-doc
57
- - advanced-elicitation
58
- - document-project
53
+ - facilitate-brainstorming-session.md
54
+ - create-deep-research-prompt.md
55
+ - create-doc.md
56
+ - advanced-elicitation.md
57
+ - document-project.md
59
58
  templates:
60
- - project-brief-tmpl
61
- - market-research-tmpl
62
- - competitor-analysis-tmpl
59
+ - project-brief-tmpl.yaml
60
+ - market-research-tmpl.yaml
61
+ - competitor-analysis-tmpl.yaml
62
+ - brainstorming-output-tmpl.yaml
63
63
  data:
64
- - bmad-kb
65
- utils:
66
- - template-format
64
+ - bmad-kb.md
65
+ - brainstorming-techniques.md
67
66
  ```
@@ -4,13 +4,15 @@ CRITICAL: Read the full YAML, start activation to alter your state of being, fol
4
4
 
5
5
  ```yaml
6
6
  root: .bmad-core
7
- IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name}.md where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
8
- REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.md), or ask for clarification if ambiguous.
7
+ IDE-FILE-RESOLUTION: Dependencies map to files as {root}/{type}/{name} where root=".bmad-core", type=folder (tasks/templates/checklists/utils), name=dependency name.
8
+ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (e.g., "draft story"→*create→create-next-story task, "make a new prd" would be dependencies->tasks->create-doc combined with the dependencies->templates->prd-tmpl.yaml), or ask for clarification if ambiguous.
9
9
  activation-instructions:
10
10
  - Follow all instructions in this file -> this defines you, your persona and more importantly what you can do. STAY IN CHARACTER!
11
11
  - Only read the files/tasks listed here when user selects them for execution to minimize context usage
12
12
  - The customization field ALWAYS takes precedence over any conflicting instructions
13
13
  - When listing tasks/templates or presenting options during conversations, always show as numbered options list, allowing the user to type a number to select or execute
14
+ - Greet the user with your name and role, and inform of the *help command.
15
+ - When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
14
16
  agent:
15
17
  name: Winston
16
18
  id: architect
@@ -34,33 +36,28 @@ persona:
34
36
  - Data-Centric Design - Let data requirements drive architecture
35
37
  - Cost-Conscious Engineering - Balance technical ideals with financial reality
36
38
  - Living Architecture - Design for change and adaptation
37
- startup:
38
- - Greet the user with your name and role, and inform of the *help command.
39
- - When creating architecture, always start by understanding the complete picture - user needs, business constraints, team capabilities, and technical requirements.
40
39
  # All commands require * prefix when used (e.g., *help)
41
40
  commands:
42
41
  - help: Show numbered list of the following commands to allow selection
43
42
  - create-doc {template}: execute task create-doc (no template = ONLY show available templates listed under dependencies/templates below)
44
- - yolo: Toggle Yolo Mode off on - on will skip doc section confirmations
43
+ - yolo: Toggle Yolo Mode
45
44
  - doc-out: Output full document to current destination file
46
45
  - execute-checklist {checklist}: Run task execute-checklist (default->architect-checklist)
47
46
  - research {topic}: execute task create-deep-research-prompt for architectural decisions
48
47
  - exit: Say goodbye as the Architect, and then abandon inhabiting this persona
49
48
  dependencies:
50
49
  tasks:
51
- - create-doc
52
- - create-deep-research-prompt
53
- - document-project
54
- - execute-checklist
50
+ - create-doc.md
51
+ - create-deep-research-prompt.md
52
+ - document-project.md
53
+ - execute-checklist.md
55
54
  templates:
56
- - architecture-tmpl
57
- - front-end-architecture-tmpl
58
- - fullstack-architecture-tmpl
59
- - brownfield-architecture-tmpl
55
+ - architecture-tmpl.yaml
56
+ - front-end-architecture-tmpl.yaml
57
+ - fullstack-architecture-tmpl.yaml
58
+ - brownfield-architecture-tmpl.yaml
60
59
  checklists:
61
- - architect-checklist
60
+ - architect-checklist.md
62
61
  data:
63
- - technical-preferences
64
- utils:
65
- - template-format
62
+ - technical-preferences.md
66
63
  ```