bmad-method 4.30.4 → 4.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.vscode/settings.json +1 -7
- package/CHANGELOG.md +117 -170
- package/README.md +46 -7
- package/bmad-core/agents/analyst.md +1 -1
- package/bmad-core/agents/architect.md +2 -3
- package/bmad-core/agents/bmad-master.md +0 -1
- package/bmad-core/agents/bmad-orchestrator.md +9 -10
- package/bmad-core/agents/dev.md +1 -2
- package/bmad-core/agents/pm.md +3 -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/bmad-core/user-guide.md +0 -0
- package/bmad-core/data/bmad-kb.md +12 -2
- package/bmad-core/data/elicitation-methods.md +20 -0
- package/bmad-core/enhanced-ide-development-workflow.md +43 -0
- package/bmad-core/tasks/advanced-elicitation.md +2 -0
- package/bmad-core/tasks/create-brownfield-story.md +20 -3
- package/bmad-core/tasks/document-project.md +19 -13
- package/bmad-core/tasks/facilitate-brainstorming-session.md +1 -1
- package/bmad-core/tasks/index-docs.md +0 -1
- package/bmad-core/tasks/kb-mode-interaction.md +3 -3
- package/bmad-core/tasks/review-story.md +18 -1
- package/bmad-core/user-guide.md +251 -0
- package/{docs → bmad-core}/working-in-the-brownfield.md +39 -36
- package/dist/agents/analyst.txt +6 -6
- package/dist/agents/architect.txt +8 -3
- package/dist/agents/bmad-master.txt +2 -1
- package/dist/agents/pm.txt +9 -2
- package/dist/agents/po.txt +2 -318
- package/dist/agents/qa.txt +0 -1
- package/dist/agents/sm.txt +3 -3
- package/dist/agents/ux-expert.txt +2 -297
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +6 -6
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.txt +4047 -0
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.txt +1520 -185
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.txt +214 -1229
- package/dist/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.txt +537 -373
- package/dist/expansion-packs/bmad-2d-unity-game-dev/teams/unity-2d-game-team.txt +6917 -2140
- package/dist/teams/team-all.txt +30 -25
- package/dist/teams/team-fullstack.txt +27 -21
- package/dist/teams/team-ide-minimal.txt +5 -322
- package/dist/teams/team-no-ui.txt +25 -16
- package/expansion-packs/bmad-2d-phaser-game-dev/data/development-guidelines.md +3 -1
- package/expansion-packs/bmad-2d-unity-game-dev/agent-teams/unity-2d-game-team.yaml +1 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-architect.md +80 -0
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-designer.md +21 -16
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-developer.md +25 -25
- package/expansion-packs/bmad-2d-unity-game-dev/agents/game-sm.md +15 -14
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-architect-checklist.md +396 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-change-checklist.md +203 -0
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-design-checklist.md +1 -1
- package/expansion-packs/bmad-2d-unity-game-dev/checklists/game-story-dod-checklist.md +93 -121
- package/expansion-packs/bmad-2d-unity-game-dev/config.yaml +1 -1
- package/expansion-packs/bmad-2d-unity-game-dev/data/bmad-kb.md +593 -68
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/correct-course-game.md +151 -0
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/create-game-story.md +165 -198
- package/expansion-packs/bmad-2d-unity-game-dev/tasks/validate-game-story.md +200 -0
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-architecture-tmpl.yaml +938 -453
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-brief-tmpl.yaml +3 -3
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-design-doc-tmpl.yaml +517 -155
- package/expansion-packs/bmad-2d-unity-game-dev/templates/game-story-tmpl.yaml +12 -12
- package/expansion-packs/bmad-2d-unity-game-dev/templates/level-design-doc-tmpl.yaml +11 -11
- package/package.json +79 -76
- package/tools/cli.js +9 -0
- package/tools/flattener/main.js +559 -0
- package/tools/installer/lib/installer.js +4 -0
- package/tools/installer/package.json +1 -1
- package/.husky/pre-commit +0 -2
- package/.prettierignore +0 -21
- package/.prettierrc +0 -23
- package/docs/agentic-tools/claude-code-guide.md +0 -19
- package/docs/agentic-tools/cline-guide.md +0 -16
- package/docs/agentic-tools/cursor-guide.md +0 -14
- package/docs/agentic-tools/gemini-cli-guide.md +0 -31
- package/docs/agentic-tools/github-copilot-guide.md +0 -42
- package/docs/agentic-tools/roo-code-guide.md +0 -15
- package/docs/agentic-tools/trae-guide.md +0 -14
- package/docs/agentic-tools/windsurf-guide.md +0 -14
- package/docs/bmad-workflow-guide.md +0 -166
- package/docs/user-guide.md +0 -1142
|
@@ -1,31 +0,0 @@
|
|
|
1
|
-
# BMad Method Guide for Gemini CLI
|
|
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 **Gemini CLI** as your IDE. This creates:
|
|
8
|
-
|
|
9
|
-
- `.gemini/bmad-method/` directory with all agent context in GEMINI.md file
|
|
10
|
-
|
|
11
|
-
## Using BMad Agents with Gemini CLI
|
|
12
|
-
|
|
13
|
-
Simply mention the agent in your prompt:
|
|
14
|
-
|
|
15
|
-
- "As \*dev, implement the login feature"
|
|
16
|
-
- "Acting as \*architect, review this system design"
|
|
17
|
-
- "\*sm, create the next story for our project"
|
|
18
|
-
|
|
19
|
-
The Gemini CLI automatically loads the appropriate agent context.
|
|
20
|
-
|
|
21
|
-
## Gemini CLI-Specific Features
|
|
22
|
-
|
|
23
|
-
- **Context files**: All agents loaded as context in `.gemini/bmad-method/GEMINI.md`
|
|
24
|
-
- **Automatic loading**: GEMINI.md ensures agents are always available
|
|
25
|
-
- **Natural language**: No special syntax needed, just mention the agent
|
|
26
|
-
|
|
27
|
-
## Tips for Gemini CLI Users
|
|
28
|
-
|
|
29
|
-
- Be explicit about which agent you're addressing
|
|
30
|
-
- You can switch agents mid-conversation by mentioning a different one
|
|
31
|
-
- The CLI maintains context across your session
|
|
@@ -1,42 +0,0 @@
|
|
|
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 GitHub Copilot
|
|
14
|
-
|
|
15
|
-
1. **Open GitHub Copilot chat** in VS Code (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux).
|
|
16
|
-
2. Select the agent you want to use from the chat input's participant selector (e.g., `@workspace` > `dev`).
|
|
17
|
-
3. The agent adopts that persona for the conversation.
|
|
18
|
-
4. Use `*help` to see the commands available for the selected agent.
|
|
19
|
-
|
|
20
|
-
## Available Agents
|
|
21
|
-
|
|
22
|
-
You can switch between agents using the chat participant selector. The following agents are available for GitHub Copilot:
|
|
23
|
-
|
|
24
|
-
- `bmad-master` - Master Task Executor
|
|
25
|
-
- `dev` - Development expert
|
|
26
|
-
- `qa` - Quality Assurance specialist
|
|
27
|
-
- `ux-expert` - UX specialist
|
|
28
|
-
|
|
29
|
-
## GitHub Copilot-Specific Features
|
|
30
|
-
|
|
31
|
-
- **Settings**: Use the `.vscode/settings.json` file to configure Copilot behavior. The installer can configure these for you.
|
|
32
|
-
- `chat.agent.maxRequests`: Maximum requests per agent session (recommended: 15).
|
|
33
|
-
- `github.copilot.chat.agent.runTasks`: Allow agents to run workspace tasks (e.g., from `package.json` scripts).
|
|
34
|
-
- `github.copilot.chat.agent.autoFix`: Enable automatic error detection and fixing in generated code.
|
|
35
|
-
- `chat.tools.autoApprove`: Auto-approve ALL tools without confirmation (use with caution).
|
|
36
|
-
- **VS Code integration**: Works within VS Code's GitHub Copilot chat panel.
|
|
37
|
-
- **Tool Confirmation**: Copilot will ask for confirmation before running tools that can modify files. You can approve a tool once, for the session, or always.
|
|
38
|
-
|
|
39
|
-
## Tips for GitHub Copilot Users
|
|
40
|
-
|
|
41
|
-
- You can use a `.github/copilot-instructions.md` file to provide additional context or instructions for your projects that are not covered by the BMAD framework.
|
|
42
|
-
- BMAD agents can come with a pre-configured set of tools. You can see which tools an agent uses by looking at the `tools` section in its `.github/chatmodes/[agent].chatmode.md` file.
|
|
@@ -1,15 +0,0 @@
|
|
|
1
|
-
# BMad Method Guide for Roo Code
|
|
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 **Roo Code** as your IDE. This creates:
|
|
8
|
-
|
|
9
|
-
- `.bmad-core/` folder with all agents
|
|
10
|
-
- `.roomodes` file in project root with custom modes
|
|
11
|
-
|
|
12
|
-
## Roo Code-Specific Features
|
|
13
|
-
|
|
14
|
-
- **Mode file**: `.roomodes` in project root
|
|
15
|
-
- **Mode switching**: Use mode selecto
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
# BMad Method Guide for Trae
|
|
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 **Trae** as your IDE. This creates:
|
|
8
|
-
|
|
9
|
-
- `.bmad-core/` folder with all agents
|
|
10
|
-
- `.trae/rules/` folder with agent rule files (`.md`)
|
|
11
|
-
|
|
12
|
-
## Using BMad Agents in Trae
|
|
13
|
-
|
|
14
|
-
Type `@agent-name` in chat to activate an agent.
|
|
@@ -1,14 +0,0 @@
|
|
|
1
|
-
# BMad Method Guide for Windsurf
|
|
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 **Windsurf** as your IDE. This creates:
|
|
8
|
-
|
|
9
|
-
- `.bmad-core/` folder with all agents
|
|
10
|
-
- `.windsurf/rules/` folder with agent rule files (`.md`)
|
|
11
|
-
|
|
12
|
-
## Using BMad Agents in Windsurf
|
|
13
|
-
|
|
14
|
-
Type `@agent-name` in chat to activate an agent.
|
|
@@ -1,166 +0,0 @@
|
|
|
1
|
-
# BMad Method Universal Workflow Guide
|
|
2
|
-
|
|
3
|
-
This guide outlines the core BMad workflow that applies regardless of which AI-powered IDE you're using.
|
|
4
|
-
|
|
5
|
-
## Overview
|
|
6
|
-
|
|
7
|
-
The BMad Method follows a structured approach to AI-assisted software development:
|
|
8
|
-
|
|
9
|
-
1. **Install BMad** in your project
|
|
10
|
-
2. **Plan with Gemini** using team-fullstack
|
|
11
|
-
3. **Organize with bmad-master** (document sharding)
|
|
12
|
-
4. **Develop iteratively** with SM → Dev cycles
|
|
13
|
-
|
|
14
|
-
## The Complete Workflow
|
|
15
|
-
|
|
16
|
-
### Phase 1: Project Setup
|
|
17
|
-
|
|
18
|
-
1. **Install BMad in your project**:
|
|
19
|
-
|
|
20
|
-
```bash
|
|
21
|
-
npx bmad-method install
|
|
22
|
-
```
|
|
23
|
-
|
|
24
|
-
- Choose "Complete installation"
|
|
25
|
-
- Select your IDE (Cursor, Claude Code, Windsurf, Trae, Roo Code, or GitHub Copilot)
|
|
26
|
-
|
|
27
|
-
2. **Verify installation**:
|
|
28
|
-
- `.bmad-core/` folder created with all agents
|
|
29
|
-
- IDE-specific integration files created
|
|
30
|
-
- All agent commands/rules/modes available
|
|
31
|
-
|
|
32
|
-
### Phase 2: Ideation & Planning (Gemini)
|
|
33
|
-
|
|
34
|
-
Use Google's Gemini for collaborative planning with the full team:
|
|
35
|
-
|
|
36
|
-
1. **Open [Google Gems](https://gemini.google.com/gems/view)**
|
|
37
|
-
2. **Create a new Gem**:
|
|
38
|
-
- Give it a title and description (e.g., "BMad Team Fullstack")
|
|
39
|
-
3. **Load team-fullstack**:
|
|
40
|
-
- Copy contents of: `web-bundles/teams/team-fullstack.txt` from your project
|
|
41
|
-
- Paste this content into the Gem setup to configure the team
|
|
42
|
-
4. **Collaborate with the team**:
|
|
43
|
-
- Business Analyst: Requirements gathering
|
|
44
|
-
- Product Manager: Feature prioritization
|
|
45
|
-
- Solution Architect: Technical design
|
|
46
|
-
- UX Expert: User experience design
|
|
47
|
-
|
|
48
|
-
### Example Gemini Sessions:
|
|
49
|
-
|
|
50
|
-
```text
|
|
51
|
-
"I want to build a [type] application that [core purpose].
|
|
52
|
-
Help me brainstorm features and create a comprehensive PRD."
|
|
53
|
-
|
|
54
|
-
"Based on this PRD, design a scalable technical architecture
|
|
55
|
-
that can handle [specific requirements]."
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
5. **Export planning documents**:
|
|
59
|
-
- Copy the PRD output and save as `docs/prd.md` in your project
|
|
60
|
-
- Copy the architecture output and save as `docs/architecture.md` in your project
|
|
61
|
-
|
|
62
|
-
### Phase 3: Document Organization (IDE)
|
|
63
|
-
|
|
64
|
-
Switch back to your IDE for document management:
|
|
65
|
-
|
|
66
|
-
1. **Load bmad-master agent** (syntax varies by IDE)
|
|
67
|
-
2. **Shard the PRD**:
|
|
68
|
-
```
|
|
69
|
-
*shard-doc docs/prd.md prd
|
|
70
|
-
```
|
|
71
|
-
3. **Shard the architecture**:
|
|
72
|
-
```
|
|
73
|
-
*shard-doc docs/architecture.md architecture
|
|
74
|
-
```
|
|
75
|
-
|
|
76
|
-
**Result**: Organized folder structure:
|
|
77
|
-
|
|
78
|
-
- `docs/prd/` - Broken down PRD sections
|
|
79
|
-
- `docs/architecture/` - Broken down architecture sections
|
|
80
|
-
|
|
81
|
-
### Phase 4: Iterative Development
|
|
82
|
-
|
|
83
|
-
Follow the SM → Dev cycle for systematic story development:
|
|
84
|
-
|
|
85
|
-
#### Story Creation (Scrum Master)
|
|
86
|
-
|
|
87
|
-
1. **Start new chat/conversation**
|
|
88
|
-
2. **Load SM agent**
|
|
89
|
-
3. **Execute**: `*create` (runs create-next-story task)
|
|
90
|
-
4. **Review generated story** in `docs/stories/`
|
|
91
|
-
5. **Update status**: Change from "Draft" to "Approved"
|
|
92
|
-
|
|
93
|
-
#### Story Implementation (Developer)
|
|
94
|
-
|
|
95
|
-
1. **Start new chat/conversation**
|
|
96
|
-
2. **Load Dev agent**
|
|
97
|
-
3. **Agent asks**: Which story to implement
|
|
98
|
-
4. **Follow development tasks**
|
|
99
|
-
5. **Complete implementation**
|
|
100
|
-
6. **Update status**: Change to "Done"
|
|
101
|
-
|
|
102
|
-
#### Repeat Until Complete
|
|
103
|
-
|
|
104
|
-
- **SM**: Create next story → Review → Approve
|
|
105
|
-
- **Dev**: Implement story → Complete → Mark done
|
|
106
|
-
- **Continue**: Until all features implemented
|
|
107
|
-
|
|
108
|
-
## IDE-Specific Syntax
|
|
109
|
-
|
|
110
|
-
### Agent Loading Syntax by IDE:
|
|
111
|
-
|
|
112
|
-
- **Claude Code**: `/agent-name` (e.g., `/bmad-master`)
|
|
113
|
-
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
|
114
|
-
- **Gemini CLI**: `*agent-name` (e.g., `*bmad-master`)
|
|
115
|
-
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
|
116
|
-
- **Trae**: `@agent-name` (e.g., `@bmad-master`)
|
|
117
|
-
- **Roo Code**: Select mode from mode selector (e.g., `bmad-master`)
|
|
118
|
-
- **GitHub Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
|
119
|
-
|
|
120
|
-
### Chat Management:
|
|
121
|
-
|
|
122
|
-
- **Claude Code, Cursor, Windsurf, Trae**: Start new chats when switching agents
|
|
123
|
-
- **Roo Code**: Switch modes within the same conversation
|
|
124
|
-
|
|
125
|
-
## Available Agents
|
|
126
|
-
|
|
127
|
-
### Core Development Agents:
|
|
128
|
-
|
|
129
|
-
- **bmad-master**: Universal task executor, document management
|
|
130
|
-
- **sm**: Scrum Master for story creation and agile process
|
|
131
|
-
- **dev**: Full-stack developer for implementation
|
|
132
|
-
- **architect**: Solution architect for technical design
|
|
133
|
-
|
|
134
|
-
### Specialized Agents:
|
|
135
|
-
|
|
136
|
-
- **pm**: Product manager for planning and prioritization
|
|
137
|
-
- **analyst**: Business analyst for requirements
|
|
138
|
-
- **qa**: QA specialist for testing strategies
|
|
139
|
-
- **po**: Product owner for backlog management
|
|
140
|
-
- **ux-expert**: UX specialist for design
|
|
141
|
-
|
|
142
|
-
## Key Principles
|
|
143
|
-
|
|
144
|
-
1. **Agent Specialization**: Each agent has specific expertise and responsibilities
|
|
145
|
-
2. **Clean Handoffs**: Always start fresh when switching between agents
|
|
146
|
-
3. **Status Tracking**: Maintain story statuses (Draft → Approved → InProgress → Done)
|
|
147
|
-
4. **Iterative Development**: Complete one story before starting the next
|
|
148
|
-
5. **Documentation First**: Always start with solid PRD and architecture
|
|
149
|
-
|
|
150
|
-
## Common Commands
|
|
151
|
-
|
|
152
|
-
Every agent supports these core commands:
|
|
153
|
-
|
|
154
|
-
- `*help` - Show available commands
|
|
155
|
-
- `*status` - Show current context/progress
|
|
156
|
-
- `*exit` - Exit the agent mode
|
|
157
|
-
|
|
158
|
-
## Success Tips
|
|
159
|
-
|
|
160
|
-
- **Use Gemini for big picture planning** - The team-fullstack bundle provides collaborative expertise
|
|
161
|
-
- **Use bmad-master for document organization** - Sharding creates manageable chunks
|
|
162
|
-
- **Follow the SM → Dev cycle religiously** - This ensures systematic progress
|
|
163
|
-
- **Keep conversations focused** - One agent, one task per conversation
|
|
164
|
-
- **Review everything** - Always review and approve before marking complete
|
|
165
|
-
|
|
166
|
-
This workflow ensures systematic, AI-assisted development following agile principles with clear separation of concerns and consistent progress tracking.
|