bmad-method 4.24.3 → 4.24.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.prettierignore +1 -1
- package/CHANGELOG.md +8 -1
- package/README.md +22 -22
- package/bmad-core/agents/bmad-master.md +5 -5
- package/bmad-core/agents/bmad-orchestrator.md +9 -9
- package/bmad-core/checklists/change-checklist.md +2 -2
- package/bmad-core/data/bmad-kb.md +18 -18
- package/bmad-core/tasks/create-brownfield-story.md +2 -2
- package/bmad-core/tasks/create-next-story.md +2 -2
- package/bmad-core/tasks/kb-mode-interaction.md +13 -13
- package/common/utils/template-format.md +1 -1
- package/common/utils/workflow-management.md +1 -1
- package/dist/agents/analyst.txt +21 -21
- package/dist/agents/architect.txt +3 -3
- package/dist/agents/bmad-master.txt +31 -31
- package/dist/agents/bmad-orchestrator.txt +44 -44
- package/dist/agents/dev.txt +2 -2
- package/dist/agents/pm.txt +5 -5
- package/dist/agents/po.txt +5 -5
- package/dist/agents/qa.txt +3 -3
- package/dist/agents/sm.txt +5 -5
- package/dist/agents/ux-expert.txt +3 -3
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-designer.txt +2 -2
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-developer.txt +2 -2
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/agents/game-sm.txt +2 -2
- package/dist/expansion-packs/bmad-2d-phaser-game-dev/teams/phaser-2d-nodejs-game-team.txt +29 -29
- package/dist/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.txt +21 -21
- package/dist/expansion-packs/bmad-infrastructure-devops/agents/infra-devops-platform.txt +14 -14
- package/dist/teams/team-all.txt +48 -48
- package/dist/teams/team-fullstack.txt +46 -46
- package/dist/teams/team-ide-minimal.txt +48 -48
- package/dist/teams/team-no-ui.txt +46 -46
- package/docs/agentic-tools/claude-code-guide.md +5 -22
- package/docs/agentic-tools/cline-guide.md +3 -29
- package/docs/agentic-tools/cursor-guide.md +4 -27
- package/docs/agentic-tools/gemini-cli-guide.md +3 -17
- package/docs/agentic-tools/github-copilot-guide.md +22 -0
- package/docs/agentic-tools/roo-code-guide.md +2 -35
- package/docs/agentic-tools/windsurf-guide.md +3 -28
- package/docs/bmad-workflow-guide.md +8 -8
- package/docs/core-architecture.md +19 -184
- package/docs/expansion-packs.md +4 -4
- package/docs/how-to-contribute-with-pull-requests.md +1 -1
- package/docs/user-guide.md +29 -414
- package/docs/versions.md +4 -4
- package/docs/working-in-the-brownfield.md +9 -6
- package/expansion-packs/README.md +2 -2
- package/expansion-packs/bmad-2d-phaser-game-dev/config.yaml +1 -1
- package/expansion-packs/bmad-2d-phaser-game-dev/data/bmad-kb.md +3 -3
- package/expansion-packs/bmad-creator-tools/README.md +2 -2
- package/expansion-packs/bmad-creator-tools/agents/bmad-the-creator.md +8 -8
- package/expansion-packs/bmad-creator-tools/config.yaml +2 -2
- package/expansion-packs/bmad-creator-tools/tasks/create-agent.md +1 -1
- package/expansion-packs/bmad-creator-tools/tasks/generate-expansion-pack.md +9 -9
- package/expansion-packs/bmad-creator-tools/templates/expansion-pack-plan-tmpl.md +1 -1
- package/expansion-packs/bmad-infrastructure-devops/README.md +6 -6
- package/expansion-packs/bmad-infrastructure-devops/checklists/infrastructure-checklist.md +1 -1
- package/expansion-packs/bmad-infrastructure-devops/config.yaml +1 -1
- package/expansion-packs/bmad-infrastructure-devops/tasks/review-infrastructure.md +4 -4
- package/expansion-packs/bmad-infrastructure-devops/tasks/validate-infrastructure.md +4 -4
- package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.md +2 -2
- package/package.json +1 -1
- package/tools/bmad-npx-wrapper.js +1 -1
- package/tools/builders/web-builder.js +1 -1
- package/tools/cli.js +2 -2
- package/tools/installer/README.md +1 -51
- package/tools/installer/bin/bmad.js +9 -9
- package/tools/installer/config/install.config.yaml +10 -10
- package/tools/installer/lib/config-loader.js +2 -2
- package/tools/installer/lib/ide-setup.js +9 -9
- package/tools/installer/lib/installer.js +17 -17
- package/tools/installer/package.json +3 -3
- package/tools/md-assets/web-agent-startup-instructions.md +2 -2
- package/tools/upgraders/v3-to-v4-upgrader.js +2 -2
- package/tools/version-bump.js +1 -1
- package/tools/yaml-format.js +1 -1
- package/docs/agentic-tools/vs-code-copilot-guide.md +0 -53
- package/tools/installer/templates/claude-commands.md +0 -7
- package/tools/installer/templates/cursor-rules.md +0 -22
- package/tools/installer/templates/windsurf-rules.md +0 -22
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Game Development
|
|
1
|
+
# Game Development BMad Knowledge Base
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
5
|
-
This game development expansion of
|
|
5
|
+
This game development expansion of BMad-Method specializes in creating 2D games using Phaser 3 and TypeScript. It extends the core BMad framework with game-specific agents, workflows, and best practices for professional game development.
|
|
6
6
|
|
|
7
7
|
### Game Development Focus
|
|
8
8
|
|
|
@@ -251,4 +251,4 @@ game-project/
|
|
|
251
251
|
- Culling and level-of-detail systems
|
|
252
252
|
- Memory management and garbage collection optimization
|
|
253
253
|
|
|
254
|
-
This knowledge base provides the foundation for effective game development using the
|
|
254
|
+
This knowledge base provides the foundation for effective game development using the BMad-Method framework with specialized focus on 2D game creation using Phaser 3 and TypeScript.
|
|
@@ -11,27 +11,27 @@ activation-instructions:
|
|
|
11
11
|
agent:
|
|
12
12
|
name: The Creator
|
|
13
13
|
id: bmad-the-creator
|
|
14
|
-
title:
|
|
14
|
+
title: BMad Framework Extension Specialist
|
|
15
15
|
icon: 🏗️
|
|
16
|
-
whenToUse: Use for creating new agents, expansion packs, and extending the
|
|
16
|
+
whenToUse: Use for creating new agents, expansion packs, and extending the BMad framework
|
|
17
17
|
customization: null
|
|
18
18
|
persona:
|
|
19
|
-
role: Expert
|
|
19
|
+
role: Expert BMad Framework Architect & Creator
|
|
20
20
|
style: Methodical, creative, framework-aware, systematic
|
|
21
|
-
identity: Master builder who extends
|
|
22
|
-
focus: Creating well-structured agents, expansion packs, and framework extensions that follow
|
|
21
|
+
identity: Master builder who extends BMad capabilities through thoughtful design and deep framework understanding
|
|
22
|
+
focus: Creating well-structured agents, expansion packs, and framework extensions that follow BMad patterns and conventions
|
|
23
23
|
core_principles:
|
|
24
|
-
- Framework Consistency - All creations follow established
|
|
24
|
+
- Framework Consistency - All creations follow established BMad patterns
|
|
25
25
|
- Modular Design - Create reusable, composable components
|
|
26
26
|
- Clear Documentation - Every creation includes proper documentation
|
|
27
|
-
- Convention Over Configuration - Follow
|
|
27
|
+
- Convention Over Configuration - Follow BMad naming and structure patterns
|
|
28
28
|
- Extensibility First - Design for future expansion and customization
|
|
29
29
|
- Numbered Options Protocol - Always use numbered lists for user selections
|
|
30
30
|
startup:
|
|
31
31
|
- Greet the user with your name and role, and inform of the *help command
|
|
32
32
|
- CRITICAL: Do NOT automatically create documents or execute tasks during startup
|
|
33
33
|
- CRITICAL: Do NOT create or modify any files during startup
|
|
34
|
-
- Offer to help with
|
|
34
|
+
- Offer to help with BMad framework extensions but wait for explicit user confirmation
|
|
35
35
|
- Only execute tasks when user explicitly requests them
|
|
36
36
|
commands:
|
|
37
37
|
- '*help" - Show numbered list of available commands for selection'
|
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
name: bmad-creator-tools
|
|
2
2
|
version: 1.2.0
|
|
3
|
-
short-title: Tools for creating
|
|
4
|
-
description: Tools for creating and extending
|
|
3
|
+
short-title: Tools for creating BMad framework components
|
|
4
|
+
description: Tools for creating and extending BMad framework components.
|
|
5
5
|
author: Brian (BMad)
|
|
@@ -1,10 +1,10 @@
|
|
|
1
1
|
# Create Expansion Pack Task
|
|
2
2
|
|
|
3
|
-
This task helps you create a sophisticated
|
|
3
|
+
This task helps you create a sophisticated BMad expansion pack with advanced agent orchestration, template systems, and quality assurance patterns based on proven best practices.
|
|
4
4
|
|
|
5
5
|
## Understanding Expansion Packs
|
|
6
6
|
|
|
7
|
-
Expansion packs extend
|
|
7
|
+
Expansion packs extend BMad with domain-specific capabilities using sophisticated AI agent orchestration patterns. They are self-contained packages that leverage:
|
|
8
8
|
|
|
9
9
|
- **Advanced Agent Architecture**: YAML-in-Markdown with embedded personas and character consistency
|
|
10
10
|
- **Template Systems**: LLM instruction embedding with conditional content and dynamic variables
|
|
@@ -12,7 +12,7 @@ Expansion packs extend BMAD with domain-specific capabilities using sophisticate
|
|
|
12
12
|
- **Quality Assurance**: Multi-level validation with star ratings and comprehensive checklists
|
|
13
13
|
- **Knowledge Integration**: Domain-specific data organization and best practices embedding
|
|
14
14
|
|
|
15
|
-
Every expansion pack MUST include a custom
|
|
15
|
+
Every expansion pack MUST include a custom BMad orchestrator agent with sophisticated command systems and numbered options protocols.
|
|
16
16
|
|
|
17
17
|
## CRITICAL REQUIREMENTS
|
|
18
18
|
|
|
@@ -83,7 +83,7 @@ Create `expansion-packs/{pack-name}/plan.md` with:
|
|
|
83
83
|
|
|
84
84
|
### Agents (with Character Personas)
|
|
85
85
|
|
|
86
|
-
- [ ] {pack-name}-orchestrator (REQUIRED: Custom
|
|
86
|
+
- [ ] {pack-name}-orchestrator (REQUIRED: Custom BMad orchestrator)
|
|
87
87
|
- Character Name: {human-name}
|
|
88
88
|
- Communication Style: {style}
|
|
89
89
|
- Key Commands: {command-list}
|
|
@@ -157,7 +157,7 @@ Important: Wait for user approval before proceeding to Phase 2
|
|
|
157
157
|
|
|
158
158
|
#### 2.1 Create Orchestrator Agent with Domain-Themed Character
|
|
159
159
|
|
|
160
|
-
**FIRST PRIORITY**: Design the custom
|
|
160
|
+
**FIRST PRIORITY**: Design the custom BMad orchestrator with domain-appropriate theme:
|
|
161
161
|
|
|
162
162
|
**Themed Character Design:**
|
|
163
163
|
|
|
@@ -183,7 +183,7 @@ Important: Wait for user approval before proceeding to Phase 2
|
|
|
183
183
|
- **Activation Instructions**: Embedded YAML with behavior directives
|
|
184
184
|
- **Startup Procedures**: Initialize without auto-execution
|
|
185
185
|
- **Dependencies**: Clear references to tasks, templates, and data files
|
|
186
|
-
- **Integration Points**: How it coordinates with core
|
|
186
|
+
- **Integration Points**: How it coordinates with core BMad agents
|
|
187
187
|
|
|
188
188
|
#### 2.2 Design Specialist Agents with Character Personas
|
|
189
189
|
|
|
@@ -374,7 +374,7 @@ embedded_knowledge:
|
|
|
374
374
|
- {domain}-terminology.md
|
|
375
375
|
- {domain}-standards.md
|
|
376
376
|
|
|
377
|
-
# Dependencies on core
|
|
377
|
+
# Dependencies on core BMad components
|
|
378
378
|
core_dependencies:
|
|
379
379
|
agents:
|
|
380
380
|
- architect # For system design
|
|
@@ -863,7 +863,7 @@ Embedded knowledge (automatic):
|
|
|
863
863
|
7. "Where in the workflow should users choose between different paths?"
|
|
864
864
|
8. "How should the orchestrator hand off to specialist agents?"
|
|
865
865
|
9. "What quality gates should be built into the workflow?"
|
|
866
|
-
10. "How should it integrate with core
|
|
866
|
+
10. "How should it integrate with core BMad agents?"
|
|
867
867
|
|
|
868
868
|
### Agent Planning
|
|
869
869
|
|
|
@@ -913,7 +913,7 @@ Embedded knowledge (automatic):
|
|
|
913
913
|
**Quality and Validation:**
|
|
914
914
|
|
|
915
915
|
- **Plan First**: ALWAYS create and get approval for plan.md before implementing
|
|
916
|
-
- **Orchestrator Required**: Every pack MUST have a custom
|
|
916
|
+
- **Orchestrator Required**: Every pack MUST have a custom BMad orchestrator with sophisticated command system
|
|
917
917
|
- **Verify References**: ALL referenced tasks/templates MUST exist and be tested
|
|
918
918
|
- **Multi-Level Validation**: Quality systems must provide basic, comprehensive, and expert-level assessment
|
|
919
919
|
- **Domain Expertise**: Ensure accuracy in specialized fields with embedded best practices
|
|
@@ -70,7 +70,7 @@ Users must add these files to `bmad-core/data/`:
|
|
|
70
70
|
|
|
71
71
|
## Integration Points
|
|
72
72
|
|
|
73
|
-
- Depends on core agents: {list any core
|
|
73
|
+
- Depends on core agents: {list any core BMad agents used}
|
|
74
74
|
- Extends teams: {which teams to update}
|
|
75
75
|
|
|
76
76
|
## Success Criteria
|
|
@@ -2,11 +2,11 @@
|
|
|
2
2
|
|
|
3
3
|
## Overview
|
|
4
4
|
|
|
5
|
-
This expansion pack extends
|
|
5
|
+
This expansion pack extends BMad Method with comprehensive infrastructure and DevOps capabilities. It's designed for teams that need to define, implement, and manage cloud infrastructure alongside their application development.
|
|
6
6
|
|
|
7
7
|
## Purpose
|
|
8
8
|
|
|
9
|
-
While the core
|
|
9
|
+
While the core BMad flow focuses on getting from business requirements to development (Analyst → PM → Architect → SM → Dev), many projects require sophisticated infrastructure planning and implementation. This expansion pack adds:
|
|
10
10
|
|
|
11
11
|
- Infrastructure architecture design capabilities
|
|
12
12
|
- Platform engineering implementation workflows
|
|
@@ -52,9 +52,9 @@ Install this expansion pack when your project requires:
|
|
|
52
52
|
|
|
53
53
|
- `infrastructure-checklist.md` - Comprehensive 16-section infrastructure validation checklist
|
|
54
54
|
|
|
55
|
-
## Integration with Core
|
|
55
|
+
## Integration with Core BMad
|
|
56
56
|
|
|
57
|
-
This expansion pack integrates with the core
|
|
57
|
+
This expansion pack integrates with the core BMad flow at these points:
|
|
58
58
|
|
|
59
59
|
1. **After Architecture Phase**: The Architect can trigger infrastructure architecture design
|
|
60
60
|
2. **Parallel to Development**: Infrastructure implementation can proceed alongside application development
|
|
@@ -123,7 +123,7 @@ The DevOps agent can be added to team configurations:
|
|
|
123
123
|
|
|
124
124
|
This expansion pack works best when used with:
|
|
125
125
|
|
|
126
|
-
- Core
|
|
126
|
+
- Core BMad agents (especially Architect)
|
|
127
127
|
- Technical preferences documentation
|
|
128
128
|
- Approved PRD and system architecture
|
|
129
129
|
|
|
@@ -144,4 +144,4 @@ You can customize this expansion pack by:
|
|
|
144
144
|
---
|
|
145
145
|
|
|
146
146
|
_Version: 1.0_
|
|
147
|
-
_Compatible with:
|
|
147
|
+
_Compatible with: BMad Method v4_
|
|
@@ -270,7 +270,7 @@ This checklist serves as a comprehensive framework for validating infrastructure
|
|
|
270
270
|
- [ ] Business stakeholders informed of changes
|
|
271
271
|
- [ ] Feedback loops established for continuous improvement
|
|
272
272
|
|
|
273
|
-
## 11.
|
|
273
|
+
## 11. BMad WORKFLOW INTEGRATION
|
|
274
274
|
|
|
275
275
|
### 11.1 Development Agent Alignment
|
|
276
276
|
|
|
@@ -2,7 +2,7 @@ name: bmad-infrastructure-devops
|
|
|
2
2
|
version: 1.2.0
|
|
3
3
|
short-title: Infrastructure and DevOps capabilities
|
|
4
4
|
description: >-
|
|
5
|
-
This expansion pack extends
|
|
5
|
+
This expansion pack extends BMad Method with comprehensive infrastructure and
|
|
6
6
|
DevOps capabilities. It's designed for teams that need to define, implement,
|
|
7
7
|
and manage cloud infrastructure alongside their application development.
|
|
8
8
|
author: Brian (BMad)
|
|
@@ -55,13 +55,13 @@ To conduct a thorough review of existing infrastructure to identify improvement
|
|
|
55
55
|
- Create an improvement roadmap with suggested timelines
|
|
56
56
|
- Highlight cost optimization opportunities
|
|
57
57
|
|
|
58
|
-
### 5.
|
|
58
|
+
### 5. BMad Integration Assessment
|
|
59
59
|
|
|
60
|
-
- Evaluate how current infrastructure supports other
|
|
60
|
+
- Evaluate how current infrastructure supports other BMad agents:
|
|
61
61
|
- **Development Support:** Assess how infrastructure enables Frontend Dev (Mira), Backend Dev (Enrique), and Full Stack Dev workflows
|
|
62
62
|
- **Product Alignment:** Verify infrastructure supports PRD requirements from Product Owner (Oli)
|
|
63
63
|
- **Architecture Compliance:** Check if implementation follows Architect (Alphonse) decisions
|
|
64
|
-
- Document any gaps in
|
|
64
|
+
- Document any gaps in BMad integration
|
|
65
65
|
|
|
66
66
|
### 6. Architectural Escalation Assessment
|
|
67
67
|
|
|
@@ -133,7 +133,7 @@ A comprehensive infrastructure review report that includes:
|
|
|
133
133
|
2. **Prioritized findings** with severity ratings
|
|
134
134
|
3. **Detailed recommendations** with effort/impact estimates
|
|
135
135
|
4. **Cost optimization opportunities**
|
|
136
|
-
5. **
|
|
136
|
+
5. **BMad integration assessment**
|
|
137
137
|
6. **Architectural escalation assessment** with clear escalation recommendations
|
|
138
138
|
7. **Action plan** for critical improvements and architectural work
|
|
139
139
|
8. **Escalation documentation** for Architect Agent collaboration (if applicable)
|
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
|
|
3
3
|
## Purpose
|
|
4
4
|
|
|
5
|
-
To comprehensively validate platform infrastructure changes against security, reliability, operational, and compliance requirements before deployment. This task ensures all platform infrastructure meets organizational standards, follows best practices, and properly integrates with the broader
|
|
5
|
+
To comprehensively validate platform infrastructure changes against security, reliability, operational, and compliance requirements before deployment. This task ensures all platform infrastructure meets organizational standards, follows best practices, and properly integrates with the broader BMad ecosystem.
|
|
6
6
|
|
|
7
7
|
## Inputs
|
|
8
8
|
|
|
@@ -82,9 +82,9 @@ To comprehensively validate platform infrastructure changes against security, re
|
|
|
82
82
|
- Provide validation signoff recommendation based on complete platform assessment
|
|
83
83
|
- Document platform component integration validation results
|
|
84
84
|
|
|
85
|
-
### 6.
|
|
85
|
+
### 6. BMad Integration Assessment
|
|
86
86
|
|
|
87
|
-
- Review how platform infrastructure changes support other
|
|
87
|
+
- Review how platform infrastructure changes support other BMad agents:
|
|
88
88
|
- **Development Agent Alignment:** Verify platform infrastructure supports Frontend Dev, Backend Dev, and Full Stack Dev requirements including:
|
|
89
89
|
- Container platform development environment provisioning
|
|
90
90
|
- GitOps workflows for application deployment
|
|
@@ -128,7 +128,7 @@ A comprehensive platform validation report documenting:
|
|
|
128
128
|
3. **Detailed findings for each non-compliant item** across foundation and platform components
|
|
129
129
|
4. **Platform integration validation results** documenting component interoperability
|
|
130
130
|
5. **Remediation recommendations with priority levels** based on platform impact
|
|
131
|
-
6. **
|
|
131
|
+
6. **BMad integration assessment results** for complete platform stack
|
|
132
132
|
7. **Clear signoff recommendation** for platform deployment readiness or architectural revision requirements
|
|
133
133
|
8. **Next steps for implementation or remediation** prioritized by platform dependencies
|
|
134
134
|
|
package/expansion-packs/bmad-infrastructure-devops/templates/infrastructure-architecture-tmpl.md
CHANGED
|
@@ -264,9 +264,9 @@ Create pipeline diagram showing:
|
|
|
264
264
|
- Cost Monitoring & Reporting
|
|
265
265
|
- Optimization Recommendations
|
|
266
266
|
|
|
267
|
-
##
|
|
267
|
+
## BMad Integration Architecture
|
|
268
268
|
|
|
269
|
-
[[LLM: Design infrastructure to specifically support other
|
|
269
|
+
[[LLM: Design infrastructure to specifically support other BMad agents and their workflows. This ensures the infrastructure enables the entire BMad methodology.]]
|
|
270
270
|
|
|
271
271
|
### Development Agent Support
|
|
272
272
|
|
package/package.json
CHANGED
|
@@ -470,7 +470,7 @@ class WebBuilder {
|
|
|
470
470
|
}
|
|
471
471
|
}
|
|
472
472
|
} else {
|
|
473
|
-
// Use core
|
|
473
|
+
// Use core BMad version
|
|
474
474
|
try {
|
|
475
475
|
const coreAgentPath = path.join(this.rootDir, "bmad-core", "agents", `${agentId}.md`);
|
|
476
476
|
const coreAgentContent = await fs.readFile(coreAgentPath, "utf8");
|
package/tools/cli.js
CHANGED
|
@@ -10,7 +10,7 @@ const program = new Command();
|
|
|
10
10
|
|
|
11
11
|
program
|
|
12
12
|
.name('bmad-build')
|
|
13
|
-
.description('
|
|
13
|
+
.description('BMad-Method build tool for creating web bundles')
|
|
14
14
|
.version('4.0.0');
|
|
15
15
|
|
|
16
16
|
program
|
|
@@ -136,7 +136,7 @@ program
|
|
|
136
136
|
|
|
137
137
|
program
|
|
138
138
|
.command('upgrade')
|
|
139
|
-
.description('Upgrade a
|
|
139
|
+
.description('Upgrade a BMad-Method V3 project to V4')
|
|
140
140
|
.option('-p, --project <path>', 'Path to V3 project (defaults to current directory)')
|
|
141
141
|
.option('--dry-run', 'Show what would be changed without making changes')
|
|
142
142
|
.option('--no-backup', 'Skip creating backup (not recommended)')
|
|
@@ -1,58 +1,8 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
-
This directory contains the BMAD Method installer implementation.
|
|
4
|
-
|
|
5
|
-
## Structure
|
|
6
|
-
|
|
7
|
-
```text
|
|
8
|
-
installer/
|
|
9
|
-
├── bin/ # CLI entry points
|
|
10
|
-
│ └── bmad.js # Main CLI executable
|
|
11
|
-
├── lib/ # Core implementation
|
|
12
|
-
│ ├── installer.js # Main installation logic
|
|
13
|
-
│ ├── updater.js # Update management
|
|
14
|
-
│ ├── config-loader.js # YAML config parsing
|
|
15
|
-
│ ├── file-manager.js # File operations
|
|
16
|
-
│ ├── ide-setup.js # IDE-specific setup
|
|
17
|
-
│ └── prompts.js # Interactive CLI prompts
|
|
18
|
-
├── config/ # Configuration files
|
|
19
|
-
│ └── install.config.yaml # Installation profiles
|
|
20
|
-
├── templates/ # IDE template files
|
|
21
|
-
│ ├── cursor-rules.md # Cursor template
|
|
22
|
-
│ ├── claude-commands.md # Claude Code template
|
|
23
|
-
│ └── windsurf-rules.md # Windsurf template
|
|
24
|
-
└── package.json # NPM package configuration
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
## Installation Profiles
|
|
28
|
-
|
|
29
|
-
- **minimal**: IDE agents only (best for beginners)
|
|
30
|
-
- **core**: IDE + Web agents
|
|
31
|
-
- **teams**: Full team workflows
|
|
32
|
-
- **developer**: Everything including creation tools
|
|
1
|
+
# BMad Method Installer
|
|
33
2
|
|
|
34
3
|
## Usage
|
|
35
4
|
|
|
36
5
|
```bash
|
|
37
6
|
# Interactive installation
|
|
38
7
|
npx bmad-method install
|
|
39
|
-
|
|
40
|
-
# Direct profile installation
|
|
41
|
-
npx bmad-method install --profile=minimal
|
|
42
|
-
|
|
43
|
-
# Update existing installation
|
|
44
|
-
npx bmad-method update
|
|
45
|
-
```
|
|
46
|
-
|
|
47
|
-
## Development
|
|
48
|
-
|
|
49
|
-
```bash
|
|
50
|
-
# Install dependencies
|
|
51
|
-
npm install
|
|
52
|
-
|
|
53
|
-
# Run tests
|
|
54
|
-
npm test
|
|
55
|
-
|
|
56
|
-
# Lint code
|
|
57
|
-
npm run lint
|
|
58
8
|
```
|
|
@@ -42,15 +42,15 @@ try {
|
|
|
42
42
|
|
|
43
43
|
program
|
|
44
44
|
.version(version)
|
|
45
|
-
.description('
|
|
45
|
+
.description('BMad Method installer - Universal AI agent framework for any domain');
|
|
46
46
|
|
|
47
47
|
program
|
|
48
48
|
.command('install')
|
|
49
|
-
.description('Install
|
|
50
|
-
.option('-f, --full', 'Install complete
|
|
49
|
+
.description('Install BMad Method agents and tools')
|
|
50
|
+
.option('-f, --full', 'Install complete BMad Method')
|
|
51
51
|
.option('-x, --expansion-only', 'Install only expansion packs (no bmad-core)')
|
|
52
52
|
.option('-d, --directory <path>', 'Installation directory')
|
|
53
|
-
.option('-i, --ide <ide...>', 'Configure for specific IDE(s) - can specify multiple (cursor, claude-code, windsurf, roo, cline, gemini,
|
|
53
|
+
.option('-i, --ide <ide...>', 'Configure for specific IDE(s) - can specify multiple (cursor, claude-code, windsurf, roo, cline, gemini, github-copilot, other)')
|
|
54
54
|
.option('-e, --expansion-packs <packs...>', 'Install specific expansion packs (can specify multiple)')
|
|
55
55
|
.action(async (options) => {
|
|
56
56
|
try {
|
|
@@ -83,7 +83,7 @@ program
|
|
|
83
83
|
|
|
84
84
|
program
|
|
85
85
|
.command('update')
|
|
86
|
-
.description('Update existing
|
|
86
|
+
.description('Update existing BMad installation')
|
|
87
87
|
.option('--force', 'Force update, overwriting modified files')
|
|
88
88
|
.option('--dry-run', 'Show what would be updated without making changes')
|
|
89
89
|
.action(async () => {
|
|
@@ -124,7 +124,7 @@ program
|
|
|
124
124
|
|
|
125
125
|
async function promptInstallation() {
|
|
126
126
|
await initializeModules();
|
|
127
|
-
console.log(chalk.bold.blue(`\nWelcome to
|
|
127
|
+
console.log(chalk.bold.blue(`\nWelcome to BMad Method Installer v${version}\n`));
|
|
128
128
|
|
|
129
129
|
const answers = {};
|
|
130
130
|
|
|
@@ -133,7 +133,7 @@ async function promptInstallation() {
|
|
|
133
133
|
{
|
|
134
134
|
type: 'input',
|
|
135
135
|
name: 'directory',
|
|
136
|
-
message: 'Enter the full path to your project directory where
|
|
136
|
+
message: 'Enter the full path to your project directory where BMad should be installed:',
|
|
137
137
|
validate: (input) => {
|
|
138
138
|
if (!input.trim()) {
|
|
139
139
|
return 'Please enter a valid project path';
|
|
@@ -162,7 +162,7 @@ async function promptInstallation() {
|
|
|
162
162
|
const coreConfig = yaml.load(await fs.readFile(coreConfigPath, 'utf8'));
|
|
163
163
|
const coreShortTitle = coreConfig['short-title'] || 'BMad Agile Core System';
|
|
164
164
|
|
|
165
|
-
// Add
|
|
165
|
+
// Add BMad core option
|
|
166
166
|
let bmadOptionText;
|
|
167
167
|
if (state.type === 'v4_existing') {
|
|
168
168
|
const currentVersion = state.manifest?.version || 'unknown';
|
|
@@ -237,7 +237,7 @@ async function promptInstallation() {
|
|
|
237
237
|
{ name: 'Roo Code', value: 'roo' },
|
|
238
238
|
{ name: 'Cline', value: 'cline' },
|
|
239
239
|
{ name: 'Gemini CLI', value: 'gemini' },
|
|
240
|
-
{ name: '
|
|
240
|
+
{ name: 'Github Copilot', value: 'github-copilot' }
|
|
241
241
|
]
|
|
242
242
|
}
|
|
243
243
|
]);
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
installation-options:
|
|
2
2
|
full:
|
|
3
|
-
name: Complete
|
|
3
|
+
name: Complete BMad Core
|
|
4
4
|
description: Copy the entire .bmad-core folder with all agents, templates, and tools
|
|
5
5
|
action: copy-folder
|
|
6
6
|
source: bmad-core
|
|
@@ -15,7 +15,7 @@ ide-configurations:
|
|
|
15
15
|
format: multi-file
|
|
16
16
|
command-suffix: .mdc
|
|
17
17
|
instructions: |
|
|
18
|
-
# To use
|
|
18
|
+
# To use BMad agents in Cursor:
|
|
19
19
|
# 1. Press Ctrl+L (Cmd+L on Mac) to open the chat
|
|
20
20
|
# 2. Type @agent-name (e.g., "@dev", "@pm", "@architect")
|
|
21
21
|
# 3. The agent will adopt that persona for the conversation
|
|
@@ -25,7 +25,7 @@ ide-configurations:
|
|
|
25
25
|
format: multi-file
|
|
26
26
|
command-suffix: .md
|
|
27
27
|
instructions: |
|
|
28
|
-
# To use
|
|
28
|
+
# To use BMad agents in Claude Code:
|
|
29
29
|
# 1. Type /agent-name (e.g., "/dev", "/pm", "/architect")
|
|
30
30
|
# 2. Claude will switch to that agent's persona
|
|
31
31
|
windsurf:
|
|
@@ -34,7 +34,7 @@ ide-configurations:
|
|
|
34
34
|
format: multi-file
|
|
35
35
|
command-suffix: .md
|
|
36
36
|
instructions: |
|
|
37
|
-
# To use
|
|
37
|
+
# To use BMad agents in Windsurf:
|
|
38
38
|
# 1. Type @agent-name (e.g., "@dev", "@pm")
|
|
39
39
|
# 2. Windsurf will adopt that agent's persona
|
|
40
40
|
roo:
|
|
@@ -42,7 +42,7 @@ ide-configurations:
|
|
|
42
42
|
format: custom-modes
|
|
43
43
|
file: .roomodes
|
|
44
44
|
instructions: |
|
|
45
|
-
# To use
|
|
45
|
+
# To use BMad agents in Roo Code:
|
|
46
46
|
# 1. Open the mode selector (usually in the status bar)
|
|
47
47
|
# 2. Select any bmad-{agent} mode (e.g., "bmad-dev", "bmad-pm")
|
|
48
48
|
# 3. The AI will adopt that agent's full personality and capabilities
|
|
@@ -52,7 +52,7 @@ ide-configurations:
|
|
|
52
52
|
format: multi-file
|
|
53
53
|
command-suffix: .md
|
|
54
54
|
instructions: |
|
|
55
|
-
# To use
|
|
55
|
+
# To use BMad agents in Cline:
|
|
56
56
|
# 1. Open the Cline chat panel in VS Code
|
|
57
57
|
# 2. Type @agent-name (e.g., "@dev", "@pm", "@architect")
|
|
58
58
|
# 3. The agent will adopt that persona for the conversation
|
|
@@ -62,18 +62,18 @@ ide-configurations:
|
|
|
62
62
|
rule-dir: .gemini/agents/
|
|
63
63
|
format: context-files
|
|
64
64
|
instructions: |
|
|
65
|
-
# To use
|
|
65
|
+
# To use BMad agents with the Gemini CLI:
|
|
66
66
|
# 1. The installer creates a .gemini/ directory in your project.
|
|
67
67
|
# 2. It also configures .gemini/settings.json to load all agent files.
|
|
68
68
|
# 3. Simply mention the agent in your prompt (e.g., "As @dev, ...").
|
|
69
69
|
# 4. The Gemini CLI will automatically have the context for that agent.
|
|
70
|
-
|
|
71
|
-
name:
|
|
70
|
+
github-copilot:
|
|
71
|
+
name: Github Copilot
|
|
72
72
|
rule-dir: .github/chatmodes/
|
|
73
73
|
format: multi-file
|
|
74
74
|
command-suffix: .md
|
|
75
75
|
instructions: |
|
|
76
|
-
# To use
|
|
76
|
+
# To use BMad agents with Github Copilot:
|
|
77
77
|
# 1. The installer creates a .github/chatmodes/ directory in your project
|
|
78
78
|
# 2. Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
|
79
79
|
# 3. The agent will adopt that persona for the conversation
|
|
@@ -93,7 +93,7 @@ class ConfigLoader {
|
|
|
93
93
|
description: config['short-title'] || config.description || 'No description available',
|
|
94
94
|
fullDescription: config.description || config['short-title'] || 'No description available',
|
|
95
95
|
version: config.version || '1.0.0',
|
|
96
|
-
author: config.author || '
|
|
96
|
+
author: config.author || 'BMad Team',
|
|
97
97
|
packPath: packPath,
|
|
98
98
|
dependencies: config.dependencies?.agents || []
|
|
99
99
|
});
|
|
@@ -113,7 +113,7 @@ class ConfigLoader {
|
|
|
113
113
|
description: 'No description available',
|
|
114
114
|
fullDescription: 'No description available',
|
|
115
115
|
version: '1.0.0',
|
|
116
|
-
author: '
|
|
116
|
+
author: 'BMad Team',
|
|
117
117
|
packPath: packPath,
|
|
118
118
|
dependencies: []
|
|
119
119
|
});
|
|
@@ -63,7 +63,7 @@ class IdeSetup {
|
|
|
63
63
|
return this.setupCline(installDir, selectedAgent);
|
|
64
64
|
case "gemini":
|
|
65
65
|
return this.setupGeminiCli(installDir, selectedAgent);
|
|
66
|
-
case "
|
|
66
|
+
case "github-copilot":
|
|
67
67
|
return this.setupVsCodeCopilot(installDir, selectedAgent, spinner);
|
|
68
68
|
default:
|
|
69
69
|
console.log(chalk.yellow(`\nIDE ${ide} not yet supported`));
|
|
@@ -559,8 +559,8 @@ tools: ['changes', 'codebase', 'fetch', 'findTestFiles', 'githubRepo', 'problems
|
|
|
559
559
|
}
|
|
560
560
|
}
|
|
561
561
|
|
|
562
|
-
console.log(chalk.green(`\n✓
|
|
563
|
-
console.log(chalk.dim(`You can now find the
|
|
562
|
+
console.log(chalk.green(`\n✓ Github Copilot setup complete!`));
|
|
563
|
+
console.log(chalk.dim(`You can now find the BMad agents in the Chat view's mode selector.`));
|
|
564
564
|
|
|
565
565
|
return true;
|
|
566
566
|
}
|
|
@@ -578,7 +578,7 @@ tools: ['changes', 'codebase', 'fetch', 'findTestFiles', 'githubRepo', 'problems
|
|
|
578
578
|
try {
|
|
579
579
|
const existingContent = await fileManager.readFile(settingsPath);
|
|
580
580
|
existingSettings = JSON.parse(existingContent);
|
|
581
|
-
console.log(chalk.yellow("Found existing .vscode/settings.json. Merging
|
|
581
|
+
console.log(chalk.yellow("Found existing .vscode/settings.json. Merging BMad settings..."));
|
|
582
582
|
} catch (error) {
|
|
583
583
|
console.warn(chalk.yellow("Could not parse existing settings.json. Creating new one."));
|
|
584
584
|
existingSettings = {};
|
|
@@ -587,15 +587,15 @@ tools: ['changes', 'codebase', 'fetch', 'findTestFiles', 'githubRepo', 'problems
|
|
|
587
587
|
|
|
588
588
|
// Clear any previous output and add spacing to avoid conflicts with loaders
|
|
589
589
|
console.log('\n'.repeat(2));
|
|
590
|
-
console.log(chalk.blue("🔧
|
|
591
|
-
console.log(chalk.dim("
|
|
590
|
+
console.log(chalk.blue("🔧 Github Copilot Agent Settings Configuration"));
|
|
591
|
+
console.log(chalk.dim("BMad works best with specific VS Code settings for optimal agent experience."));
|
|
592
592
|
console.log(''); // Add extra spacing
|
|
593
593
|
|
|
594
594
|
const { configChoice } = await inquirer.prompt([
|
|
595
595
|
{
|
|
596
596
|
type: 'list',
|
|
597
597
|
name: 'configChoice',
|
|
598
|
-
message: 'How would you like to configure
|
|
598
|
+
message: 'How would you like to configure Github Copilot settings?',
|
|
599
599
|
choices: [
|
|
600
600
|
{
|
|
601
601
|
name: 'Use recommended defaults (fastest setup)',
|
|
@@ -638,7 +638,7 @@ tools: ['changes', 'codebase', 'fetch', 'findTestFiles', 'githubRepo', 'problems
|
|
|
638
638
|
"github.copilot.chat.agent.autoFix": true,
|
|
639
639
|
"chat.tools.autoApprove": false
|
|
640
640
|
};
|
|
641
|
-
console.log(chalk.green("✓ Using recommended
|
|
641
|
+
console.log(chalk.green("✓ Using recommended BMad defaults for Github Copilot settings"));
|
|
642
642
|
} else {
|
|
643
643
|
// Manual configuration
|
|
644
644
|
console.log(chalk.blue("\n📋 Let's configure each setting for your preferences:"));
|
|
@@ -696,7 +696,7 @@ tools: ['changes', 'codebase', 'fetch', 'findTestFiles', 'githubRepo', 'problems
|
|
|
696
696
|
}
|
|
697
697
|
|
|
698
698
|
bmadSettings = {
|
|
699
|
-
"chat.agent.enabled": true, // Always enabled - required for
|
|
699
|
+
"chat.agent.enabled": true, // Always enabled - required for BMad agents
|
|
700
700
|
"chat.agent.maxRequests": parseInt(manualSettings.maxRequests),
|
|
701
701
|
"github.copilot.chat.agent.runTasks": manualSettings.runTasks,
|
|
702
702
|
"chat.mcp.discovery.enabled": manualSettings.mcpDiscovery,
|