bmad-method 4.24.3 → 4.24.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.prettierignore +1 -1
- package/CHANGELOG.md +8 -1
- package/README.md +22 -22
- package/bmad-core/agents/bmad-master.md +5 -5
- package/bmad-core/agents/bmad-orchestrator.md +9 -9
- package/bmad-core/checklists/change-checklist.md +2 -2
- package/bmad-core/data/bmad-kb.md +18 -18
- package/bmad-core/tasks/create-brownfield-story.md +2 -2
- package/bmad-core/tasks/create-next-story.md +2 -2
- package/bmad-core/tasks/kb-mode-interaction.md +13 -13
- package/common/utils/template-format.md +1 -1
- package/common/utils/workflow-management.md +1 -1
- package/dist/agents/analyst.txt +21 -21
- package/dist/agents/architect.txt +3 -3
- package/dist/agents/bmad-master.txt +31 -31
- package/dist/agents/bmad-orchestrator.txt +44 -44
- package/dist/agents/dev.txt +2 -2
- package/dist/agents/pm.txt +5 -5
- package/dist/agents/po.txt +5 -5
- package/dist/agents/qa.txt +3 -3
- package/dist/agents/sm.txt +5 -5
- package/dist/agents/ux-expert.txt +3 -3
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +2 -2
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +2 -2
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +2 -2
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +29 -29
- package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +21 -21
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +14 -14
- package/dist/teams/team-all.txt +48 -48
- package/dist/teams/team-fullstack.txt +46 -46
- package/dist/teams/team-ide-minimal.txt +48 -48
- package/dist/teams/team-no-ui.txt +46 -46
- package/docs/agentic-tools/claude-code-guide.md +5 -22
- package/docs/agentic-tools/cline-guide.md +3 -29
- package/docs/agentic-tools/cursor-guide.md +4 -27
- package/docs/agentic-tools/gemini-cli-guide.md +3 -17
- package/docs/agentic-tools/github-copilot-guide.md +22 -0
- package/docs/agentic-tools/roo-code-guide.md +2 -35
- package/docs/agentic-tools/windsurf-guide.md +3 -28
- package/docs/bmad-workflow-guide.md +8 -8
- package/docs/core-architecture.md +19 -184
- package/docs/expansion-packs.md +4 -4
- package/docs/how-to-contribute-with-pull-requests.md +1 -1
- package/docs/user-guide.md +29 -414
- package/docs/versions.md +4 -4
- package/docs/working-in-the-brownfield.md +9 -6
- package/expansion-packs/README.md +2 -2
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
- package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +3 -3
- package/expansion-packs/bmad-creator-tools/README.md +2 -2
- package/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.md +8 -8
- package/expansion-packs/bmad-creator-tools/config.yaml +2 -2
- package/expansion-packs/bmad-creator-tools/tasks/create-agent.md +1 -1
- package/expansion-packs/bmad-creator-tools/tasks/generate-expansion-pack.md +9 -9
- package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.md +1 -1
- package/expansion-packs/bmad-infrastructure-devops/README.md +6 -6
- package/expansion-packs/bmad-infrastructure-devops/checklists/infrastructure-checklist.md +1 -1
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
- package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +4 -4
- package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +4 -4
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.md +2 -2
- package/package.json +1 -1
- package/tools/bmad-npx-wrapper.js +1 -1
- package/tools/builders/web-builder.js +1 -1
- package/tools/cli.js +2 -2
- package/tools/installer/README.md +1 -51
- package/tools/installer/bin/bmad.js +9 -9
- package/tools/installer/config/install.config.yaml +10 -10
- package/tools/installer/lib/config-loader.js +2 -2
- package/tools/installer/lib/ide-setup.js +9 -9
- package/tools/installer/lib/installer.js +17 -17
- package/tools/installer/package.json +3 -3
- package/tools/md-assets/web-agent-startup-instructions.md +2 -2
- package/tools/upgraders/v3-to-v4-upgrader.js +2 -2
- package/tools/version-bump.js +1 -1
- package/tools/yaml-format.js +1 -1
- package/docs/agentic-tools/vs-code-copilot-guide.md +0 -53
- package/tools/installer/templates/claude-commands.md +0 -7
- package/tools/installer/templates/cursor-rules.md +0 -22
- package/tools/installer/templates/windsurf-rules.md +0 -22
package/.prettierignore
CHANGED
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
## [4.24.4](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.3...v4.24.4) (2025-07-04)
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
### Bug Fixes
|
|
5
|
+
|
|
6
|
+
* documentation updates ([2018ad0](https://github.com/bmadcode/BMAD-METHOD/commit/2018ad07c7d4c68efb3c24d85ac7612942c6df9c))
|
|
7
|
+
|
|
1
8
|
## [4.24.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.2...v4.24.3) (2025-07-04)
|
|
2
9
|
|
|
3
10
|
|
|
@@ -38,7 +45,7 @@
|
|
|
38
45
|
|
|
39
46
|
### Features
|
|
40
47
|
|
|
41
|
-
*
|
|
48
|
+
* Github Copilot integration ([#284](https://github.com/bmadcode/BMAD-METHOD/issues/284)) ([1a4ca4f](https://github.com/bmadcode/BMAD-METHOD/commit/1a4ca4ffa630c2d4156bdd7a040d4c2274801757))
|
|
42
49
|
|
|
43
50
|
## [4.22.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.22.0...v4.22.1) (2025-06-30)
|
|
44
51
|
|
package/README.md
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# BMad-
|
|
1
|
+
# BMad-Method: Universal AI Agent Framework
|
|
2
2
|
|
|
3
3
|
[](https://www.npmjs.com/package/bmad-method)
|
|
4
4
|
[](LICENSE)
|
|
@@ -11,13 +11,13 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
|
|
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 in the upper right hand corner!** It helps others discover BMad-
|
|
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
|
|
17
17
|
|
|
18
|
-
### 🚨 MUST READ: Understanding the
|
|
18
|
+
### 🚨 MUST READ: Understanding the BMad Workflow
|
|
19
19
|
|
|
20
|
-
**Before diving in, review these critical workflow diagrams that explain how
|
|
20
|
+
**Before diving in, review these critical workflow diagrams that explain how BMad works:**
|
|
21
21
|
|
|
22
22
|
1. **[Planning Workflow (Web UI)](docs/user-guide.md#the-planning-workflow-web-ui)** - How to create PRD and Architecture documents
|
|
23
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
|
|
@@ -26,8 +26,8 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
|
|
26
26
|
|
|
27
27
|
### What would you like to do?
|
|
28
28
|
|
|
29
|
-
- **[Build software with Full Stack Agile AI Team](
|
|
30
|
-
- **[Learn how to use
|
|
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
31
|
- **[See available AI agents](#available-agents)** → Specialized roles for your team
|
|
32
32
|
- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
|
|
33
33
|
- **[Create my own AI agents](#creating-your-own-expansion-pack)** → Build agents for your domain
|
|
@@ -37,7 +37,7 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
|
|
37
37
|
|
|
38
38
|
### Popular Use Cases
|
|
39
39
|
|
|
40
|
-
- **Software Development** - [Quick Start](
|
|
40
|
+
- **Software Development** - [Quick Start](quick-start) | [User Guide](docs/user-guide.md) | [Workflow Guides](#documentation--guides)
|
|
41
41
|
- **Game Development** - [2D Phaser Pack](expansion-packs/bmad-2d-phaser-game-dev/)
|
|
42
42
|
- **Business Strategy** - [Full Guide](docs/expansion-packs.md#business-strategy-pack)
|
|
43
43
|
- **Creative Writing** - [Full Guide](docs/expansion-packs.md#creative-writing-pack)
|
|
@@ -47,12 +47,12 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
|
|
47
47
|
|
|
48
48
|
- **[Installation](#installation)** → Get started in minutes
|
|
49
49
|
- **[Documentation](#documentation--guides)** → All guides and references
|
|
50
|
-
- **[Contributing](#contributing)** → Help improve
|
|
50
|
+
- **[Contributing](#contributing)** → Help improve BMad
|
|
51
51
|
- **[Support](#support)** → Get help and connect
|
|
52
52
|
|
|
53
53
|
## Important: Keep Your BMad Installation Updated
|
|
54
54
|
|
|
55
|
-
**Stay up-to-date effortlessly!** If you already have BMad-
|
|
55
|
+
**Stay up-to-date effortlessly!** If you already have BMad-Method installed in your project, simply run:
|
|
56
56
|
|
|
57
57
|
```bash
|
|
58
58
|
npx bmad-method install
|
|
@@ -111,9 +111,9 @@ npm run install:bmad # build and install all to a destination folder
|
|
|
111
111
|
|
|
112
112
|
## Overview
|
|
113
113
|
|
|
114
|
-
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
|
|
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
115
|
|
|
116
|
-
Unlike systems like Task Master, or inbuilt Task
|
|
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
117
|
|
|
118
118
|
## Installation
|
|
119
119
|
|
|
@@ -156,7 +156,7 @@ The BMad Method works with any IDE, but has built-in integration for:
|
|
|
156
156
|
- `gemini-cli` - Gemini with @agent commands
|
|
157
157
|
- `windsurf` - Windsurf with manual rule @agent commands
|
|
158
158
|
- `roo` - Roo Code with custom modes (see `.roomodes`)
|
|
159
|
-
- `
|
|
159
|
+
- `github-copilot` - GitHub Copilot agent mode integration
|
|
160
160
|
|
|
161
161
|
## Available Agents
|
|
162
162
|
|
|
@@ -208,7 +208,7 @@ Many of the Agents and Templates for docs, and some tasks, include Advanced Elic
|
|
|
208
208
|
|
|
209
209
|
## Usage
|
|
210
210
|
|
|
211
|
-
The
|
|
211
|
+
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)**.
|
|
212
212
|
|
|
213
213
|
### Quick Start Examples
|
|
214
214
|
|
|
@@ -274,12 +274,12 @@ See the **[Core Architecture](docs/core-architecture.md)** for the complete sour
|
|
|
274
274
|
### Architecture & Technical
|
|
275
275
|
|
|
276
276
|
- 🏗️ [Core Architecture](docs/core-architecture.md) - Complete technical architecture and system design
|
|
277
|
-
- 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using
|
|
278
|
-
- 🚀 [Expansion Packs Guide](docs/expansion-packs.md) - Extend
|
|
277
|
+
- 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMad-Method effectively
|
|
278
|
+
- 🚀 [Expansion Packs Guide](docs/expansion-packs.md) - Extend BMad to any domain beyond software development
|
|
279
279
|
|
|
280
280
|
### Workflow Guides
|
|
281
281
|
|
|
282
|
-
- 📚 [Universal
|
|
282
|
+
- 📚 [Universal BMad Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
|
|
283
283
|
- 🏗️ [Working in the Brownfield Guide](docs/working-in-the-brownfield.md) - Complete guide for enhancing existing projects
|
|
284
284
|
|
|
285
285
|
### IDE-Specific Guides
|
|
@@ -290,11 +290,11 @@ See the **[Core Architecture](docs/core-architecture.md)** for the complete sour
|
|
|
290
290
|
- 🦘 [Roo Code Guide](docs/agentic-tools/roo-code-guide.md) - Setup and usage for Roo Code
|
|
291
291
|
- 🔧 [Cline Guide](docs/agentic-tools/cline-guide.md) - Setup and usage for Cline (VS Code)
|
|
292
292
|
- ✨ [Gemini CLI Guide](docs/agentic-tools/gemini-cli-guide.md) - Setup and usage for Gemini CLI
|
|
293
|
-
- 💻 [
|
|
293
|
+
- 💻 [Github Copilot Guide](docs/agentic-tools/github-copilot-guide.md) - Setup and usage for VS Code with GitHub Copilot
|
|
294
294
|
|
|
295
295
|
## 🌟 Beyond Software Development - Expansion Packs
|
|
296
296
|
|
|
297
|
-
While BMad excels at software development, its natural language framework can structure expertise in ANY domain. Expansion packs transform
|
|
297
|
+
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.
|
|
298
298
|
|
|
299
299
|
### Available Expansion Packs
|
|
300
300
|
|
|
@@ -341,9 +341,9 @@ MIT License - see [LICENSE](LICENSE) for details.
|
|
|
341
341
|
|
|
342
342
|
- **Current**: [v4](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
|
|
343
343
|
- **Previous Versions**:
|
|
344
|
-
- [Version 3](https://github.com/bmadcode/
|
|
345
|
-
- [Version 2](https://github.com/bmadcode/
|
|
346
|
-
- [Version 1](https://github.com/bmadcode/
|
|
344
|
+
- [Version 3](https://github.com/bmadcode/BMad-Method/tree/V3) - Introduced the unified BMad Agent and Gemini optimization
|
|
345
|
+
- [Version 2](https://github.com/bmadcode/BMad-Method/tree/V2) - Added web agents and template separation
|
|
346
|
+
- [Version 1](https://github.com/bmadcode/BMad-Method/tree/V1) - Original 7-file proof of concept
|
|
347
347
|
|
|
348
348
|
See [versions.md](docs/versions.md) for detailed version history and migration guides.
|
|
349
349
|
|
|
@@ -360,7 +360,7 @@ Created by Brian (BMad) Madison
|
|
|
360
360
|
To ensure your contribution aligns with the BMad Method and gets merged smoothly:
|
|
361
361
|
|
|
362
362
|
1. 📋 **Read [CONTRIBUTING.md](CONTRIBUTING.md)** - Our contribution guidelines, PR requirements, and process
|
|
363
|
-
2. 🎯 **Read [GUIDING-PRINCIPLES.md](GUIDING-PRINCIPLES.md)** - Core principles that keep
|
|
363
|
+
2. 🎯 **Read [GUIDING-PRINCIPLES.md](GUIDING-PRINCIPLES.md)** - Core principles that keep BMad powerful through simplicity
|
|
364
364
|
3. 🆕 **New to GitHub?** Start with our [Pull Request Guide](docs/how-to-contribute-with-pull-requests.md)
|
|
365
365
|
|
|
366
366
|
### Key Points to Remember
|
|
@@ -9,18 +9,18 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
|
|
|
9
9
|
agent:
|
|
10
10
|
name: BMad Master
|
|
11
11
|
id: bmad-master
|
|
12
|
-
title:
|
|
12
|
+
title: BMad Master Task Executor
|
|
13
13
|
icon: 🧙
|
|
14
14
|
whenToUse: Use when you need comprehensive expertise across all domains or rapid context switching between multiple agent capabilities
|
|
15
15
|
persona:
|
|
16
|
-
role: Master Task Executor &
|
|
17
|
-
style: Efficient, direct, action-oriented. Executes any
|
|
18
|
-
identity: Universal executor of all
|
|
16
|
+
role: Master Task Executor & BMad Method Expert
|
|
17
|
+
style: Efficient, direct, action-oriented. Executes any BMad task/template/util/checklist with precision
|
|
18
|
+
identity: Universal executor of all BMad-Method capabilities, directly runs any resource
|
|
19
19
|
focus: Direct execution without transformation, load resources only when needed
|
|
20
20
|
core_principles:
|
|
21
21
|
- Execute any resource directly without persona transformation
|
|
22
22
|
- Load resources at runtime, never pre-load
|
|
23
|
-
- Expert knowledge of all
|
|
23
|
+
- Expert knowledge of all BMad resources
|
|
24
24
|
- Track execution state and guide multi-step processes
|
|
25
25
|
- Use numbered lists for choices
|
|
26
26
|
- Process (*) commands immediately
|
|
@@ -9,13 +9,13 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
|
|
|
9
9
|
agent:
|
|
10
10
|
name: BMad Orchestrator
|
|
11
11
|
id: bmad-orchestrator
|
|
12
|
-
title:
|
|
12
|
+
title: BMad Master Orchestrator
|
|
13
13
|
icon: 🎭
|
|
14
14
|
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
|
15
15
|
persona:
|
|
16
|
-
role: Master Orchestrator &
|
|
17
|
-
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use
|
|
18
|
-
identity: Unified interface to all
|
|
16
|
+
role: Master Orchestrator & BMad Method Expert
|
|
17
|
+
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMad Method while orchestrating agents
|
|
18
|
+
identity: Unified interface to all BMad-Method capabilities, dynamically transforms into any specialized agent
|
|
19
19
|
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
|
20
20
|
core_principles:
|
|
21
21
|
- Become any agent on demand, loading files only when needed
|
|
@@ -28,7 +28,7 @@ persona:
|
|
|
28
28
|
- Process commands starting with * immediately
|
|
29
29
|
- Always remind users that commands require * prefix
|
|
30
30
|
startup:
|
|
31
|
-
- Announce: Introduce yourself as the
|
|
31
|
+
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
|
32
32
|
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
|
33
33
|
- Mention *help shows all available commands and options
|
|
34
34
|
- Check for active workflow plan using utils#plan-management
|
|
@@ -41,7 +41,7 @@ startup:
|
|
|
41
41
|
commands: # All commands require * prefix when used (e.g., *help, *agent pm)
|
|
42
42
|
help: Show this guide with available agents and workflows
|
|
43
43
|
chat-mode: Start conversational mode for detailed assistance
|
|
44
|
-
kb-mode: Load full
|
|
44
|
+
kb-mode: Load full BMad knowledge base
|
|
45
45
|
status: Show current context, active agent, and progress
|
|
46
46
|
agent: Transform into a specialized agent (list if name not specified)
|
|
47
47
|
exit: Return to BMad or exit session
|
|
@@ -56,13 +56,13 @@ commands: # All commands require * prefix when used (e.g., *help, *agent pm)
|
|
|
56
56
|
party-mode: Group chat with all agents
|
|
57
57
|
doc-out: Output full document
|
|
58
58
|
help-display-template: |
|
|
59
|
-
===
|
|
59
|
+
=== BMad Orchestrator Commands ===
|
|
60
60
|
All commands must start with * (asterisk)
|
|
61
61
|
|
|
62
62
|
Core Commands:
|
|
63
63
|
*help ............... Show this guide
|
|
64
64
|
*chat-mode .......... Start conversational mode for detailed assistance
|
|
65
|
-
*kb-mode ............ Load full
|
|
65
|
+
*kb-mode ............ Load full BMad knowledge base
|
|
66
66
|
*status ............. Show current context, active agent, and progress
|
|
67
67
|
*exit ............... Return to BMad or exit session
|
|
68
68
|
|
|
@@ -104,7 +104,7 @@ transformation:
|
|
|
104
104
|
- Announce transformation
|
|
105
105
|
- Operate until exit
|
|
106
106
|
loading:
|
|
107
|
-
- KB: Only for *kb-mode or
|
|
107
|
+
- KB: Only for *kb-mode or BMad questions
|
|
108
108
|
- Agents: Only when transforming
|
|
109
109
|
- Templates/Tasks: Only when executing
|
|
110
110
|
- Always indicate loading
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Change Navigation Checklist
|
|
2
2
|
|
|
3
|
-
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the
|
|
3
|
+
**Purpose:** To systematically guide the selected Agent and user through the analysis and planning required when a significant change (pivot, tech issue, missing requirement, failed story) is identified during the BMad workflow.
|
|
4
4
|
|
|
5
5
|
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
|
6
6
|
|
|
@@ -75,7 +75,7 @@ Think about both immediate and downstream effects.]]
|
|
|
75
75
|
|
|
76
76
|
## 3. Artifact Conflict & Impact Analysis
|
|
77
77
|
|
|
78
|
-
[[LLM: Documentation drives development in
|
|
78
|
+
[[LLM: Documentation drives development in BMad. Check each artifact:
|
|
79
79
|
|
|
80
80
|
1. Does this change invalidate documented decisions?
|
|
81
81
|
2. Are architectural assumptions still valid?
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BMad Knowledge Base
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
BMad-Method (Breakthrough Method of Agile AI-driven Development) is a framework that combines AI agents with Agile development methodologies. The v4 system introduces a modular architecture with improved dependency management, bundle optimization, and support for both web and IDE environments.
|
|
6
6
|
|
|
7
7
|
### Key Features
|
|
8
8
|
|
|
@@ -12,7 +12,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
12
12
|
- **Reusable Resources**: Portable templates, tasks, and checklists
|
|
13
13
|
- **Slash Command Integration**: Quick agent switching and control
|
|
14
14
|
|
|
15
|
-
### When to Use
|
|
15
|
+
### When to Use BMad
|
|
16
16
|
|
|
17
17
|
- **New Projects (Greenfield)**: Complete end-to-end development
|
|
18
18
|
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
|
@@ -20,11 +20,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
20
20
|
- **Quality Assurance**: Structured testing and validation
|
|
21
21
|
- **Documentation**: Professional PRDs, architecture docs, user stories
|
|
22
22
|
|
|
23
|
-
## How
|
|
23
|
+
## How BMad Works
|
|
24
24
|
|
|
25
25
|
### The Core Method
|
|
26
26
|
|
|
27
|
-
|
|
27
|
+
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
|
28
28
|
|
|
29
29
|
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
|
30
30
|
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
|
@@ -78,7 +78,7 @@ BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|
|
78
78
|
5. Type `/help` to see available commands
|
|
79
79
|
|
|
80
80
|
#### Option 2: IDE Integration
|
|
81
|
-
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code,
|
|
81
|
+
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
|
82
82
|
|
|
83
83
|
```bash
|
|
84
84
|
# Interactive installation (recommended)
|
|
@@ -93,16 +93,16 @@ npx bmad-method install
|
|
|
93
93
|
- **Windsurf**: Built-in AI capabilities
|
|
94
94
|
- **Cline**: VS Code extension with AI features
|
|
95
95
|
- **Roo Code**: Web-based IDE with agent support
|
|
96
|
-
- **
|
|
96
|
+
- **Github Copilot**: AI-powered coding assistant
|
|
97
97
|
|
|
98
|
-
**Note for VS Code Users**:
|
|
98
|
+
**Note for VS Code Users**: BMad-Method assumes when you mention "VS Code" that you're using it with an AI-powered extension like GitHub Copilot, Cline, or Roo. Standard VS Code without AI capabilities cannot run BMad agents. The installer includes built-in support for Cline and Roo.
|
|
99
99
|
|
|
100
100
|
**Verify Installation**:
|
|
101
101
|
- `.bmad-core/` folder created with all agents
|
|
102
102
|
- IDE-specific integration files created
|
|
103
103
|
- All agent commands/rules/modes available
|
|
104
104
|
|
|
105
|
-
**Remember**: At its core,
|
|
105
|
+
**Remember**: At its core, BMad-Method is about mastering and harnessing prompt engineering. Any IDE with AI agent support can use BMad - the framework provides the structured prompts and workflows that make AI development effective
|
|
106
106
|
|
|
107
107
|
### Environment Selection Guide
|
|
108
108
|
|
|
@@ -163,11 +163,11 @@ npx bmad-method install
|
|
|
163
163
|
|
|
164
164
|
## Core Configuration (core-config.yaml)
|
|
165
165
|
|
|
166
|
-
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables
|
|
166
|
+
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
|
167
167
|
|
|
168
168
|
### What is core-config.yaml?
|
|
169
169
|
|
|
170
|
-
This configuration file acts as a map for
|
|
170
|
+
This configuration file acts as a map for BMad agents, telling them exactly where to find your project documents and how they're structured. It enables:
|
|
171
171
|
|
|
172
172
|
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
|
173
173
|
- **Custom Locations**: Define where your documents and shards live
|
|
@@ -196,7 +196,7 @@ This configuration file acts as a map for BMAD agents, telling them exactly wher
|
|
|
196
196
|
|
|
197
197
|
1. **No Forced Migrations**: Keep your existing document structure
|
|
198
198
|
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
|
199
|
-
3. **Custom Workflows**: Configure
|
|
199
|
+
3. **Custom Workflows**: Configure BMad to match your team's process
|
|
200
200
|
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
|
201
201
|
|
|
202
202
|
### Common Configurations
|
|
@@ -279,7 +279,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
279
279
|
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
280
280
|
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
|
281
281
|
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
|
282
|
-
- **
|
|
282
|
+
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
|
283
283
|
|
|
284
284
|
**Chat Management Guidelines**:
|
|
285
285
|
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
|
@@ -325,7 +325,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
325
325
|
|
|
326
326
|
### System Overview
|
|
327
327
|
|
|
328
|
-
The
|
|
328
|
+
The BMad-Method is built around a modular architecture centered on the `bmad-core` directory, which serves as the brain of the entire system. This design enables the framework to operate effectively in both IDE environments (like Cursor, VS Code) and web-based AI interfaces (like ChatGPT, Gemini).
|
|
329
329
|
|
|
330
330
|
### Key Architectural Components
|
|
331
331
|
|
|
@@ -369,7 +369,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
|
|
369
369
|
|
|
370
370
|
### Template Processing System
|
|
371
371
|
|
|
372
|
-
|
|
372
|
+
BMad employs a sophisticated template system with three key components:
|
|
373
373
|
|
|
374
374
|
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
|
375
375
|
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
|
@@ -398,7 +398,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
|
|
398
398
|
3. Concatenating content into single text files with clear separators
|
|
399
399
|
4. Outputting ready-to-upload bundles for web AI interfaces
|
|
400
400
|
|
|
401
|
-
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes
|
|
401
|
+
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
|
402
402
|
|
|
403
403
|
## Complete Development Workflow
|
|
404
404
|
|
|
@@ -659,7 +659,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|
|
659
659
|
- **Keep conversations focused** - One agent, one task per conversation
|
|
660
660
|
- **Review everything** - Always review and approve before marking complete
|
|
661
661
|
|
|
662
|
-
## Contributing to
|
|
662
|
+
## Contributing to BMad-Method
|
|
663
663
|
|
|
664
664
|
### Quick Contribution Guidelines
|
|
665
665
|
|
|
@@ -688,7 +688,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
|
|
688
688
|
|
|
689
689
|
### What Are Expansion Packs?
|
|
690
690
|
|
|
691
|
-
Expansion packs extend
|
|
691
|
+
Expansion packs extend BMad-Method beyond traditional software development into ANY domain. They provide specialized agent teams, templates, and workflows while keeping the core framework lean and focused on development.
|
|
692
692
|
|
|
693
693
|
### Why Use Expansion Packs?
|
|
694
694
|
|
|
@@ -11,7 +11,7 @@ Create detailed, implementation-ready stories for brownfield projects where trad
|
|
|
11
11
|
- Working on brownfield projects with non-standard documentation
|
|
12
12
|
- Stories need to be created from document-project output
|
|
13
13
|
- Working from brownfield epics without full PRD/architecture
|
|
14
|
-
- Existing project documentation doesn't follow
|
|
14
|
+
- Existing project documentation doesn't follow BMad v4+ structure
|
|
15
15
|
- Need to gather additional context from user during story creation
|
|
16
16
|
|
|
17
17
|
**Use create-next-story when:**
|
|
@@ -117,7 +117,7 @@ If using brownfield PRD:
|
|
|
117
117
|
|
|
118
118
|
#### 2.3 From User Documentation
|
|
119
119
|
|
|
120
|
-
[[LLM: When working with non-
|
|
120
|
+
[[LLM: When working with non-BMad documentation, actively extract and organize the information into categories the Dev agent will need]]
|
|
121
121
|
|
|
122
122
|
Ask the user to help identify:
|
|
123
123
|
|
|
@@ -13,8 +13,8 @@ To identify the next logical story based on project progress and epic definition
|
|
|
13
13
|
- Load `.bmad-core/core-config.yaml` from the project root
|
|
14
14
|
- If the file does not exist:
|
|
15
15
|
- HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can:
|
|
16
|
-
1. Copy it from GITHUB
|
|
17
|
-
2. Run the
|
|
16
|
+
1. Copy it from GITHUB BMad-Method/bmad-core/core-config.yaml and configure it for your project
|
|
17
|
+
2. Run the BMad installer against your project to upgrade and add the file automatically
|
|
18
18
|
Please add and configure core-config.yaml before proceeding."
|
|
19
19
|
- Extract the following key configurations:
|
|
20
20
|
- `devStoryLocation`: Where to save story files
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
# KB Mode Interaction Task
|
|
2
2
|
|
|
3
3
|
## Purpose
|
|
4
|
-
Provide a user-friendly interface to the
|
|
4
|
+
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
|
5
5
|
|
|
6
6
|
## Instructions
|
|
7
7
|
|
|
@@ -10,23 +10,23 @@ When entering KB mode (*kb-mode), follow these steps:
|
|
|
10
10
|
### 1. Welcome and Guide
|
|
11
11
|
Announce entering KB mode with a brief, friendly introduction:
|
|
12
12
|
|
|
13
|
-
"I've entered KB mode and have access to the full
|
|
13
|
+
"I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method."
|
|
14
14
|
|
|
15
15
|
### 2. Present Topic Areas
|
|
16
16
|
Offer a concise list of main topic areas the user might want to explore:
|
|
17
17
|
|
|
18
18
|
**What would you like to know more about?**
|
|
19
19
|
|
|
20
|
-
1. **Setup & Installation** - Getting started with
|
|
20
|
+
1. **Setup & Installation** - Getting started with BMad
|
|
21
21
|
2. **Workflows** - Choosing the right workflow for your project
|
|
22
22
|
3. **Web vs IDE** - When to use each environment
|
|
23
23
|
4. **Agents** - Understanding specialized agents and their roles
|
|
24
24
|
5. **Documents** - PRDs, Architecture, Stories, and more
|
|
25
|
-
6. **Agile Process** - How
|
|
26
|
-
7. **Configuration** - Customizing
|
|
27
|
-
8. **Best Practices** - Tips for effective
|
|
25
|
+
6. **Agile Process** - How BMad implements Agile methodologies
|
|
26
|
+
7. **Configuration** - Customizing BMad for your needs
|
|
27
|
+
8. **Best Practices** - Tips for effective BMad usage
|
|
28
28
|
|
|
29
|
-
Or ask me about anything else related to
|
|
29
|
+
Or ask me about anything else related to BMad-Method!
|
|
30
30
|
|
|
31
31
|
### 3. Respond Contextually
|
|
32
32
|
- Wait for user's specific question or topic selection
|
|
@@ -50,20 +50,20 @@ When user is done or wants to exit KB mode:
|
|
|
50
50
|
|
|
51
51
|
**User**: *kb-mode
|
|
52
52
|
|
|
53
|
-
**Assistant**: I've entered KB mode and have access to the full
|
|
53
|
+
**Assistant**: I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method.
|
|
54
54
|
|
|
55
55
|
**What would you like to know more about?**
|
|
56
56
|
|
|
57
|
-
1. **Setup & Installation** - Getting started with
|
|
57
|
+
1. **Setup & Installation** - Getting started with BMad
|
|
58
58
|
2. **Workflows** - Choosing the right workflow for your project
|
|
59
59
|
3. **Web vs IDE** - When to use each environment
|
|
60
60
|
4. **Agents** - Understanding specialized agents and their roles
|
|
61
61
|
5. **Documents** - PRDs, Architecture, Stories, and more
|
|
62
|
-
6. **Agile Process** - How
|
|
63
|
-
7. **Configuration** - Customizing
|
|
64
|
-
8. **Best Practices** - Tips for effective
|
|
62
|
+
6. **Agile Process** - How BMad implements Agile methodologies
|
|
63
|
+
7. **Configuration** - Customizing BMad for your needs
|
|
64
|
+
8. **Best Practices** - Tips for effective BMad usage
|
|
65
65
|
|
|
66
|
-
Or ask me about anything else related to
|
|
66
|
+
Or ask me about anything else related to BMad-Method!
|
|
67
67
|
|
|
68
68
|
**User**: Tell me about workflows
|
|
69
69
|
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Template Format Conventions
|
|
2
2
|
|
|
3
|
-
Templates in the
|
|
3
|
+
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
|
4
4
|
|
|
5
5
|
## Template Markup Elements
|
|
6
6
|
|