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.
- package/.prettierignore +1 -1
- package/CHANGELOG.md +15 -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 +19 -19
- 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/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/dist/agents/analyst.txt
CHANGED
|
@@ -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
|
|
|
@@ -1950,11 +1950,11 @@ These replace the standard elicitation options when working on competitive analy
|
|
|
1950
1950
|
==================== END: templates#competitor-analysis-tmpl ====================
|
|
1951
1951
|
|
|
1952
1952
|
==================== START: data#bmad-kb ====================
|
|
1953
|
-
#
|
|
1953
|
+
# BMad Knowledge Base
|
|
1954
1954
|
|
|
1955
1955
|
## Overview
|
|
1956
1956
|
|
|
1957
|
-
|
|
1957
|
+
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.
|
|
1958
1958
|
|
|
1959
1959
|
### Key Features
|
|
1960
1960
|
|
|
@@ -1964,7 +1964,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
1964
1964
|
- **Reusable Resources**: Portable templates, tasks, and checklists
|
|
1965
1965
|
- **Slash Command Integration**: Quick agent switching and control
|
|
1966
1966
|
|
|
1967
|
-
### When to Use
|
|
1967
|
+
### When to Use BMad
|
|
1968
1968
|
|
|
1969
1969
|
- **New Projects (Greenfield)**: Complete end-to-end development
|
|
1970
1970
|
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
|
@@ -1972,11 +1972,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
1972
1972
|
- **Quality Assurance**: Structured testing and validation
|
|
1973
1973
|
- **Documentation**: Professional PRDs, architecture docs, user stories
|
|
1974
1974
|
|
|
1975
|
-
## How
|
|
1975
|
+
## How BMad Works
|
|
1976
1976
|
|
|
1977
1977
|
### The Core Method
|
|
1978
1978
|
|
|
1979
|
-
|
|
1979
|
+
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
|
1980
1980
|
|
|
1981
1981
|
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
|
1982
1982
|
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
|
@@ -2030,7 +2030,7 @@ BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|
|
2030
2030
|
5. Type `/help` to see available commands
|
|
2031
2031
|
|
|
2032
2032
|
#### Option 2: IDE Integration
|
|
2033
|
-
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code,
|
|
2033
|
+
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
|
2034
2034
|
|
|
2035
2035
|
```bash
|
|
2036
2036
|
# Interactive installation (recommended)
|
|
@@ -2045,16 +2045,16 @@ npx bmad-method install
|
|
|
2045
2045
|
- **Windsurf**: Built-in AI capabilities
|
|
2046
2046
|
- **Cline**: VS Code extension with AI features
|
|
2047
2047
|
- **Roo Code**: Web-based IDE with agent support
|
|
2048
|
-
- **
|
|
2048
|
+
- **Github Copilot**: AI-powered coding assistant
|
|
2049
2049
|
|
|
2050
|
-
**Note for VS Code Users**:
|
|
2050
|
+
**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.
|
|
2051
2051
|
|
|
2052
2052
|
**Verify Installation**:
|
|
2053
2053
|
- `.bmad-core/` folder created with all agents
|
|
2054
2054
|
- IDE-specific integration files created
|
|
2055
2055
|
- All agent commands/rules/modes available
|
|
2056
2056
|
|
|
2057
|
-
**Remember**: At its core,
|
|
2057
|
+
**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
|
|
2058
2058
|
|
|
2059
2059
|
### Environment Selection Guide
|
|
2060
2060
|
|
|
@@ -2115,11 +2115,11 @@ npx bmad-method install
|
|
|
2115
2115
|
|
|
2116
2116
|
## Core Configuration (core-config.yaml)
|
|
2117
2117
|
|
|
2118
|
-
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables
|
|
2118
|
+
**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.
|
|
2119
2119
|
|
|
2120
2120
|
### What is core-config.yaml?
|
|
2121
2121
|
|
|
2122
|
-
This configuration file acts as a map for
|
|
2122
|
+
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:
|
|
2123
2123
|
|
|
2124
2124
|
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
|
2125
2125
|
- **Custom Locations**: Define where your documents and shards live
|
|
@@ -2148,7 +2148,7 @@ This configuration file acts as a map for BMAD agents, telling them exactly wher
|
|
|
2148
2148
|
|
|
2149
2149
|
1. **No Forced Migrations**: Keep your existing document structure
|
|
2150
2150
|
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
|
2151
|
-
3. **Custom Workflows**: Configure
|
|
2151
|
+
3. **Custom Workflows**: Configure BMad to match your team's process
|
|
2152
2152
|
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
|
2153
2153
|
|
|
2154
2154
|
### Common Configurations
|
|
@@ -2231,7 +2231,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
2231
2231
|
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
2232
2232
|
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
|
2233
2233
|
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
|
2234
|
-
- **
|
|
2234
|
+
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
|
2235
2235
|
|
|
2236
2236
|
**Chat Management Guidelines**:
|
|
2237
2237
|
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
|
@@ -2277,7 +2277,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
2277
2277
|
|
|
2278
2278
|
### System Overview
|
|
2279
2279
|
|
|
2280
|
-
The
|
|
2280
|
+
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).
|
|
2281
2281
|
|
|
2282
2282
|
### Key Architectural Components
|
|
2283
2283
|
|
|
@@ -2321,7 +2321,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
|
|
2321
2321
|
|
|
2322
2322
|
### Template Processing System
|
|
2323
2323
|
|
|
2324
|
-
|
|
2324
|
+
BMad employs a sophisticated template system with three key components:
|
|
2325
2325
|
|
|
2326
2326
|
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
|
2327
2327
|
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
|
@@ -2350,7 +2350,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
|
|
2350
2350
|
3. Concatenating content into single text files with clear separators
|
|
2351
2351
|
4. Outputting ready-to-upload bundles for web AI interfaces
|
|
2352
2352
|
|
|
2353
|
-
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes
|
|
2353
|
+
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
|
2354
2354
|
|
|
2355
2355
|
## Complete Development Workflow
|
|
2356
2356
|
|
|
@@ -2611,7 +2611,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|
|
2611
2611
|
- **Keep conversations focused** - One agent, one task per conversation
|
|
2612
2612
|
- **Review everything** - Always review and approve before marking complete
|
|
2613
2613
|
|
|
2614
|
-
## Contributing to
|
|
2614
|
+
## Contributing to BMad-Method
|
|
2615
2615
|
|
|
2616
2616
|
### Quick Contribution Guidelines
|
|
2617
2617
|
|
|
@@ -2640,7 +2640,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
|
|
2640
2640
|
|
|
2641
2641
|
### What Are Expansion Packs?
|
|
2642
2642
|
|
|
2643
|
-
Expansion packs extend
|
|
2643
|
+
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.
|
|
2644
2644
|
|
|
2645
2645
|
### Why Use Expansion Packs?
|
|
2646
2646
|
|
|
@@ -2704,7 +2704,7 @@ Use the **expansion-creator** pack to build your own:
|
|
|
2704
2704
|
==================== START: utils#template-format ====================
|
|
2705
2705
|
# Template Format Conventions
|
|
2706
2706
|
|
|
2707
|
-
Templates in the
|
|
2707
|
+
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
|
2708
2708
|
|
|
2709
2709
|
## Template Markup Elements
|
|
2710
2710
|
|
|
@@ -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
|
|
|
@@ -3896,7 +3896,7 @@ None Listed
|
|
|
3896
3896
|
==================== START: utils#template-format ====================
|
|
3897
3897
|
# Template Format Conventions
|
|
3898
3898
|
|
|
3899
|
-
Templates in the
|
|
3899
|
+
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
|
3900
3900
|
|
|
3901
3901
|
## Template Markup Elements
|
|
3902
3902
|
|
|
@@ -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
|
|
|
@@ -47,18 +47,18 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
|
|
|
47
47
|
agent:
|
|
48
48
|
name: BMad Master
|
|
49
49
|
id: bmad-master
|
|
50
|
-
title:
|
|
50
|
+
title: BMad Master Task Executor
|
|
51
51
|
icon: 🧙
|
|
52
52
|
whenToUse: Use when you need comprehensive expertise across all domains or rapid context switching between multiple agent capabilities
|
|
53
53
|
persona:
|
|
54
|
-
role: Master Task Executor &
|
|
55
|
-
style: Efficient, direct, action-oriented. Executes any
|
|
56
|
-
identity: Universal executor of all
|
|
54
|
+
role: Master Task Executor & BMad Method Expert
|
|
55
|
+
style: Efficient, direct, action-oriented. Executes any BMad task/template/util/checklist with precision
|
|
56
|
+
identity: Universal executor of all BMad-Method capabilities, directly runs any resource
|
|
57
57
|
focus: Direct execution without transformation, load resources only when needed
|
|
58
58
|
core_principles:
|
|
59
59
|
- Execute any resource directly without persona transformation
|
|
60
60
|
- Load resources at runtime, never pre-load
|
|
61
|
-
- Expert knowledge of all
|
|
61
|
+
- Expert knowledge of all BMad resources
|
|
62
62
|
- Track execution state and guide multi-step processes
|
|
63
63
|
- Use numbered lists for choices
|
|
64
64
|
- Process (*) commands immediately
|
|
@@ -1903,8 +1903,8 @@ To identify the next logical story based on project progress and epic definition
|
|
|
1903
1903
|
- Load `.bmad-core/core-config.yaml` from the project root
|
|
1904
1904
|
- If the file does not exist:
|
|
1905
1905
|
- HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can:
|
|
1906
|
-
1. Copy it from GITHUB
|
|
1907
|
-
2. Run the
|
|
1906
|
+
1. Copy it from GITHUB BMad-Method/bmad-core/core-config.yaml and configure it for your project
|
|
1907
|
+
2. Run the BMad installer against your project to upgrade and add the file automatically
|
|
1908
1908
|
Please add and configure core-config.yaml before proceeding."
|
|
1909
1909
|
- Extract the following key configurations:
|
|
1910
1910
|
- `devStoryLocation`: Where to save story files
|
|
@@ -7673,7 +7673,7 @@ After presenting the report, ask the user if they would like detailed analysis o
|
|
|
7673
7673
|
==================== START: checklists#change-checklist ====================
|
|
7674
7674
|
# Change Navigation Checklist
|
|
7675
7675
|
|
|
7676
|
-
**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
|
|
7676
|
+
**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.
|
|
7677
7677
|
|
|
7678
7678
|
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
|
7679
7679
|
|
|
@@ -7748,7 +7748,7 @@ Think about both immediate and downstream effects.]]
|
|
|
7748
7748
|
|
|
7749
7749
|
## 3. Artifact Conflict & Impact Analysis
|
|
7750
7750
|
|
|
7751
|
-
[[LLM: Documentation drives development in
|
|
7751
|
+
[[LLM: Documentation drives development in BMad. Check each artifact:
|
|
7752
7752
|
|
|
7753
7753
|
1. Does this change invalidate documented decisions?
|
|
7754
7754
|
2. Are architectural assumptions still valid?
|
|
@@ -8941,11 +8941,11 @@ Be pragmatic - perfect documentation doesn't exist. Focus on whether a competent
|
|
|
8941
8941
|
==================== END: checklists#story-draft-checklist ====================
|
|
8942
8942
|
|
|
8943
8943
|
==================== START: data#bmad-kb ====================
|
|
8944
|
-
#
|
|
8944
|
+
# BMad Knowledge Base
|
|
8945
8945
|
|
|
8946
8946
|
## Overview
|
|
8947
8947
|
|
|
8948
|
-
|
|
8948
|
+
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.
|
|
8949
8949
|
|
|
8950
8950
|
### Key Features
|
|
8951
8951
|
|
|
@@ -8955,7 +8955,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
8955
8955
|
- **Reusable Resources**: Portable templates, tasks, and checklists
|
|
8956
8956
|
- **Slash Command Integration**: Quick agent switching and control
|
|
8957
8957
|
|
|
8958
|
-
### When to Use
|
|
8958
|
+
### When to Use BMad
|
|
8959
8959
|
|
|
8960
8960
|
- **New Projects (Greenfield)**: Complete end-to-end development
|
|
8961
8961
|
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
|
@@ -8963,11 +8963,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
|
|
8963
8963
|
- **Quality Assurance**: Structured testing and validation
|
|
8964
8964
|
- **Documentation**: Professional PRDs, architecture docs, user stories
|
|
8965
8965
|
|
|
8966
|
-
## How
|
|
8966
|
+
## How BMad Works
|
|
8967
8967
|
|
|
8968
8968
|
### The Core Method
|
|
8969
8969
|
|
|
8970
|
-
|
|
8970
|
+
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
|
8971
8971
|
|
|
8972
8972
|
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
|
8973
8973
|
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
|
@@ -9021,7 +9021,7 @@ BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
|
|
9021
9021
|
5. Type `/help` to see available commands
|
|
9022
9022
|
|
|
9023
9023
|
#### Option 2: IDE Integration
|
|
9024
|
-
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code,
|
|
9024
|
+
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
|
9025
9025
|
|
|
9026
9026
|
```bash
|
|
9027
9027
|
# Interactive installation (recommended)
|
|
@@ -9036,16 +9036,16 @@ npx bmad-method install
|
|
|
9036
9036
|
- **Windsurf**: Built-in AI capabilities
|
|
9037
9037
|
- **Cline**: VS Code extension with AI features
|
|
9038
9038
|
- **Roo Code**: Web-based IDE with agent support
|
|
9039
|
-
- **
|
|
9039
|
+
- **Github Copilot**: AI-powered coding assistant
|
|
9040
9040
|
|
|
9041
|
-
**Note for VS Code Users**:
|
|
9041
|
+
**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.
|
|
9042
9042
|
|
|
9043
9043
|
**Verify Installation**:
|
|
9044
9044
|
- `.bmad-core/` folder created with all agents
|
|
9045
9045
|
- IDE-specific integration files created
|
|
9046
9046
|
- All agent commands/rules/modes available
|
|
9047
9047
|
|
|
9048
|
-
**Remember**: At its core,
|
|
9048
|
+
**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
|
|
9049
9049
|
|
|
9050
9050
|
### Environment Selection Guide
|
|
9051
9051
|
|
|
@@ -9106,11 +9106,11 @@ npx bmad-method install
|
|
|
9106
9106
|
|
|
9107
9107
|
## Core Configuration (core-config.yaml)
|
|
9108
9108
|
|
|
9109
|
-
**New in V4**: The `bmad-core/core-config.yaml` file is a critical innovation that enables
|
|
9109
|
+
**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.
|
|
9110
9110
|
|
|
9111
9111
|
### What is core-config.yaml?
|
|
9112
9112
|
|
|
9113
|
-
This configuration file acts as a map for
|
|
9113
|
+
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:
|
|
9114
9114
|
|
|
9115
9115
|
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
|
9116
9116
|
- **Custom Locations**: Define where your documents and shards live
|
|
@@ -9139,7 +9139,7 @@ This configuration file acts as a map for BMAD agents, telling them exactly wher
|
|
|
9139
9139
|
|
|
9140
9140
|
1. **No Forced Migrations**: Keep your existing document structure
|
|
9141
9141
|
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
|
9142
|
-
3. **Custom Workflows**: Configure
|
|
9142
|
+
3. **Custom Workflows**: Configure BMad to match your team's process
|
|
9143
9143
|
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
|
9144
9144
|
|
|
9145
9145
|
### Common Configurations
|
|
@@ -9222,7 +9222,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
9222
9222
|
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
9223
9223
|
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
|
9224
9224
|
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
|
9225
|
-
- **
|
|
9225
|
+
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
|
9226
9226
|
|
|
9227
9227
|
**Chat Management Guidelines**:
|
|
9228
9228
|
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
|
@@ -9268,7 +9268,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
|
|
9268
9268
|
|
|
9269
9269
|
### System Overview
|
|
9270
9270
|
|
|
9271
|
-
The
|
|
9271
|
+
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).
|
|
9272
9272
|
|
|
9273
9273
|
### Key Architectural Components
|
|
9274
9274
|
|
|
@@ -9312,7 +9312,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
|
|
9312
9312
|
|
|
9313
9313
|
### Template Processing System
|
|
9314
9314
|
|
|
9315
|
-
|
|
9315
|
+
BMad employs a sophisticated template system with three key components:
|
|
9316
9316
|
|
|
9317
9317
|
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
|
9318
9318
|
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
|
@@ -9341,7 +9341,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
|
|
9341
9341
|
3. Concatenating content into single text files with clear separators
|
|
9342
9342
|
4. Outputting ready-to-upload bundles for web AI interfaces
|
|
9343
9343
|
|
|
9344
|
-
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes
|
|
9344
|
+
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
|
9345
9345
|
|
|
9346
9346
|
## Complete Development Workflow
|
|
9347
9347
|
|
|
@@ -9602,7 +9602,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
|
|
9602
9602
|
- **Keep conversations focused** - One agent, one task per conversation
|
|
9603
9603
|
- **Review everything** - Always review and approve before marking complete
|
|
9604
9604
|
|
|
9605
|
-
## Contributing to
|
|
9605
|
+
## Contributing to BMad-Method
|
|
9606
9606
|
|
|
9607
9607
|
### Quick Contribution Guidelines
|
|
9608
9608
|
|
|
@@ -9631,7 +9631,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
|
|
9631
9631
|
|
|
9632
9632
|
### What Are Expansion Packs?
|
|
9633
9633
|
|
|
9634
|
-
Expansion packs extend
|
|
9634
|
+
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.
|
|
9635
9635
|
|
|
9636
9636
|
### Why Use Expansion Packs?
|
|
9637
9637
|
|
|
@@ -9927,7 +9927,7 @@ Would you like to:
|
|
|
9927
9927
|
==================== START: utils#template-format ====================
|
|
9928
9928
|
# Template Format Conventions
|
|
9929
9929
|
|
|
9930
|
-
Templates in the
|
|
9930
|
+
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
|
9931
9931
|
|
|
9932
9932
|
## Template Markup Elements
|
|
9933
9933
|
|
|
@@ -9956,7 +9956,7 @@ Templates in the BMAD method use standardized markup for AI processing. These co
|
|
|
9956
9956
|
==================== START: utils#workflow-management ====================
|
|
9957
9957
|
# Workflow Management
|
|
9958
9958
|
|
|
9959
|
-
Enables
|
|
9959
|
+
Enables BMad orchestrator to manage and execute team workflows.
|
|
9960
9960
|
|
|
9961
9961
|
## Dynamic Workflow Loading
|
|
9962
9962
|
|