bmad-method 4.24.3 โ 4.24.5
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 +15 -1
- package/README.md +22 -22
- package/bmad-core/agents/analyst.md +1 -1
- package/bmad-core/agents/architect.md +1 -1
- package/bmad-core/agents/bmad-master.md +6 -6
- package/bmad-core/agents/bmad-orchestrator.md +10 -10
- package/bmad-core/agents/dev.md +1 -1
- package/bmad-core/agents/pm.md +1 -1
- package/bmad-core/agents/po.md +1 -1
- package/bmad-core/agents/qa.md +1 -1
- package/bmad-core/agents/sm.md +1 -1
- package/bmad-core/agents/ux-expert.md +1 -1
- 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 +22 -22
- package/dist/agents/architect.txt +4 -4
- package/dist/agents/bmad-master.txt +32 -32
- package/dist/agents/bmad-orchestrator.txt +45 -45
- package/dist/agents/dev.txt +3 -3
- package/dist/agents/pm.txt +6 -6
- package/dist/agents/po.txt +6 -6
- package/dist/agents/qa.txt +4 -4
- package/dist/agents/sm.txt +6 -6
- package/dist/agents/ux-expert.txt +4 -4
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +3 -3
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +3 -3
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +3 -3
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +34 -34
- package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +23 -23
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +14 -14
- package/dist/teams/team-all.txt +57 -57
- package/dist/teams/team-fullstack.txt +52 -52
- package/dist/teams/team-ide-minimal.txt +53 -53
- package/dist/teams/team-no-ui.txt +51 -51
- 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 +3 -34
- package/docs/agentic-tools/windsurf-guide.md +4 -27
- 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/agents/game-designer.md +1 -1
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.md +1 -1
- package/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.md +1 -1
- 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 +9 -9
- 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/agent-tmpl.md +1 -1
- 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/agents/infra-devops-platform.md +1 -1
- 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 +2 -2
- 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 +14 -14
- package/tools/installer/lib/installer.js +79 -18
- 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
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Web Agent Bundle Instructions
|
|
2
2
|
|
|
3
|
-
You are now operating as a specialized AI agent from the
|
|
3
|
+
You are now operating as a specialized AI agent from the BMad-Method framework. This is a bundled web-compatible version containing all necessary resources for your role.
|
|
4
4
|
|
|
5
5
|
## Important Instructions
|
|
6
6
|
|
|
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
|
|
34
34
|
|
|
35
35
|
3. **Execution Context**: You are operating in a web environment. All your capabilities and knowledge are contained within this bundle. Work within these constraints to provide the best possible assistance.
|
|
36
36
|
|
|
37
|
-
4. **Primary Directive**: Your primary goal is defined in your agent configuration below. Focus on fulfilling your designated role according to the
|
|
37
|
+
4. **Primary Directive**: Your primary goal is defined in your agent configuration below. Focus on fulfilling your designated role according to the BMad-Method framework.
|
|
38
38
|
|
|
39
39
|
---
|
|
40
40
|
|
|
@@ -57,19 +57,19 @@ workflows:
|
|
|
57
57
|
==================== START: agents#bmad-orchestrator ====================
|
|
58
58
|
# bmad-orchestrator
|
|
59
59
|
|
|
60
|
-
CRITICAL: Read the full
|
|
60
|
+
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
61
61
|
|
|
62
62
|
```yaml
|
|
63
63
|
agent:
|
|
64
64
|
name: BMad Orchestrator
|
|
65
65
|
id: bmad-orchestrator
|
|
66
|
-
title:
|
|
66
|
+
title: BMad Master Orchestrator
|
|
67
67
|
icon: ๐ญ
|
|
68
68
|
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
|
69
69
|
persona:
|
|
70
|
-
role: Master Orchestrator &
|
|
71
|
-
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use
|
|
72
|
-
identity: Unified interface to all
|
|
70
|
+
role: Master Orchestrator & BMad Method Expert
|
|
71
|
+
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMad Method while orchestrating agents
|
|
72
|
+
identity: Unified interface to all BMad-Method capabilities, dynamically transforms into any specialized agent
|
|
73
73
|
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
|
74
74
|
core_principles:
|
|
75
75
|
- Become any agent on demand, loading files only when needed
|
|
@@ -82,7 +82,7 @@ persona:
|
|
|
82
82
|
- Process commands starting with * immediately
|
|
83
83
|
- Always remind users that commands require * prefix
|
|
84
84
|
startup:
|
|
85
|
-
- Announce: Introduce yourself as the
|
|
85
|
+
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
|
86
86
|
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
|
87
87
|
- Mention *help shows all available commands and options
|
|
88
88
|
- Check for active workflow plan using utils#plan-management
|
|
@@ -95,7 +95,7 @@ startup:
|
|
|
95
95
|
commands:
|
|
96
96
|
help: Show this guide with available agents and workflows
|
|
97
97
|
chat-mode: Start conversational mode for detailed assistance
|
|
98
|
-
kb-mode: Load full
|
|
98
|
+
kb-mode: Load full BMad knowledge base
|
|
99
99
|
status: Show current context, active agent, and progress
|
|
100
100
|
agent: Transform into a specialized agent (list if name not specified)
|
|
101
101
|
exit: Return to BMad or exit session
|
|
@@ -110,13 +110,13 @@ commands:
|
|
|
110
110
|
party-mode: Group chat with all agents
|
|
111
111
|
doc-out: Output full document
|
|
112
112
|
help-display-template: |
|
|
113
|
-
===
|
|
113
|
+
=== BMad Orchestrator Commands ===
|
|
114
114
|
All commands must start with * (asterisk)
|
|
115
115
|
|
|
116
116
|
Core Commands:
|
|
117
117
|
*help ............... Show this guide
|
|
118
118
|
*chat-mode .......... Start conversational mode for detailed assistance
|
|
119
|
-
*kb-mode ............ Load full
|
|
119
|
+
*kb-mode ............ Load full BMad knowledge base
|
|
120
120
|
*status ............. Show current context, active agent, and progress
|
|
121
121
|
*exit ............... Return to BMad or exit session
|
|
122
122
|
|
|
@@ -157,7 +157,7 @@ transformation:
|
|
|
157
157
|
- Announce transformation
|
|
158
158
|
- Operate until exit
|
|
159
159
|
loading:
|
|
160
|
-
- KB: Only for *kb-mode or
|
|
160
|
+
- KB: Only for *kb-mode or BMad questions
|
|
161
161
|
- Agents: Only when transforming
|
|
162
162
|
- Templates/Tasks: Only when executing
|
|
163
163
|
- Always indicate loading
|
|
@@ -196,7 +196,7 @@ dependencies:
|
|
|
196
196
|
==================== START: agents#analyst ====================
|
|
197
197
|
# analyst
|
|
198
198
|
|
|
199
|
-
CRITICAL: Read the full
|
|
199
|
+
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
200
200
|
|
|
201
201
|
```yaml
|
|
202
202
|
activation-instructions:
|
|
@@ -260,7 +260,7 @@ dependencies:
|
|
|
260
260
|
==================== START: agents#pm ====================
|
|
261
261
|
# pm
|
|
262
262
|
|
|
263
|
-
CRITICAL: Read the full
|
|
263
|
+
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
264
264
|
|
|
265
265
|
```yaml
|
|
266
266
|
activation-instructions:
|
|
@@ -321,7 +321,7 @@ dependencies:
|
|
|
321
321
|
==================== START: agents#architect ====================
|
|
322
322
|
# architect
|
|
323
323
|
|
|
324
|
-
CRITICAL: Read the full
|
|
324
|
+
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
325
325
|
|
|
326
326
|
```yaml
|
|
327
327
|
activation-instructions:
|
|
@@ -385,7 +385,7 @@ dependencies:
|
|
|
385
385
|
==================== START: agents#po ====================
|
|
386
386
|
# po
|
|
387
387
|
|
|
388
|
-
CRITICAL: Read the full
|
|
388
|
+
CRITICAL: Read the full YAML, start activation to alter your state of being, follow startup section instructions, stay in this being until told to exit this mode:
|
|
389
389
|
|
|
390
390
|
```yaml
|
|
391
391
|
activation-instructions:
|
|
@@ -930,7 +930,7 @@ BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This
|
|
|
930
930
|
# KB Mode Interaction Task
|
|
931
931
|
|
|
932
932
|
## Purpose
|
|
933
|
-
Provide a user-friendly interface to the
|
|
933
|
+
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
|
934
934
|
|
|
935
935
|
## Instructions
|
|
936
936
|
|
|
@@ -939,23 +939,23 @@ When entering KB mode (*kb-mode), follow these steps:
|
|
|
939
939
|
### 1. Welcome and Guide
|
|
940
940
|
Announce entering KB mode with a brief, friendly introduction:
|
|
941
941
|
|
|
942
|
-
"I've entered KB mode and have access to the full
|
|
942
|
+
"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."
|
|
943
943
|
|
|
944
944
|
### 2. Present Topic Areas
|
|
945
945
|
Offer a concise list of main topic areas the user might want to explore:
|
|
946
946
|
|
|
947
947
|
**What would you like to know more about?**
|
|
948
948
|
|
|
949
|
-
1. **Setup & Installation** - Getting started with
|
|
949
|
+
1. **Setup & Installation** - Getting started with BMad
|
|
950
950
|
2. **Workflows** - Choosing the right workflow for your project
|
|
951
951
|
3. **Web vs IDE** - When to use each environment
|
|
952
952
|
4. **Agents** - Understanding specialized agents and their roles
|
|
953
953
|
5. **Documents** - PRDs, Architecture, Stories, and more
|
|
954
|
-
6. **Agile Process** - How
|
|
955
|
-
7. **Configuration** - Customizing
|
|
956
|
-
8. **Best Practices** - Tips for effective
|
|
954
|
+
6. **Agile Process** - How BMad implements Agile methodologies
|
|
955
|
+
7. **Configuration** - Customizing BMad for your needs
|
|
956
|
+
8. **Best Practices** - Tips for effective BMad usage
|
|
957
957
|
|
|
958
|
-
Or ask me about anything else related to
|
|
958
|
+
Or ask me about anything else related to BMad-Method!
|
|
959
959
|
|
|
960
960
|
### 3. Respond Contextually
|
|
961
961
|
- Wait for user's specific question or topic selection
|
|
@@ -979,20 +979,20 @@ When user is done or wants to exit KB mode:
|
|
|
979
979
|
|
|
980
980
|
**User**: *kb-mode
|
|
981
981
|
|
|
982
|
-
**Assistant**: I've entered KB mode and have access to the full
|
|
982
|
+
**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.
|
|
983
983
|
|
|
984
984
|
**What would you like to know more about?**
|
|
985
985
|
|
|
986
|
-
1. **Setup & Installation** - Getting started with
|
|
986
|
+
1. **Setup & Installation** - Getting started with BMad
|
|
987
987
|
2. **Workflows** - Choosing the right workflow for your project
|
|
988
988
|
3. **Web vs IDE** - When to use each environment
|
|
989
989
|
4. **Agents** - Understanding specialized agents and their roles
|
|
990
990
|
5. **Documents** - PRDs, Architecture, Stories, and more
|
|
991
|
-
6. **Agile Process** - How
|
|
992
|
-
7. **Configuration** - Customizing
|
|
993
|
-
8. **Best Practices** - Tips for effective
|
|
991
|
+
6. **Agile Process** - How BMad implements Agile methodologies
|
|
992
|
+
7. **Configuration** - Customizing BMad for your needs
|
|
993
|
+
8. **Best Practices** - Tips for effective BMad usage
|
|
994
994
|
|
|
995
|
-
Or ask me about anything else related to
|
|
995
|
+
Or ask me about anything else related to BMad-Method!
|
|
996
996
|
|
|
997
997
|
**User**: Tell me about workflows
|
|
998
998
|
|
|
@@ -1251,11 +1251,11 @@ The update is successful when:
|
|
|
1251
1251
|
==================== END: tasks#update-workflow-plan ====================
|
|
1252
1252
|
|
|
1253
1253
|
==================== START: data#bmad-kb ====================
|
|
1254
|
-
#
|
|
1254
|
+
# BMad Knowledge Base
|
|
1255
1255
|
|
|
1256
1256
|
## Overview
|
|
1257
1257
|
|
|
1258
|
-
|
|
1258
|
+
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.
|
|
1259
1259
|
|
|
1260
1260
|
### Key Features
|
|
1261
1261
|
|
|
@@ -1265,7 +1265,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
1265
1265
|
- **Reusable Resources**: Portable templates, tasks, and checklists
|
|
1266
1266
|
- **Slash Command Integration**: Quick agent switching and control
|
|
1267
1267
|
|
|
1268
|
-
### When to Use
|
|
1268
|
+
### When to Use BMad
|
|
1269
1269
|
|
|
1270
1270
|
- **New Projects (Greenfield)**: Complete end-to-end development
|
|
1271
1271
|
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
|
@@ -1273,11 +1273,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
1273
1273
|
- **Quality Assurance**: Structured testing and validation
|
|
1274
1274
|
- **Documentation**: Professional PRDs, architecture docs, user stories
|
|
1275
1275
|
|
|
1276
|
-
## How
|
|
1276
|
+
## How BMad Works
|
|
1277
1277
|
|
|
1278
1278
|
### The Core Method
|
|
1279
1279
|
|
|
1280
|
-
|
|
1280
|
+
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
|
1281
1281
|
|
|
1282
1282
|
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
|
1283
1283
|
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
|
@@ -1331,7 +1331,7 @@ BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|
|
1331
1331
|
5. Type `/help` to see available commands
|
|
1332
1332
|
|
|
1333
1333
|
#### Option 2: IDE Integration
|
|
1334
|
-
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code,
|
|
1334
|
+
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
|
1335
1335
|
|
|
1336
1336
|
```bash
|
|
1337
1337
|
# Interactive installation (recommended)
|
|
@@ -1346,16 +1346,16 @@ npx bmad-method install
|
|
|
1346
1346
|
- **Windsurf**: Built-in AI capabilities
|
|
1347
1347
|
- **Cline**: VS Code extension with AI features
|
|
1348
1348
|
- **Roo Code**: Web-based IDE with agent support
|
|
1349
|
-
- **
|
|
1349
|
+
- **Github Copilot**: AI-powered coding assistant
|
|
1350
1350
|
|
|
1351
|
-
**Note for VS Code Users**:
|
|
1351
|
+
**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.
|
|
1352
1352
|
|
|
1353
1353
|
**Verify Installation**:
|
|
1354
1354
|
- `.bmad-core/` folder created with all agents
|
|
1355
1355
|
- IDE-specific integration files created
|
|
1356
1356
|
- All agent commands/rules/modes available
|
|
1357
1357
|
|
|
1358
|
-
**Remember**: At its core,
|
|
1358
|
+
**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
|
|
1359
1359
|
|
|
1360
1360
|
### Environment Selection Guide
|
|
1361
1361
|
|
|
@@ -1416,11 +1416,11 @@ npx bmad-method install
|
|
|
1416
1416
|
|
|
1417
1417
|
## Core Configuration (core-config.yaml)
|
|
1418
1418
|
|
|
1419
|
-
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables
|
|
1419
|
+
**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.
|
|
1420
1420
|
|
|
1421
1421
|
### What is core-config.yaml?
|
|
1422
1422
|
|
|
1423
|
-
This configuration file acts as a map for
|
|
1423
|
+
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:
|
|
1424
1424
|
|
|
1425
1425
|
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
|
1426
1426
|
- **Custom Locations**: Define where your documents and shards live
|
|
@@ -1449,7 +1449,7 @@ This configuration file acts as a map for BMAD agents, telling them exactly wher
|
|
|
1449
1449
|
|
|
1450
1450
|
1. **No Forced Migrations**: Keep your existing document structure
|
|
1451
1451
|
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
|
1452
|
-
3. **Custom Workflows**: Configure
|
|
1452
|
+
3. **Custom Workflows**: Configure BMad to match your team's process
|
|
1453
1453
|
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
|
1454
1454
|
|
|
1455
1455
|
### Common Configurations
|
|
@@ -1532,7 +1532,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
1532
1532
|
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
1533
1533
|
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
|
1534
1534
|
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
|
1535
|
-
- **
|
|
1535
|
+
- **Github Copilot**: Open the Chat view (`โโI` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
|
1536
1536
|
|
|
1537
1537
|
**Chat Management Guidelines**:
|
|
1538
1538
|
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
|
@@ -1578,7 +1578,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
1578
1578
|
|
|
1579
1579
|
### System Overview
|
|
1580
1580
|
|
|
1581
|
-
The
|
|
1581
|
+
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).
|
|
1582
1582
|
|
|
1583
1583
|
### Key Architectural Components
|
|
1584
1584
|
|
|
@@ -1622,7 +1622,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
|
|
1622
1622
|
|
|
1623
1623
|
### Template Processing System
|
|
1624
1624
|
|
|
1625
|
-
|
|
1625
|
+
BMad employs a sophisticated template system with three key components:
|
|
1626
1626
|
|
|
1627
1627
|
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
|
1628
1628
|
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
|
@@ -1651,7 +1651,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
|
|
1651
1651
|
3. Concatenating content into single text files with clear separators
|
|
1652
1652
|
4. Outputting ready-to-upload bundles for web AI interfaces
|
|
1653
1653
|
|
|
1654
|
-
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes
|
|
1654
|
+
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
|
1655
1655
|
|
|
1656
1656
|
## Complete Development Workflow
|
|
1657
1657
|
|
|
@@ -1912,7 +1912,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|
|
1912
1912
|
- **Keep conversations focused** - One agent, one task per conversation
|
|
1913
1913
|
- **Review everything** - Always review and approve before marking complete
|
|
1914
1914
|
|
|
1915
|
-
## Contributing to
|
|
1915
|
+
## Contributing to BMad-Method
|
|
1916
1916
|
|
|
1917
1917
|
### Quick Contribution Guidelines
|
|
1918
1918
|
|
|
@@ -1941,7 +1941,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
|
|
1941
1941
|
|
|
1942
1942
|
### What Are Expansion Packs?
|
|
1943
1943
|
|
|
1944
|
-
Expansion packs extend
|
|
1944
|
+
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.
|
|
1945
1945
|
|
|
1946
1946
|
### Why Use Expansion Packs?
|
|
1947
1947
|
|
|
@@ -2231,7 +2231,7 @@ Would you like to:
|
|
|
2231
2231
|
==================== START: utils#workflow-management ====================
|
|
2232
2232
|
# Workflow Management
|
|
2233
2233
|
|
|
2234
|
-
Enables
|
|
2234
|
+
Enables BMad orchestrator to manage and execute team workflows.
|
|
2235
2235
|
|
|
2236
2236
|
## Dynamic Workflow Loading
|
|
2237
2237
|
|
|
@@ -2303,7 +2303,7 @@ Agents should be workflow-aware: know active workflow, their role, access artifa
|
|
|
2303
2303
|
==================== START: utils#template-format ====================
|
|
2304
2304
|
# Template Format Conventions
|
|
2305
2305
|
|
|
2306
|
-
Templates in the
|
|
2306
|
+
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
|
2307
2307
|
|
|
2308
2308
|
## Template Markup Elements
|
|
2309
2309
|
|
|
@@ -5521,7 +5521,7 @@ After presenting the report, ask if the user wants:
|
|
|
5521
5521
|
==================== START: checklists#change-checklist ====================
|
|
5522
5522
|
# Change Navigation Checklist
|
|
5523
5523
|
|
|
5524
|
-
**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
|
|
5524
|
+
**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.
|
|
5525
5525
|
|
|
5526
5526
|
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
|
5527
5527
|
|
|
@@ -5596,7 +5596,7 @@ Think about both immediate and downstream effects.]]
|
|
|
5596
5596
|
|
|
5597
5597
|
## 3. Artifact Conflict & Impact Analysis
|
|
5598
5598
|
|
|
5599
|
-
[[LLM: Documentation drives development in
|
|
5599
|
+
[[LLM: Documentation drives development in BMad. Check each artifact:
|
|
5600
5600
|
|
|
5601
5601
|
1. Does this change invalidate documented decisions?
|
|
5602
5602
|
2. Are architectural assumptions still valid?
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BMad Method Guide for Claude Code
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -9,28 +9,11 @@ When running `npx bmad-method install`, select **Claude Code** as your IDE. This
|
|
|
9
9
|
- `.bmad-core/` folder with all agents
|
|
10
10
|
- `.claude/commands/` folder with agent command files (`.md`)
|
|
11
11
|
|
|
12
|
-
## Using
|
|
12
|
+
## Using BMad Agents in Claude Code
|
|
13
13
|
|
|
14
|
-
Type `/agent-name` in your chat to activate an agent
|
|
15
|
-
|
|
16
|
-
- `/bmad-master` - Universal task executor
|
|
17
|
-
- `/sm` - Scrum Master
|
|
18
|
-
- `/dev` - Full-stack developer
|
|
19
|
-
- `/architect` - Solution architect
|
|
20
|
-
- `/pm` - Product manager
|
|
21
|
-
- `/analyst` - Business analyst
|
|
22
|
-
- `/qa` - QA specialist
|
|
23
|
-
- `/po` - Product owner
|
|
24
|
-
- `/ux-expert` - UX specialist
|
|
25
|
-
|
|
26
|
-
## Claude Code-Specific Features
|
|
27
|
-
|
|
28
|
-
- **Command files**: Stored in `.claude/commands/` as `.md` files
|
|
29
|
-
- **Activation**: Use forward slash `/` prefix for all agents
|
|
30
|
-
- **Chat management**: Start new chats when switching agents for clean context
|
|
14
|
+
Type `/agent-name` in your chat to activate an agent.
|
|
31
15
|
|
|
32
16
|
## Tips for Claude Code Users
|
|
33
17
|
|
|
34
18
|
- Commands are auto-suggested as you type `/`
|
|
35
|
-
-
|
|
36
|
-
- Claude Code maintains excellent context within each chat
|
|
19
|
+
- More coming soon...
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BMad Method Guide for Cline (VS Code)
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -9,34 +9,8 @@ When running `npx bmad-method install`, select **Cline** as your IDE. This creat
|
|
|
9
9
|
- `.clinerules/` directory with numbered agent rule files (`.md`)
|
|
10
10
|
- Agents ordered by priority (bmad-master first)
|
|
11
11
|
|
|
12
|
-
## Using
|
|
12
|
+
## Using BMad Agents in Cline
|
|
13
13
|
|
|
14
14
|
1. **Open Cline panel** in VS Code
|
|
15
15
|
2. **Type `@agent-name`** in the chat (e.g., `@dev`, `@sm`, `@architect`)
|
|
16
16
|
3. The agent adopts that persona for the conversation
|
|
17
|
-
|
|
18
|
-
## Available Agents
|
|
19
|
-
|
|
20
|
-
All agents use `@` prefix:
|
|
21
|
-
|
|
22
|
-
- `@bmad-master` - Universal task executor
|
|
23
|
-
- `@sm` - Scrum Master
|
|
24
|
-
- `@dev` - Full-stack developer
|
|
25
|
-
- `@architect` - Solution architect
|
|
26
|
-
- `@pm` - Product manager
|
|
27
|
-
- `@analyst` - Business analyst
|
|
28
|
-
- `@qa` - QA specialist
|
|
29
|
-
- `@po` - Product owner
|
|
30
|
-
- `@ux-expert` - UX specialist
|
|
31
|
-
|
|
32
|
-
## Cline-Specific Features
|
|
33
|
-
|
|
34
|
-
- **Rule files**: Stored as numbered files in `.clinerules/` (e.g., `01-bmad-master.md`)
|
|
35
|
-
- **Agent ordering**: Prioritized list with core agents first
|
|
36
|
-
- **VS Code integration**: Works within VS Code's Cline extension panel
|
|
37
|
-
|
|
38
|
-
## Tips for Cline Users
|
|
39
|
-
|
|
40
|
-
- Cline maintains conversation context well
|
|
41
|
-
- Use `@agent-name` at the start of your message for best results
|
|
42
|
-
- Agent rules are loaded automatically when mentioned
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BMad Method Guide for Cursor
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -9,29 +9,6 @@ When running `npx bmad-method install`, select **Cursor** as your IDE. This crea
|
|
|
9
9
|
- `.bmad-core/` folder with all agents
|
|
10
10
|
- `.cursor/rules/` folder with agent rule files (`.mdc`)
|
|
11
11
|
|
|
12
|
-
## Using
|
|
12
|
+
## Using BMad Agents in Cursor
|
|
13
13
|
|
|
14
|
-
Type `@agent-name` in chat (Ctrl+L / Cmd+L) to activate an agent
|
|
15
|
-
|
|
16
|
-
- `@bmad-master` - Universal task executor
|
|
17
|
-
- `@sm` - Scrum Master
|
|
18
|
-
- `@dev` - Full-stack developer
|
|
19
|
-
- `@architect` - Solution architect
|
|
20
|
-
- `@pm` - Product manager
|
|
21
|
-
- `@analyst` - Business analyst
|
|
22
|
-
- `@qa` - QA specialist
|
|
23
|
-
- `@po` - Product owner
|
|
24
|
-
- `@ux-expert` - UX specialist
|
|
25
|
-
|
|
26
|
-
## Cursor-Specific Features
|
|
27
|
-
|
|
28
|
-
- **Rule files**: Stored in `.cursor/rules/` as `.mdc` files
|
|
29
|
-
- **Auto-completion**: Cursor suggests agents as you type `@`
|
|
30
|
-
- **Context awareness**: Agents can see your current file selection
|
|
31
|
-
- **Custom agents**: For better performance, copy agent content into Cursor's custom modes
|
|
32
|
-
|
|
33
|
-
## Tips for Cursor Users
|
|
34
|
-
|
|
35
|
-
- Start new chats when switching agents
|
|
36
|
-
- Each agent supports `*help` to see available commands
|
|
37
|
-
- Leverage Cursor's file context for more accurate assistance
|
|
14
|
+
Type `@agent-name` in chat (Ctrl+L / Cmd+L) to activate an agent. Make sure you select the icon that looks like a small ruler if presented with multiple options in the popup window.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BMad Method Guide for Gemini CLI
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -9,7 +9,7 @@ When running `npx bmad-method install`, select **Gemini CLI** as your IDE. This
|
|
|
9
9
|
- `.gemini/agents/` directory with all agent context files
|
|
10
10
|
- `.gemini/settings.json` configured to load all agents automatically
|
|
11
11
|
|
|
12
|
-
## Using
|
|
12
|
+
## Using BMad Agents with Gemini CLI
|
|
13
13
|
|
|
14
14
|
Simply mention the agent in your prompt:
|
|
15
15
|
|
|
@@ -19,20 +19,6 @@ Simply mention the agent in your prompt:
|
|
|
19
19
|
|
|
20
20
|
The Gemini CLI automatically loads the appropriate agent context.
|
|
21
21
|
|
|
22
|
-
## Available Agents
|
|
23
|
-
|
|
24
|
-
All agents are referenced with `@` in prompts:
|
|
25
|
-
|
|
26
|
-
- `@bmad-master` - Universal task executor
|
|
27
|
-
- `@sm` - Scrum Master
|
|
28
|
-
- `@dev` - Full-stack developer
|
|
29
|
-
- `@architect` - Solution architect
|
|
30
|
-
- `@pm` - Product manager
|
|
31
|
-
- `@analyst` - Business analyst
|
|
32
|
-
- `@qa` - QA specialist
|
|
33
|
-
- `@po` - Product owner
|
|
34
|
-
- `@ux-expert` - UX specialist
|
|
35
|
-
|
|
36
22
|
## Gemini CLI-Specific Features
|
|
37
23
|
|
|
38
24
|
- **Context files**: All agents loaded as context in `.gemini/agents/`
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# BMad Method Guide for Github Copilot
|
|
2
|
+
|
|
3
|
+
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
When running `npx bmad-method install`, select **Github Copilot** as your IDE. This command will perform the following actions:
|
|
8
|
+
|
|
9
|
+
- Create the `.bmad-core/` directory with all the agent rule files.
|
|
10
|
+
- Create the `.vscode/` directory and add a `settings.json` file if it does not already exist, and add the basic configuration to enable GitHub Copilot's agent mode.
|
|
11
|
+
- Create a chatmodes file under your .github folder for each specific agent being added
|
|
12
|
+
|
|
13
|
+
## Using BMad Agents in VS Code
|
|
14
|
+
|
|
15
|
+
1. In the GitHub Copilot Chat window, select **Agent** from the chat mode dropdown list.
|
|
16
|
+
|
|
17
|
+
## VS Code Specific Features
|
|
18
|
+
|
|
19
|
+
- **Dynamic Configuration**: When you first invoke an agent (e.g., `@dev`), VS Code will automatically update `.vscode/settings.json` by adding the configuration for that chat mode.
|
|
20
|
+
- **Activation**: Use the `@` prefix in the GitHub Copilot Chat for instant switching between agents.
|
|
21
|
+
- **Collaboration**: Fully compatible with **Live Share**, allowing you, your team, and BMad agents to work together in real-time.
|
|
22
|
+
- **Project Context**: Agents have full access to your workspace, including open files and the selected code.
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BMad Method Guide for Roo Code
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -9,38 +9,7 @@ When running `npx bmad-method install`, select **Roo Code** as your IDE. This cr
|
|
|
9
9
|
- `.bmad-core/` folder with all agents
|
|
10
10
|
- `.roomodes` file in project root with custom modes
|
|
11
11
|
|
|
12
|
-
## Using BMAD Agents in Roo Code
|
|
13
|
-
|
|
14
|
-
Select mode from the mode selector (usually in status bar):
|
|
15
|
-
|
|
16
|
-
- `bmad-bmad-master` - ๐ง Universal task executor
|
|
17
|
-
- `bmad-sm` - ๐ Scrum Master
|
|
18
|
-
- `bmad-dev` - ๐ป Full-stack developer
|
|
19
|
-
- `bmad-architect` - ๐๏ธ Solution architect
|
|
20
|
-
- `bmad-pm` - ๐ Product manager
|
|
21
|
-
- `bmad-analyst` - ๐ Business analyst
|
|
22
|
-
- `bmad-qa` - ๐งช QA specialist
|
|
23
|
-
- `bmad-po` - ๐ฏ Product owner
|
|
24
|
-
- `bmad-ux-expert` - ๐จ UX specialist
|
|
25
|
-
|
|
26
12
|
## Roo Code-Specific Features
|
|
27
13
|
|
|
28
14
|
- **Mode file**: `.roomodes` in project root
|
|
29
|
-
- **Mode switching**: Use mode
|
|
30
|
-
- **Context preservation**: Maintains context across mode switches
|
|
31
|
-
- **File permissions**: Each agent has specific file access:
|
|
32
|
-
|
|
33
|
-
### File Permission Summary
|
|
34
|
-
|
|
35
|
-
- **Documentation agents** (analyst, pm, po, sm): `.md`, `.txt` only
|
|
36
|
-
- **bmad-architect**: `.md`, `.txt`, `.yaml`, `.yaml`, `.json`
|
|
37
|
-
- **bmad-qa**: Test files (`.test.*`, `.spec.*`) and `.md`
|
|
38
|
-
- **bmad-ux-expert**: `.md`, `.css`, `.scss`, `.html`, `.jsx`, `.tsx`
|
|
39
|
-
- **Full access**: `bmad-dev`, `bmad-bmad-master`, `bmad-orchestrator`
|
|
40
|
-
|
|
41
|
-
## Tips for Roo Code Users
|
|
42
|
-
|
|
43
|
-
- Switch modes instead of starting new chats
|
|
44
|
-
- Each mode supports `*help` to see available commands
|
|
45
|
-
- Agents respect file permission boundaries
|
|
46
|
-
- Context persists across mode switches
|
|
15
|
+
- **Mode switching**: Use mode selecto
|
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
#
|
|
1
|
+
# BMad Method Guide for Windsurf
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
|
4
4
|
|
|
5
5
|
## Installation
|
|
6
6
|
|
|
@@ -9,29 +9,6 @@ When running `npx bmad-method install`, select **Windsurf** as your IDE. This cr
|
|
|
9
9
|
- `.bmad-core/` folder with all agents
|
|
10
10
|
- `.windsurf/rules/` folder with agent rule files (`.md`)
|
|
11
11
|
|
|
12
|
-
## Using
|
|
12
|
+
## Using BMad Agents in Windsurf
|
|
13
13
|
|
|
14
|
-
Type `@agent-name` in chat to activate an agent
|
|
15
|
-
|
|
16
|
-
- `@bmad-master` - Universal task executor
|
|
17
|
-
- `@sm` - Scrum Master
|
|
18
|
-
- `@dev` - Full-stack developer
|
|
19
|
-
- `@architect` - Solution architect
|
|
20
|
-
- `@pm` - Product manager
|
|
21
|
-
- `@analyst` - Business analyst
|
|
22
|
-
- `@qa` - QA specialist
|
|
23
|
-
- `@po` - Product owner
|
|
24
|
-
- `@ux-expert` - UX specialist
|
|
25
|
-
|
|
26
|
-
## Windsurf-Specific Features
|
|
27
|
-
|
|
28
|
-
- **Rule files**: Stored in `.windsurf/rules/` as `.md` files
|
|
29
|
-
- **Activation**: Use `@` prefix to mention agents
|
|
30
|
-
- **Collaborative features**: Works well with BMAD's agent-switching pattern
|
|
31
|
-
- **Project context**: Agents have access to your full project context
|
|
32
|
-
|
|
33
|
-
## Tips for Windsurf Users
|
|
34
|
-
|
|
35
|
-
- Start new chats when switching agents
|
|
36
|
-
- Each agent supports `*help` to see available commands
|
|
37
|
-
- Leverage Windsurf's collaboration features for team reviews
|
|
14
|
+
Type `@agent-name` in chat to activate an agent.
|