bmad-method 4.24.2 → 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.
Files changed (79) hide show
  1. package/.prettierignore +1 -1
  2. package/CHANGELOG.md +15 -1
  3. package/README.md +22 -22
  4. package/bmad-core/agents/bmad-master.md +5 -5
  5. package/bmad-core/agents/bmad-orchestrator.md +9 -9
  6. package/bmad-core/checklists/change-checklist.md +2 -2
  7. package/bmad-core/data/bmad-kb.md +18 -18
  8. package/bmad-core/tasks/create-brownfield-story.md +2 -2
  9. package/bmad-core/tasks/create-next-story.md +2 -2
  10. package/bmad-core/tasks/kb-mode-interaction.md +13 -13
  11. package/common/utils/template-format.md +1 -1
  12. package/common/utils/workflow-management.md +1 -1
  13. package/dist/agents/analyst.txt +21 -21
  14. package/dist/agents/architect.txt +3 -3
  15. package/dist/agents/bmad-master.txt +31 -31
  16. package/dist/agents/bmad-orchestrator.txt +44 -44
  17. package/dist/agents/dev.txt +2 -2
  18. package/dist/agents/pm.txt +5 -5
  19. package/dist/agents/po.txt +5 -5
  20. package/dist/agents/qa.txt +3 -3
  21. package/dist/agents/sm.txt +5 -5
  22. package/dist/agents/ux-expert.txt +3 -3
  23. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +2 -2
  24. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +2 -2
  25. package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +2 -2
  26. package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +29 -29
  27. package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +21 -21
  28. package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +14 -14
  29. package/dist/teams/team-all.txt +48 -48
  30. package/dist/teams/team-fullstack.txt +46 -46
  31. package/dist/teams/team-ide-minimal.txt +48 -48
  32. package/dist/teams/team-no-ui.txt +46 -46
  33. package/docs/agentic-tools/claude-code-guide.md +5 -22
  34. package/docs/agentic-tools/cline-guide.md +3 -29
  35. package/docs/agentic-tools/cursor-guide.md +4 -27
  36. package/docs/agentic-tools/gemini-cli-guide.md +3 -17
  37. package/docs/agentic-tools/github-copilot-guide.md +22 -0
  38. package/docs/agentic-tools/roo-code-guide.md +2 -35
  39. package/docs/agentic-tools/windsurf-guide.md +3 -28
  40. package/docs/bmad-workflow-guide.md +8 -8
  41. package/docs/core-architecture.md +19 -184
  42. package/docs/expansion-packs.md +4 -4
  43. package/docs/how-to-contribute-with-pull-requests.md +1 -1
  44. package/docs/user-guide.md +29 -414
  45. package/docs/versions.md +4 -4
  46. package/docs/working-in-the-brownfield.md +9 -6
  47. package/expansion-packs/README.md +2 -2
  48. package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
  49. package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +3 -3
  50. package/expansion-packs/bmad-creator-tools/README.md +2 -2
  51. package/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.md +8 -8
  52. package/expansion-packs/bmad-creator-tools/config.yaml +2 -2
  53. package/expansion-packs/bmad-creator-tools/tasks/create-agent.md +1 -1
  54. package/expansion-packs/bmad-creator-tools/tasks/generate-expansion-pack.md +9 -9
  55. package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.md +1 -1
  56. package/expansion-packs/bmad-infrastructure-devops/README.md +6 -6
  57. package/expansion-packs/bmad-infrastructure-devops/checklists/infrastructure-checklist.md +1 -1
  58. package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
  59. package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +4 -4
  60. package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +4 -4
  61. package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.md +2 -2
  62. package/package.json +1 -1
  63. package/tools/bmad-npx-wrapper.js +1 -1
  64. package/tools/builders/web-builder.js +1 -1
  65. package/tools/cli.js +2 -2
  66. package/tools/installer/README.md +1 -51
  67. package/tools/installer/bin/bmad.js +9 -9
  68. package/tools/installer/config/install.config.yaml +10 -10
  69. package/tools/installer/lib/config-loader.js +2 -2
  70. package/tools/installer/lib/ide-setup.js +9 -9
  71. package/tools/installer/lib/installer.js +19 -19
  72. package/tools/installer/package.json +3 -3
  73. package/tools/md-assets/web-agent-startup-instructions.md +2 -2
  74. package/tools/upgraders/v3-to-v4-upgrader.js +2 -2
  75. package/tools/version-bump.js +1 -1
  76. package/tools/yaml-format.js +1 -1
  77. package/tools/installer/templates/claude-commands.md +0 -7
  78. package/tools/installer/templates/cursor-rules.md +0 -22
  79. package/tools/installer/templates/windsurf-rules.md +0 -22
