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.
- package/.github/FUNDING.yml +15 -0
- package/.github/ISSUE_TEMPLATE/bug_report.md +32 -0
- package/.github/ISSUE_TEMPLATE/feature_request.md +22 -0
- package/.vscode/settings.json +6 -76
- package/CHANGELOG.md +7 -0
- package/CONTRIBUTING.md +1 -1
- package/GUIDING-PRINCIPLES.md +2 -2
- package/LICENSE +1 -1
- package/README.md +178 -220
- package/bmad-core/agents/dev.md +1 -1
- package/bmad-core/data/bmad-kb.md +1 -1
- package/dist/agents/analyst.txt +1 -1
- package/dist/agents/bmad-master.txt +1 -1
- package/dist/agents/bmad-orchestrator.txt +1 -1
- package/dist/teams/team-all.txt +39 -39
- package/dist/teams/team-fullstack.txt +39 -39
- package/dist/teams/team-ide-minimal.txt +1 -1
- package/dist/teams/team-no-ui.txt +13 -13
- package/docs/agentic-tools/claude-code-guide.md +36 -0
- package/docs/agentic-tools/cline-guide.md +42 -0
- package/docs/agentic-tools/cursor-guide.md +37 -0
- package/docs/agentic-tools/gemini-cli-guide.md +46 -0
- package/docs/agentic-tools/roo-code-guide.md +46 -0
- package/docs/agentic-tools/windsurf-guide.md +37 -0
- package/docs/core-architecture.md +174 -6
- package/docs/expansion-packs.md +15 -0
- package/docs/user-guide.md +283 -36
- package/docs/versioning-and-releases.md +2 -10
- package/docs/versions.md +0 -1
- package/docs/working-in-the-brownfield.md +4 -8
- package/package.json +1 -1
- package/tools/installer/bin/bmad.js +2 -2
- package/tools/installer/package.json +1 -1
- package/.claude/commands/analyst.md +0 -68
- package/.claude/commands/architect.md +0 -68
- package/.claude/commands/bmad-master.md +0 -105
- package/.claude/commands/bmad-orchestrator.md +0 -130
- package/.claude/commands/bmad-the-creator.md +0 -57
- package/.claude/commands/dev.md +0 -69
- package/.claude/commands/game-designer.md +0 -62
- package/.claude/commands/game-developer.md +0 -70
- package/.claude/commands/game-sm.md +0 -55
- package/.claude/commands/infra-devops-platform.md +0 -63
- package/.claude/commands/pm.md +0 -65
- package/.claude/commands/po.md +0 -67
- package/.claude/commands/qa.md +0 -54
- package/.claude/commands/sm.md +0 -55
- package/.claude/commands/ux-expert.md +0 -67
- package/.clinerules/01-bmad-master.md +0 -116
- package/.clinerules/02-bmad-orchestrator.md +0 -141
- package/.clinerules/03-pm.md +0 -76
- package/.clinerules/04-analyst.md +0 -79
- package/.clinerules/05-architect.md +0 -79
- package/.clinerules/06-po.md +0 -78
- package/.clinerules/07-sm.md +0 -66
- package/.clinerules/08-dev.md +0 -80
- package/.clinerules/09-qa.md +0 -65
- package/.clinerules/10-ux-expert.md +0 -78
- package/.clinerules/11-bmad-the-creator.md +0 -68
- package/.clinerules/12-game-designer.md +0 -73
- package/.clinerules/13-game-developer.md +0 -81
- package/.clinerules/14-game-sm.md +0 -66
- package/.clinerules/15-infra-devops-platform.md +0 -74
- package/.cursor/rules/analyst.mdc +0 -82
- package/.cursor/rules/architect.mdc +0 -82
- package/.cursor/rules/bmad-master.mdc +0 -119
- package/.cursor/rules/bmad-orchestrator.mdc +0 -144
- package/.cursor/rules/bmad-the-creator.mdc +0 -71
- package/.cursor/rules/dev.mdc +0 -83
- package/.cursor/rules/game-designer.mdc +0 -76
- package/.cursor/rules/game-developer.mdc +0 -84
- package/.cursor/rules/game-sm.mdc +0 -69
- package/.cursor/rules/infra-devops-platform.mdc +0 -77
- package/.cursor/rules/pm.mdc +0 -79
- package/.cursor/rules/po.mdc +0 -81
- package/.cursor/rules/qa.mdc +0 -68
- package/.cursor/rules/sm.mdc +0 -69
- package/.cursor/rules/ux-expert.mdc +0 -81
- package/.gemini/agents/analyst.md +0 -64
- package/.gemini/agents/architect.md +0 -64
- package/.gemini/agents/bmad-master.md +0 -101
- package/.gemini/agents/bmad-orchestrator.md +0 -126
- package/.gemini/agents/bmad-the-creator.md +0 -53
- package/.gemini/agents/dev.md +0 -65
- package/.gemini/agents/game-designer.md +0 -58
- package/.gemini/agents/game-developer.md +0 -66
- package/.gemini/agents/game-sm.md +0 -51
- package/.gemini/agents/infra-devops-platform.md +0 -59
- package/.gemini/agents/pm.md +0 -61
- package/.gemini/agents/po.md +0 -63
- package/.gemini/agents/qa.md +0 -50
- package/.gemini/agents/sm.md +0 -51
- package/.gemini/agents/ux-expert.md +0 -63
- package/.gemini/settings.json +0 -20
- package/.roomodes +0 -139
- package/.vscode/extensions.json +0 -6
- package/.vscode/tasks.json +0 -41
- package/.windsurf/rules/analyst.md +0 -76
- package/.windsurf/rules/architect.md +0 -76
- package/.windsurf/rules/bmad-master.md +0 -113
- package/.windsurf/rules/bmad-orchestrator.md +0 -138
- package/.windsurf/rules/bmad-the-creator.md +0 -65
- package/.windsurf/rules/dev.md +0 -77
- package/.windsurf/rules/game-designer.md +0 -70
- package/.windsurf/rules/game-developer.md +0 -78
- package/.windsurf/rules/game-sm.md +0 -63
- package/.windsurf/rules/infra-devops-platform.md +0 -71
- package/.windsurf/rules/pm.md +0 -73
- package/.windsurf/rules/po.md +0 -75
- package/.windsurf/rules/qa.md +0 -62
- package/.windsurf/rules/sm.md +0 -63
- package/.windsurf/rules/ux-expert.md +0 -75
- package/docs/claude-code-guide.md +0 -121
- package/docs/cursor-guide.md +0 -131
- package/docs/expansion-pack-ideas.md +0 -121
- package/docs/roo-code-guide.md +0 -142
- package/docs/windsurf-guide.md +0 -129
- /package/dist/expansion-packs/{expansion-creator → bmad-creator-tools}/agents/bmad-the-creator.txt +0 -0
package/README.md
CHANGED
|
@@ -1,34 +1,73 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BMad-METHOD: Universal AI Agent Framework
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/bmad-method)
|
|
4
4
|
[](LICENSE)
|
|
5
5
|
[](https://nodejs.org)
|
|
6
6
|
[](https://discord.gg/gk8jAdXWmj)
|
|
7
7
|
|
|
8
|
-
|
|
8
|
+
Foundations in Agentic Agile Driven Development, known as the Breakthrough Method of Agile AI-Driven Development, but it is so much more. Transform any domain with specialized AI expertise: software development, entertainment, creative writing, business strategy to personal wellness just to name a few.
|
|
9
9
|
|
|
10
|
-
|
|
10
|
+
**[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)**
|
|
11
11
|
|
|
12
|
-
|
|
12
|
+
**[Join our Discord Community](https://discord.gg/gk8jAdXWmj)** - A growing community for AI enthusiasts! Get help, share ideas, explore AI agents & frameworks, collaborate on tech projects, enjoy hobbies, and help each other succeed. Whether you're stuck on BMad, building your own agents, or just want to chat about the latest in AI - we're here for you!
|
|
13
13
|
|
|
14
|
-
⭐ **If you find this project helpful or useful, please give it a star!** It helps others discover
|
|
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
|
-
##
|
|
16
|
+
## 🧭 Quick Navigation - Find Your Path
|
|
17
17
|
|
|
18
|
-
|
|
18
|
+
### 🚨 MUST READ: Understanding the BMAD Workflow
|
|
19
|
+
|
|
20
|
+
**Before diving in, review these critical workflow diagrams that explain how BMAD works:**
|
|
21
|
+
|
|
22
|
+
1. **[Planning Workflow (Web UI)](docs/user-guide.md#the-planning-workflow-web-ui)** - How to create PRD and Architecture documents
|
|
23
|
+
2. **[Core Development Cycle (IDE)](docs/user-guide.md#the-core-development-cycle-ide)** - How SM, Dev, and QA agents collaborate through story files
|
|
24
|
+
|
|
25
|
+
> ⚠️ **These diagrams explain 90% of BMad Method Agentic Agile flow confusion** - Understanding the PRD+Architecture creation and the SM/Dev/QA workflow and how agents pass notes through story files is essential - and also explains why this is NOT taskmaster or just a simple task runner!
|
|
26
|
+
|
|
27
|
+
### What would you like to do?
|
|
28
|
+
|
|
29
|
+
- **[Build software with Full Stack Agile AI Team](#-quick-start)** → Quick Start Instruction
|
|
30
|
+
- **[Learn how to use BMAD](docs/user-guide.md)** → Complete user guide and walkthrough
|
|
31
|
+
- **[See available AI agents](#available-agents)** → Specialized roles for your team
|
|
32
|
+
- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
|
|
33
|
+
- **[Create my own AI agents](#creating-your-own-expansion-pack)** → Build agents for your domain
|
|
34
|
+
- **[Browse ready-made expansion packs](expansion-packs/)** → Game dev, DevOps, infrastructure and get inspired with ideas and examples
|
|
35
|
+
- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
|
|
36
|
+
- **[Join the community](https://discord.gg/g6ypHytrCB)** → Get help and share ideas
|
|
37
|
+
|
|
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
|
+
## 🔄 Important: Keeping Your BMad Installation Updated
|
|
54
|
+
|
|
55
|
+
**Stay up-to-date effortlessly!** If you already have BMad-METHOD installed in your project, simply run:
|
|
19
56
|
|
|
20
57
|
```bash
|
|
21
58
|
npx bmad-method install
|
|
59
|
+
# OR
|
|
60
|
+
npm run install:bmad
|
|
22
61
|
```
|
|
23
62
|
|
|
24
|
-
|
|
63
|
+
This will:
|
|
25
64
|
|
|
26
65
|
- ✅ Automatically detect your existing v4 installation
|
|
27
|
-
- ✅ Update only the files that have changed
|
|
66
|
+
- ✅ Update only the files that have changed and add new files
|
|
28
67
|
- ✅ Create `.bak` backup files for any custom modifications you've made
|
|
29
68
|
- ✅ Preserve your project-specific configurations
|
|
30
69
|
|
|
31
|
-
This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!
|
|
70
|
+
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.
|
|
32
71
|
|
|
33
72
|
## 🚀 Quick Start
|
|
34
73
|
|
|
@@ -47,28 +86,20 @@ This makes it easy to benefit from the latest improvements, bug fixes, and new a
|
|
|
47
86
|
|
|
48
87
|
Run `npx bmad-method install`
|
|
49
88
|
|
|
50
|
-
|
|
89
|
+
OR
|
|
51
90
|
|
|
52
|
-
|
|
91
|
+
```bash
|
|
92
|
+
git clone https://github.com/bmadcode/bmad-method.git
|
|
93
|
+
npm run install:bmad # build and install all to a destination folder
|
|
94
|
+
```
|
|
53
95
|
|
|
54
|
-
|
|
55
|
-
- [Installation](#installation)
|
|
56
|
-
- [Available Agents](#available-agents)
|
|
57
|
-
- [Usage](#usage)
|
|
58
|
-
- [Project Structure](#project-structure)
|
|
59
|
-
- [Contributing](#contributing)
|
|
96
|
+
This installs all agents and configures them for your IDE. If you have an existing v3 installation, it will offer to upgrade it automatically.
|
|
60
97
|
|
|
61
98
|
## Overview
|
|
62
99
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
### Why BMAD?
|
|
100
|
+
The BMad Method (Breakthrough Method of Agile Agentic-Driven Development) elevates 'Vibe Coding' 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.
|
|
66
101
|
|
|
67
|
-
|
|
68
|
-
- **🔄 True Agile Workflow**: Follows real Agile methodologies and best practices
|
|
69
|
-
- **📦 Modular Design**: Use one agent or an entire team
|
|
70
|
-
- **🛠️ IDE Integration**: Works seamlessly with Cursor, Claude Code, Windsurf, and Gemini
|
|
71
|
-
- **🌐 Platform Agnostic**: Use with ChatGPT, Claude, Gemini, or any AI platform
|
|
102
|
+
Unlike systems like Task Master, or inbuilt Task tool, the BMad Methods agile flow does so much more. With most systems, you give your idea in a few sentences at most, 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 techniques and techniques also based in psychology to produce beyond the average slop LLMs and Task generators will on their own. This truly is a system of Human in the Loop produces markedly better results.
|
|
72
103
|
|
|
73
104
|
## Installation
|
|
74
105
|
|
|
@@ -105,153 +136,92 @@ The BMad Method works with any IDE, but has built-in integration for:
|
|
|
105
136
|
|
|
106
137
|
### Core Development Team
|
|
107
138
|
|
|
108
|
-
| Agent | Role | Specialty
|
|
109
|
-
| ----------- | ------------------ |
|
|
110
|
-
| `analyst` | Business Analyst | market analysis, brainstorming, project brief
|
|
111
|
-
| `pm` | Product Manager | Product strategy,
|
|
112
|
-
| `architect` | Solution Architect | System design, technical architecture
|
|
113
|
-
| `
|
|
114
|
-
| `
|
|
115
|
-
| `
|
|
116
|
-
| `
|
|
117
|
-
| `
|
|
118
|
-
|
|
119
|
-
### Meta Agents
|
|
139
|
+
| Agent | Role | Specialty |
|
|
140
|
+
| ----------- | ------------------ | -------------------------------------------------------------------------------------------- |
|
|
141
|
+
| `analyst` | Business Analyst | market analysis, brainstorming, project brief creation |
|
|
142
|
+
| `pm` | Product Manager | Product strategy, MVP Decisioning, PRD creation with Epics |
|
|
143
|
+
| `architect` | Solution Architect | System design, technical full stack, front end or backend architecture |
|
|
144
|
+
| `ux-expert` | UX Designer | User experience, UI design, prompts for V0, Lovable, and others |
|
|
145
|
+
| `po` | Product Owner | Ensure PRD and Architecture are aligned, and changes from architecture end up in PRD stories |
|
|
146
|
+
| `sm` | Scrum Master | High level epics and stories transformed into detailed dev stories with tasks and subtasks |
|
|
147
|
+
| `dev` | Developer | Code implementation across all technologies - follows the detailed SM created story |
|
|
148
|
+
| `qa` | QA Specialist | Detailed review of the devs ready for review story, refactor and propose issues and changes |
|
|
120
149
|
|
|
121
|
-
|
|
122
|
-
| ------------------- | ---------------- | ------------------------------------------------------------------- |
|
|
123
|
-
| `bmad-orchestrator` | Team Coordinator | Multi-agent workflows, role switching, is part of every team bundle |
|
|
124
|
-
| `bmad-master` | Universal Expert | All capabilities without switching |
|
|
125
|
-
|
|
126
|
-
## Usage
|
|
150
|
+
### BMad Agents
|
|
127
151
|
|
|
128
|
-
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
```bash
|
|
133
|
-
# In Cursor
|
|
134
|
-
@pm Create a PRD for a task management app
|
|
135
|
-
|
|
136
|
-
# In Claude Code
|
|
137
|
-
/architect Design a microservices architecture
|
|
138
|
-
|
|
139
|
-
# In Windsurf
|
|
140
|
-
@dev Implement story 1.3
|
|
141
|
-
```
|
|
142
|
-
|
|
143
|
-
### With Web UI (ChatGPT/Claude/Gemini)
|
|
144
|
-
|
|
145
|
-
After uploading a bundle you can ask /help of the agent to learn what it can do
|
|
146
|
-
|
|
147
|
-
### CLI Commands
|
|
148
|
-
|
|
149
|
-
```bash
|
|
150
|
-
# List all available agents
|
|
151
|
-
npx bmad-method list
|
|
152
|
-
|
|
153
|
-
# Install or update (automatically detects existing installations)
|
|
154
|
-
npx bmad-method install
|
|
152
|
+
| Agent | Role | Specialty |
|
|
153
|
+
| ------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------ |
|
|
154
|
+
| `bmad-orchestrator` | Team Coordinator | Helps guide you and answers your questions with its massive knowledge base, and guides you through Multi-agent workflows |
|
|
155
|
+
| `bmad-master` | Universal Expert | All capabilities without switching (Except Dev) |
|
|
155
156
|
|
|
156
|
-
|
|
157
|
-
npx bmad-method status
|
|
158
|
-
```
|
|
159
|
-
|
|
160
|
-
### Upgrading from V3 to V4
|
|
161
|
-
|
|
162
|
-
If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory:
|
|
157
|
+
## Advanced Features
|
|
163
158
|
|
|
164
|
-
|
|
165
|
-
npx bmad-method install
|
|
166
|
-
# The installer will automatically detect your V3 installation and offer to upgrade
|
|
167
|
-
```
|
|
159
|
+
### Dynamic Dependencies
|
|
168
160
|
|
|
169
|
-
|
|
161
|
+
Each agent only loads the resources it needs, keeping context windows lean.
|
|
170
162
|
|
|
171
|
-
|
|
172
|
-
2. Install the new V4 `.bmad-core/` structure
|
|
173
|
-
3. Migrate your documents (PRD, Architecture, Stories, Epics)
|
|
174
|
-
4. Set up IDE integration for all V4 agents
|
|
175
|
-
5. Create an install manifest for future updates
|
|
163
|
+
### Template System
|
|
176
164
|
|
|
177
|
-
|
|
165
|
+
Rich templates for all document types:
|
|
178
166
|
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
167
|
+
- Product Requirements (PRD)
|
|
168
|
+
- Architecture Documents
|
|
169
|
+
- User Stories
|
|
170
|
+
- Test Plans
|
|
171
|
+
- And more...
|
|
182
172
|
|
|
183
|
-
|
|
173
|
+
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.
|
|
184
174
|
|
|
185
|
-
|
|
175
|
+
### Slash Star Commands
|
|
186
176
|
|
|
187
|
-
|
|
177
|
+
Ask the agent you are using for help with /help (in the web) or \*help in the ide to see what commands are available!
|
|
188
178
|
|
|
189
|
-
|
|
179
|
+
### Advanced Elicitation
|
|
190
180
|
|
|
191
|
-
|
|
181
|
+
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.
|
|
192
182
|
|
|
193
|
-
|
|
183
|
+
## Usage
|
|
194
184
|
|
|
195
|
-
|
|
185
|
+
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)**.
|
|
196
186
|
|
|
197
|
-
|
|
198
|
-
- **Flexible Document Locations**: Works whether your epics are embedded in PRD or properly sharded
|
|
199
|
-
- **Developer Context**: Define which files the dev agent should always load
|
|
200
|
-
- **Debug Support**: Built-in logging for troubleshooting story implementation
|
|
187
|
+
### Quick Start Examples
|
|
201
188
|
|
|
202
|
-
####
|
|
189
|
+
#### With IDE Integration
|
|
203
190
|
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
- **Seamless upgrades** - Start with V3 docs and gradually adopt V4 patterns
|
|
191
|
+
```bash
|
|
192
|
+
# In Cursor
|
|
193
|
+
@pm Create a PRD for a task management app
|
|
208
194
|
|
|
209
|
-
|
|
195
|
+
# In Claude Code
|
|
196
|
+
/architect Design a microservices architecture
|
|
210
197
|
|
|
211
|
-
|
|
198
|
+
# In Windsurf
|
|
199
|
+
@dev Implement story 1.3
|
|
200
|
+
```
|
|
212
201
|
|
|
213
|
-
|
|
202
|
+
#### With Web UI
|
|
214
203
|
|
|
215
|
-
|
|
204
|
+
After uploading a bundle, type `/help` to see available commands.
|
|
216
205
|
|
|
217
|
-
|
|
218
|
-
- **Team Fullstack**: Frontend + Backend development focus
|
|
219
|
-
- **Team No-UI**: Backend/API development without UX
|
|
206
|
+
### Key Resources
|
|
220
207
|
|
|
221
|
-
|
|
208
|
+
- **[Complete User Guide](docs/user-guide.md)** - Full walkthrough from project inception to completion
|
|
209
|
+
- **[CLI Commands](docs/user-guide.md#cli-commands)** - Installation, updates, and management
|
|
210
|
+
- **[Upgrading from V3](docs/user-guide.md#upgrading-from-v3-to-v4)** - Migration instructions
|
|
211
|
+
- **[Core Configuration](docs/user-guide.md#core-configuration-coreconfigyml)** - V4's flexible project structure support
|
|
212
|
+
- **[Teams & Workflows](docs/user-guide.md#team-configurations)** - Pre-configured agent teams
|
|
222
213
|
|
|
223
|
-
|
|
214
|
+
## Project Structure
|
|
224
215
|
|
|
225
|
-
|
|
226
|
-
- **Brownfield**: Enhancing existing projects
|
|
227
|
-
- **Simple**: Quick prototypes and MVPs
|
|
228
|
-
- **Complex**: Enterprise and large-scale projects
|
|
216
|
+
See the **[Core Architecture](docs/core-architecture.md)** for the complete source tree and detailed explanations of each component.
|
|
229
217
|
|
|
230
|
-
|
|
218
|
+
### Key Directories
|
|
231
219
|
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
├── templates/ # Document templates (PRD, Architecture, etc.)
|
|
238
|
-
├── tasks/ # Reusable task definitions
|
|
239
|
-
├── checklists/ # Quality checklists
|
|
240
|
-
├── data/ # Knowledge base
|
|
241
|
-
└── web-bundles/ # Optional can be added if you use the install command and select this folder as a destination for the build bundle files
|
|
242
|
-
|
|
243
|
-
tools/
|
|
244
|
-
├── cli.js # Build tool
|
|
245
|
-
├── installer/ # NPX installer
|
|
246
|
-
└── lib/ # Build utilities
|
|
247
|
-
|
|
248
|
-
expansion-packs/ # Domain-specific add-ons (Technical & Non-Technical)
|
|
249
|
-
|
|
250
|
-
dist/ # 📦 PRE-BUILT BUNDLES (Ready to use!)
|
|
251
|
-
├── agents/ # Individual agent bundles (.txt files)
|
|
252
|
-
├── teams/ # Team bundles (.txt files)
|
|
253
|
-
└── expansion-packs/ # Expansion pack bundles
|
|
254
|
-
```
|
|
220
|
+
- **`.bmad-core/`** - Heart of the framework (agents, templates, workflows)
|
|
221
|
+
- **`dist/`** - Pre-built bundles ready for web UI use
|
|
222
|
+
- **`expansion-packs/`** - Domain-specific extensions
|
|
223
|
+
- **`tools/`** - Build and installation utilities
|
|
224
|
+
- **`docs/`** - Your project documentation (PRD, architecture, stories)
|
|
255
225
|
|
|
256
226
|
### 📦 Pre-Built Bundles (dist/ folder)
|
|
257
227
|
|
|
@@ -273,58 +243,86 @@ dist/ # 📦 PRE-BUILT BUNDLES (Ready to use!)
|
|
|
273
243
|
|
|
274
244
|
**For Web UI usage**: Simply copy any `.txt` file from `dist/` and upload to your AI platform!`
|
|
275
245
|
|
|
276
|
-
##
|
|
246
|
+
## Documentation & Guides
|
|
277
247
|
|
|
278
|
-
###
|
|
248
|
+
### Architecture & Technical
|
|
279
249
|
|
|
280
|
-
|
|
250
|
+
- 🏗️ [Core Architecture](docs/core-architecture.md) - Complete technical architecture and system design
|
|
251
|
+
- 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMAD-METHOD effectively
|
|
252
|
+
- 🚀 [Expansion Packs Guide](docs/expansion-packs.md) - Extend BMAD to any domain beyond software development
|
|
281
253
|
|
|
282
|
-
###
|
|
254
|
+
### Workflow Guides
|
|
283
255
|
|
|
284
|
-
|
|
256
|
+
- 📚 [Universal BMAD Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
|
|
257
|
+
- 🏗️ [Working in the Brownfield Guide](docs/working-in-the-brownfield.md) - Complete guide for enhancing existing projects
|
|
285
258
|
|
|
286
|
-
-
|
|
287
|
-
- Architecture Documents
|
|
288
|
-
- User Stories
|
|
289
|
-
- Test Plans
|
|
290
|
-
- And more...
|
|
259
|
+
### IDE-Specific Guides
|
|
291
260
|
|
|
292
|
-
|
|
261
|
+
- 🎯 [Cursor Guide](docs/agentic-tools/cursor-guide.md) - Setup and usage for Cursor
|
|
262
|
+
- 🤖 [Claude Code Guide](docs/agentic-tools/claude-code-guide.md) - Setup and usage for Claude Code
|
|
263
|
+
- 🌊 [Windsurf Guide](docs/agentic-tools/windsurf-guide.md) - Setup and usage for Windsurf
|
|
264
|
+
- 🦘 [Roo Code Guide](docs/agentic-tools/roo-code-guide.md) - Setup and usage for Roo Code
|
|
265
|
+
- 🔧 [Cline Guide](docs/agentic-tools/cline-guide.md) - Setup and usage for Cline (VS Code)
|
|
266
|
+
- ✨ [Gemini CLI Guide](docs/agentic-tools/gemini-cli-guide.md) - Setup and usage for Gemini CLI
|
|
293
267
|
|
|
294
|
-
|
|
268
|
+
## 🌟 Beyond Software Development - Expansion Packs
|
|
295
269
|
|
|
296
|
-
|
|
270
|
+
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.
|
|
297
271
|
|
|
298
|
-
|
|
272
|
+
### Available Expansion Packs
|
|
299
273
|
|
|
300
|
-
|
|
274
|
+
#### Technical Domains
|
|
301
275
|
|
|
302
|
-
- 🎮 **Game Development** -
|
|
303
|
-
- 🏗️ **Infrastructure/DevOps** - Cloud architects, security specialists, SRE
|
|
304
|
-
- 📱 **Mobile Development** - iOS/Android specialists, UX designers
|
|
276
|
+
- 🎮 **[Game Development](expansion-packs/bmad-2d-phaser-game-dev/)** - Complete game studio team with designers, developers, and narrative writers
|
|
277
|
+
- 🏗️ **[Infrastructure/DevOps](expansion-packs/bmad-infrastructure-devops/)** - Cloud architects, security specialists, SRE experts
|
|
278
|
+
- 📱 **Mobile Development** - iOS/Android specialists, mobile UX designers
|
|
305
279
|
- 🔗 **Blockchain/Web3** - Smart contract developers, DeFi architects
|
|
306
280
|
|
|
307
|
-
|
|
281
|
+
#### Non-Technical Domains
|
|
308
282
|
|
|
309
283
|
- 💼 **Business Strategy** - Strategic planners, market analysts, business coaches
|
|
310
284
|
- 💪 **Health & Wellness** - Fitness coaches, nutrition advisors, meditation guides
|
|
311
285
|
- 🎨 **Creative Arts** - Story writers, world builders, character developers
|
|
312
286
|
- 📚 **Education** - Curriculum designers, tutors, learning coaches
|
|
313
287
|
- 🧠 **Personal Development** - Life coaches, goal setters, habit builders
|
|
314
|
-
- 🏢 **Professional Services** - Legal advisors,
|
|
288
|
+
- 🏢 **Professional Services** - Legal advisors, content creators, research assistants
|
|
315
289
|
|
|
316
290
|
### Creating Your Own Expansion Pack
|
|
317
291
|
|
|
318
|
-
|
|
292
|
+
Transform your expertise into AI agents:
|
|
293
|
+
|
|
294
|
+
1. **Identify your domain** - What knowledge do you want to share?
|
|
295
|
+
2. **Design specialized agents** - Each with unique expertise and personality
|
|
296
|
+
3. **Create reusable tasks** - Standard procedures in your field
|
|
297
|
+
4. **Build professional templates** - Structured outputs for consistency
|
|
298
|
+
5. **Share with the community** - Help others benefit from your expertise
|
|
319
299
|
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
4. Package as an expansion pack for others to use
|
|
300
|
+
📖 **[Read the full Expansion Packs Guide](docs/expansion-packs.md)** - Detailed examples, inspiration, and technical details
|
|
301
|
+
|
|
302
|
+
## Support
|
|
324
303
|
|
|
325
|
-
|
|
304
|
+
- 💬 [Discord Community](https://discord.gg/g6ypHytrCB)
|
|
305
|
+
- 📖 [Documentation](docs/)
|
|
306
|
+
- 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
|
|
307
|
+
- 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)
|
|
326
308
|
|
|
327
|
-
|
|
309
|
+
## License
|
|
310
|
+
|
|
311
|
+
MIT License - see [LICENSE](LICENSE) for details.
|
|
312
|
+
|
|
313
|
+
## Version History
|
|
314
|
+
|
|
315
|
+
- **Current**: [v4](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
|
|
316
|
+
- **Previous Versions**:
|
|
317
|
+
- [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3) - Introduced the unified BMAD Agent and Gemini optimization
|
|
318
|
+
- [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) - Added web agents and template separation
|
|
319
|
+
- [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1) - Original 7-file proof of concept
|
|
320
|
+
|
|
321
|
+
See [versions.md](docs/versions.md) for detailed version history and migration guides.
|
|
322
|
+
|
|
323
|
+
## Author
|
|
324
|
+
|
|
325
|
+
Created by Brian (BMad) Madison
|
|
328
326
|
|
|
329
327
|
## Contributing
|
|
330
328
|
|
|
@@ -332,7 +330,7 @@ The BMAD framework can support any domain where structured AI assistance is valu
|
|
|
332
330
|
|
|
333
331
|
### Before Contributing - MUST READ
|
|
334
332
|
|
|
335
|
-
To ensure your contribution aligns with the
|
|
333
|
+
To ensure your contribution aligns with the BMad Method and gets merged smoothly:
|
|
336
334
|
|
|
337
335
|
1. 📋 **Read [CONTRIBUTING.md](CONTRIBUTING.md)** - Our contribution guidelines, PR requirements, and process
|
|
338
336
|
2. 🎯 **Read [GUIDING-PRINCIPLES.md](GUIDING-PRINCIPLES.md)** - Core principles that keep BMAD powerful through simplicity
|
|
@@ -343,62 +341,22 @@ To ensure your contribution aligns with the BMAD Method and gets merged smoothly
|
|
|
343
341
|
- Keep dev agents lean (save context for coding!)
|
|
344
342
|
- Use small, focused files over large branching ones
|
|
345
343
|
- Reuse existing tasks (like `create-doc`) instead of creating duplicates
|
|
346
|
-
- Consider expansion packs for domain-specific features
|
|
347
|
-
- All contributions must follow our natural language, markdown-based approach
|
|
344
|
+
- Consider expansion packs for domain-specific features and not improvements to the core system (those belong in the core system)
|
|
345
|
+
- All contributions must follow our natural language, markdown-based templating approach with template embedded LLM instructions and elicitations
|
|
348
346
|
|
|
349
347
|
We're building something amazing together - let's keep it simple, powerful, and focused! 💪
|
|
350
348
|
|
|
351
349
|
### Development Setup
|
|
352
350
|
|
|
351
|
+
Want to help improve the BMad Method. Fork n' Clone the repo
|
|
352
|
+
|
|
353
353
|
```bash
|
|
354
354
|
git clone https://github.com/bmadcode/bmad-method.git
|
|
355
355
|
cd bmad-method
|
|
356
|
-
npm install
|
|
357
|
-
```
|
|
358
356
|
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
- 🏗️ [Core Architecture](docs/core-architecture.md) - Complete technical architecture and system design
|
|
364
|
-
- 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMAD-METHOD effectively
|
|
365
|
-
- 🚀 [Expansion Packs Guide](docs/expansion-packs.md) - Extend BMAD to any domain beyond software development
|
|
366
|
-
|
|
367
|
-
### Workflow Guides
|
|
368
|
-
|
|
369
|
-
- 📚 [Universal BMAD Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
|
|
370
|
-
- 🏗️ [Working in the Brownfield Guide](docs/working-in-the-brownfield.md) - Complete guide for enhancing existing projects
|
|
371
|
-
- 🎯 [Cursor Guide](docs/cursor-guide.md) - Complete workflow for Cursor users
|
|
372
|
-
- 🤖 [Claude Code Guide](docs/claude-code-guide.md) - Complete workflow for Claude Code users
|
|
373
|
-
- 🌊 [Windsurf Guide](docs/windsurf-guide.md) - Complete workflow for Windsurf users
|
|
374
|
-
- 🦘 [Roo Code Guide](docs/roo-code-guide.md) - Complete workflow for Roo Code users
|
|
375
|
-
|
|
376
|
-
## Support
|
|
377
|
-
|
|
378
|
-
- 💬 [Discord Community](https://discord.gg/g6ypHytrCB)
|
|
379
|
-
- 📖 [Documentation](docs/)
|
|
380
|
-
- 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
|
|
381
|
-
- 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)
|
|
382
|
-
|
|
383
|
-
## License
|
|
384
|
-
|
|
385
|
-
MIT License - see [LICENSE](LICENSE) for details.
|
|
386
|
-
|
|
387
|
-
## Version History
|
|
388
|
-
|
|
389
|
-
- **Current**: [v4](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
|
|
390
|
-
- **Previous Versions**:
|
|
391
|
-
- [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3) - Introduced the unified BMAD Agent and Gemini optimization
|
|
392
|
-
- [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) - Added web agents and template separation
|
|
393
|
-
- [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1) - Original 7-file proof of concept
|
|
394
|
-
|
|
395
|
-
See [versions.md](docs/versions.md) for detailed version history and migration guides.
|
|
396
|
-
|
|
397
|
-
## Author
|
|
398
|
-
|
|
399
|
-
Created by Brian (BMad) Madison
|
|
400
|
-
|
|
401
|
-
---
|
|
357
|
+
npm run build # rebuild the dist folder
|
|
358
|
+
npm run install:bmad # build and install all to a destination folder
|
|
359
|
+
```
|
|
402
360
|
|
|
403
361
|
[](https://github.com/bmadcode/bmad-method/graphs/contributors)
|
|
404
362
|
|
package/bmad-core/agents/dev.md
CHANGED
|
@@ -50,7 +50,7 @@ task-execution:
|
|
|
50
50
|
updates-ONLY:
|
|
51
51
|
- "Checkboxes: [ ] not started | [-] in progress | [x] complete"
|
|
52
52
|
- "Debug Log: | Task | File | Change | Reverted? |"
|
|
53
|
-
- "Completion Notes: Deviations only, <50 words"
|
|
53
|
+
- "Completion Notes: Deviations from AC or tasks during execution only, <50 words"
|
|
54
54
|
- "Change Log: Requirement changes only"
|
|
55
55
|
- "File List: CRITICAL - Maintain complete list of ALL files created/modified during implementation"
|
|
56
56
|
blocking: "Unapproved deps | Ambiguous after story check | 3 failures | Missing config | Failing validations"
|
|
@@ -719,7 +719,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
|
|
|
719
719
|
### Using Expansion Packs
|
|
720
720
|
|
|
721
721
|
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
|
722
|
-
2. **Get Inspiration**: See `docs/expansion-
|
|
722
|
+
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
|
723
723
|
3. **Install via CLI**:
|
|
724
724
|
```bash
|
|
725
725
|
npx bmad-method install
|
package/dist/agents/analyst.txt
CHANGED
|
@@ -2654,7 +2654,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
|
|
|
2654
2654
|
### Using Expansion Packs
|
|
2655
2655
|
|
|
2656
2656
|
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
|
2657
|
-
2. **Get Inspiration**: See `docs/expansion-
|
|
2657
|
+
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
|
2658
2658
|
3. **Install via CLI**:
|
|
2659
2659
|
```bash
|
|
2660
2660
|
npx bmad-method install
|
|
@@ -9040,7 +9040,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
|
|
|
9040
9040
|
### Using Expansion Packs
|
|
9041
9041
|
|
|
9042
9042
|
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
|
9043
|
-
2. **Get Inspiration**: See `docs/expansion-
|
|
9043
|
+
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
|
9044
9044
|
3. **Install via CLI**:
|
|
9045
9045
|
```bash
|
|
9046
9046
|
npx bmad-method install
|
|
@@ -1130,7 +1130,7 @@ Expansion packs extend BMAD-METHOD beyond traditional software development into
|
|
|
1130
1130
|
### Using Expansion Packs
|
|
1131
1131
|
|
|
1132
1132
|
1. **Browse Available Packs**: Check `expansion-packs/` directory
|
|
1133
|
-
2. **Get Inspiration**: See `docs/expansion-
|
|
1133
|
+
2. **Get Inspiration**: See `docs/expansion-packs.md` for detailed examples and ideas
|
|
1134
1134
|
3. **Install via CLI**:
|
|
1135
1135
|
```bash
|
|
1136
1136
|
npx bmad-method install
|