@@ -1,6 +1,6 @@
1
- # BMAD Method Guide for Claude Code
1
+ # BMad Method Guide for Claude Code
2
2
 
3
- This guide covers Claude Code-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
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 BMAD Agents in Claude Code
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
- - Each agent supports `*help` to see available commands
36
- - Claude Code maintains excellent context within each chat
19
+ - More coming soon...
@@ -1,6 +1,6 @@
1
- # BMAD Method Guide for Cline (VS Code)
1
+ # BMad Method Guide for Cline (VS Code)
2
2
 
3
- This guide covers Cline-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
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 BMAD Agents in Cline
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
- # BMAD Method Guide for Cursor
1
+ # BMad Method Guide for Cursor
2
2
 
3
- This guide covers Cursor-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
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 BMAD Agents in Cursor
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
- # BMAD Method Guide for Gemini CLI
1
+ # BMad Method Guide for Gemini CLI
2
2
 
3
- This guide covers Gemini CLI-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
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 BMAD Agents with Gemini CLI
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,4 @@
1
- # BMAD Method Guide for Roo Code
2
-
3
- This guide covers Roo Code-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
1
+ # BMad Method Guide for Roo Code
4
2
 
5
3
  ## Installation
6
4
 
@@ -9,38 +7,7 @@ When running `npx bmad-method install`, select **Roo Code** as your IDE. This cr
9
7
  - `.bmad-core/` folder with all agents
10
8
  - `.roomodes` file in project root with custom modes
11
9
 
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
10
  ## Roo Code-Specific Features
27
11
 
28
12
  - **Mode file**: `.roomodes` in project root
29
- - **Mode switching**: Use mode selector instead of starting new chats
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
13
+ - **Mode switching**: Use mode selecto
@@ -1,6 +1,4 @@
1
- # BMAD Method Guide for Windsurf
2
-
3
- This guide covers Windsurf-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
1
+ # BMad Method Guide for Windsurf
4
2
 
5
3
  ## Installation
6
4
 
@@ -9,29 +7,6 @@ When running `npx bmad-method install`, select **Windsurf** as your IDE. This cr
9
7
  - `.bmad-core/` folder with all agents
10
8
  - `.windsurf/rules/` folder with agent rule files (`.md`)
11
9
 
12
- ## Using BMAD Agents in Windsurf
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
10
+ ## Using BMad Agents in Windsurf
34
11
 
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
12
+ Type `@agent-name` in chat to activate an agent.
@@ -1,12 +1,12 @@
1
- # BMAD Method Universal Workflow Guide
1
+ # BMad Method Universal Workflow Guide
2
2
 
3
- This guide outlines the core BMAD workflow that applies regardless of which AI-powered IDE you're using.
3
+ This guide outlines the core BMad workflow that applies regardless of which AI-powered IDE you're using.
4
4
 
5
5
  ## Overview
6
6
 
7
- The BMAD Method follows a structured approach to AI-assisted software development:
7
+ The BMad Method follows a structured approach to AI-assisted software development:
8
8
 
9
- 1. **Install BMAD** in your project
9
+ 1. **Install BMad** in your project
10
10
  2. **Plan with Gemini** using team-fullstack
11
11
  3. **Organize with bmad-master** (document sharding)
12
12
  4. **Develop iteratively** with SM → Dev cycles
@@ -15,14 +15,14 @@ The BMAD Method follows a structured approach to AI-assisted software developmen
15
15
 
16
16
  ### Phase 1: Project Setup
17
17
 
18
- 1. **Install BMAD in your project**:
18
+ 1. **Install BMad in your project**:
19
19
 
20
20
  ```bash
21
21
  npx bmad-method install
22
22
  ```
23
23
 
24
24
  - Choose "Complete installation"
25
- - Select your IDE (Cursor, Claude Code, Windsurf, Roo Code, or VS Code Copilot)
25
+ - Select your IDE (Cursor, Claude Code, Windsurf, Roo Code, or Github Copilot)
26
26
 
27
27
  2. **Verify installation**:
28
28
  - `.bmad-core/` folder created with all agents
@@ -35,7 +35,7 @@ Use Google's Gemini for collaborative planning with the full team:
35
35
 
36
36
  1. **Open [Google Gems](https://gemini.google.com/gems/view)**
37
37
  2. **Create a new Gem**:
38
- - Give it a title and description (e.g., "BMAD Team Fullstack")
38
+ - Give it a title and description (e.g., "BMad Team Fullstack")
39
39
  3. **Load team-fullstack**:
40
40
  - Copy contents of: `dist/teams/team-fullstack.txt` from your project
41
41
  - Paste this content into the Gem setup to configure the team
@@ -113,7 +113,7 @@ Follow the SM → Dev cycle for systematic story development:
113
113
  - **Cursor**: `@agent-name` (e.g., `@bmad-master`)
114
114
  - **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
115
115
  - **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
116
- - **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
116
+ - **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
117
117
 
118
118
  ### Chat Management:
119
119
 
@@ -1,24 +1,22 @@
1
- # BMAD Method: Core Architecture
2
-
3
- This document serves as the definitive source of truth for the BMAD-Method's architecture. It is designed to be understood by both human developers and the AI agents that operate within the framework.
1
+ # BMad Method: Core Architecture
4
2
 
5
3
  ## 1. Overview
6
4
 
7
- The BMAD-Method is an AI-Powered Agile Development Framework designed to transform software development by providing specialized AI agents for every role in a complete Agile team. The core purpose of the project is to provide a structured yet flexible set of prompts, templates, and workflows that users can employ to guide AI agents (like Gemini, Claude, or ChatGPT) to perform complex software development tasks in a predictable, high-quality manner.
5
+ The BMad Method is designed to provide agentic modes, tasks and templates to allow repeatable helpful workflows be it for agile agentic development, or expansion into vastly different domains. The core purpose of the project is to provide a structured yet flexible set of prompts, templates, and workflows that users can employ to guide AI agents (like Gemini, Claude, or ChatGPT) to perform complex tasks, guided discussions, or other meaningful domain specific flows in a predictable, high-quality manner.
8
6
 
9
- The system facilitates a full development lifecycle:
7
+ The systems core module facilitates a full development lifecycle tailored to the challenges of current modern AI Agentic tooling:
10
8
 
11
9
  1. **Ideation & Planning**: Brainstorming, market research, and creating project briefs.
12
10
  2. **Architecture & Design**: Defining system architecture and UI/UX specifications.
13
- 3. **Development Execution**: A cyclical workflow where a Scrum Master (SM) agent drafts stories and a Developer (Dev) agent implements them one at a time. This process works for both new (Greenfield) and existing (Brownfield) projects.
11
+ 3. **Development Execution**: A cyclical workflow where a Scrum Master (SM) agent drafts stories with extremely specific context and a Developer (Dev) agent implements them one at a time. This process works for both new (Greenfield) and existing (Brownfield) projects.
14
12
 
15
13
  ## 2. System Architecture Diagram
16
14
 
17
- The entire BMAD-Method ecosystem is designed around the `.bmad-core` directory, which acts as the brain of the operation. The `tools` directory provides the means to process and package this brain for different environments.
15
+ The entire BMad-Method ecosystem is designed around the installed `bmad-core` directory, which acts as the brain of the operation. The `tools` directory provides the means to process and package this brain for different environments.
18
16
 
19
17
  ```mermaid
20
18
  graph TD
21
- subgraph BMAD Method Project
19
+ subgraph BMad Method Project
22
20
  subgraph Core Framework
23
21
  A["bmad-core"]
24
22
  A --> B["agents"]
@@ -63,9 +61,9 @@ graph TD
63
61
 
64
62
  ## 3. Core Components
65
63
 
66
- The `.bmad-core` directory contains all the definitions and resources that give the agents their capabilities.
64
+ The `bmad-core` directory contains all the definitions and resources that give the agents their capabilities.
67
65
 
68
- ### 3.1. Agents (`.bmad-core/agents/`)
66
+ ### 3.1. Agents (`bmad-core/agents/`)
69
67
 
70
68
  - **Purpose**: These are the foundational building blocks of the system. Each markdown file (e.g., `bmad-master.md`, `pm.md`, `dev.md`) defines the persona, capabilities, and dependencies of a single AI agent.
71
69
  - **Structure**: An agent file contains a YAML header that specifies its role, persona, dependencies, and startup instructions. These dependencies are lists of tasks, templates, checklists, and data files that the agent is allowed to use.
@@ -73,12 +71,12 @@ The `.bmad-core` directory contains all the definitions and resources that give
73
71
  - **Document Integration**: Agents can reference and load documents from the project's `docs/` folder as part of tasks, workflows, or startup sequences. Users can also drag documents directly into chat interfaces to provide additional context.
74
72
  - **Example**: The `bmad-master` agent lists its dependencies, which tells the build tool which files to include in a web bundle and informs the agent of its own capabilities.
75
73
 
76
- ### 3.2. Agent Teams (`.bmad-core/agent-teams/`)
74
+ ### 3.2. Agent Teams (`bmad-core/agent-teams/`)
77
75
 
78
76
  - **Purpose**: Team files (e.g., `team-all.yaml`) define collections of agents and workflows that are bundled together for a specific purpose, like "full-stack development" or "backend-only". This creates a larger, pre-packaged context for web UI environments.
79
77
  - **Structure**: A team file lists the agents to include. It can use wildcards, such as `"*"` to include all agents. This allows for the creation of comprehensive bundles like `team-all`.
80
78
 
81
- ### 3.3. Workflows (`.bmad-core/workflows/`)
79
+ ### 3.3. Workflows (`bmad-core/workflows/`)
82
80
 
83
81
  - **Purpose**: Workflows are YAML files (e.g., `greenfield-fullstack.yaml`) that define a prescribed sequence of steps and agent interactions for a specific project type. They act as a strategic guide for the user and the `bmad-orchestrator` agent.
84
82
  - **Structure**: A workflow defines sequences for both complex and simple projects, lists the agents involved at each step, the artifacts they create, and the conditions for moving from one step to the next. It often includes a Mermaid diagram for visualization.
@@ -93,21 +91,21 @@ The `.bmad-core` directory contains all the definitions and resources that give
93
91
 
94
92
  #### 3.4.1. Template Processing System
95
93
 
96
- A key architectural principle of BMAD is that templates are self-contained and interactive - they embed both the desired document output and the LLM instructions needed to work with users. This means that in many cases, no separate task is needed for document creation, as the template itself contains all the processing logic.
94
+ A key architectural principle of BMad is that templates are self-contained and interactive - they embed both the desired document output and the LLM instructions needed to work with users. This means that in many cases, no separate task is needed for document creation, as the template itself contains all the processing logic.
97
95
 
98
- The BMAD framework employs a sophisticated template processing system orchestrated by three key components:
96
+ The BMad framework employs a sophisticated template processing system orchestrated by three key components:
99
97
 
100
- - **`template-format.md`** (`.bmad-core/utils/`): Defines the foundational markup language used throughout all BMAD templates. This specification establishes syntax rules for variable substitution (`{{placeholders}}`), AI-only processing directives (`[[LLM: instructions]]`), and conditional logic blocks. Templates follow this format to ensure consistent processing across the system.
98
+ - **`template-format.md`** (`bmad-core/utils/`): Defines the foundational markup language used throughout all BMad templates. This specification establishes syntax rules for variable substitution (`{{placeholders}}`), AI-only processing directives (`[[LLM: instructions]]`), and conditional logic blocks. Templates follow this format to ensure consistent processing across the system.
101
99
 
102
- - **`create-doc.md`** (`.bmad-core/tasks/`): Acts as the orchestration engine that manages the entire document generation workflow. This task coordinates template selection, manages user interaction modes (incremental vs. rapid generation), enforces template-format processing rules, and handles validation. It serves as the primary interface between users and the template system.
100
+ - **`create-doc.md`** (`bmad-core/tasks/`): Acts as the orchestration engine that manages the entire document generation workflow. This task coordinates template selection, manages user interaction modes (incremental vs. rapid generation), enforces template-format processing rules, and handles validation. It serves as the primary interface between users and the template system.
103
101
 
104
- - **`advanced-elicitation.md`** (`.bmad-core/tasks/`): Provides an interactive refinement layer that can be embedded within templates through `[[LLM: instructions]]` blocks. This component offers 10 structured brainstorming actions, section-by-section review capabilities, and iterative improvement workflows to enhance content quality.
102
+ - **`advanced-elicitation.md`** (`bmad-core/tasks/`): Provides an interactive refinement layer that can be embedded within templates through `[[LLM: instructions]]` blocks. This component offers 10 structured brainstorming actions, section-by-section review capabilities, and iterative improvement workflows to enhance content quality.
105
103
 
106
104
  The system maintains a clean separation of concerns: template markup is processed internally by AI agents but never exposed to users, while providing sophisticated AI processing capabilities through embedded intelligence within the templates themselves.
107
105
 
108
106
  #### 3.4.2. Technical Preferences System
109
107
 
110
- BMAD includes a personalization layer through the `technical-preferences.md` file in `.bmad-core/data/`. This file serves as a persistent technical profile that influences agent behavior across all projects.
108
+ BMad includes a personalization layer through the `technical-preferences.md` file in `bmad-core/data/`. This file serves as a persistent technical profile that influences agent behavior across all projects.
111
109
 
112
110
  **Purpose and Benefits:**
113
111
 
@@ -144,14 +142,14 @@ The framework is designed for two primary environments: local IDEs and web-based
144
142
 
145
143
  ### 4.2. Environment-Specific Usage
146
144
 
147
- - **For IDEs**: Users interact with the agents directly via their markdown files in `.bmad-core/agents/`. The IDE integration (for Cursor, Claude Code, etc.) knows how to call these agents.
145
+ - **For IDEs**: Users interact with the agents directly via their markdown files in `bmad-core/agents/`. The IDE integration (for Cursor, Claude Code, etc.) knows how to call these agents.
148
146
  - **For Web UIs**: Users upload a pre-built bundle from `dist`. This single file provides the AI with the context of the entire team and all their required tools and knowledge.
149
147
 
150
- ## 5. BMAD Workflows
148
+ ## 5. BMad Workflows
151
149
 
152
150
  ### 5.1. The Planning Workflow
153
151
 
154
- Before development begins, BMAD follows a structured planning workflow that establishes the foundation for successful project execution:
152
+ Before development begins, BMad follows a structured planning workflow that establishes the foundation for successful project execution:
155
153
 
156
154
  ```mermaid
157
155
  graph TD
@@ -219,166 +217,3 @@ graph TD
219
217
  ```
220
218
 
221
219
  This cycle continues, with the Scrum Master, Developer, and optionally QA agents working together. The QA agent provides senior developer review capabilities through the `review-story` task, offering code refactoring, quality improvements, and knowledge transfer. This ensures high code quality while maintaining development velocity.
222
-
223
- ## 8. Complete Source Tree
224
-
225
- The BMAD-METHOD project structure is designed for clarity, modularity, and extensibility. Here's the complete source tree with explanations:
226
-
227
- ```plaintext
228
- bmad-method/
229
- ├── .bmad-core/ # Core framework (installed in user projects)
230
- │ ├── agents/ # Individual agent definitions
231
- │ │ ├── analyst.md # Business analyst agent
232
- │ │ ├── architect.md # Solution architect agent
233
- │ │ ├── bmad-master.md # Universal expert agent
234
- │ │ ├── bmad-orchestrator.md # Multi-agent coordinator
235
- │ │ ├── dev.md # Full-stack developer agent
236
- │ │ ├── pm.md # Product manager agent
237
- │ │ ├── po.md # Product owner agent
238
- │ │ ├── qa.md # QA specialist agent
239
- │ │ ├── sm.md # Scrum master agent
240
- │ │ └── ux-expert.md # UX designer agent
241
- │ ├── agent-teams/ # Pre-configured agent teams
242
- │ │ ├── team-all.yaml # All agents bundle
243
- │ │ ├── team-fullstack.yaml # Full-stack development team
244
- │ │ ├── team-ide-minimal.yaml # Minimal IDE-focused team
245
- │ │ └── team-no-ui.yaml # Backend-only team
246
- │ ├── checklists/ # Quality assurance checklists
247
- │ │ ├── architect-checklist.md
248
- │ │ ├── po-master-checklist.md
249
- │ │ └── story-dod-checklist.md
250
- │ ├── data/ # Knowledge base and preferences
251
- │ │ ├── bmad-kb.md # Core knowledge base
252
- │ │ └── technical-preferences.md # User tech preferences
253
- │ ├── tasks/ # Reusable task definitions
254
- │ │ ├── advanced-elicitation.md # Deep diving techniques
255
- │ │ ├── create-doc.md # Document creation task
256
- │ │ ├── create-next-story.md # Story generation task
257
- │ │ ├── doc-migration-task.md # V3 to V4 migration
258
- │ │ ├── execute-checklist.md # Checklist runner
259
- │ │ └── shard-doc.md # Document sharding task
260
- │ ├── templates/ # Document templates
261
- │ │ ├── full-stack-architecture-tmpl.md
262
- │ │ ├── prd-tmpl.md
263
- │ │ ├── project-brief-tmpl.md
264
- │ │ ├── story-tmpl.md
265
- │ │ └── [other templates...]
266
- │ ├── utils/ # Utility components
267
- │ │ ├── agent-switcher.web # Web UI agent switching
268
- │ │ ├── template-format.md # Template markup spec
269
- │ │ └── workflow-management.md # Workflow helpers
270
- │ ├── workflows/ # Development workflows
271
- │ │ ├── brownfield-enhancement.yaml
272
- │ │ ├── greenfield-fullstack.yaml
273
- │ │ ├── greenfield-service.yaml
274
- │ │ └── greenfield-simple.yaml
275
- │ └── core-config.yaml # V4 configuration system
276
-
277
- ├── dist/ # Pre-built bundles (generated)
278
- │ ├── agents/ # Individual agent bundles
279
- │ │ ├── analyst.txt
280
- │ │ ├── architect.txt
281
- │ │ └── [other agents...]
282
- │ ├── teams/ # Team bundles for web UI
283
- │ │ ├── team-all.txt
284
- │ │ ├── team-fullstack.txt
285
- │ │ └── [other teams...]
286
- │ └── expansion-packs/ # Expansion pack bundles
287
-
288
- ├── docs/ # Documentation
289
- │ ├── agentic-tools/ # IDE-specific guides
290
- │ │ ├── claude-code-guide.md
291
- │ │ ├── cursor-guide.md
292
- │ │ ├── cline-guide.md
293
- │ │ ├── gemini-cli-guide.md
294
- │ │ ├── roo-code-guide.md
295
- │ │ ├── windsurf-guide.md
296
- │ │ └── vs-code-copilot-guide.md
297
- │ ├── bmad-workflow-guide.md # Universal workflow guide
298
- │ ├── core-architecture.md # This document
299
- │ ├── expansion-packs.md # Expansion pack guide
300
- │ ├── user-guide.md # Comprehensive user guide
301
- │ └── [other docs...]
302
-
303
- ├── expansion-packs/ # Domain-specific extensions
304
- │ ├── bmad-2d-phaser-game-dev/ # Game development pack
305
- │ ├── bmad-creator-tools/ # Agent creation tools
306
- │ ├── bmad-infrastructure-devops/ # DevOps pack
307
- │ └── README.md
308
-
309
- ├── tools/ # Build and installation tools
310
- │ ├── builders/ # Build system
311
- │ │ └── web-builder.js # Bundle generator
312
- │ ├── cli.js # Main CLI tool
313
- │ ├── installer/ # NPX installer
314
- │ │ ├── index.js # Installer entry point
315
- │ │ ├── config/ # Installation configs
316
- │ │ ├── lib/ # Installer utilities
317
- │ │ └── templates/ # IDE template files
318
- │ └── lib/ # Shared libraries
319
- │ ├── bundle-utils.js
320
- │ ├── dependency-resolver.js
321
- │ └── file-processor.js
322
-
323
- ├── .github/ # GitHub configuration
324
- │ ├── workflows/ # GitHub Actions
325
- │ └── ISSUE_TEMPLATE/ # Issue templates
326
-
327
- ├── common/ # Shared resources
328
- │ ├── tasks/ # Common tasks
329
- │ └── utils/ # Common utilities
330
-
331
- ├── bmad-core/ # Source for .bmad-core
332
- │ └── [mirrors .bmad-core structure]
333
-
334
- ├── package.json # Node.js configuration
335
- ├── README.md # Project readme
336
- ├── CONTRIBUTING.md # Contribution guidelines
337
- ├── GUIDING-PRINCIPLES.md # Core principles
338
- └── LICENSE # MIT license
339
- ```
340
-
341
- ### Directory Purposes
342
-
343
- #### Core Framework (.bmad-core/)
344
-
345
- - **agents/**: Individual AI agent personalities and capabilities
346
- - **agent-teams/**: Bundles of agents for specific workflows
347
- - **checklists/**: Quality assurance and validation steps
348
- - **data/**: Knowledge base and user preferences
349
- - **tasks/**: Reusable procedures agents can execute
350
- - **templates/**: Document templates with embedded AI instructions
351
- - **utils/**: Helper components for agents
352
- - **workflows/**: Structured development processes
353
-
354
- #### Generated Bundles (dist/)
355
-
356
- - Pre-built text files ready for web UI upload
357
- - Automatically generated by the build system
358
- - Includes resolved dependencies for each agent/team
359
-
360
- #### Tools (tools/)
361
-
362
- - **cli.js**: Main build tool for creating bundles
363
- - **installer/**: NPX-based installer for projects
364
- - **builders/**: Bundle generation logic
365
- - **lib/**: Shared utilities for build system
366
-
367
- #### Expansion Packs (expansion-packs/)
368
-
369
- - Domain-specific agent collections
370
- - Extend BMAD beyond software development
371
- - Each pack is self-contained with its own agents, tasks, and templates
372
-
373
- #### Documentation (docs/)
374
-
375
- - Comprehensive guides for users
376
- - Technical architecture documentation
377
- - IDE-specific setup instructions
378
-
379
- ### Key Files
380
-
381
- - **core-config.yaml**: V4's flexible configuration system
382
- - **bmad-kb.md**: Central knowledge base loaded by most agents
383
- - **template-format.md**: Specification for BMAD's template markup
384
- - **dependency-resolver.js**: Manages agent resource loading
@@ -1,14 +1,14 @@
1
- # The Power of BMAD Expansion Packs
1
+ # The Power of BMad Expansion Packs
2
2
 
3
3
  ## Overview
4
4
 
5
- BMAD Method's expansion packs unlock the framework's true potential by extending its natural language AI orchestration to ANY domain. While the core framework focuses on software development, expansion packs transform BMAD into a universal AI agent system.
5
+ BMad Method's expansion packs unlock the framework's true potential by extending its natural language AI orchestration to ANY domain. While the core framework focuses on software development, expansion packs transform BMad into a universal AI agent system.
6
6
 
7
7
  ## Why Expansion Packs?
8
8
 
9
9
  ### Keep Core Lean
10
10
 
11
- The core BMAD framework maintains its focus on software development, ensuring dev agents have maximum context for coding. Expansion packs handle everything else.
11
+ The core BMad framework maintains its focus on software development, ensuring dev agents have maximum context for coding. Expansion packs handle everything else.
12
12
 
13
13
  ### Domain Expertise
14
14
 
@@ -275,6 +275,6 @@ Every expansion pack:
275
275
 
276
276
  ## Remember
277
277
 
278
- The BMAD Method is more than a development framework - it's a platform for structuring human expertise into AI-accessible formats. Every expansion pack you create makes specialized knowledge more accessible to everyone.
278
+ The BMad Method is more than a development framework - it's a platform for structuring human expertise into AI-accessible formats. Every expansion pack you create makes specialized knowledge more accessible to everyone.
279
279
 
280
280
  **What expertise will you share with the world?**
@@ -22,7 +22,7 @@ A pull request (PR) is how you propose changes to a project on GitHub. Think of
22
22
 
23
23
  ### 1. Fork the Repository
24
24
 
25
- 1. Go to the [BMAD-METHOD repository](https://github.com/bmadcode/bmad-method)
25
+ 1. Go to the [BMad-Method repository](https://github.com/bmadcode/bmad-method)
26
26
  2. Click the "Fork" button in the top-right corner
27
27
  3. This creates your own copy of the project
28
28