Compare commits
8 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
ddd3e53d12 | ||
|
|
2018ad07c7 | ||
|
|
38dd71db7f | ||
|
|
eb960f99f2 | ||
|
|
f440d14565 | ||
|
|
be4fcd8668 | ||
|
|
03f30ad28b | ||
|
|
e32b477e42 |
3
.gitignore
vendored
3
.gitignore
vendored
@@ -24,4 +24,5 @@ sample-project/*
|
||||
.bmad-core
|
||||
.bmad-creator-tools
|
||||
.gemini
|
||||
.bmad*/
|
||||
.bmad*/.cursor/
|
||||
web-bundles/
|
||||
|
||||
@@ -9,7 +9,7 @@ dist/
|
||||
*.log
|
||||
*.lock
|
||||
|
||||
# BMAD core files (have their own formatting)
|
||||
# BMad core files (have their own formatting)
|
||||
bmad-core/**/*.md
|
||||
|
||||
# Specific files that need custom formatting
|
||||
|
||||
16
CHANGELOG.md
16
CHANGELOG.md
@@ -1,3 +1,17 @@
|
||||
## [4.24.4](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.3...v4.24.4) (2025-07-04)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* documentation updates ([2018ad0](https://github.com/bmadcode/BMAD-METHOD/commit/2018ad07c7d4c68efb3c24d85ac7612942c6df9c))
|
||||
|
||||
## [4.24.3](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.2...v4.24.3) (2025-07-04)
|
||||
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* update YAML library from 'yaml' to 'js-yaml' in resolveExpansionPackCoreAgents for consistency ([#295](https://github.com/bmadcode/BMAD-METHOD/issues/295)) ([03f30ad](https://github.com/bmadcode/BMAD-METHOD/commit/03f30ad28b282fbb4fa5a6ed6b57d0327218cce0))
|
||||
|
||||
## [4.24.2](https://github.com/bmadcode/BMAD-METHOD/compare/v4.24.1...v4.24.2) (2025-07-03)
|
||||
|
||||
|
||||
@@ -31,7 +45,7 @@
|
||||
|
||||
### Features
|
||||
|
||||
* VS Code Copilot integration ([#284](https://github.com/bmadcode/BMAD-METHOD/issues/284)) ([1a4ca4f](https://github.com/bmadcode/BMAD-METHOD/commit/1a4ca4ffa630c2d4156bdd7a040d4c2274801757))
|
||||
* Github Copilot integration ([#284](https://github.com/bmadcode/BMAD-METHOD/issues/284)) ([1a4ca4f](https://github.com/bmadcode/BMAD-METHOD/commit/1a4ca4ffa630c2d4156bdd7a040d4c2274801757))
|
||||
|
||||
## [4.22.1](https://github.com/bmadcode/BMAD-METHOD/compare/v4.22.0...v4.22.1) (2025-06-30)
|
||||
|
||||
|
||||
44
README.md
44
README.md
@@ -1,4 +1,4 @@
|
||||
# BMad-METHOD: Universal AI Agent Framework
|
||||
# BMad-Method: Universal AI Agent Framework
|
||||
|
||||
[](https://www.npmjs.com/package/bmad-method)
|
||||
[](LICENSE)
|
||||
@@ -11,13 +11,13 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
||||
|
||||
**[Join our Discord Community](https://discord.gg/gk8jAdXWmj)** - A growing community for AI enthusiasts! Get help, share ideas, explore AI agents & frameworks, collaborate on tech projects, enjoy hobbies, and help each other succeed. Whether you're stuck on BMad, building your own agents, or just want to chat about the latest in AI - we're here for you!
|
||||
|
||||
⭐ **If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover BMad-METHOD and you will be notified of updates!
|
||||
⭐ **If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover BMad-Method and you will be notified of updates!
|
||||
|
||||
## Quick Navigation
|
||||
|
||||
### 🚨 MUST READ: Understanding the BMAD Workflow
|
||||
### 🚨 MUST READ: Understanding the BMad Workflow
|
||||
|
||||
**Before diving in, review these critical workflow diagrams that explain how BMAD works:**
|
||||
**Before diving in, review these critical workflow diagrams that explain how BMad works:**
|
||||
|
||||
1. **[Planning Workflow (Web UI)](docs/user-guide.md#the-planning-workflow-web-ui)** - How to create PRD and Architecture documents
|
||||
2. **[Core Development Cycle (IDE)](docs/user-guide.md#the-core-development-cycle-ide)** - How SM, Dev, and QA agents collaborate through story files
|
||||
@@ -26,8 +26,8 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
||||
|
||||
### What would you like to do?
|
||||
|
||||
- **[Build software with Full Stack Agile AI Team](#-quick-start)** → Quick Start Instruction
|
||||
- **[Learn how to use BMAD](docs/user-guide.md)** → Complete user guide and walkthrough
|
||||
- **[Build software with Full Stack Agile AI Team](quick-start)** → Quick Start Instruction
|
||||
- **[Learn how to use BMad](docs/user-guide.md)** → Complete user guide and walkthrough
|
||||
- **[See available AI agents](#available-agents)** → Specialized roles for your team
|
||||
- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
|
||||
- **[Create my own AI agents](#creating-your-own-expansion-pack)** → Build agents for your domain
|
||||
@@ -37,7 +37,7 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
||||
|
||||
### Popular Use Cases
|
||||
|
||||
- **Software Development** - [Quick Start](#-quick-start) | [User Guide](docs/user-guide.md) | [Workflow Guides](#documentation--guides)
|
||||
- **Software Development** - [Quick Start](quick-start) | [User Guide](docs/user-guide.md) | [Workflow Guides](#documentation--guides)
|
||||
- **Game Development** - [2D Phaser Pack](expansion-packs/bmad-2d-phaser-game-dev/)
|
||||
- **Business Strategy** - [Full Guide](docs/expansion-packs.md#business-strategy-pack)
|
||||
- **Creative Writing** - [Full Guide](docs/expansion-packs.md#creative-writing-pack)
|
||||
@@ -47,12 +47,12 @@ Foundations in Agentic Agile Driven Development, known as the Breakthrough Metho
|
||||
|
||||
- **[Installation](#installation)** → Get started in minutes
|
||||
- **[Documentation](#documentation--guides)** → All guides and references
|
||||
- **[Contributing](#contributing)** → Help improve BMAD
|
||||
- **[Contributing](#contributing)** → Help improve BMad
|
||||
- **[Support](#support)** → Get help and connect
|
||||
|
||||
## Important: Keep Your BMad Installation Updated
|
||||
|
||||
**Stay up-to-date effortlessly!** If you already have BMad-METHOD installed in your project, simply run:
|
||||
**Stay up-to-date effortlessly!** If you already have BMad-Method installed in your project, simply run:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
@@ -111,9 +111,9 @@ npm run install:bmad # build and install all to a destination folder
|
||||
|
||||
## Overview
|
||||
|
||||
The BMad Method (Breakthrough Method of Agile Agentic-Driven Development) elevates 'Vibe Coding' by providing specialized AI agents for every role in an Agile team. Each agent has deep expertise in their domain helping you really plan and execute on your vision while keeping the agents on the rails even through complex application plans.
|
||||
The BMad Method (Breakthrough Method of Agile Agentic-Driven Development) elevates 'Vibe Coding' by utilizing advanced prompt engineering techniques and critical context management at the most critical stages of development implementation. By providing specialized AI agents for every role in an Agile team, each agent has deep expertise in their domain helping you really plan and execute on your vision while keeping the agents on the rails even through complex application plans.
|
||||
|
||||
Unlike systems like Task Master, or inbuilt Task tool, the BMad Methods agile flow does so much more. With most systems, you give your idea in a few sentences at most, and the system churns out a plan, task list, lets you review it and then starts executing. Where the BMad agile flow is different is you can choose to have more upfront planning and architecture specification to ensure the system is built in a sustainable way, not a vibe coded spaghetti mess. When producing the PRD and Architectures (full stack, front end and or backend), the Agents work with you back and forth using advanced proven LLM techniques and techniques also based in psychology to produce beyond the average slop LLMs and Task generators will on their own. This truly is a system of Human in the Loop produces markedly better results.
|
||||
Unlike systems like Task Master, or inbuilt Task tools, the BMad Methods agile flow does so much more. With most systems, you give your idea, and the system churns out a plan, task list, lets you review it and then starts executing. Where the BMad agile flow is different is you can choose to have more upfront planning and architecture specification to ensure the system is built in a sustainable way, not a vibe coded spaghetti mess. When producing the PRD and Architectures (full stack, front end and or backend), the Agents work with you back and forth using advanced proven LLM prompt engineering advanced techniques to produce anything beyond what the average slop LLMs and Task generators will produce on their own. This truly is a system of Human in the Loop producing markedly better results.
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -156,7 +156,7 @@ The BMad Method works with any IDE, but has built-in integration for:
|
||||
- `gemini-cli` - Gemini with @agent commands
|
||||
- `windsurf` - Windsurf with manual rule @agent commands
|
||||
- `roo` - Roo Code with custom modes (see `.roomodes`)
|
||||
- `vs-code-copilot` - VS Code with GitHub Copilot agent mode integration
|
||||
- `github-copilot` - GitHub Copilot agent mode integration
|
||||
|
||||
## Available Agents
|
||||
|
||||
@@ -208,7 +208,7 @@ Many of the Agents and Templates for docs, and some tasks, include Advanced Elic
|
||||
|
||||
## Usage
|
||||
|
||||
The BMAD Method follows a structured Agile workflow with specialized AI agents. For complete usage instructions and walkthroughs, see the **[User Guide](docs/user-guide.md)**.
|
||||
The BMad Method follows a structured Agile workflow with specialized AI agents. For complete usage instructions and walkthroughs, see the **[User Guide](docs/user-guide.md)**.
|
||||
|
||||
### Quick Start Examples
|
||||
|
||||
@@ -274,12 +274,12 @@ See the **[Core Architecture](docs/core-architecture.md)** for the complete sour
|
||||
### Architecture & Technical
|
||||
|
||||
- 🏗️ [Core Architecture](docs/core-architecture.md) - Complete technical architecture and system design
|
||||
- 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMAD-METHOD effectively
|
||||
- 🚀 [Expansion Packs Guide](docs/expansion-packs.md) - Extend BMAD to any domain beyond software development
|
||||
- 📖 [User Guide](docs/user-guide.md) - Comprehensive guide to using BMad-Method effectively
|
||||
- 🚀 [Expansion Packs Guide](docs/expansion-packs.md) - Extend BMad to any domain beyond software development
|
||||
|
||||
### Workflow Guides
|
||||
|
||||
- 📚 [Universal BMAD Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
|
||||
- 📚 [Universal BMad Workflow Guide](docs/bmad-workflow-guide.md) - Core workflow that applies to all IDEs
|
||||
- 🏗️ [Working in the Brownfield Guide](docs/working-in-the-brownfield.md) - Complete guide for enhancing existing projects
|
||||
|
||||
### IDE-Specific Guides
|
||||
@@ -290,11 +290,11 @@ See the **[Core Architecture](docs/core-architecture.md)** for the complete sour
|
||||
- 🦘 [Roo Code Guide](docs/agentic-tools/roo-code-guide.md) - Setup and usage for Roo Code
|
||||
- 🔧 [Cline Guide](docs/agentic-tools/cline-guide.md) - Setup and usage for Cline (VS Code)
|
||||
- ✨ [Gemini CLI Guide](docs/agentic-tools/gemini-cli-guide.md) - Setup and usage for Gemini CLI
|
||||
- 💻 [VS Code Copilot Guide](docs/agentic-tools/vs-code-copilot-guide.md) - Setup and usage for VS Code with GitHub Copilot
|
||||
- 💻 [Github Copilot Guide](docs/agentic-tools/github-copilot-guide.md) - Setup and usage for VS Code with GitHub Copilot
|
||||
|
||||
## 🌟 Beyond Software Development - Expansion Packs
|
||||
|
||||
While BMad excels at software development, its natural language framework can structure expertise in ANY domain. Expansion packs transform BMAD into a universal AI agent system for creative writing, business strategy, health & wellness, education, and much more.
|
||||
While BMad excels at software development, its natural language framework can structure expertise in ANY domain. Expansion packs transform BMad into a universal AI agent system for creative writing, business strategy, health & wellness, education, and much more.
|
||||
|
||||
### Available Expansion Packs
|
||||
|
||||
@@ -341,9 +341,9 @@ MIT License - see [LICENSE](LICENSE) for details.
|
||||
|
||||
- **Current**: [v4](https://github.com/bmadcode/bmad-method) - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
|
||||
- **Previous Versions**:
|
||||
- [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3) - Introduced the unified BMAD Agent and Gemini optimization
|
||||
- [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2) - Added web agents and template separation
|
||||
- [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1) - Original 7-file proof of concept
|
||||
- [Version 3](https://github.com/bmadcode/BMad-Method/tree/V3) - Introduced the unified BMad Agent and Gemini optimization
|
||||
- [Version 2](https://github.com/bmadcode/BMad-Method/tree/V2) - Added web agents and template separation
|
||||
- [Version 1](https://github.com/bmadcode/BMad-Method/tree/V1) - Original 7-file proof of concept
|
||||
|
||||
See [versions.md](docs/versions.md) for detailed version history and migration guides.
|
||||
|
||||
@@ -360,7 +360,7 @@ Created by Brian (BMad) Madison
|
||||
To ensure your contribution aligns with the BMad Method and gets merged smoothly:
|
||||
|
||||
1. 📋 **Read [CONTRIBUTING.md](CONTRIBUTING.md)** - Our contribution guidelines, PR requirements, and process
|
||||
2. 🎯 **Read [GUIDING-PRINCIPLES.md](GUIDING-PRINCIPLES.md)** - Core principles that keep BMAD powerful through simplicity
|
||||
2. 🎯 **Read [GUIDING-PRINCIPLES.md](GUIDING-PRINCIPLES.md)** - Core principles that keep BMad powerful through simplicity
|
||||
3. 🆕 **New to GitHub?** Start with our [Pull Request Guide](docs/how-to-contribute-with-pull-requests.md)
|
||||
|
||||
### Key Points to Remember
|
||||
|
||||
@@ -9,18 +9,18 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
|
||||
agent:
|
||||
name: BMad Master
|
||||
id: bmad-master
|
||||
title: BMAD Master Task Executor
|
||||
title: BMad Master Task Executor
|
||||
icon: 🧙
|
||||
whenToUse: Use when you need comprehensive expertise across all domains or rapid context switching between multiple agent capabilities
|
||||
persona:
|
||||
role: Master Task Executor & BMAD Method Expert
|
||||
style: Efficient, direct, action-oriented. Executes any BMAD task/template/util/checklist with precision
|
||||
identity: Universal executor of all BMAD-METHOD capabilities, directly runs any resource
|
||||
role: Master Task Executor & BMad Method Expert
|
||||
style: Efficient, direct, action-oriented. Executes any BMad task/template/util/checklist with precision
|
||||
identity: Universal executor of all BMad-Method capabilities, directly runs any resource
|
||||
focus: Direct execution without transformation, load resources only when needed
|
||||
core_principles:
|
||||
- Execute any resource directly without persona transformation
|
||||
- Load resources at runtime, never pre-load
|
||||
- Expert knowledge of all BMAD resources
|
||||
- Expert knowledge of all BMad resources
|
||||
- Track execution state and guide multi-step processes
|
||||
- Use numbered lists for choices
|
||||
- Process (*) commands immediately
|
||||
|
||||
@@ -9,13 +9,13 @@ REQUEST-RESOLUTION: Match user requests to your commands/dependencies flexibly (
|
||||
agent:
|
||||
name: BMad Orchestrator
|
||||
id: bmad-orchestrator
|
||||
title: BMAD Master Orchestrator
|
||||
title: BMad Master Orchestrator
|
||||
icon: 🎭
|
||||
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
||||
persona:
|
||||
role: Master Orchestrator & BMAD Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
|
||||
identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
|
||||
role: Master Orchestrator & BMad Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMad Method while orchestrating agents
|
||||
identity: Unified interface to all BMad-Method capabilities, dynamically transforms into any specialized agent
|
||||
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
||||
core_principles:
|
||||
- Become any agent on demand, loading files only when needed
|
||||
@@ -28,7 +28,7 @@ persona:
|
||||
- Process commands starting with * immediately
|
||||
- Always remind users that commands require * prefix
|
||||
startup:
|
||||
- Announce: Introduce yourself as the BMAD Orchestrator, explain you can coordinate agents and workflows
|
||||
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||
- Mention *help shows all available commands and options
|
||||
- Check for active workflow plan using utils#plan-management
|
||||
@@ -41,7 +41,7 @@ startup:
|
||||
commands: # All commands require * prefix when used (e.g., *help, *agent pm)
|
||||
help: Show this guide with available agents and workflows
|
||||
chat-mode: Start conversational mode for detailed assistance
|
||||
kb-mode: Load full BMAD knowledge base
|
||||
kb-mode: Load full BMad knowledge base
|
||||
status: Show current context, active agent, and progress
|
||||
agent: Transform into a specialized agent (list if name not specified)
|
||||
exit: Return to BMad or exit session
|
||||
@@ -56,13 +56,13 @@ commands: # All commands require * prefix when used (e.g., *help, *agent pm)
|
||||
party-mode: Group chat with all agents
|
||||
doc-out: Output full document
|
||||
help-display-template: |
|
||||
=== BMAD Orchestrator Commands ===
|
||||
=== BMad Orchestrator Commands ===
|
||||
All commands must start with * (asterisk)
|
||||
|
||||
Core Commands:
|
||||
*help ............... Show this guide
|
||||
*chat-mode .......... Start conversational mode for detailed assistance
|
||||
*kb-mode ............ Load full BMAD knowledge base
|
||||
*kb-mode ............ Load full BMad knowledge base
|
||||
*status ............. Show current context, active agent, and progress
|
||||
*exit ............... Return to BMad or exit session
|
||||
|
||||
@@ -104,7 +104,7 @@ transformation:
|
||||
- Announce transformation
|
||||
- Operate until exit
|
||||
loading:
|
||||
- KB: Only for *kb-mode or BMAD questions
|
||||
- KB: Only for *kb-mode or BMad questions
|
||||
- Agents: Only when transforming
|
||||
- Templates/Tasks: Only when executing
|
||||
- Always indicate loading
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Change Navigation Checklist
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
||||
|
||||
@@ -75,7 +75,7 @@ Think about both immediate and downstream effects.]]
|
||||
|
||||
## 3. Artifact Conflict & Impact Analysis
|
||||
|
||||
[[LLM: Documentation drives development in BMAD. Check each artifact:
|
||||
[[LLM: Documentation drives development in BMad. Check each artifact:
|
||||
|
||||
1. Does this change invalidate documented decisions?
|
||||
2. Are architectural assumptions still valid?
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# BMAD Knowledge Base
|
||||
# BMad Knowledge Base
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Key Features
|
||||
|
||||
@@ -12,7 +12,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Reusable Resources**: Portable templates, tasks, and checklists
|
||||
- **Slash Command Integration**: Quick agent switching and control
|
||||
|
||||
### When to Use BMAD
|
||||
### When to Use BMad
|
||||
|
||||
- **New Projects (Greenfield)**: Complete end-to-end development
|
||||
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
||||
@@ -20,11 +20,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Quality Assurance**: Structured testing and validation
|
||||
- **Documentation**: Professional PRDs, architecture docs, user stories
|
||||
|
||||
## How BMAD Works
|
||||
## How BMad Works
|
||||
|
||||
### The Core Method
|
||||
|
||||
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
|
||||
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
||||
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
||||
@@ -78,7 +78,7 @@ BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
||||
5. Type `/help` to see available commands
|
||||
|
||||
#### Option 2: IDE Integration
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, VS Code Copilot users
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
||||
|
||||
```bash
|
||||
# Interactive installation (recommended)
|
||||
@@ -93,16 +93,16 @@ npx bmad-method install
|
||||
- **Windsurf**: Built-in AI capabilities
|
||||
- **Cline**: VS Code extension with AI features
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **VS Code Copilot**: AI-powered coding assistant
|
||||
- **Github Copilot**: AI-powered coding assistant
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Verify Installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
|
||||
**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
|
||||
**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
|
||||
|
||||
### Environment Selection Guide
|
||||
|
||||
@@ -163,11 +163,11 @@ npx bmad-method install
|
||||
|
||||
## Core Configuration (core-config.yaml)
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
### What is core-config.yaml?
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
||||
- **Custom Locations**: Define where your documents and shards live
|
||||
@@ -196,7 +196,7 @@ This configuration file acts as a map for BMAD agents, telling them exactly wher
|
||||
|
||||
1. **No Forced Migrations**: Keep your existing document structure
|
||||
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
||||
3. **Custom Workflows**: Configure BMAD to match your team's process
|
||||
3. **Custom Workflows**: Configure BMad to match your team's process
|
||||
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
||||
|
||||
### Common Configurations
|
||||
@@ -279,7 +279,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
**Chat Management Guidelines**:
|
||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
||||
@@ -325,7 +325,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
|
||||
### System Overview
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
### Key Architectural Components
|
||||
|
||||
@@ -369,7 +369,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
||||
|
||||
### Template Processing System
|
||||
|
||||
BMAD employs a sophisticated template system with three key components:
|
||||
BMad employs a sophisticated template system with three key components:
|
||||
|
||||
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
||||
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
||||
@@ -398,7 +398,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
||||
3. Concatenating content into single text files with clear separators
|
||||
4. Outputting ready-to-upload bundles for web AI interfaces
|
||||
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
||||
|
||||
## Complete Development Workflow
|
||||
|
||||
@@ -659,7 +659,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
## Contributing to BMAD-METHOD
|
||||
## Contributing to BMad-Method
|
||||
|
||||
### Quick Contribution Guidelines
|
||||
|
||||
@@ -688,7 +688,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
||||
|
||||
### What Are Expansion Packs?
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Why Use Expansion Packs?
|
||||
|
||||
|
||||
@@ -11,7 +11,7 @@ Create detailed, implementation-ready stories for brownfield projects where trad
|
||||
- Working on brownfield projects with non-standard documentation
|
||||
- Stories need to be created from document-project output
|
||||
- Working from brownfield epics without full PRD/architecture
|
||||
- Existing project documentation doesn't follow BMAD v4+ structure
|
||||
- Existing project documentation doesn't follow BMad v4+ structure
|
||||
- Need to gather additional context from user during story creation
|
||||
|
||||
**Use create-next-story when:**
|
||||
@@ -117,7 +117,7 @@ If using brownfield PRD:
|
||||
|
||||
#### 2.3 From User Documentation
|
||||
|
||||
[[LLM: When working with non-BMAD documentation, actively extract and organize the information into categories the Dev agent will need]]
|
||||
[[LLM: When working with non-BMad documentation, actively extract and organize the information into categories the Dev agent will need]]
|
||||
|
||||
Ask the user to help identify:
|
||||
|
||||
|
||||
@@ -13,8 +13,8 @@ To identify the next logical story based on project progress and epic definition
|
||||
- Load `.bmad-core/core-config.yaml` from the project root
|
||||
- If the file does not exist:
|
||||
- HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can:
|
||||
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yaml and configure it for your project
|
||||
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
||||
1. Copy it from GITHUB BMad-Method/bmad-core/core-config.yaml and configure it for your project
|
||||
2. Run the BMad installer against your project to upgrade and add the file automatically
|
||||
Please add and configure core-config.yaml before proceeding."
|
||||
- Extract the following key configurations:
|
||||
- `devStoryLocation`: Where to save story files
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# KB Mode Interaction Task
|
||||
|
||||
## Purpose
|
||||
Provide a user-friendly interface to the BMAD knowledge base without overwhelming users with information upfront.
|
||||
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -10,23 +10,23 @@ When entering KB mode (*kb-mode), follow these steps:
|
||||
### 1. Welcome and Guide
|
||||
Announce entering KB mode with a brief, friendly introduction:
|
||||
|
||||
"I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD."
|
||||
"I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method."
|
||||
|
||||
### 2. Present Topic Areas
|
||||
Offer a concise list of main topic areas the user might want to explore:
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
### 3. Respond Contextually
|
||||
- Wait for user's specific question or topic selection
|
||||
@@ -50,20 +50,20 @@ When user is done or wants to exit KB mode:
|
||||
|
||||
**User**: *kb-mode
|
||||
|
||||
**Assistant**: I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD.
|
||||
**Assistant**: I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method.
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
**User**: Tell me about workflows
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Workflow Management
|
||||
|
||||
Enables BMAD orchestrator to manage and execute team workflows.
|
||||
Enables BMad orchestrator to manage and execute team workflows.
|
||||
|
||||
## Dynamic Workflow Loading
|
||||
|
||||
|
||||
42
dist/agents/analyst.txt
vendored
42
dist/agents/analyst.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -1950,11 +1950,11 @@ These replace the standard elicitation options when working on competitive analy
|
||||
==================== END: templates#competitor-analysis-tmpl ====================
|
||||
|
||||
==================== START: data#bmad-kb ====================
|
||||
# BMAD Knowledge Base
|
||||
# BMad Knowledge Base
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Key Features
|
||||
|
||||
@@ -1964,7 +1964,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Reusable Resources**: Portable templates, tasks, and checklists
|
||||
- **Slash Command Integration**: Quick agent switching and control
|
||||
|
||||
### When to Use BMAD
|
||||
### When to Use BMad
|
||||
|
||||
- **New Projects (Greenfield)**: Complete end-to-end development
|
||||
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
||||
@@ -1972,11 +1972,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Quality Assurance**: Structured testing and validation
|
||||
- **Documentation**: Professional PRDs, architecture docs, user stories
|
||||
|
||||
## How BMAD Works
|
||||
## How BMad Works
|
||||
|
||||
### The Core Method
|
||||
|
||||
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
|
||||
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
||||
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
|
||||
5. Type `/help` to see available commands
|
||||
|
||||
#### Option 2: IDE Integration
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, VS Code Copilot users
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
||||
|
||||
```bash
|
||||
# Interactive installation (recommended)
|
||||
@@ -2045,16 +2045,16 @@ npx bmad-method install
|
||||
- **Windsurf**: Built-in AI capabilities
|
||||
- **Cline**: VS Code extension with AI features
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **VS Code Copilot**: AI-powered coding assistant
|
||||
- **Github Copilot**: AI-powered coding assistant
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Verify Installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
|
||||
**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
|
||||
**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
|
||||
|
||||
### Environment Selection Guide
|
||||
|
||||
@@ -2115,11 +2115,11 @@ npx bmad-method install
|
||||
|
||||
## Core Configuration (core-config.yaml)
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
### What is core-config.yaml?
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
||||
- **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
|
||||
|
||||
1. **No Forced Migrations**: Keep your existing document structure
|
||||
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
||||
3. **Custom Workflows**: Configure BMAD to match your team's process
|
||||
3. **Custom Workflows**: Configure BMad to match your team's process
|
||||
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
||||
|
||||
### Common Configurations
|
||||
@@ -2231,7 +2231,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
**Chat Management Guidelines**:
|
||||
- **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
|
||||
|
||||
### System Overview
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
### Key Architectural Components
|
||||
|
||||
@@ -2321,7 +2321,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
||||
|
||||
### Template Processing System
|
||||
|
||||
BMAD employs a sophisticated template system with three key components:
|
||||
BMad employs a sophisticated template system with three key components:
|
||||
|
||||
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
||||
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:
|
||||
3. Concatenating content into single text files with clear separators
|
||||
4. Outputting ready-to-upload bundles for web AI interfaces
|
||||
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
||||
|
||||
## Complete Development Workflow
|
||||
|
||||
@@ -2611,7 +2611,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
## Contributing to BMAD-METHOD
|
||||
## Contributing to BMad-Method
|
||||
|
||||
### Quick Contribution Guidelines
|
||||
|
||||
@@ -2640,7 +2640,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
||||
|
||||
### What Are Expansion Packs?
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Why Use Expansion Packs?
|
||||
|
||||
@@ -2704,7 +2704,7 @@ Use the **expansion-creator** pack to build your own:
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
|
||||
6
dist/agents/architect.txt
vendored
6
dist/agents/architect.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -3896,7 +3896,7 @@ None Listed
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
|
||||
62
dist/agents/bmad-master.txt
vendored
62
dist/agents/bmad-master.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -47,18 +47,18 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
|
||||
agent:
|
||||
name: BMad Master
|
||||
id: bmad-master
|
||||
title: BMAD Master Task Executor
|
||||
title: BMad Master Task Executor
|
||||
icon: 🧙
|
||||
whenToUse: Use when you need comprehensive expertise across all domains or rapid context switching between multiple agent capabilities
|
||||
persona:
|
||||
role: Master Task Executor & BMAD Method Expert
|
||||
style: Efficient, direct, action-oriented. Executes any BMAD task/template/util/checklist with precision
|
||||
identity: Universal executor of all BMAD-METHOD capabilities, directly runs any resource
|
||||
role: Master Task Executor & BMad Method Expert
|
||||
style: Efficient, direct, action-oriented. Executes any BMad task/template/util/checklist with precision
|
||||
identity: Universal executor of all BMad-Method capabilities, directly runs any resource
|
||||
focus: Direct execution without transformation, load resources only when needed
|
||||
core_principles:
|
||||
- Execute any resource directly without persona transformation
|
||||
- Load resources at runtime, never pre-load
|
||||
- Expert knowledge of all BMAD resources
|
||||
- Expert knowledge of all BMad resources
|
||||
- Track execution state and guide multi-step processes
|
||||
- Use numbered lists for choices
|
||||
- Process (*) commands immediately
|
||||
@@ -1903,8 +1903,8 @@ To identify the next logical story based on project progress and epic definition
|
||||
- Load `.bmad-core/core-config.yaml` from the project root
|
||||
- If the file does not exist:
|
||||
- HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can:
|
||||
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yaml and configure it for your project
|
||||
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
||||
1. Copy it from GITHUB BMad-Method/bmad-core/core-config.yaml and configure it for your project
|
||||
2. Run the BMad installer against your project to upgrade and add the file automatically
|
||||
Please add and configure core-config.yaml before proceeding."
|
||||
- Extract the following key configurations:
|
||||
- `devStoryLocation`: Where to save story files
|
||||
@@ -7673,7 +7673,7 @@ After presenting the report, ask the user if they would like detailed analysis o
|
||||
==================== START: checklists#change-checklist ====================
|
||||
# Change Navigation Checklist
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
||||
|
||||
@@ -7748,7 +7748,7 @@ Think about both immediate and downstream effects.]]
|
||||
|
||||
## 3. Artifact Conflict & Impact Analysis
|
||||
|
||||
[[LLM: Documentation drives development in BMAD. Check each artifact:
|
||||
[[LLM: Documentation drives development in BMad. Check each artifact:
|
||||
|
||||
1. Does this change invalidate documented decisions?
|
||||
2. Are architectural assumptions still valid?
|
||||
@@ -8941,11 +8941,11 @@ Be pragmatic - perfect documentation doesn't exist. Focus on whether a competent
|
||||
==================== END: checklists#story-draft-checklist ====================
|
||||
|
||||
==================== START: data#bmad-kb ====================
|
||||
# BMAD Knowledge Base
|
||||
# BMad Knowledge Base
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Key Features
|
||||
|
||||
@@ -8955,7 +8955,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Reusable Resources**: Portable templates, tasks, and checklists
|
||||
- **Slash Command Integration**: Quick agent switching and control
|
||||
|
||||
### When to Use BMAD
|
||||
### When to Use BMad
|
||||
|
||||
- **New Projects (Greenfield)**: Complete end-to-end development
|
||||
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
||||
@@ -8963,11 +8963,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Quality Assurance**: Structured testing and validation
|
||||
- **Documentation**: Professional PRDs, architecture docs, user stories
|
||||
|
||||
## How BMAD Works
|
||||
## How BMad Works
|
||||
|
||||
### The Core Method
|
||||
|
||||
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
|
||||
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
||||
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
|
||||
5. Type `/help` to see available commands
|
||||
|
||||
#### Option 2: IDE Integration
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, VS Code Copilot users
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
||||
|
||||
```bash
|
||||
# Interactive installation (recommended)
|
||||
@@ -9036,16 +9036,16 @@ npx bmad-method install
|
||||
- **Windsurf**: Built-in AI capabilities
|
||||
- **Cline**: VS Code extension with AI features
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **VS Code Copilot**: AI-powered coding assistant
|
||||
- **Github Copilot**: AI-powered coding assistant
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Verify Installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
|
||||
**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
|
||||
**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
|
||||
|
||||
### Environment Selection Guide
|
||||
|
||||
@@ -9106,11 +9106,11 @@ npx bmad-method install
|
||||
|
||||
## Core Configuration (core-config.yaml)
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
### What is core-config.yaml?
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
||||
- **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
|
||||
|
||||
1. **No Forced Migrations**: Keep your existing document structure
|
||||
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
||||
3. **Custom Workflows**: Configure BMAD to match your team's process
|
||||
3. **Custom Workflows**: Configure BMad to match your team's process
|
||||
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
||||
|
||||
### Common Configurations
|
||||
@@ -9222,7 +9222,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
**Chat Management Guidelines**:
|
||||
- **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
|
||||
|
||||
### System Overview
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
### Key Architectural Components
|
||||
|
||||
@@ -9312,7 +9312,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
||||
|
||||
### Template Processing System
|
||||
|
||||
BMAD employs a sophisticated template system with three key components:
|
||||
BMad employs a sophisticated template system with three key components:
|
||||
|
||||
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
||||
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:
|
||||
3. Concatenating content into single text files with clear separators
|
||||
4. Outputting ready-to-upload bundles for web AI interfaces
|
||||
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
||||
|
||||
## Complete Development Workflow
|
||||
|
||||
@@ -9602,7 +9602,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
## Contributing to BMAD-METHOD
|
||||
## Contributing to BMad-Method
|
||||
|
||||
### Quick Contribution Guidelines
|
||||
|
||||
@@ -9631,7 +9631,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
||||
|
||||
### What Are Expansion Packs?
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Why Use Expansion Packs?
|
||||
|
||||
@@ -9927,7 +9927,7 @@ Would you like to:
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
@@ -9956,7 +9956,7 @@ Templates in the BMAD method use standardized markup for AI processing. These co
|
||||
==================== START: utils#workflow-management ====================
|
||||
# Workflow Management
|
||||
|
||||
Enables BMAD orchestrator to manage and execute team workflows.
|
||||
Enables BMad orchestrator to manage and execute team workflows.
|
||||
|
||||
## Dynamic Workflow Loading
|
||||
|
||||
|
||||
88
dist/agents/bmad-orchestrator.txt
vendored
88
dist/agents/bmad-orchestrator.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -47,13 +47,13 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
|
||||
agent:
|
||||
name: BMad Orchestrator
|
||||
id: bmad-orchestrator
|
||||
title: BMAD Master Orchestrator
|
||||
title: BMad Master Orchestrator
|
||||
icon: 🎭
|
||||
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
||||
persona:
|
||||
role: Master Orchestrator & BMAD Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
|
||||
identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
|
||||
role: Master Orchestrator & BMad Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMad Method while orchestrating agents
|
||||
identity: Unified interface to all BMad-Method capabilities, dynamically transforms into any specialized agent
|
||||
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
||||
core_principles:
|
||||
- Become any agent on demand, loading files only when needed
|
||||
@@ -66,7 +66,7 @@ persona:
|
||||
- Process commands starting with * immediately
|
||||
- Always remind users that commands require * prefix
|
||||
startup:
|
||||
- Announce: Introduce yourself as the BMAD Orchestrator, explain you can coordinate agents and workflows
|
||||
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||
- Mention *help shows all available commands and options
|
||||
- Check for active workflow plan using utils#plan-management
|
||||
@@ -79,7 +79,7 @@ startup:
|
||||
commands:
|
||||
help: Show this guide with available agents and workflows
|
||||
chat-mode: Start conversational mode for detailed assistance
|
||||
kb-mode: Load full BMAD knowledge base
|
||||
kb-mode: Load full BMad knowledge base
|
||||
status: Show current context, active agent, and progress
|
||||
agent: Transform into a specialized agent (list if name not specified)
|
||||
exit: Return to BMad or exit session
|
||||
@@ -94,13 +94,13 @@ commands:
|
||||
party-mode: Group chat with all agents
|
||||
doc-out: Output full document
|
||||
help-display-template: |
|
||||
=== BMAD Orchestrator Commands ===
|
||||
=== BMad Orchestrator Commands ===
|
||||
All commands must start with * (asterisk)
|
||||
|
||||
Core Commands:
|
||||
*help ............... Show this guide
|
||||
*chat-mode .......... Start conversational mode for detailed assistance
|
||||
*kb-mode ............ Load full BMAD knowledge base
|
||||
*kb-mode ............ Load full BMad knowledge base
|
||||
*status ............. Show current context, active agent, and progress
|
||||
*exit ............... Return to BMad or exit session
|
||||
|
||||
@@ -141,7 +141,7 @@ transformation:
|
||||
- Announce transformation
|
||||
- Operate until exit
|
||||
loading:
|
||||
- KB: Only for *kb-mode or BMAD questions
|
||||
- KB: Only for *kb-mode or BMad questions
|
||||
- Agents: Only when transforming
|
||||
- Templates/Tasks: Only when executing
|
||||
- Always indicate loading
|
||||
@@ -662,7 +662,7 @@ BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This
|
||||
# KB Mode Interaction Task
|
||||
|
||||
## Purpose
|
||||
Provide a user-friendly interface to the BMAD knowledge base without overwhelming users with information upfront.
|
||||
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -671,23 +671,23 @@ When entering KB mode (*kb-mode), follow these steps:
|
||||
### 1. Welcome and Guide
|
||||
Announce entering KB mode with a brief, friendly introduction:
|
||||
|
||||
"I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD."
|
||||
"I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method."
|
||||
|
||||
### 2. Present Topic Areas
|
||||
Offer a concise list of main topic areas the user might want to explore:
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
### 3. Respond Contextually
|
||||
- Wait for user's specific question or topic selection
|
||||
@@ -711,20 +711,20 @@ When user is done or wants to exit KB mode:
|
||||
|
||||
**User**: *kb-mode
|
||||
|
||||
**Assistant**: I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD.
|
||||
**Assistant**: I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method.
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
**User**: Tell me about workflows
|
||||
|
||||
@@ -983,11 +983,11 @@ The update is successful when:
|
||||
==================== END: tasks#update-workflow-plan ====================
|
||||
|
||||
==================== START: data#bmad-kb ====================
|
||||
# BMAD Knowledge Base
|
||||
# BMad Knowledge Base
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Key Features
|
||||
|
||||
@@ -997,7 +997,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Reusable Resources**: Portable templates, tasks, and checklists
|
||||
- **Slash Command Integration**: Quick agent switching and control
|
||||
|
||||
### When to Use BMAD
|
||||
### When to Use BMad
|
||||
|
||||
- **New Projects (Greenfield)**: Complete end-to-end development
|
||||
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
||||
@@ -1005,11 +1005,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Quality Assurance**: Structured testing and validation
|
||||
- **Documentation**: Professional PRDs, architecture docs, user stories
|
||||
|
||||
## How BMAD Works
|
||||
## How BMad Works
|
||||
|
||||
### The Core Method
|
||||
|
||||
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
|
||||
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
||||
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
||||
@@ -1063,7 +1063,7 @@ BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
||||
5. Type `/help` to see available commands
|
||||
|
||||
#### Option 2: IDE Integration
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, VS Code Copilot users
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
||||
|
||||
```bash
|
||||
# Interactive installation (recommended)
|
||||
@@ -1078,16 +1078,16 @@ npx bmad-method install
|
||||
- **Windsurf**: Built-in AI capabilities
|
||||
- **Cline**: VS Code extension with AI features
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **VS Code Copilot**: AI-powered coding assistant
|
||||
- **Github Copilot**: AI-powered coding assistant
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Verify Installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
|
||||
**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
|
||||
**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
|
||||
|
||||
### Environment Selection Guide
|
||||
|
||||
@@ -1148,11 +1148,11 @@ npx bmad-method install
|
||||
|
||||
## Core Configuration (core-config.yaml)
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
### What is core-config.yaml?
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
||||
- **Custom Locations**: Define where your documents and shards live
|
||||
@@ -1181,7 +1181,7 @@ This configuration file acts as a map for BMAD agents, telling them exactly wher
|
||||
|
||||
1. **No Forced Migrations**: Keep your existing document structure
|
||||
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
||||
3. **Custom Workflows**: Configure BMAD to match your team's process
|
||||
3. **Custom Workflows**: Configure BMad to match your team's process
|
||||
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
||||
|
||||
### Common Configurations
|
||||
@@ -1264,7 +1264,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
**Chat Management Guidelines**:
|
||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
||||
@@ -1310,7 +1310,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
|
||||
### System Overview
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
### Key Architectural Components
|
||||
|
||||
@@ -1354,7 +1354,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
||||
|
||||
### Template Processing System
|
||||
|
||||
BMAD employs a sophisticated template system with three key components:
|
||||
BMad employs a sophisticated template system with three key components:
|
||||
|
||||
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
||||
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
||||
@@ -1383,7 +1383,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
||||
3. Concatenating content into single text files with clear separators
|
||||
4. Outputting ready-to-upload bundles for web AI interfaces
|
||||
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
||||
|
||||
## Complete Development Workflow
|
||||
|
||||
@@ -1644,7 +1644,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
## Contributing to BMAD-METHOD
|
||||
## Contributing to BMad-Method
|
||||
|
||||
### Quick Contribution Guidelines
|
||||
|
||||
@@ -1673,7 +1673,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
||||
|
||||
### What Are Expansion Packs?
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Why Use Expansion Packs?
|
||||
|
||||
@@ -1963,7 +1963,7 @@ Would you like to:
|
||||
==================== START: utils#workflow-management ====================
|
||||
# Workflow Management
|
||||
|
||||
Enables BMAD orchestrator to manage and execute team workflows.
|
||||
Enables BMad orchestrator to manage and execute team workflows.
|
||||
|
||||
## Dynamic Workflow Loading
|
||||
|
||||
@@ -2035,7 +2035,7 @@ Agents should be workflow-aware: know active workflow, their role, access artifa
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
|
||||
4
dist/agents/dev.txt
vendored
4
dist/agents/dev.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
|
||||
10
dist/agents/pm.txt
vendored
10
dist/agents/pm.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -2031,7 +2031,7 @@ After presenting the report, ask if the user wants:
|
||||
==================== START: checklists#change-checklist ====================
|
||||
# Change Navigation Checklist
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
||||
|
||||
@@ -2106,7 +2106,7 @@ Think about both immediate and downstream effects.]]
|
||||
|
||||
## 3. Artifact Conflict & Impact Analysis
|
||||
|
||||
[[LLM: Documentation drives development in BMAD. Check each artifact:
|
||||
[[LLM: Documentation drives development in BMad. Check each artifact:
|
||||
|
||||
1. Does this change invalidate documented decisions?
|
||||
2. Are architectural assumptions still valid?
|
||||
@@ -2222,7 +2222,7 @@ None Listed
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
|
||||
10
dist/agents/po.txt
vendored
10
dist/agents/po.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -1299,7 +1299,7 @@ After presenting the report, ask if the user wants:
|
||||
==================== START: checklists#change-checklist ====================
|
||||
# Change Navigation Checklist
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
||||
|
||||
@@ -1374,7 +1374,7 @@ Think about both immediate and downstream effects.]]
|
||||
|
||||
## 3. Artifact Conflict & Impact Analysis
|
||||
|
||||
[[LLM: Documentation drives development in BMAD. Check each artifact:
|
||||
[[LLM: Documentation drives development in BMad. Check each artifact:
|
||||
|
||||
1. Does this change invalidate documented decisions?
|
||||
2. Are architectural assumptions still valid?
|
||||
@@ -1484,7 +1484,7 @@ Keep it action-oriented and forward-looking.]]
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
|
||||
6
dist/agents/qa.txt
vendored
6
dist/agents/qa.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -235,7 +235,7 @@ None Listed
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
|
||||
10
dist/agents/sm.txt
vendored
10
dist/agents/sm.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -105,8 +105,8 @@ To identify the next logical story based on project progress and epic definition
|
||||
- Load `.bmad-core/core-config.yaml` from the project root
|
||||
- If the file does not exist:
|
||||
- HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can:
|
||||
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yaml and configure it for your project
|
||||
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
||||
1. Copy it from GITHUB BMad-Method/bmad-core/core-config.yaml and configure it for your project
|
||||
2. Run the BMad installer against your project to upgrade and add the file automatically
|
||||
Please add and configure core-config.yaml before proceeding."
|
||||
- Extract the following key configurations:
|
||||
- `devStoryLocation`: Where to save story files
|
||||
@@ -699,7 +699,7 @@ Be pragmatic - perfect documentation doesn't exist. Focus on whether a competent
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
|
||||
6
dist/agents/ux-expert.txt
vendored
6
dist/agents/ux-expert.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -1074,7 +1074,7 @@ None Listed
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -127,13 +127,13 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
|
||||
agent:
|
||||
name: BMad Orchestrator
|
||||
id: bmad-orchestrator
|
||||
title: BMAD Master Orchestrator
|
||||
title: BMad Master Orchestrator
|
||||
icon: 🎭
|
||||
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
||||
persona:
|
||||
role: Master Orchestrator & BMAD Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
|
||||
identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
|
||||
role: Master Orchestrator & BMad Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMad Method while orchestrating agents
|
||||
identity: Unified interface to all BMad-Method capabilities, dynamically transforms into any specialized agent
|
||||
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
||||
core_principles:
|
||||
- Become any agent on demand, loading files only when needed
|
||||
@@ -146,7 +146,7 @@ persona:
|
||||
- Process commands starting with * immediately
|
||||
- Always remind users that commands require * prefix
|
||||
startup:
|
||||
- Announce: Introduce yourself as the BMAD Orchestrator, explain you can coordinate agents and workflows
|
||||
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||
- Mention *help shows all available commands and options
|
||||
- Check for active workflow plan using utils#plan-management
|
||||
@@ -159,7 +159,7 @@ startup:
|
||||
commands:
|
||||
help: Show this guide with available agents and workflows
|
||||
chat-mode: Start conversational mode for detailed assistance
|
||||
kb-mode: Load full BMAD knowledge base
|
||||
kb-mode: Load full BMad knowledge base
|
||||
status: Show current context, active agent, and progress
|
||||
agent: Transform into a specialized agent (list if name not specified)
|
||||
exit: Return to BMad or exit session
|
||||
@@ -174,13 +174,13 @@ commands:
|
||||
party-mode: Group chat with all agents
|
||||
doc-out: Output full document
|
||||
help-display-template: |
|
||||
=== BMAD Orchestrator Commands ===
|
||||
=== BMad Orchestrator Commands ===
|
||||
All commands must start with * (asterisk)
|
||||
|
||||
Core Commands:
|
||||
*help ............... Show this guide
|
||||
*chat-mode .......... Start conversational mode for detailed assistance
|
||||
*kb-mode ............ Load full BMAD knowledge base
|
||||
*kb-mode ............ Load full BMad knowledge base
|
||||
*status ............. Show current context, active agent, and progress
|
||||
*exit ............... Return to BMad or exit session
|
||||
|
||||
@@ -221,7 +221,7 @@ transformation:
|
||||
- Announce transformation
|
||||
- Operate until exit
|
||||
loading:
|
||||
- KB: Only for *kb-mode or BMAD questions
|
||||
- KB: Only for *kb-mode or BMad questions
|
||||
- Agents: Only when transforming
|
||||
- Templates/Tasks: Only when executing
|
||||
- Always indicate loading
|
||||
@@ -2308,11 +2308,11 @@ These replace the standard elicitation options when working on competitive analy
|
||||
==================== END: templates#competitor-analysis-tmpl ====================
|
||||
|
||||
==================== START: data#bmad-kb ====================
|
||||
# Game Development BMAD Knowledge Base
|
||||
# Game Development BMad Knowledge Base
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Game Development Focus
|
||||
|
||||
@@ -2561,13 +2561,13 @@ game-project/
|
||||
- Culling and level-of-detail systems
|
||||
- Memory management and garbage collection optimization
|
||||
|
||||
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.
|
||||
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.
|
||||
==================== END: data#bmad-kb ====================
|
||||
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
@@ -2889,7 +2889,7 @@ BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This
|
||||
# KB Mode Interaction Task
|
||||
|
||||
## Purpose
|
||||
Provide a user-friendly interface to the BMAD knowledge base without overwhelming users with information upfront.
|
||||
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -2898,23 +2898,23 @@ When entering KB mode (*kb-mode), follow these steps:
|
||||
### 1. Welcome and Guide
|
||||
Announce entering KB mode with a brief, friendly introduction:
|
||||
|
||||
"I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD."
|
||||
"I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method."
|
||||
|
||||
### 2. Present Topic Areas
|
||||
Offer a concise list of main topic areas the user might want to explore:
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
### 3. Respond Contextually
|
||||
- Wait for user's specific question or topic selection
|
||||
@@ -2938,20 +2938,20 @@ When user is done or wants to exit KB mode:
|
||||
|
||||
**User**: *kb-mode
|
||||
|
||||
**Assistant**: I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD.
|
||||
**Assistant**: I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method.
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
**User**: Tell me about workflows
|
||||
|
||||
@@ -3438,7 +3438,7 @@ Would you like to:
|
||||
==================== START: utils#workflow-management ====================
|
||||
# Workflow Management
|
||||
|
||||
Enables BMAD orchestrator to manage and execute team workflows.
|
||||
Enables BMad orchestrator to manage and execute team workflows.
|
||||
|
||||
## Dynamic Workflow Loading
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -52,27 +52,27 @@ activation-instructions:
|
||||
agent:
|
||||
name: The Creator
|
||||
id: bmad-the-creator
|
||||
title: BMAD Framework Extension Specialist
|
||||
title: BMad Framework Extension Specialist
|
||||
icon: 🏗️
|
||||
whenToUse: Use for creating new agents, expansion packs, and extending the BMAD framework
|
||||
whenToUse: Use for creating new agents, expansion packs, and extending the BMad framework
|
||||
customization: null
|
||||
persona:
|
||||
role: Expert BMAD Framework Architect & Creator
|
||||
role: Expert BMad Framework Architect & Creator
|
||||
style: Methodical, creative, framework-aware, systematic
|
||||
identity: Master builder who extends BMAD capabilities through thoughtful design and deep framework understanding
|
||||
focus: Creating well-structured agents, expansion packs, and framework extensions that follow BMAD patterns and conventions
|
||||
identity: Master builder who extends BMad capabilities through thoughtful design and deep framework understanding
|
||||
focus: Creating well-structured agents, expansion packs, and framework extensions that follow BMad patterns and conventions
|
||||
core_principles:
|
||||
- Framework Consistency - All creations follow established BMAD patterns
|
||||
- Framework Consistency - All creations follow established BMad patterns
|
||||
- Modular Design - Create reusable, composable components
|
||||
- Clear Documentation - Every creation includes proper documentation
|
||||
- Convention Over Configuration - Follow BMAD naming and structure patterns
|
||||
- Convention Over Configuration - Follow BMad naming and structure patterns
|
||||
- Extensibility First - Design for future expansion and customization
|
||||
- Numbered Options Protocol - Always use numbered lists for user selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- CRITICAL: Do NOT automatically create documents or execute tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with BMAD framework extensions but wait for explicit user confirmation
|
||||
- Offer to help with BMad framework extensions but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
@@ -97,7 +97,7 @@ dependencies:
|
||||
==================== START: tasks#create-agent ====================
|
||||
# Create Agent Task
|
||||
|
||||
This task guides you through creating a new BMAD agent following the standard template.
|
||||
This task guides you through creating a new BMad agent following the standard template.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
@@ -300,11 +300,11 @@ dependencies:
|
||||
==================== START: tasks#generate-expansion-pack ====================
|
||||
# Create Expansion Pack Task
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Understanding Expansion Packs
|
||||
|
||||
Expansion packs extend BMAD with domain-specific capabilities using sophisticated AI agent orchestration patterns. They are self-contained packages that leverage:
|
||||
Expansion packs extend BMad with domain-specific capabilities using sophisticated AI agent orchestration patterns. They are self-contained packages that leverage:
|
||||
|
||||
- **Advanced Agent Architecture**: YAML-in-Markdown with embedded personas and character consistency
|
||||
- **Template Systems**: LLM instruction embedding with conditional content and dynamic variables
|
||||
@@ -312,7 +312,7 @@ Expansion packs extend BMAD with domain-specific capabilities using sophisticate
|
||||
- **Quality Assurance**: Multi-level validation with star ratings and comprehensive checklists
|
||||
- **Knowledge Integration**: Domain-specific data organization and best practices embedding
|
||||
|
||||
Every expansion pack MUST include a custom BMAD orchestrator agent with sophisticated command systems and numbered options protocols.
|
||||
Every expansion pack MUST include a custom BMad orchestrator agent with sophisticated command systems and numbered options protocols.
|
||||
|
||||
## CRITICAL REQUIREMENTS
|
||||
|
||||
@@ -383,7 +383,7 @@ Create `expansion-packs/{pack-name}/plan.md` with:
|
||||
|
||||
### Agents (with Character Personas)
|
||||
|
||||
- [ ] {pack-name}-orchestrator (REQUIRED: Custom BMAD orchestrator)
|
||||
- [ ] {pack-name}-orchestrator (REQUIRED: Custom BMad orchestrator)
|
||||
- Character Name: {human-name}
|
||||
- Communication Style: {style}
|
||||
- Key Commands: {command-list}
|
||||
@@ -457,7 +457,7 @@ Important: Wait for user approval before proceeding to Phase 2
|
||||
|
||||
#### 2.1 Create Orchestrator Agent with Domain-Themed Character
|
||||
|
||||
**FIRST PRIORITY**: Design the custom BMAD orchestrator with domain-appropriate theme:
|
||||
**FIRST PRIORITY**: Design the custom BMad orchestrator with domain-appropriate theme:
|
||||
|
||||
**Themed Character Design:**
|
||||
|
||||
@@ -483,7 +483,7 @@ Important: Wait for user approval before proceeding to Phase 2
|
||||
- **Activation Instructions**: Embedded YAML with behavior directives
|
||||
- **Startup Procedures**: Initialize without auto-execution
|
||||
- **Dependencies**: Clear references to tasks, templates, and data files
|
||||
- **Integration Points**: How it coordinates with core BMAD agents
|
||||
- **Integration Points**: How it coordinates with core BMad agents
|
||||
|
||||
#### 2.2 Design Specialist Agents with Character Personas
|
||||
|
||||
@@ -674,7 +674,7 @@ embedded_knowledge:
|
||||
- {domain}-terminology.md
|
||||
- {domain}-standards.md
|
||||
|
||||
# Dependencies on core BMAD components
|
||||
# Dependencies on core BMad components
|
||||
core_dependencies:
|
||||
agents:
|
||||
- architect # For system design
|
||||
@@ -1163,7 +1163,7 @@ Embedded knowledge (automatic):
|
||||
7. "Where in the workflow should users choose between different paths?"
|
||||
8. "How should the orchestrator hand off to specialist agents?"
|
||||
9. "What quality gates should be built into the workflow?"
|
||||
10. "How should it integrate with core BMAD agents?"
|
||||
10. "How should it integrate with core BMad agents?"
|
||||
|
||||
### Agent Planning
|
||||
|
||||
@@ -1213,7 +1213,7 @@ Embedded knowledge (automatic):
|
||||
**Quality and Validation:**
|
||||
|
||||
- **Plan First**: ALWAYS create and get approval for plan.md before implementing
|
||||
- **Orchestrator Required**: Every pack MUST have a custom BMAD orchestrator with sophisticated command system
|
||||
- **Orchestrator Required**: Every pack MUST have a custom BMad orchestrator with sophisticated command system
|
||||
- **Verify References**: ALL referenced tasks/templates MUST exist and be tested
|
||||
- **Multi-Level Validation**: Quality systems must provide basic, comprehensive, and expert-level assessment
|
||||
- **Domain Expertise**: Ensure accuracy in specialized fields with embedded best practices
|
||||
@@ -1938,7 +1938,7 @@ Users must add these files to `bmad-core/data/`:
|
||||
|
||||
## Integration Points
|
||||
|
||||
- Depends on core agents: {list any core BMAD agents used}
|
||||
- Depends on core agents: {list any core BMad agents used}
|
||||
- Extends teams: {which teams to update}
|
||||
|
||||
## Success Criteria
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -252,13 +252,13 @@ To conduct a thorough review of existing infrastructure to identify improvement
|
||||
- Create an improvement roadmap with suggested timelines
|
||||
- Highlight cost optimization opportunities
|
||||
|
||||
### 5. BMAD Integration Assessment
|
||||
### 5. BMad Integration Assessment
|
||||
|
||||
- Evaluate how current infrastructure supports other BMAD agents:
|
||||
- Evaluate how current infrastructure supports other BMad agents:
|
||||
- **Development Support:** Assess how infrastructure enables Frontend Dev (Mira), Backend Dev (Enrique), and Full Stack Dev workflows
|
||||
- **Product Alignment:** Verify infrastructure supports PRD requirements from Product Owner (Oli)
|
||||
- **Architecture Compliance:** Check if implementation follows Architect (Alphonse) decisions
|
||||
- Document any gaps in BMAD integration
|
||||
- Document any gaps in BMad integration
|
||||
|
||||
### 6. Architectural Escalation Assessment
|
||||
|
||||
@@ -330,7 +330,7 @@ A comprehensive infrastructure review report that includes:
|
||||
2. **Prioritized findings** with severity ratings
|
||||
3. **Detailed recommendations** with effort/impact estimates
|
||||
4. **Cost optimization opportunities**
|
||||
5. **BMAD integration assessment**
|
||||
5. **BMad integration assessment**
|
||||
6. **Architectural escalation assessment** with clear escalation recommendations
|
||||
7. **Action plan** for critical improvements and architectural work
|
||||
8. **Escalation documentation** for Architect Agent collaboration (if applicable)
|
||||
@@ -362,7 +362,7 @@ REPEAT by Asking the user if they would like to perform another Reflective, Elic
|
||||
|
||||
## Purpose
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Inputs
|
||||
|
||||
@@ -442,9 +442,9 @@ To comprehensively validate platform infrastructure changes against security, re
|
||||
- Provide validation signoff recommendation based on complete platform assessment
|
||||
- Document platform component integration validation results
|
||||
|
||||
### 6. BMAD Integration Assessment
|
||||
### 6. BMad Integration Assessment
|
||||
|
||||
- Review how platform infrastructure changes support other BMAD agents:
|
||||
- Review how platform infrastructure changes support other BMad agents:
|
||||
- **Development Agent Alignment:** Verify platform infrastructure supports Frontend Dev, Backend Dev, and Full Stack Dev requirements including:
|
||||
- Container platform development environment provisioning
|
||||
- GitOps workflows for application deployment
|
||||
@@ -488,7 +488,7 @@ A comprehensive platform validation report documenting:
|
||||
3. **Detailed findings for each non-compliant item** across foundation and platform components
|
||||
4. **Platform integration validation results** documenting component interoperability
|
||||
5. **Remediation recommendations with priority levels** based on platform impact
|
||||
6. **BMAD integration assessment results** for complete platform stack
|
||||
6. **BMad integration assessment results** for complete platform stack
|
||||
7. **Clear signoff recommendation** for platform deployment readiness or architectural revision requirements
|
||||
8. **Next steps for implementation or remediation** prioritized by platform dependencies
|
||||
|
||||
@@ -781,9 +781,9 @@ Create pipeline diagram showing:
|
||||
- Cost Monitoring & Reporting
|
||||
- Optimization Recommendations
|
||||
|
||||
## BMAD Integration Architecture
|
||||
## BMad Integration Architecture
|
||||
|
||||
[[LLM: Design infrastructure to specifically support other BMAD agents and their workflows. This ensures the infrastructure enables the entire BMAD methodology.]]
|
||||
[[LLM: Design infrastructure to specifically support other BMad agents and their workflows. This ensures the infrastructure enables the entire BMad methodology.]]
|
||||
|
||||
### Development Agent Support
|
||||
|
||||
@@ -1823,7 +1823,7 @@ This checklist serves as a comprehensive framework for validating infrastructure
|
||||
- [ ] Business stakeholders informed of changes
|
||||
- [ ] Feedback loops established for continuous improvement
|
||||
|
||||
## 11. BMAD WORKFLOW INTEGRATION
|
||||
## 11. BMad WORKFLOW INTEGRATION
|
||||
|
||||
### 11.1 Development Agent Alignment
|
||||
|
||||
@@ -2046,7 +2046,7 @@ None Listed
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
|
||||
96
dist/teams/team-all.txt
vendored
96
dist/teams/team-all.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -64,13 +64,13 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
|
||||
agent:
|
||||
name: BMad Orchestrator
|
||||
id: bmad-orchestrator
|
||||
title: BMAD Master Orchestrator
|
||||
title: BMad Master Orchestrator
|
||||
icon: 🎭
|
||||
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
||||
persona:
|
||||
role: Master Orchestrator & BMAD Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
|
||||
identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
|
||||
role: Master Orchestrator & BMad Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMad Method while orchestrating agents
|
||||
identity: Unified interface to all BMad-Method capabilities, dynamically transforms into any specialized agent
|
||||
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
||||
core_principles:
|
||||
- Become any agent on demand, loading files only when needed
|
||||
@@ -83,7 +83,7 @@ persona:
|
||||
- Process commands starting with * immediately
|
||||
- Always remind users that commands require * prefix
|
||||
startup:
|
||||
- Announce: Introduce yourself as the BMAD Orchestrator, explain you can coordinate agents and workflows
|
||||
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||
- Mention *help shows all available commands and options
|
||||
- Check for active workflow plan using utils#plan-management
|
||||
@@ -96,7 +96,7 @@ startup:
|
||||
commands:
|
||||
help: Show this guide with available agents and workflows
|
||||
chat-mode: Start conversational mode for detailed assistance
|
||||
kb-mode: Load full BMAD knowledge base
|
||||
kb-mode: Load full BMad knowledge base
|
||||
status: Show current context, active agent, and progress
|
||||
agent: Transform into a specialized agent (list if name not specified)
|
||||
exit: Return to BMad or exit session
|
||||
@@ -111,13 +111,13 @@ commands:
|
||||
party-mode: Group chat with all agents
|
||||
doc-out: Output full document
|
||||
help-display-template: |
|
||||
=== BMAD Orchestrator Commands ===
|
||||
=== BMad Orchestrator Commands ===
|
||||
All commands must start with * (asterisk)
|
||||
|
||||
Core Commands:
|
||||
*help ............... Show this guide
|
||||
*chat-mode .......... Start conversational mode for detailed assistance
|
||||
*kb-mode ............ Load full BMAD knowledge base
|
||||
*kb-mode ............ Load full BMad knowledge base
|
||||
*status ............. Show current context, active agent, and progress
|
||||
*exit ............... Return to BMad or exit session
|
||||
|
||||
@@ -158,7 +158,7 @@ transformation:
|
||||
- Announce transformation
|
||||
- Operate until exit
|
||||
loading:
|
||||
- KB: Only for *kb-mode or BMAD questions
|
||||
- KB: Only for *kb-mode or BMad questions
|
||||
- Agents: Only when transforming
|
||||
- Templates/Tasks: Only when executing
|
||||
- Always indicate loading
|
||||
@@ -1154,7 +1154,7 @@ BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This
|
||||
# KB Mode Interaction Task
|
||||
|
||||
## Purpose
|
||||
Provide a user-friendly interface to the BMAD knowledge base without overwhelming users with information upfront.
|
||||
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -1163,23 +1163,23 @@ When entering KB mode (*kb-mode), follow these steps:
|
||||
### 1. Welcome and Guide
|
||||
Announce entering KB mode with a brief, friendly introduction:
|
||||
|
||||
"I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD."
|
||||
"I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method."
|
||||
|
||||
### 2. Present Topic Areas
|
||||
Offer a concise list of main topic areas the user might want to explore:
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
### 3. Respond Contextually
|
||||
- Wait for user's specific question or topic selection
|
||||
@@ -1203,20 +1203,20 @@ When user is done or wants to exit KB mode:
|
||||
|
||||
**User**: *kb-mode
|
||||
|
||||
**Assistant**: I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD.
|
||||
**Assistant**: I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method.
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
**User**: Tell me about workflows
|
||||
|
||||
@@ -1475,11 +1475,11 @@ The update is successful when:
|
||||
==================== END: tasks#update-workflow-plan ====================
|
||||
|
||||
==================== START: data#bmad-kb ====================
|
||||
# BMAD Knowledge Base
|
||||
# BMad Knowledge Base
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Key Features
|
||||
|
||||
@@ -1489,7 +1489,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Reusable Resources**: Portable templates, tasks, and checklists
|
||||
- **Slash Command Integration**: Quick agent switching and control
|
||||
|
||||
### When to Use BMAD
|
||||
### When to Use BMad
|
||||
|
||||
- **New Projects (Greenfield)**: Complete end-to-end development
|
||||
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
||||
@@ -1497,11 +1497,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Quality Assurance**: Structured testing and validation
|
||||
- **Documentation**: Professional PRDs, architecture docs, user stories
|
||||
|
||||
## How BMAD Works
|
||||
## How BMad Works
|
||||
|
||||
### The Core Method
|
||||
|
||||
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
|
||||
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
||||
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
||||
@@ -1555,7 +1555,7 @@ BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
||||
5. Type `/help` to see available commands
|
||||
|
||||
#### Option 2: IDE Integration
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, VS Code Copilot users
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
||||
|
||||
```bash
|
||||
# Interactive installation (recommended)
|
||||
@@ -1570,16 +1570,16 @@ npx bmad-method install
|
||||
- **Windsurf**: Built-in AI capabilities
|
||||
- **Cline**: VS Code extension with AI features
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **VS Code Copilot**: AI-powered coding assistant
|
||||
- **Github Copilot**: AI-powered coding assistant
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Verify Installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
|
||||
**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
|
||||
**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
|
||||
|
||||
### Environment Selection Guide
|
||||
|
||||
@@ -1640,11 +1640,11 @@ npx bmad-method install
|
||||
|
||||
## Core Configuration (core-config.yaml)
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
### What is core-config.yaml?
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
||||
- **Custom Locations**: Define where your documents and shards live
|
||||
@@ -1673,7 +1673,7 @@ This configuration file acts as a map for BMAD agents, telling them exactly wher
|
||||
|
||||
1. **No Forced Migrations**: Keep your existing document structure
|
||||
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
||||
3. **Custom Workflows**: Configure BMAD to match your team's process
|
||||
3. **Custom Workflows**: Configure BMad to match your team's process
|
||||
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
||||
|
||||
### Common Configurations
|
||||
@@ -1756,7 +1756,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
**Chat Management Guidelines**:
|
||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
||||
@@ -1802,7 +1802,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
|
||||
### System Overview
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
### Key Architectural Components
|
||||
|
||||
@@ -1846,7 +1846,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
||||
|
||||
### Template Processing System
|
||||
|
||||
BMAD employs a sophisticated template system with three key components:
|
||||
BMad employs a sophisticated template system with three key components:
|
||||
|
||||
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
||||
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
||||
@@ -1875,7 +1875,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
||||
3. Concatenating content into single text files with clear separators
|
||||
4. Outputting ready-to-upload bundles for web AI interfaces
|
||||
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
||||
|
||||
## Complete Development Workflow
|
||||
|
||||
@@ -2136,7 +2136,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
## Contributing to BMAD-METHOD
|
||||
## Contributing to BMad-Method
|
||||
|
||||
### Quick Contribution Guidelines
|
||||
|
||||
@@ -2165,7 +2165,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
||||
|
||||
### What Are Expansion Packs?
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Why Use Expansion Packs?
|
||||
|
||||
@@ -2455,7 +2455,7 @@ Would you like to:
|
||||
==================== START: utils#workflow-management ====================
|
||||
# Workflow Management
|
||||
|
||||
Enables BMAD orchestrator to manage and execute team workflows.
|
||||
Enables BMad orchestrator to manage and execute team workflows.
|
||||
|
||||
## Dynamic Workflow Loading
|
||||
|
||||
@@ -2527,7 +2527,7 @@ Agents should be workflow-aware: know active workflow, their role, access artifa
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
@@ -8826,7 +8826,7 @@ After presenting the report, ask if the user wants:
|
||||
==================== START: checklists#change-checklist ====================
|
||||
# Change Navigation Checklist
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
||||
|
||||
@@ -8901,7 +8901,7 @@ Think about both immediate and downstream effects.]]
|
||||
|
||||
## 3. Artifact Conflict & Impact Analysis
|
||||
|
||||
[[LLM: Documentation drives development in BMAD. Check each artifact:
|
||||
[[LLM: Documentation drives development in BMad. Check each artifact:
|
||||
|
||||
1. Does this change invalidate documented decisions?
|
||||
2. Are architectural assumptions still valid?
|
||||
@@ -9678,8 +9678,8 @@ To identify the next logical story based on project progress and epic definition
|
||||
- Load `.bmad-core/core-config.yaml` from the project root
|
||||
- If the file does not exist:
|
||||
- HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can:
|
||||
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yaml and configure it for your project
|
||||
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
||||
1. Copy it from GITHUB BMad-Method/bmad-core/core-config.yaml and configure it for your project
|
||||
2. Run the BMad installer against your project to upgrade and add the file automatically
|
||||
Please add and configure core-config.yaml before proceeding."
|
||||
- Extract the following key configurations:
|
||||
- `devStoryLocation`: Where to save story files
|
||||
|
||||
92
dist/teams/team-fullstack.txt
vendored
92
dist/teams/team-fullstack.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -68,13 +68,13 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
|
||||
agent:
|
||||
name: BMad Orchestrator
|
||||
id: bmad-orchestrator
|
||||
title: BMAD Master Orchestrator
|
||||
title: BMad Master Orchestrator
|
||||
icon: 🎭
|
||||
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
||||
persona:
|
||||
role: Master Orchestrator & BMAD Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
|
||||
identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
|
||||
role: Master Orchestrator & BMad Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMad Method while orchestrating agents
|
||||
identity: Unified interface to all BMad-Method capabilities, dynamically transforms into any specialized agent
|
||||
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
||||
core_principles:
|
||||
- Become any agent on demand, loading files only when needed
|
||||
@@ -87,7 +87,7 @@ persona:
|
||||
- Process commands starting with * immediately
|
||||
- Always remind users that commands require * prefix
|
||||
startup:
|
||||
- Announce: Introduce yourself as the BMAD Orchestrator, explain you can coordinate agents and workflows
|
||||
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||
- Mention *help shows all available commands and options
|
||||
- Check for active workflow plan using utils#plan-management
|
||||
@@ -100,7 +100,7 @@ startup:
|
||||
commands:
|
||||
help: Show this guide with available agents and workflows
|
||||
chat-mode: Start conversational mode for detailed assistance
|
||||
kb-mode: Load full BMAD knowledge base
|
||||
kb-mode: Load full BMad knowledge base
|
||||
status: Show current context, active agent, and progress
|
||||
agent: Transform into a specialized agent (list if name not specified)
|
||||
exit: Return to BMad or exit session
|
||||
@@ -115,13 +115,13 @@ commands:
|
||||
party-mode: Group chat with all agents
|
||||
doc-out: Output full document
|
||||
help-display-template: |
|
||||
=== BMAD Orchestrator Commands ===
|
||||
=== BMad Orchestrator Commands ===
|
||||
All commands must start with * (asterisk)
|
||||
|
||||
Core Commands:
|
||||
*help ............... Show this guide
|
||||
*chat-mode .......... Start conversational mode for detailed assistance
|
||||
*kb-mode ............ Load full BMAD knowledge base
|
||||
*kb-mode ............ Load full BMad knowledge base
|
||||
*status ............. Show current context, active agent, and progress
|
||||
*exit ............... Return to BMad or exit session
|
||||
|
||||
@@ -162,7 +162,7 @@ transformation:
|
||||
- Announce transformation
|
||||
- Operate until exit
|
||||
loading:
|
||||
- KB: Only for *kb-mode or BMAD questions
|
||||
- KB: Only for *kb-mode or BMad questions
|
||||
- Agents: Only when transforming
|
||||
- Templates/Tasks: Only when executing
|
||||
- Always indicate loading
|
||||
@@ -998,7 +998,7 @@ BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This
|
||||
# KB Mode Interaction Task
|
||||
|
||||
## Purpose
|
||||
Provide a user-friendly interface to the BMAD knowledge base without overwhelming users with information upfront.
|
||||
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -1007,23 +1007,23 @@ When entering KB mode (*kb-mode), follow these steps:
|
||||
### 1. Welcome and Guide
|
||||
Announce entering KB mode with a brief, friendly introduction:
|
||||
|
||||
"I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD."
|
||||
"I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method."
|
||||
|
||||
### 2. Present Topic Areas
|
||||
Offer a concise list of main topic areas the user might want to explore:
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
### 3. Respond Contextually
|
||||
- Wait for user's specific question or topic selection
|
||||
@@ -1047,20 +1047,20 @@ When user is done or wants to exit KB mode:
|
||||
|
||||
**User**: *kb-mode
|
||||
|
||||
**Assistant**: I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD.
|
||||
**Assistant**: I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method.
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
**User**: Tell me about workflows
|
||||
|
||||
@@ -1319,11 +1319,11 @@ The update is successful when:
|
||||
==================== END: tasks#update-workflow-plan ====================
|
||||
|
||||
==================== START: data#bmad-kb ====================
|
||||
# BMAD Knowledge Base
|
||||
# BMad Knowledge Base
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Key Features
|
||||
|
||||
@@ -1333,7 +1333,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Reusable Resources**: Portable templates, tasks, and checklists
|
||||
- **Slash Command Integration**: Quick agent switching and control
|
||||
|
||||
### When to Use BMAD
|
||||
### When to Use BMad
|
||||
|
||||
- **New Projects (Greenfield)**: Complete end-to-end development
|
||||
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
||||
@@ -1341,11 +1341,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Quality Assurance**: Structured testing and validation
|
||||
- **Documentation**: Professional PRDs, architecture docs, user stories
|
||||
|
||||
## How BMAD Works
|
||||
## How BMad Works
|
||||
|
||||
### The Core Method
|
||||
|
||||
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
|
||||
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
||||
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
||||
@@ -1399,7 +1399,7 @@ BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
||||
5. Type `/help` to see available commands
|
||||
|
||||
#### Option 2: IDE Integration
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, VS Code Copilot users
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
||||
|
||||
```bash
|
||||
# Interactive installation (recommended)
|
||||
@@ -1414,16 +1414,16 @@ npx bmad-method install
|
||||
- **Windsurf**: Built-in AI capabilities
|
||||
- **Cline**: VS Code extension with AI features
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **VS Code Copilot**: AI-powered coding assistant
|
||||
- **Github Copilot**: AI-powered coding assistant
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Verify Installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
|
||||
**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
|
||||
**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
|
||||
|
||||
### Environment Selection Guide
|
||||
|
||||
@@ -1484,11 +1484,11 @@ npx bmad-method install
|
||||
|
||||
## Core Configuration (core-config.yaml)
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
### What is core-config.yaml?
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
||||
- **Custom Locations**: Define where your documents and shards live
|
||||
@@ -1517,7 +1517,7 @@ This configuration file acts as a map for BMAD agents, telling them exactly wher
|
||||
|
||||
1. **No Forced Migrations**: Keep your existing document structure
|
||||
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
||||
3. **Custom Workflows**: Configure BMAD to match your team's process
|
||||
3. **Custom Workflows**: Configure BMad to match your team's process
|
||||
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
||||
|
||||
### Common Configurations
|
||||
@@ -1600,7 +1600,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
**Chat Management Guidelines**:
|
||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
||||
@@ -1646,7 +1646,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
|
||||
### System Overview
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
### Key Architectural Components
|
||||
|
||||
@@ -1690,7 +1690,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
||||
|
||||
### Template Processing System
|
||||
|
||||
BMAD employs a sophisticated template system with three key components:
|
||||
BMad employs a sophisticated template system with three key components:
|
||||
|
||||
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
||||
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
||||
@@ -1719,7 +1719,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
||||
3. Concatenating content into single text files with clear separators
|
||||
4. Outputting ready-to-upload bundles for web AI interfaces
|
||||
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
||||
|
||||
## Complete Development Workflow
|
||||
|
||||
@@ -1980,7 +1980,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
## Contributing to BMAD-METHOD
|
||||
## Contributing to BMad-Method
|
||||
|
||||
### Quick Contribution Guidelines
|
||||
|
||||
@@ -2009,7 +2009,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
||||
|
||||
### What Are Expansion Packs?
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Why Use Expansion Packs?
|
||||
|
||||
@@ -2299,7 +2299,7 @@ Would you like to:
|
||||
==================== START: utils#workflow-management ====================
|
||||
# Workflow Management
|
||||
|
||||
Enables BMAD orchestrator to manage and execute team workflows.
|
||||
Enables BMad orchestrator to manage and execute team workflows.
|
||||
|
||||
## Dynamic Workflow Loading
|
||||
|
||||
@@ -2371,7 +2371,7 @@ Agents should be workflow-aware: know active workflow, their role, access artifa
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
@@ -5589,7 +5589,7 @@ After presenting the report, ask if the user wants:
|
||||
==================== START: checklists#change-checklist ====================
|
||||
# Change Navigation Checklist
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
||||
|
||||
@@ -5664,7 +5664,7 @@ Think about both immediate and downstream effects.]]
|
||||
|
||||
## 3. Artifact Conflict & Impact Analysis
|
||||
|
||||
[[LLM: Documentation drives development in BMAD. Check each artifact:
|
||||
[[LLM: Documentation drives development in BMad. Check each artifact:
|
||||
|
||||
1. Does this change invalidate documented decisions?
|
||||
2. Are architectural assumptions still valid?
|
||||
|
||||
96
dist/teams/team-ide-minimal.txt
vendored
96
dist/teams/team-ide-minimal.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -60,13 +60,13 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
|
||||
agent:
|
||||
name: BMad Orchestrator
|
||||
id: bmad-orchestrator
|
||||
title: BMAD Master Orchestrator
|
||||
title: BMad Master Orchestrator
|
||||
icon: 🎭
|
||||
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
||||
persona:
|
||||
role: Master Orchestrator & BMAD Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
|
||||
identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
|
||||
role: Master Orchestrator & BMad Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMad Method while orchestrating agents
|
||||
identity: Unified interface to all BMad-Method capabilities, dynamically transforms into any specialized agent
|
||||
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
||||
core_principles:
|
||||
- Become any agent on demand, loading files only when needed
|
||||
@@ -79,7 +79,7 @@ persona:
|
||||
- Process commands starting with * immediately
|
||||
- Always remind users that commands require * prefix
|
||||
startup:
|
||||
- Announce: Introduce yourself as the BMAD Orchestrator, explain you can coordinate agents and workflows
|
||||
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||
- Mention *help shows all available commands and options
|
||||
- Check for active workflow plan using utils#plan-management
|
||||
@@ -92,7 +92,7 @@ startup:
|
||||
commands:
|
||||
help: Show this guide with available agents and workflows
|
||||
chat-mode: Start conversational mode for detailed assistance
|
||||
kb-mode: Load full BMAD knowledge base
|
||||
kb-mode: Load full BMad knowledge base
|
||||
status: Show current context, active agent, and progress
|
||||
agent: Transform into a specialized agent (list if name not specified)
|
||||
exit: Return to BMad or exit session
|
||||
@@ -107,13 +107,13 @@ commands:
|
||||
party-mode: Group chat with all agents
|
||||
doc-out: Output full document
|
||||
help-display-template: |
|
||||
=== BMAD Orchestrator Commands ===
|
||||
=== BMad Orchestrator Commands ===
|
||||
All commands must start with * (asterisk)
|
||||
|
||||
Core Commands:
|
||||
*help ............... Show this guide
|
||||
*chat-mode .......... Start conversational mode for detailed assistance
|
||||
*kb-mode ............ Load full BMAD knowledge base
|
||||
*kb-mode ............ Load full BMad knowledge base
|
||||
*status ............. Show current context, active agent, and progress
|
||||
*exit ............... Return to BMad or exit session
|
||||
|
||||
@@ -154,7 +154,7 @@ transformation:
|
||||
- Announce transformation
|
||||
- Operate until exit
|
||||
loading:
|
||||
- KB: Only for *kb-mode or BMAD questions
|
||||
- KB: Only for *kb-mode or BMad questions
|
||||
- Agents: Only when transforming
|
||||
- Templates/Tasks: Only when executing
|
||||
- Always indicate loading
|
||||
@@ -898,7 +898,7 @@ BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This
|
||||
# KB Mode Interaction Task
|
||||
|
||||
## Purpose
|
||||
Provide a user-friendly interface to the BMAD knowledge base without overwhelming users with information upfront.
|
||||
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -907,23 +907,23 @@ When entering KB mode (*kb-mode), follow these steps:
|
||||
### 1. Welcome and Guide
|
||||
Announce entering KB mode with a brief, friendly introduction:
|
||||
|
||||
"I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD."
|
||||
"I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method."
|
||||
|
||||
### 2. Present Topic Areas
|
||||
Offer a concise list of main topic areas the user might want to explore:
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
### 3. Respond Contextually
|
||||
- Wait for user's specific question or topic selection
|
||||
@@ -947,20 +947,20 @@ When user is done or wants to exit KB mode:
|
||||
|
||||
**User**: *kb-mode
|
||||
|
||||
**Assistant**: I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD.
|
||||
**Assistant**: I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method.
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
**User**: Tell me about workflows
|
||||
|
||||
@@ -1219,11 +1219,11 @@ The update is successful when:
|
||||
==================== END: tasks#update-workflow-plan ====================
|
||||
|
||||
==================== START: data#bmad-kb ====================
|
||||
# BMAD Knowledge Base
|
||||
# BMad Knowledge Base
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Key Features
|
||||
|
||||
@@ -1233,7 +1233,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Reusable Resources**: Portable templates, tasks, and checklists
|
||||
- **Slash Command Integration**: Quick agent switching and control
|
||||
|
||||
### When to Use BMAD
|
||||
### When to Use BMad
|
||||
|
||||
- **New Projects (Greenfield)**: Complete end-to-end development
|
||||
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
||||
@@ -1241,11 +1241,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Quality Assurance**: Structured testing and validation
|
||||
- **Documentation**: Professional PRDs, architecture docs, user stories
|
||||
|
||||
## How BMAD Works
|
||||
## How BMad Works
|
||||
|
||||
### The Core Method
|
||||
|
||||
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
|
||||
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
||||
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
||||
@@ -1299,7 +1299,7 @@ BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
||||
5. Type `/help` to see available commands
|
||||
|
||||
#### Option 2: IDE Integration
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, VS Code Copilot users
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
||||
|
||||
```bash
|
||||
# Interactive installation (recommended)
|
||||
@@ -1314,16 +1314,16 @@ npx bmad-method install
|
||||
- **Windsurf**: Built-in AI capabilities
|
||||
- **Cline**: VS Code extension with AI features
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **VS Code Copilot**: AI-powered coding assistant
|
||||
- **Github Copilot**: AI-powered coding assistant
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Verify Installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
|
||||
**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
|
||||
**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
|
||||
|
||||
### Environment Selection Guide
|
||||
|
||||
@@ -1384,11 +1384,11 @@ npx bmad-method install
|
||||
|
||||
## Core Configuration (core-config.yaml)
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
### What is core-config.yaml?
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
||||
- **Custom Locations**: Define where your documents and shards live
|
||||
@@ -1417,7 +1417,7 @@ This configuration file acts as a map for BMAD agents, telling them exactly wher
|
||||
|
||||
1. **No Forced Migrations**: Keep your existing document structure
|
||||
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
||||
3. **Custom Workflows**: Configure BMAD to match your team's process
|
||||
3. **Custom Workflows**: Configure BMad to match your team's process
|
||||
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
||||
|
||||
### Common Configurations
|
||||
@@ -1500,7 +1500,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
**Chat Management Guidelines**:
|
||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
||||
@@ -1546,7 +1546,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
|
||||
### System Overview
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
### Key Architectural Components
|
||||
|
||||
@@ -1590,7 +1590,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
||||
|
||||
### Template Processing System
|
||||
|
||||
BMAD employs a sophisticated template system with three key components:
|
||||
BMad employs a sophisticated template system with three key components:
|
||||
|
||||
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
||||
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
||||
@@ -1619,7 +1619,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
||||
3. Concatenating content into single text files with clear separators
|
||||
4. Outputting ready-to-upload bundles for web AI interfaces
|
||||
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
||||
|
||||
## Complete Development Workflow
|
||||
|
||||
@@ -1880,7 +1880,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
## Contributing to BMAD-METHOD
|
||||
## Contributing to BMad-Method
|
||||
|
||||
### Quick Contribution Guidelines
|
||||
|
||||
@@ -1909,7 +1909,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
||||
|
||||
### What Are Expansion Packs?
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Why Use Expansion Packs?
|
||||
|
||||
@@ -2199,7 +2199,7 @@ Would you like to:
|
||||
==================== START: utils#workflow-management ====================
|
||||
# Workflow Management
|
||||
|
||||
Enables BMAD orchestrator to manage and execute team workflows.
|
||||
Enables BMad orchestrator to manage and execute team workflows.
|
||||
|
||||
## Dynamic Workflow Loading
|
||||
|
||||
@@ -2271,7 +2271,7 @@ Agents should be workflow-aware: know active workflow, their role, access artifa
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
@@ -3495,7 +3495,7 @@ After presenting the report, ask if the user wants:
|
||||
==================== START: checklists#change-checklist ====================
|
||||
# Change Navigation Checklist
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
||||
|
||||
@@ -3570,7 +3570,7 @@ Think about both immediate and downstream effects.]]
|
||||
|
||||
## 3. Artifact Conflict & Impact Analysis
|
||||
|
||||
[[LLM: Documentation drives development in BMAD. Check each artifact:
|
||||
[[LLM: Documentation drives development in BMad. Check each artifact:
|
||||
|
||||
1. Does this change invalidate documented decisions?
|
||||
2. Are architectural assumptions still valid?
|
||||
@@ -3693,8 +3693,8 @@ To identify the next logical story based on project progress and epic definition
|
||||
- Load `.bmad-core/core-config.yaml` from the project root
|
||||
- If the file does not exist:
|
||||
- HALT and inform the user: "core-config.yaml not found. This file is required for story creation. You can:
|
||||
1. Copy it from GITHUB BMAD-METHOD/bmad-core/core-config.yaml and configure it for your project
|
||||
2. Run the BMAD installer against your project to upgrade and add the file automatically
|
||||
1. Copy it from GITHUB BMad-Method/bmad-core/core-config.yaml and configure it for your project
|
||||
2. Run the BMad installer against your project to upgrade and add the file automatically
|
||||
Please add and configure core-config.yaml before proceeding."
|
||||
- Extract the following key configurations:
|
||||
- `devStoryLocation`: Where to save story files
|
||||
|
||||
92
dist/teams/team-no-ui.txt
vendored
92
dist/teams/team-no-ui.txt
vendored
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,7 +34,7 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -63,13 +63,13 @@ CRITICAL: Read the full YML, start activation to alter your state of being, foll
|
||||
agent:
|
||||
name: BMad Orchestrator
|
||||
id: bmad-orchestrator
|
||||
title: BMAD Master Orchestrator
|
||||
title: BMad Master Orchestrator
|
||||
icon: 🎭
|
||||
whenToUse: Use for workflow coordination, multi-agent tasks, role switching guidance, and when unsure which specialist to consult
|
||||
persona:
|
||||
role: Master Orchestrator & BMAD Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMAD Method while orchestrating agents
|
||||
identity: Unified interface to all BMAD-METHOD capabilities, dynamically transforms into any specialized agent
|
||||
role: Master Orchestrator & BMad Method Expert
|
||||
style: Knowledgeable, guiding, adaptable, efficient, encouraging, technically brilliant yet approachable. Helps customize and use BMad Method while orchestrating agents
|
||||
identity: Unified interface to all BMad-Method capabilities, dynamically transforms into any specialized agent
|
||||
focus: Orchestrating the right agent/capability for each need, loading resources only when needed
|
||||
core_principles:
|
||||
- Become any agent on demand, loading files only when needed
|
||||
@@ -82,7 +82,7 @@ persona:
|
||||
- Process commands starting with * immediately
|
||||
- Always remind users that commands require * prefix
|
||||
startup:
|
||||
- Announce: Introduce yourself as the BMAD Orchestrator, explain you can coordinate agents and workflows
|
||||
- Announce: Introduce yourself as the BMad Orchestrator, explain you can coordinate agents and workflows
|
||||
- IMPORTANT: Tell users that all commands start with * (e.g., *help, *agent, *workflow)
|
||||
- Mention *help shows all available commands and options
|
||||
- Check for active workflow plan using utils#plan-management
|
||||
@@ -95,7 +95,7 @@ startup:
|
||||
commands:
|
||||
help: Show this guide with available agents and workflows
|
||||
chat-mode: Start conversational mode for detailed assistance
|
||||
kb-mode: Load full BMAD knowledge base
|
||||
kb-mode: Load full BMad knowledge base
|
||||
status: Show current context, active agent, and progress
|
||||
agent: Transform into a specialized agent (list if name not specified)
|
||||
exit: Return to BMad or exit session
|
||||
@@ -110,13 +110,13 @@ commands:
|
||||
party-mode: Group chat with all agents
|
||||
doc-out: Output full document
|
||||
help-display-template: |
|
||||
=== BMAD Orchestrator Commands ===
|
||||
=== BMad Orchestrator Commands ===
|
||||
All commands must start with * (asterisk)
|
||||
|
||||
Core Commands:
|
||||
*help ............... Show this guide
|
||||
*chat-mode .......... Start conversational mode for detailed assistance
|
||||
*kb-mode ............ Load full BMAD knowledge base
|
||||
*kb-mode ............ Load full BMad knowledge base
|
||||
*status ............. Show current context, active agent, and progress
|
||||
*exit ............... Return to BMad or exit session
|
||||
|
||||
@@ -157,7 +157,7 @@ transformation:
|
||||
- Announce transformation
|
||||
- Operate until exit
|
||||
loading:
|
||||
- KB: Only for *kb-mode or BMAD questions
|
||||
- KB: Only for *kb-mode or BMad questions
|
||||
- Agents: Only when transforming
|
||||
- Templates/Tasks: Only when executing
|
||||
- Always indicate loading
|
||||
@@ -930,7 +930,7 @@ BMad Orchestrator: "I've created a workflow plan at docs/workflow-plan.md. This
|
||||
# KB Mode Interaction Task
|
||||
|
||||
## Purpose
|
||||
Provide a user-friendly interface to the BMAD knowledge base without overwhelming users with information upfront.
|
||||
Provide a user-friendly interface to the BMad knowledge base without overwhelming users with information upfront.
|
||||
|
||||
## Instructions
|
||||
|
||||
@@ -939,23 +939,23 @@ When entering KB mode (*kb-mode), follow these steps:
|
||||
### 1. Welcome and Guide
|
||||
Announce entering KB mode with a brief, friendly introduction:
|
||||
|
||||
"I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD."
|
||||
"I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method."
|
||||
|
||||
### 2. Present Topic Areas
|
||||
Offer a concise list of main topic areas the user might want to explore:
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
### 3. Respond Contextually
|
||||
- Wait for user's specific question or topic selection
|
||||
@@ -979,20 +979,20 @@ When user is done or wants to exit KB mode:
|
||||
|
||||
**User**: *kb-mode
|
||||
|
||||
**Assistant**: I've entered KB mode and have access to the full BMAD knowledge base. I can help you with detailed information about any aspect of BMAD-METHOD.
|
||||
**Assistant**: I've entered KB mode and have access to the full BMad knowledge base. I can help you with detailed information about any aspect of BMad-Method.
|
||||
|
||||
**What would you like to know more about?**
|
||||
|
||||
1. **Setup & Installation** - Getting started with BMAD
|
||||
1. **Setup & Installation** - Getting started with BMad
|
||||
2. **Workflows** - Choosing the right workflow for your project
|
||||
3. **Web vs IDE** - When to use each environment
|
||||
4. **Agents** - Understanding specialized agents and their roles
|
||||
5. **Documents** - PRDs, Architecture, Stories, and more
|
||||
6. **Agile Process** - How BMAD implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMAD for your needs
|
||||
8. **Best Practices** - Tips for effective BMAD usage
|
||||
6. **Agile Process** - How BMad implements Agile methodologies
|
||||
7. **Configuration** - Customizing BMad for your needs
|
||||
8. **Best Practices** - Tips for effective BMad usage
|
||||
|
||||
Or ask me about anything else related to BMAD-METHOD!
|
||||
Or ask me about anything else related to BMad-Method!
|
||||
|
||||
**User**: Tell me about workflows
|
||||
|
||||
@@ -1251,11 +1251,11 @@ The update is successful when:
|
||||
==================== END: tasks#update-workflow-plan ====================
|
||||
|
||||
==================== START: data#bmad-kb ====================
|
||||
# BMAD Knowledge Base
|
||||
# BMad Knowledge Base
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Key Features
|
||||
|
||||
@@ -1265,7 +1265,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Reusable Resources**: Portable templates, tasks, and checklists
|
||||
- **Slash Command Integration**: Quick agent switching and control
|
||||
|
||||
### When to Use BMAD
|
||||
### When to Use BMad
|
||||
|
||||
- **New Projects (Greenfield)**: Complete end-to-end development
|
||||
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
||||
@@ -1273,11 +1273,11 @@ BMAD-METHOD (Breakthrough Method of Agile AI-driven Development) is a framework
|
||||
- **Quality Assurance**: Structured testing and validation
|
||||
- **Documentation**: Professional PRDs, architecture docs, user stories
|
||||
|
||||
## How BMAD Works
|
||||
## How BMad Works
|
||||
|
||||
### The Core Method
|
||||
|
||||
BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
BMad transforms you into a "Vibe CEO" - directing a team of specialized AI agents through structured workflows. Here's how:
|
||||
|
||||
1. **You Direct, AI Executes**: You provide vision and decisions; agents handle implementation details
|
||||
2. **Specialized Agents**: Each agent masters one role (PM, Developer, Architect, etc.)
|
||||
@@ -1331,7 +1331,7 @@ BMAD transforms you into a "Vibe CEO" - directing a team of specialized AI agent
|
||||
5. Type `/help` to see available commands
|
||||
|
||||
#### Option 2: IDE Integration
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, VS Code Copilot users
|
||||
**Best for**: Cursor, Claude Code, Windsurf, Cline, Roo Code, Github Copilot users
|
||||
|
||||
```bash
|
||||
# Interactive installation (recommended)
|
||||
@@ -1346,16 +1346,16 @@ npx bmad-method install
|
||||
- **Windsurf**: Built-in AI capabilities
|
||||
- **Cline**: VS Code extension with AI features
|
||||
- **Roo Code**: Web-based IDE with agent support
|
||||
- **VS Code Copilot**: AI-powered coding assistant
|
||||
- **Github Copilot**: AI-powered coding assistant
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Verify Installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
- IDE-specific integration files created
|
||||
- All agent commands/rules/modes available
|
||||
|
||||
**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
|
||||
**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
|
||||
|
||||
### Environment Selection Guide
|
||||
|
||||
@@ -1416,11 +1416,11 @@ npx bmad-method install
|
||||
|
||||
## Core Configuration (core-config.yaml)
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
### What is core-config.yaml?
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
- **Version Flexibility**: Work with V3, V4, or custom document structures
|
||||
- **Custom Locations**: Define where your documents and shards live
|
||||
@@ -1449,7 +1449,7 @@ This configuration file acts as a map for BMAD agents, telling them exactly wher
|
||||
|
||||
1. **No Forced Migrations**: Keep your existing document structure
|
||||
2. **Gradual Adoption**: Start with V3 and migrate to V4 at your pace
|
||||
3. **Custom Workflows**: Configure BMAD to match your team's process
|
||||
3. **Custom Workflows**: Configure BMad to match your team's process
|
||||
4. **Intelligent Agents**: Agents automatically adapt to your configuration
|
||||
|
||||
### Common Configurations
|
||||
@@ -1532,7 +1532,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
**Chat Management Guidelines**:
|
||||
- **Claude Code, Cursor, Windsurf**: Start new chats when switching agents
|
||||
@@ -1578,7 +1578,7 @@ You are the "Vibe CEO" - thinking like a CEO with unlimited resources and a sing
|
||||
|
||||
### System Overview
|
||||
|
||||
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).
|
||||
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).
|
||||
|
||||
### Key Architectural Components
|
||||
|
||||
@@ -1622,7 +1622,7 @@ The BMAD-Method is built around a modular architecture centered on the `bmad-cor
|
||||
|
||||
### Template Processing System
|
||||
|
||||
BMAD employs a sophisticated template system with three key components:
|
||||
BMad employs a sophisticated template system with three key components:
|
||||
|
||||
1. **Template Format** (`utils/template-format.md`): Defines markup language for variable substitution and AI processing directives
|
||||
2. **Document Creation** (`tasks/create-doc.md`): Orchestrates template selection and user interaction
|
||||
@@ -1651,7 +1651,7 @@ The `web-builder.js` tool creates web-ready bundles by:
|
||||
3. Concatenating content into single text files with clear separators
|
||||
4. Outputting ready-to-upload bundles for web AI interfaces
|
||||
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMAD powerful.
|
||||
This architecture enables seamless operation across environments while maintaining the rich, interconnected agent ecosystem that makes BMad powerful.
|
||||
|
||||
## Complete Development Workflow
|
||||
|
||||
@@ -1912,7 +1912,7 @@ Use the `shard-doc` task or `@kayvan/markdown-tree-parser` tool for automatic sh
|
||||
- **Keep conversations focused** - One agent, one task per conversation
|
||||
- **Review everything** - Always review and approve before marking complete
|
||||
|
||||
## Contributing to BMAD-METHOD
|
||||
## Contributing to BMad-Method
|
||||
|
||||
### Quick Contribution Guidelines
|
||||
|
||||
@@ -1941,7 +1941,7 @@ For full details, see `CONTRIBUTING.md`. Key points:
|
||||
|
||||
### What Are Expansion Packs?
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Why Use Expansion Packs?
|
||||
|
||||
@@ -2231,7 +2231,7 @@ Would you like to:
|
||||
==================== START: utils#workflow-management ====================
|
||||
# Workflow Management
|
||||
|
||||
Enables BMAD orchestrator to manage and execute team workflows.
|
||||
Enables BMad orchestrator to manage and execute team workflows.
|
||||
|
||||
## Dynamic Workflow Loading
|
||||
|
||||
@@ -2303,7 +2303,7 @@ Agents should be workflow-aware: know active workflow, their role, access artifa
|
||||
==================== START: utils#template-format ====================
|
||||
# Template Format Conventions
|
||||
|
||||
Templates in the BMAD method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
Templates in the BMad method use standardized markup for AI processing. These conventions ensure consistent document generation.
|
||||
|
||||
## Template Markup Elements
|
||||
|
||||
@@ -5521,7 +5521,7 @@ After presenting the report, ask if the user wants:
|
||||
==================== START: checklists#change-checklist ====================
|
||||
# Change Navigation Checklist
|
||||
|
||||
**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.
|
||||
**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.
|
||||
|
||||
**Instructions:** Review each item with the user. Mark `[x]` for completed/confirmed, `[N/A]` if not applicable, or add notes for discussion points.
|
||||
|
||||
@@ -5596,7 +5596,7 @@ Think about both immediate and downstream effects.]]
|
||||
|
||||
## 3. Artifact Conflict & Impact Analysis
|
||||
|
||||
[[LLM: Documentation drives development in BMAD. Check each artifact:
|
||||
[[LLM: Documentation drives development in BMad. Check each artifact:
|
||||
|
||||
1. Does this change invalidate documented decisions?
|
||||
2. Are architectural assumptions still valid?
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# BMAD Method Guide for Claude Code
|
||||
# BMad Method Guide for Claude Code
|
||||
|
||||
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).
|
||||
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -9,28 +9,11 @@ When running `npx bmad-method install`, select **Claude Code** as your IDE. This
|
||||
- `.bmad-core/` folder with all agents
|
||||
- `.claude/commands/` folder with agent command files (`.md`)
|
||||
|
||||
## Using BMAD Agents in Claude Code
|
||||
## Using BMad Agents in Claude Code
|
||||
|
||||
Type `/agent-name` in your chat to activate an agent:
|
||||
|
||||
- `/bmad-master` - Universal task executor
|
||||
- `/sm` - Scrum Master
|
||||
- `/dev` - Full-stack developer
|
||||
- `/architect` - Solution architect
|
||||
- `/pm` - Product manager
|
||||
- `/analyst` - Business analyst
|
||||
- `/qa` - QA specialist
|
||||
- `/po` - Product owner
|
||||
- `/ux-expert` - UX specialist
|
||||
|
||||
## Claude Code-Specific Features
|
||||
|
||||
- **Command files**: Stored in `.claude/commands/` as `.md` files
|
||||
- **Activation**: Use forward slash `/` prefix for all agents
|
||||
- **Chat management**: Start new chats when switching agents for clean context
|
||||
Type `/agent-name` in your chat to activate an agent.
|
||||
|
||||
## Tips for Claude Code Users
|
||||
|
||||
- Commands are auto-suggested as you type `/`
|
||||
- Each agent supports `*help` to see available commands
|
||||
- Claude Code maintains excellent context within each chat
|
||||
- More coming soon...
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# BMAD Method Guide for Cline (VS Code)
|
||||
# BMad Method Guide for Cline (VS Code)
|
||||
|
||||
This guide covers Cline-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -9,34 +9,8 @@ When running `npx bmad-method install`, select **Cline** as your IDE. This creat
|
||||
- `.clinerules/` directory with numbered agent rule files (`.md`)
|
||||
- Agents ordered by priority (bmad-master first)
|
||||
|
||||
## Using BMAD Agents in Cline
|
||||
## Using BMad Agents in Cline
|
||||
|
||||
1. **Open Cline panel** in VS Code
|
||||
2. **Type `@agent-name`** in the chat (e.g., `@dev`, `@sm`, `@architect`)
|
||||
3. The agent adopts that persona for the conversation
|
||||
|
||||
## Available Agents
|
||||
|
||||
All agents use `@` prefix:
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master
|
||||
- `@dev` - Full-stack developer
|
||||
- `@architect` - Solution architect
|
||||
- `@pm` - Product manager
|
||||
- `@analyst` - Business analyst
|
||||
- `@qa` - QA specialist
|
||||
- `@po` - Product owner
|
||||
- `@ux-expert` - UX specialist
|
||||
|
||||
## Cline-Specific Features
|
||||
|
||||
- **Rule files**: Stored as numbered files in `.clinerules/` (e.g., `01-bmad-master.md`)
|
||||
- **Agent ordering**: Prioritized list with core agents first
|
||||
- **VS Code integration**: Works within VS Code's Cline extension panel
|
||||
|
||||
## Tips for Cline Users
|
||||
|
||||
- Cline maintains conversation context well
|
||||
- Use `@agent-name` at the start of your message for best results
|
||||
- Agent rules are loaded automatically when mentioned
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# BMAD Method Guide for Cursor
|
||||
# BMad Method Guide for Cursor
|
||||
|
||||
This guide covers Cursor-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -9,29 +9,6 @@ When running `npx bmad-method install`, select **Cursor** as your IDE. This crea
|
||||
- `.bmad-core/` folder with all agents
|
||||
- `.cursor/rules/` folder with agent rule files (`.mdc`)
|
||||
|
||||
## Using BMAD Agents in Cursor
|
||||
## Using BMad Agents in Cursor
|
||||
|
||||
Type `@agent-name` in chat (Ctrl+L / Cmd+L) to activate an agent:
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master
|
||||
- `@dev` - Full-stack developer
|
||||
- `@architect` - Solution architect
|
||||
- `@pm` - Product manager
|
||||
- `@analyst` - Business analyst
|
||||
- `@qa` - QA specialist
|
||||
- `@po` - Product owner
|
||||
- `@ux-expert` - UX specialist
|
||||
|
||||
## Cursor-Specific Features
|
||||
|
||||
- **Rule files**: Stored in `.cursor/rules/` as `.mdc` files
|
||||
- **Auto-completion**: Cursor suggests agents as you type `@`
|
||||
- **Context awareness**: Agents can see your current file selection
|
||||
- **Custom agents**: For better performance, copy agent content into Cursor's custom modes
|
||||
|
||||
## Tips for Cursor Users
|
||||
|
||||
- Start new chats when switching agents
|
||||
- Each agent supports `*help` to see available commands
|
||||
- Leverage Cursor's file context for more accurate assistance
|
||||
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 @@
|
||||
# BMAD Method Guide for Gemini CLI
|
||||
# BMad Method Guide for Gemini CLI
|
||||
|
||||
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).
|
||||
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -9,7 +9,7 @@ When running `npx bmad-method install`, select **Gemini CLI** as your IDE. This
|
||||
- `.gemini/agents/` directory with all agent context files
|
||||
- `.gemini/settings.json` configured to load all agents automatically
|
||||
|
||||
## Using BMAD Agents with Gemini CLI
|
||||
## Using BMad Agents with Gemini CLI
|
||||
|
||||
Simply mention the agent in your prompt:
|
||||
|
||||
@@ -19,20 +19,6 @@ Simply mention the agent in your prompt:
|
||||
|
||||
The Gemini CLI automatically loads the appropriate agent context.
|
||||
|
||||
## Available Agents
|
||||
|
||||
All agents are referenced with `@` in prompts:
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master
|
||||
- `@dev` - Full-stack developer
|
||||
- `@architect` - Solution architect
|
||||
- `@pm` - Product manager
|
||||
- `@analyst` - Business analyst
|
||||
- `@qa` - QA specialist
|
||||
- `@po` - Product owner
|
||||
- `@ux-expert` - UX specialist
|
||||
|
||||
## Gemini CLI-Specific Features
|
||||
|
||||
- **Context files**: All agents loaded as context in `.gemini/agents/`
|
||||
|
||||
22
docs/agentic-tools/github-copilot-guide.md
Normal file
22
docs/agentic-tools/github-copilot-guide.md
Normal file
@@ -0,0 +1,22 @@
|
||||
# BMad Method Guide for Github Copilot
|
||||
|
||||
For the complete workflow, see the [BMad Workflow Guide](../bmad-workflow-guide.md).
|
||||
|
||||
## Installation
|
||||
|
||||
When running `npx bmad-method install`, select **Github Copilot** as your IDE. This command will perform the following actions:
|
||||
|
||||
- Create the `.bmad-core/` directory with all the agent rule files.
|
||||
- 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.
|
||||
- Create a chatmodes file under your .github folder for each specific agent being added
|
||||
|
||||
## Using BMad Agents in VS Code
|
||||
|
||||
1. In the GitHub Copilot Chat window, select **Agent** from the chat mode dropdown list.
|
||||
|
||||
## VS Code Specific Features
|
||||
|
||||
- **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.
|
||||
- **Activation**: Use the `@` prefix in the GitHub Copilot Chat for instant switching between agents.
|
||||
- **Collaboration**: Fully compatible with **Live Share**, allowing you, your team, and BMad agents to work together in real-time.
|
||||
- **Project Context**: Agents have full access to your workspace, including open files and the selected code.
|
||||
@@ -1,6 +1,4 @@
|
||||
# BMAD Method Guide for Roo Code
|
||||
|
||||
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).
|
||||
# BMad Method Guide for Roo Code
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -9,38 +7,7 @@ When running `npx bmad-method install`, select **Roo Code** as your IDE. This cr
|
||||
- `.bmad-core/` folder with all agents
|
||||
- `.roomodes` file in project root with custom modes
|
||||
|
||||
## Using BMAD Agents in Roo Code
|
||||
|
||||
Select mode from the mode selector (usually in status bar):
|
||||
|
||||
- `bmad-bmad-master` - 🧙 Universal task executor
|
||||
- `bmad-sm` - 🏃 Scrum Master
|
||||
- `bmad-dev` - 💻 Full-stack developer
|
||||
- `bmad-architect` - 🏗️ Solution architect
|
||||
- `bmad-pm` - 📋 Product manager
|
||||
- `bmad-analyst` - 📊 Business analyst
|
||||
- `bmad-qa` - 🧪 QA specialist
|
||||
- `bmad-po` - 🎯 Product owner
|
||||
- `bmad-ux-expert` - 🎨 UX specialist
|
||||
|
||||
## Roo Code-Specific Features
|
||||
|
||||
- **Mode file**: `.roomodes` in project root
|
||||
- **Mode switching**: Use mode selector instead of starting new chats
|
||||
- **Context preservation**: Maintains context across mode switches
|
||||
- **File permissions**: Each agent has specific file access:
|
||||
|
||||
### File Permission Summary
|
||||
|
||||
- **Documentation agents** (analyst, pm, po, sm): `.md`, `.txt` only
|
||||
- **bmad-architect**: `.md`, `.txt`, `.yaml`, `.yaml`, `.json`
|
||||
- **bmad-qa**: Test files (`.test.*`, `.spec.*`) and `.md`
|
||||
- **bmad-ux-expert**: `.md`, `.css`, `.scss`, `.html`, `.jsx`, `.tsx`
|
||||
- **Full access**: `bmad-dev`, `bmad-bmad-master`, `bmad-orchestrator`
|
||||
|
||||
## Tips for Roo Code Users
|
||||
|
||||
- Switch modes instead of starting new chats
|
||||
- Each mode supports `*help` to see available commands
|
||||
- Agents respect file permission boundaries
|
||||
- Context persists across mode switches
|
||||
- **Mode switching**: Use mode selecto
|
||||
|
||||
@@ -1,6 +1,4 @@
|
||||
# BMAD Method Guide for Windsurf
|
||||
|
||||
This guide covers Windsurf-specific setup and usage with BMAD Method. For the complete workflow, see the [BMAD Workflow Guide](../bmad-workflow-guide.md).
|
||||
# BMad Method Guide for Windsurf
|
||||
|
||||
## Installation
|
||||
|
||||
@@ -9,29 +7,6 @@ When running `npx bmad-method install`, select **Windsurf** as your IDE. This cr
|
||||
- `.bmad-core/` folder with all agents
|
||||
- `.windsurf/rules/` folder with agent rule files (`.md`)
|
||||
|
||||
## Using BMAD Agents in Windsurf
|
||||
## Using BMad Agents in Windsurf
|
||||
|
||||
Type `@agent-name` in chat to activate an agent:
|
||||
|
||||
- `@bmad-master` - Universal task executor
|
||||
- `@sm` - Scrum Master
|
||||
- `@dev` - Full-stack developer
|
||||
- `@architect` - Solution architect
|
||||
- `@pm` - Product manager
|
||||
- `@analyst` - Business analyst
|
||||
- `@qa` - QA specialist
|
||||
- `@po` - Product owner
|
||||
- `@ux-expert` - UX specialist
|
||||
|
||||
## Windsurf-Specific Features
|
||||
|
||||
- **Rule files**: Stored in `.windsurf/rules/` as `.md` files
|
||||
- **Activation**: Use `@` prefix to mention agents
|
||||
- **Collaborative features**: Works well with BMAD's agent-switching pattern
|
||||
- **Project context**: Agents have access to your full project context
|
||||
|
||||
## Tips for Windsurf Users
|
||||
|
||||
- Start new chats when switching agents
|
||||
- Each agent supports `*help` to see available commands
|
||||
- Leverage Windsurf's collaboration features for team reviews
|
||||
Type `@agent-name` in chat to activate an agent.
|
||||
|
||||
@@ -1,12 +1,12 @@
|
||||
# BMAD Method Universal Workflow Guide
|
||||
# BMad Method Universal Workflow Guide
|
||||
|
||||
This guide outlines the core BMAD workflow that applies regardless of which AI-powered IDE you're using.
|
||||
This guide outlines the core BMad workflow that applies regardless of which AI-powered IDE you're using.
|
||||
|
||||
## Overview
|
||||
|
||||
The BMAD Method follows a structured approach to AI-assisted software development:
|
||||
The BMad Method follows a structured approach to AI-assisted software development:
|
||||
|
||||
1. **Install BMAD** in your project
|
||||
1. **Install BMad** in your project
|
||||
2. **Plan with Gemini** using team-fullstack
|
||||
3. **Organize with bmad-master** (document sharding)
|
||||
4. **Develop iteratively** with SM → Dev cycles
|
||||
@@ -15,14 +15,14 @@ The BMAD Method follows a structured approach to AI-assisted software developmen
|
||||
|
||||
### Phase 1: Project Setup
|
||||
|
||||
1. **Install BMAD in your project**:
|
||||
1. **Install BMad in your project**:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
```
|
||||
|
||||
- Choose "Complete installation"
|
||||
- Select your IDE (Cursor, Claude Code, Windsurf, Roo Code, or VS Code Copilot)
|
||||
- Select your IDE (Cursor, Claude Code, Windsurf, Roo Code, or Github Copilot)
|
||||
|
||||
2. **Verify installation**:
|
||||
- `.bmad-core/` folder created with all agents
|
||||
@@ -35,7 +35,7 @@ Use Google's Gemini for collaborative planning with the full team:
|
||||
|
||||
1. **Open [Google Gems](https://gemini.google.com/gems/view)**
|
||||
2. **Create a new Gem**:
|
||||
- Give it a title and description (e.g., "BMAD Team Fullstack")
|
||||
- Give it a title and description (e.g., "BMad Team Fullstack")
|
||||
3. **Load team-fullstack**:
|
||||
- Copy contents of: `dist/teams/team-fullstack.txt` from your project
|
||||
- Paste this content into the Gem setup to configure the team
|
||||
@@ -113,7 +113,7 @@ Follow the SM → Dev cycle for systematic story development:
|
||||
- **Cursor**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Windsurf**: `@agent-name` (e.g., `@bmad-master`)
|
||||
- **Roo Code**: Select mode from mode selector (e.g., `bmad-bmad-master`)
|
||||
- **VS Code Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
- **Github Copilot**: Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
|
||||
### Chat Management:
|
||||
|
||||
|
||||
@@ -1,24 +1,22 @@
|
||||
# BMAD Method: Core Architecture
|
||||
|
||||
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.
|
||||
# BMad Method: Core Architecture
|
||||
|
||||
## 1. Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
The system facilitates a full development lifecycle:
|
||||
The systems core module facilitates a full development lifecycle tailored to the challenges of current modern AI Agentic tooling:
|
||||
|
||||
1. **Ideation & Planning**: Brainstorming, market research, and creating project briefs.
|
||||
2. **Architecture & Design**: Defining system architecture and UI/UX specifications.
|
||||
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.
|
||||
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.
|
||||
|
||||
## 2. System Architecture Diagram
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
subgraph BMAD Method Project
|
||||
subgraph BMad Method Project
|
||||
subgraph Core Framework
|
||||
A["bmad-core"]
|
||||
A --> B["agents"]
|
||||
@@ -63,9 +61,9 @@ graph TD
|
||||
|
||||
## 3. Core Components
|
||||
|
||||
The `.bmad-core` directory contains all the definitions and resources that give the agents their capabilities.
|
||||
The `bmad-core` directory contains all the definitions and resources that give the agents their capabilities.
|
||||
|
||||
### 3.1. Agents (`.bmad-core/agents/`)
|
||||
### 3.1. Agents (`bmad-core/agents/`)
|
||||
|
||||
- **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.
|
||||
- **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
|
||||
- **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.
|
||||
- **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.
|
||||
|
||||
### 3.2. Agent Teams (`.bmad-core/agent-teams/`)
|
||||
### 3.2. Agent Teams (`bmad-core/agent-teams/`)
|
||||
|
||||
- **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.
|
||||
- **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`.
|
||||
|
||||
### 3.3. Workflows (`.bmad-core/workflows/`)
|
||||
### 3.3. Workflows (`bmad-core/workflows/`)
|
||||
|
||||
- **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.
|
||||
- **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
|
||||
|
||||
#### 3.4.1. Template Processing System
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
The BMAD framework employs a sophisticated template processing system orchestrated by three key components:
|
||||
The BMad framework employs a sophisticated template processing system orchestrated by three key components:
|
||||
|
||||
- **`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.
|
||||
- **`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.
|
||||
|
||||
- **`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.
|
||||
- **`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.
|
||||
|
||||
- **`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.
|
||||
- **`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.
|
||||
|
||||
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.
|
||||
|
||||
#### 3.4.2. Technical Preferences System
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
**Purpose and Benefits:**
|
||||
|
||||
@@ -144,14 +142,14 @@ The framework is designed for two primary environments: local IDEs and web-based
|
||||
|
||||
### 4.2. Environment-Specific Usage
|
||||
|
||||
- **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.
|
||||
- **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.
|
||||
- **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.
|
||||
|
||||
## 5. BMAD Workflows
|
||||
## 5. BMad Workflows
|
||||
|
||||
### 5.1. The Planning Workflow
|
||||
|
||||
Before development begins, BMAD follows a structured planning workflow that establishes the foundation for successful project execution:
|
||||
Before development begins, BMad follows a structured planning workflow that establishes the foundation for successful project execution:
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
@@ -219,166 +217,3 @@ graph TD
|
||||
```
|
||||
|
||||
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.
|
||||
|
||||
## 8. Complete Source Tree
|
||||
|
||||
The BMAD-METHOD project structure is designed for clarity, modularity, and extensibility. Here's the complete source tree with explanations:
|
||||
|
||||
```plaintext
|
||||
bmad-method/
|
||||
├── .bmad-core/ # Core framework (installed in user projects)
|
||||
│ ├── agents/ # Individual agent definitions
|
||||
│ │ ├── analyst.md # Business analyst agent
|
||||
│ │ ├── architect.md # Solution architect agent
|
||||
│ │ ├── bmad-master.md # Universal expert agent
|
||||
│ │ ├── bmad-orchestrator.md # Multi-agent coordinator
|
||||
│ │ ├── dev.md # Full-stack developer agent
|
||||
│ │ ├── pm.md # Product manager agent
|
||||
│ │ ├── po.md # Product owner agent
|
||||
│ │ ├── qa.md # QA specialist agent
|
||||
│ │ ├── sm.md # Scrum master agent
|
||||
│ │ └── ux-expert.md # UX designer agent
|
||||
│ ├── agent-teams/ # Pre-configured agent teams
|
||||
│ │ ├── team-all.yaml # All agents bundle
|
||||
│ │ ├── team-fullstack.yaml # Full-stack development team
|
||||
│ │ ├── team-ide-minimal.yaml # Minimal IDE-focused team
|
||||
│ │ └── team-no-ui.yaml # Backend-only team
|
||||
│ ├── checklists/ # Quality assurance checklists
|
||||
│ │ ├── architect-checklist.md
|
||||
│ │ ├── po-master-checklist.md
|
||||
│ │ └── story-dod-checklist.md
|
||||
│ ├── data/ # Knowledge base and preferences
|
||||
│ │ ├── bmad-kb.md # Core knowledge base
|
||||
│ │ └── technical-preferences.md # User tech preferences
|
||||
│ ├── tasks/ # Reusable task definitions
|
||||
│ │ ├── advanced-elicitation.md # Deep diving techniques
|
||||
│ │ ├── create-doc.md # Document creation task
|
||||
│ │ ├── create-next-story.md # Story generation task
|
||||
│ │ ├── doc-migration-task.md # V3 to V4 migration
|
||||
│ │ ├── execute-checklist.md # Checklist runner
|
||||
│ │ └── shard-doc.md # Document sharding task
|
||||
│ ├── templates/ # Document templates
|
||||
│ │ ├── full-stack-architecture-tmpl.md
|
||||
│ │ ├── prd-tmpl.md
|
||||
│ │ ├── project-brief-tmpl.md
|
||||
│ │ ├── story-tmpl.md
|
||||
│ │ └── [other templates...]
|
||||
│ ├── utils/ # Utility components
|
||||
│ │ ├── agent-switcher.web # Web UI agent switching
|
||||
│ │ ├── template-format.md # Template markup spec
|
||||
│ │ └── workflow-management.md # Workflow helpers
|
||||
│ ├── workflows/ # Development workflows
|
||||
│ │ ├── brownfield-enhancement.yaml
|
||||
│ │ ├── greenfield-fullstack.yaml
|
||||
│ │ ├── greenfield-service.yaml
|
||||
│ │ └── greenfield-simple.yaml
|
||||
│ └── core-config.yaml # V4 configuration system
|
||||
│
|
||||
├── dist/ # Pre-built bundles (generated)
|
||||
│ ├── agents/ # Individual agent bundles
|
||||
│ │ ├── analyst.txt
|
||||
│ │ ├── architect.txt
|
||||
│ │ └── [other agents...]
|
||||
│ ├── teams/ # Team bundles for web UI
|
||||
│ │ ├── team-all.txt
|
||||
│ │ ├── team-fullstack.txt
|
||||
│ │ └── [other teams...]
|
||||
│ └── expansion-packs/ # Expansion pack bundles
|
||||
│
|
||||
├── docs/ # Documentation
|
||||
│ ├── agentic-tools/ # IDE-specific guides
|
||||
│ │ ├── claude-code-guide.md
|
||||
│ │ ├── cursor-guide.md
|
||||
│ │ ├── cline-guide.md
|
||||
│ │ ├── gemini-cli-guide.md
|
||||
│ │ ├── roo-code-guide.md
|
||||
│ │ ├── windsurf-guide.md
|
||||
│ │ └── vs-code-copilot-guide.md
|
||||
│ ├── bmad-workflow-guide.md # Universal workflow guide
|
||||
│ ├── core-architecture.md # This document
|
||||
│ ├── expansion-packs.md # Expansion pack guide
|
||||
│ ├── user-guide.md # Comprehensive user guide
|
||||
│ └── [other docs...]
|
||||
│
|
||||
├── expansion-packs/ # Domain-specific extensions
|
||||
│ ├── bmad-2d-phaser-game-dev/ # Game development pack
|
||||
│ ├── bmad-creator-tools/ # Agent creation tools
|
||||
│ ├── bmad-infrastructure-devops/ # DevOps pack
|
||||
│ └── README.md
|
||||
│
|
||||
├── tools/ # Build and installation tools
|
||||
│ ├── builders/ # Build system
|
||||
│ │ └── web-builder.js # Bundle generator
|
||||
│ ├── cli.js # Main CLI tool
|
||||
│ ├── installer/ # NPX installer
|
||||
│ │ ├── index.js # Installer entry point
|
||||
│ │ ├── config/ # Installation configs
|
||||
│ │ ├── lib/ # Installer utilities
|
||||
│ │ └── templates/ # IDE template files
|
||||
│ └── lib/ # Shared libraries
|
||||
│ ├── bundle-utils.js
|
||||
│ ├── dependency-resolver.js
|
||||
│ └── file-processor.js
|
||||
│
|
||||
├── .github/ # GitHub configuration
|
||||
│ ├── workflows/ # GitHub Actions
|
||||
│ └── ISSUE_TEMPLATE/ # Issue templates
|
||||
│
|
||||
├── common/ # Shared resources
|
||||
│ ├── tasks/ # Common tasks
|
||||
│ └── utils/ # Common utilities
|
||||
│
|
||||
├── bmad-core/ # Source for .bmad-core
|
||||
│ └── [mirrors .bmad-core structure]
|
||||
│
|
||||
├── package.json # Node.js configuration
|
||||
├── README.md # Project readme
|
||||
├── CONTRIBUTING.md # Contribution guidelines
|
||||
├── GUIDING-PRINCIPLES.md # Core principles
|
||||
└── LICENSE # MIT license
|
||||
```
|
||||
|
||||
### Directory Purposes
|
||||
|
||||
#### Core Framework (.bmad-core/)
|
||||
|
||||
- **agents/**: Individual AI agent personalities and capabilities
|
||||
- **agent-teams/**: Bundles of agents for specific workflows
|
||||
- **checklists/**: Quality assurance and validation steps
|
||||
- **data/**: Knowledge base and user preferences
|
||||
- **tasks/**: Reusable procedures agents can execute
|
||||
- **templates/**: Document templates with embedded AI instructions
|
||||
- **utils/**: Helper components for agents
|
||||
- **workflows/**: Structured development processes
|
||||
|
||||
#### Generated Bundles (dist/)
|
||||
|
||||
- Pre-built text files ready for web UI upload
|
||||
- Automatically generated by the build system
|
||||
- Includes resolved dependencies for each agent/team
|
||||
|
||||
#### Tools (tools/)
|
||||
|
||||
- **cli.js**: Main build tool for creating bundles
|
||||
- **installer/**: NPX-based installer for projects
|
||||
- **builders/**: Bundle generation logic
|
||||
- **lib/**: Shared utilities for build system
|
||||
|
||||
#### Expansion Packs (expansion-packs/)
|
||||
|
||||
- Domain-specific agent collections
|
||||
- Extend BMAD beyond software development
|
||||
- Each pack is self-contained with its own agents, tasks, and templates
|
||||
|
||||
#### Documentation (docs/)
|
||||
|
||||
- Comprehensive guides for users
|
||||
- Technical architecture documentation
|
||||
- IDE-specific setup instructions
|
||||
|
||||
### Key Files
|
||||
|
||||
- **core-config.yaml**: V4's flexible configuration system
|
||||
- **bmad-kb.md**: Central knowledge base loaded by most agents
|
||||
- **template-format.md**: Specification for BMAD's template markup
|
||||
- **dependency-resolver.js**: Manages agent resource loading
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
# The Power of BMAD Expansion Packs
|
||||
# The Power of BMad Expansion Packs
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Why Expansion Packs?
|
||||
|
||||
### Keep Core Lean
|
||||
|
||||
The core BMAD framework maintains its focus on software development, ensuring dev agents have maximum context for coding. Expansion packs handle everything else.
|
||||
The core BMad framework maintains its focus on software development, ensuring dev agents have maximum context for coding. Expansion packs handle everything else.
|
||||
|
||||
### Domain Expertise
|
||||
|
||||
@@ -275,6 +275,6 @@ Every expansion pack:
|
||||
|
||||
## Remember
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
**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
|
||||
|
||||
### 1. Fork the Repository
|
||||
|
||||
1. Go to the [BMAD-METHOD repository](https://github.com/bmadcode/bmad-method)
|
||||
1. Go to the [BMad-Method repository](https://github.com/bmadcode/bmad-method)
|
||||
2. Click the "Fork" button in the top-right corner
|
||||
3. This creates your own copy of the project
|
||||
|
||||
|
||||
@@ -1,26 +1,23 @@
|
||||
# BMAD-METHOD Agentic Agile Driven Development User Guide
|
||||
# BMad-Method Agentic Agile Driven Development User Guide
|
||||
|
||||
This comprehensive guide will help you understand and effectively use the BMad Method framework for AI-assisted software development.
|
||||
This comprehensive guide will help you understand and effectively use the BMad Method framework for AI-assisted software development along with many expansion purposes.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Understanding BMAD](#understanding-bmad)
|
||||
1. [Understanding BMad](#understanding-bmad)
|
||||
2. [Getting Started](#getting-started)
|
||||
3. [Agent System](#agent-system)
|
||||
4. [Templates and Document Creation](#templates-and-document-creation)
|
||||
5. [Development Workflow](#development-workflow)
|
||||
6. [Team Configurations](#team-configurations)
|
||||
7. [IDE Integration](#ide-integration)
|
||||
8. [Web UI Usage](#web-ui-usage)
|
||||
9. [Advanced Features](#advanced-features)
|
||||
10. [Troubleshooting](#troubleshooting)
|
||||
11. [Best Practices](#best-practices)
|
||||
6. [IDE Integration](#ide-integration)
|
||||
7. [Web UI Usage](#web-ui-usage)
|
||||
8. [Advanced Features](#advanced-features)
|
||||
|
||||
## Understanding BMAD
|
||||
## Understanding BMad
|
||||
|
||||
### What is BMAD-METHOD?
|
||||
### What is BMad-Method?
|
||||
|
||||
BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) is an AI agent orchestration framework that provides specialized AI agents for every role in a complete Agile development team. Unlike generic AI assistants, each BMAD agent has deep expertise in their specific domain and can collaborate to deliver complete software projects.
|
||||
BMad-Method (Breakthrough Method of Agile AI-Driven Development) is an AI agent orchestration framework that provides specialized AI agents for every role in a complete Agile development team. Unlike generic AI assistants, each BMad agent has deep expertise in their specific domain and can collaborate with you using advanced elicitation techniques, and guided workflows
|
||||
|
||||
### Core Principles
|
||||
|
||||
@@ -28,9 +25,9 @@ BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) is an AI agent
|
||||
2. **True Agile Workflow**: Follows real Agile methodologies with proper story management
|
||||
3. **Self-Contained Templates**: Documents embed both output and processing instructions
|
||||
4. **Dynamic Dependencies**: Agents only load resources they need
|
||||
5. **Platform Agnostic**: Works with any AI platform or IDE
|
||||
5. **Platform Agnostic**: Works with any Project Type or Agentic IDE
|
||||
|
||||
### When to Use BMAD
|
||||
### When to Use BMad
|
||||
|
||||
- **New Projects (Greenfield)**: Complete end-to-end development
|
||||
- **Existing Projects (Brownfield)**: Feature additions and enhancements
|
||||
@@ -44,7 +41,7 @@ BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) is an AI agent
|
||||
|
||||
#### Option 1: Web UI (Fastest - 2 minutes)
|
||||
|
||||
Best for: ChatGPT, Claude, Gemini users
|
||||
If you want to do the planning int he Web:
|
||||
|
||||
1. Navigate to `dist/teams/`
|
||||
2. Copy `team-fullstack.txt` content
|
||||
@@ -54,8 +51,6 @@ Best for: ChatGPT, Claude, Gemini users
|
||||
|
||||
#### Option 2: IDE Integration (5 minutes)
|
||||
|
||||
Best for: Cursor, Claude Code, Windsurf, VS Code users
|
||||
|
||||
```bash
|
||||
# Interactive installation (recommended)
|
||||
npx bmad-method install
|
||||
@@ -74,40 +69,6 @@ npx bmad-method install
|
||||
npx bmad-method status
|
||||
```
|
||||
|
||||
### First Steps
|
||||
|
||||
1. **Choose Your Environment**: Web UI or IDE
|
||||
2. **Select Agent/Team**: Individual agent or full team
|
||||
3. **Initialize Project**: Run `/help` or `*help` to see capabilities
|
||||
4. **Start Development**: Begin with planning or jump into coding
|
||||
|
||||
### Upgrading from V3 to V4
|
||||
|
||||
If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory:
|
||||
|
||||
```bash
|
||||
npx bmad-method install
|
||||
# The installer will automatically detect your V3 installation and offer to upgrade
|
||||
```
|
||||
|
||||
The upgrade process will:
|
||||
|
||||
1. Create a backup of your V3 files in `.bmad-v3-backup/`
|
||||
2. Install the new V4 `.bmad-core/` structure
|
||||
3. Migrate your documents (PRD, Architecture, Stories, Epics)
|
||||
4. Set up IDE integration for all V4 agents
|
||||
5. Create an install manifest for future updates
|
||||
|
||||
After upgrading:
|
||||
|
||||
1. Review your documents in the `docs/` folder - if you had a PRD or architecture in your old project, copy it from the backup to the docs folder if they are not there.
|
||||
2. Optionally run the `doc-migration-task` to align your documents with V4 templates - you can do this with your agent by saying something like: 'run {drag in task} against {drag prd or arch file from docs} to align with {drag the template from .bmad-core/templates/full-stack-architecture.md}'
|
||||
3. If you have separate front-end and backend architecture docs you can modify step 2 to merge both into a single full stack architecture or separate Front and Back end.
|
||||
|
||||
The reason #2 and #3 are optional is because now BMAD V4 makes sharding optional for the SM. See [Core Configuration](#core-configuration)
|
||||
|
||||
**Note**: The agents in `.bmad-core/` fully replace the items in `bmad-agent/` - you can remove the backup folder versions.
|
||||
|
||||
## Agent System
|
||||
|
||||
### Core Development Team
|
||||
@@ -181,7 +142,7 @@ dependencies:
|
||||
|
||||
### Understanding Templates
|
||||
|
||||
BMAD templates are **self-contained and interactive** - they embed both the desired document output and the LLM instructions needed to work with users. This means no separate task is needed for most document creation.
|
||||
BMad templates are **self-contained and interactive** - they embed both the desired document output and the LLM instructions needed to work with users. This means no separate task is needed for most document creation.
|
||||
|
||||
#### Template Structure
|
||||
|
||||
@@ -233,8 +194,8 @@ Templates follow the `template-format.md` specification:
|
||||
For cost efficiency, especially with Gemini:
|
||||
|
||||
1. **Create Large Documents in Web UI**: Use web bundles for PRD and architecture creation
|
||||
2. **Copy to Project**: Save the final markdown output to your project's `docs/` folder
|
||||
3. **Standard Naming**: Use `prd.md` and `architecture.md` for consistency
|
||||
2. **Copy to Project**: Save the final markdown output to your project's `docs/` folder (use the ... menu)
|
||||
3. **Standard Naming**: Use `prd.md` and `architecture.md` for consistent file name
|
||||
4. **Continue in IDE**: Use IDE agents for development tasks and smaller documents
|
||||
|
||||
#### File Naming Conventions
|
||||
@@ -283,7 +244,7 @@ This provides 10 structured brainstorming actions:
|
||||
|
||||
### The Planning Workflow (Web UI)
|
||||
|
||||
Before development begins, BMAD follows a structured planning workflow that's ideally done in web UI for cost efficiency:
|
||||
Before development begins, BMad follows a structured planning workflow that's ideally done in web UI for cost efficiency:
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
@@ -320,7 +281,7 @@ graph TD
|
||||
|
||||
### The Core Development Cycle (IDE)
|
||||
|
||||
Once planning is complete and documents are sharded, BMAD follows a structured development workflow:
|
||||
Once planning is complete and documents are sharded, BMad follows a structured development workflow:
|
||||
|
||||
```mermaid
|
||||
graph TD
|
||||
@@ -468,27 +429,7 @@ When the SM agent executes the `create-next-story` task:
|
||||
|
||||
#### The Story Template Structure
|
||||
|
||||
The story template contains embedded LLM instructions for different agents:
|
||||
|
||||
**SM Agent Instructions**:
|
||||
|
||||
- Populate Dev Notes with specific technical details from architecture
|
||||
- Include source references for all technical guidance
|
||||
- Create detailed tasks based on architecture constraints
|
||||
- Add testing requirements from testing strategy
|
||||
|
||||
**Dev Agent Instructions**:
|
||||
|
||||
- Update Debug Log References during implementation
|
||||
- Document any deviations in Completion Notes
|
||||
- Maintain comprehensive File List of all changes
|
||||
- Track requirement changes in Change Log
|
||||
|
||||
**QA Agent Instructions**:
|
||||
|
||||
- Append review results in QA Results section
|
||||
- Document refactoring performed with explanations
|
||||
- Note security and performance considerations
|
||||
The story template contains embedded LLM instructions for the SM Dev and QA Agent.
|
||||
|
||||
#### How Agents Pass Information
|
||||
|
||||
@@ -525,57 +466,6 @@ The QA agent contributes:
|
||||
- **Improvements Checklist**: Items completed (marked [x]) vs. items for Dev to address (marked [ ])
|
||||
- **Learning Opportunities**: Explanations for junior/mid-level developer growth
|
||||
|
||||
#### Example: How Notes Flow Between Stories
|
||||
|
||||
**Story 1.1 Completion**:
|
||||
|
||||
```markdown
|
||||
### Completion Notes List
|
||||
|
||||
- Discovered that user authentication requires additional session management not specified in architecture
|
||||
- Created new SessionManager service in services/auth/session-manager.ts
|
||||
- Recommend updating architecture to include session management patterns
|
||||
```
|
||||
|
||||
**Story 1.2 Creation** (SM uses the above notes):
|
||||
|
||||
```markdown
|
||||
## Dev Notes
|
||||
|
||||
### Previous Story Insights
|
||||
|
||||
- Story 1.1 created SessionManager service for auth (services/auth/session-manager.ts)
|
||||
- Consider using SessionManager for this story's user profile feature
|
||||
- Architecture update pending for session management patterns
|
||||
```
|
||||
|
||||
This continuous feedback loop ensures each story benefits from lessons learned in previous implementations.
|
||||
|
||||
#### QA Agent Key Principles
|
||||
|
||||
When the QA agent performs the review-story task:
|
||||
|
||||
- **Senior Developer Authority**: Reviews as a senior developer with authority to refactor directly
|
||||
- **Active Improvement**: Makes code improvements rather than just identifying issues
|
||||
- **Teaching Focus**: Explains all changes for developer learning and growth
|
||||
- **Pragmatic Balance**: Focuses on significant improvements, not nitpicks
|
||||
- **Quality Gates**: Can block story completion if critical issues exist
|
||||
|
||||
**QA Blocking Conditions**:
|
||||
The QA will stop and request clarification if:
|
||||
|
||||
- Story file is incomplete or missing critical sections
|
||||
- File List is empty or clearly incomplete
|
||||
- No tests exist when they were required
|
||||
- Code changes don't align with story requirements
|
||||
- Critical architectural issues require discussion
|
||||
|
||||
- **Benefits of QA Review**:
|
||||
- Code quality improvements and refactoring
|
||||
- Knowledge transfer through documented explanations
|
||||
- Catching edge cases and security issues
|
||||
- Ensuring architectural consistency
|
||||
|
||||
### Workflow Types
|
||||
|
||||
#### Greenfield Development
|
||||
@@ -598,85 +488,11 @@ For existing projects:
|
||||
4. Incremental development
|
||||
5. Integration testing
|
||||
|
||||
## Team Configurations
|
||||
|
||||
### Pre-Built Teams
|
||||
|
||||
#### Team All
|
||||
|
||||
- **Includes**: All 10 agents + orchestrator
|
||||
- **Use Case**: Complete projects requiring all roles
|
||||
- **Bundle**: `team-all.txt`
|
||||
|
||||
#### Team Fullstack
|
||||
|
||||
- **Includes**: PM, Architect, Developer, QA, UX Expert
|
||||
- **Use Case**: End-to-end web/mobile development
|
||||
- **Bundle**: `team-fullstack.txt`
|
||||
|
||||
#### Team No-UI
|
||||
|
||||
- **Includes**: PM, Architect, Developer, QA (no UX Expert)
|
||||
- **Use Case**: Backend services, APIs, system development
|
||||
- **Bundle**: `team-no-ui.txt`
|
||||
|
||||
### Custom Team Configuration
|
||||
|
||||
Create custom teams by modifying `.bmad-core/agent-teams/`:
|
||||
|
||||
```yaml
|
||||
name: Custom Development Team
|
||||
description: Specialized team for specific needs
|
||||
agents:
|
||||
- pm
|
||||
- architect
|
||||
- dev
|
||||
- qa
|
||||
workflows:
|
||||
- greenfield-fullstack
|
||||
```
|
||||
|
||||
## IDE Integration
|
||||
|
||||
### Supported IDEs
|
||||
|
||||
#### Cursor IDE
|
||||
|
||||
- **Commands**: `@agent-name task` (manual rules)
|
||||
- **Example**: `@pm Create a PRD for user management`
|
||||
- **Features**: Inline suggestions, context awareness
|
||||
- **Integration**: Agents loaded as manual rules
|
||||
|
||||
#### Claude Code
|
||||
|
||||
- **Commands**: `/agent-name task` (command files)
|
||||
- **Example**: `/architect Design microservices architecture`
|
||||
- **Features**: File integration, project context
|
||||
- **Integration**: Agents installed as files in commands folder
|
||||
|
||||
#### Windsurf
|
||||
|
||||
- **Commands**: `@agent-name task` (manual rules)
|
||||
- **Example**: `@dev Implement authentication`
|
||||
- **Features**: Multi-file editing, project awareness
|
||||
- **Integration**: Agents loaded as manual rules
|
||||
|
||||
#### VS Code (Generic)
|
||||
|
||||
- **Setup**: Manual installation
|
||||
- **Usage**: Copy agent content to chat
|
||||
- **Features**: Basic integration
|
||||
|
||||
### IDE Setup Process
|
||||
|
||||
1. **Install CLI**: `npx bmad-method install`
|
||||
2. **Select IDE**: Choose during installation
|
||||
3. **Configure Integration**: Automatic setup for supported IDEs
|
||||
4. **Verify Installation**: Test with `@agent-name help`
|
||||
|
||||
### IDE Best Practices
|
||||
|
||||
- **Context Management**: Keep relevant files open
|
||||
- **Context Management**: Keep relevant files only in context, keep files as lean and focused as necessary
|
||||
- **Agent Selection**: Use appropriate agent for task
|
||||
- **Iterative Development**: Work in small, focused tasks
|
||||
- **File Organization**: Maintain clean project structure
|
||||
@@ -685,92 +501,14 @@ workflows:
|
||||
|
||||
**Important**: Web UI is primarily designed for planning and documentation phases, not development. Use IDE integration for coding tasks.
|
||||
|
||||
### Platform Setup
|
||||
|
||||
#### ChatGPT Custom GPT
|
||||
|
||||
1. Create new Custom GPT
|
||||
2. Upload team bundle as knowledge
|
||||
3. Set instructions: "Your critical operating instructions are attached, do not break character as directed"
|
||||
4. Configure capabilities as needed
|
||||
|
||||
#### Claude Projects
|
||||
|
||||
1. Create new project
|
||||
2. Add team bundle to project knowledge
|
||||
3. Set project instructions with agent behavior
|
||||
4. Start conversation with `/help`
|
||||
|
||||
#### Gemini Gems
|
||||
|
||||
1. Create new Gem
|
||||
2. Upload bundle as instruction file
|
||||
3. Set system instructions for agent behavior
|
||||
4. Initialize with `/help` command
|
||||
|
||||
### Web UI Commands
|
||||
|
||||
#### Universal Commands
|
||||
|
||||
- `/help` - Show available commands
|
||||
- `/status` - Current agent status
|
||||
- `/switch agent-name` - Change active agent (if orchestrator available)
|
||||
|
||||
#### Document Commands
|
||||
|
||||
- `/create-doc type` - Create document of specified type
|
||||
- `/review-doc` - Review current document
|
||||
- `/refine-doc` - Improve document quality
|
||||
|
||||
#### Planning Commands
|
||||
|
||||
- `/pm create-doc prd` - Create Product Requirements Document
|
||||
- `/architect create-doc architecture` - Create system architecture
|
||||
- `/analyst create-doc project-brief` - Create project brief
|
||||
- `/po run-checklist` - Validate document alignment
|
||||
type #help when in the Gem or Custom GPT with one of the teams, and the BMad-Orchestrator will give you an up to date list of commands.
|
||||
|
||||
### Web UI Agent Interaction
|
||||
|
||||
Web UI agents focus on planning and documentation. Here's how to interact with each:
|
||||
|
||||
#### Agent Switching and Conversation
|
||||
|
||||
- **Switch Agents**: Use `/pm`, `/architect`, `/analyst`, `/po` to switch between roles
|
||||
- **Agent Consultation**: Each agent offers their specialized options and capabilities
|
||||
- **Natural Conversation**: Agents guide you through their processes with questions and suggestions
|
||||
|
||||
#### Planning Phase Agents
|
||||
|
||||
- **Analyst**: `/analyst` - Brainstorming, market research, competitive analysis
|
||||
- **PM**: `/pm` - Product requirements, feature definition, roadmaps
|
||||
- **Architect**: `/architect` - System design, technical architecture
|
||||
- **PO**: `/po` - Document validation, epic management, story alignment
|
||||
|
||||
### Web UI Best Practices
|
||||
|
||||
- **Clear Instructions**: Be specific about requirements
|
||||
- **Context Sharing**: Provide relevant background
|
||||
- **Iterative Refinement**: Use built-in elicitation features
|
||||
- **Document Management**: Keep generated docs organized
|
||||
- **Stay in Planning**: Use web UI for documentation, switch to IDE for development
|
||||
|
||||
#### Cost-Effective Document Creation
|
||||
|
||||
**Recommended Workflow for Large Documents:**
|
||||
|
||||
1. **Use Web UI for PRD and Architecture**: These are token-heavy documents, especially in Gemini
|
||||
2. **Copy Final Output**: Save complete markdown to your project
|
||||
3. **Standard File Names**:
|
||||
- Save PRD as `docs/prd.md`
|
||||
- Save Architecture as `docs/architecture.md`
|
||||
4. **IDE for Development**: Switch to IDE agents for implementation tasks
|
||||
|
||||
**Why This Saves Money:**
|
||||
|
||||
- Web UI pricing is typically more cost-effective for large context windows
|
||||
- PRD and architecture creation involves extensive back-and-forth refinement
|
||||
- IDE token costs can accumulate quickly with large document generation
|
||||
|
||||
## Advanced Features
|
||||
|
||||
### Dynamic Resource Loading
|
||||
@@ -784,7 +522,7 @@ BMad's dependency system ensures agents only load necessary resources:
|
||||
|
||||
### Custom Templates
|
||||
|
||||
Create custom templates following `template-format.md`:
|
||||
Create custom templates following `utils/template-format.md`:
|
||||
|
||||
```markdown
|
||||
---
|
||||
@@ -1039,7 +777,7 @@ Agents can reference and load documents from the `docs/` folder:
|
||||
|
||||
### Technical Preferences System
|
||||
|
||||
BMAD includes a powerful personalization system through the `technical-preferences.md` file located in `.bmad-core/data/`.
|
||||
BMad includes a powerful personalization system through the `technical-preferences.md` file located in `.bmad-core/data/`.
|
||||
|
||||
#### What is technical-preferences.md?
|
||||
|
||||
@@ -1133,11 +871,11 @@ When creating custom web bundles or uploading to AI platforms, include your `tec
|
||||
|
||||
### Core Configuration
|
||||
|
||||
The `bmad-core/core-config.yaml` file is a critical V4 innovation that enables BMAD to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
||||
The `bmad-core/core-config.yaml` file is a critical V4 innovation that enables BMad to work seamlessly with any project structure, providing maximum flexibility and backwards compatibility.
|
||||
|
||||
#### Understanding core-config.yaml
|
||||
|
||||
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's what makes V4 agents intelligent enough to work with V3 projects, custom layouts, or any document organization you prefer.
|
||||
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's what makes V4 agents intelligent enough to work with V3 projects, custom layouts, or any document organization you prefer.
|
||||
|
||||
#### Configuration Structure
|
||||
|
||||
@@ -1347,7 +1085,7 @@ customTechnicalDocuments:
|
||||
|
||||
#### Best Practices
|
||||
|
||||
1. **Always Configure for Your Structure**: Don't force your project to match BMAD defaults
|
||||
1. **Always Configure for Your Structure**: Don't force your project to match BMad defaults
|
||||
2. **Keep devLoadAlwaysFiles Focused**: Only include files needed for every dev task
|
||||
3. **Use Debug Log**: Enable when troubleshooting story implementation issues
|
||||
4. **Version Control core-config.yaml**: Track changes to understand project evolution
|
||||
@@ -1384,135 +1122,16 @@ Add specialized capabilities:
|
||||
|
||||
## Troubleshooting Guide
|
||||
|
||||
### Common Issues
|
||||
## Getting Help
|
||||
|
||||
#### Agent Not Responding
|
||||
|
||||
- **Cause**: Incorrect agent name or command
|
||||
- **Solution**: Check available agents with `/help`
|
||||
- **Prevention**: Use tab completion in supported IDEs
|
||||
|
||||
#### Template Errors
|
||||
|
||||
- **Cause**: Malformed template syntax
|
||||
- **Solution**: Validate against `template-format.md`
|
||||
- **Prevention**: Use provided templates as starting point
|
||||
|
||||
#### Context Overload
|
||||
|
||||
- **Cause**: Too many dependencies loaded
|
||||
- **Solution**: Use specific agents instead of `bmad-master`
|
||||
- **Prevention**: Choose appropriate team size
|
||||
|
||||
#### Installation Issues
|
||||
|
||||
- **Cause**: Node.js version, permissions
|
||||
- **Solution**: Update Node.js, check permissions
|
||||
- **Prevention**: Use recommended Node.js version (14+)
|
||||
|
||||
### Debugging Steps
|
||||
|
||||
1. **Check Installation**: `npx bmad-method status`
|
||||
2. **Verify Agent**: Test with simple command
|
||||
3. **Review Dependencies**: Ensure required files exist
|
||||
4. **Clear Cache**: Restart IDE/browser
|
||||
5. **Reinstall**: `npx bmad-method install --force`
|
||||
|
||||
### Getting Help
|
||||
|
||||
- **Discord Community**: [Join Discord](https://discord.gg/g6ypHytrCB)
|
||||
- **Discord Community**: [Join Discord](https://discord.gg/gk8jAdXWmj)
|
||||
- **GitHub Issues**: [Report bugs](https://github.com/bmadcode/bmad-method/issues)
|
||||
- **Documentation**: [Browse docs](https://github.com/bmadcode/bmad-method/tree/main/docs)
|
||||
- **YouTube**: [BMadCode Channel](https://www.youtube.com/@BMadCode)
|
||||
|
||||
## Best Practices and Tips
|
||||
|
||||
### Project Organization
|
||||
|
||||
#### Folder Structure
|
||||
|
||||
```text
|
||||
project/
|
||||
├── .bmad-core/ # BMAD agents and resources
|
||||
├── docs/ # Generated documentation
|
||||
│ ├── prd.md
|
||||
│ ├── architecture.md
|
||||
│ └── stories/
|
||||
├── src/ # Source code
|
||||
└── tests/ # Test files
|
||||
```
|
||||
|
||||
#### Document Management
|
||||
|
||||
- Keep generated docs in `docs/` folder
|
||||
- Version control all BMAD-generated content
|
||||
- Regular backups of `.bmad-core/` customizations
|
||||
|
||||
### Recommended Development Flow
|
||||
|
||||
#### Planning Phase
|
||||
|
||||
1. **Start with Analysis**: Use analyst for market research
|
||||
2. **Create PRD**: PM agent for comprehensive requirements
|
||||
3. **Design Architecture**: Architect for technical foundation
|
||||
4. **Plan UX**: UX Expert for user experience
|
||||
|
||||
#### Development Phase
|
||||
|
||||
1. **Shard Work**: PO to break down epics
|
||||
2. **Story Development**: SM for manageable tasks
|
||||
3. **Implementation**: Dev for coding
|
||||
4. **Quality Assurance**: QA for testing
|
||||
|
||||
#### Review Process
|
||||
|
||||
1. **Code Review**: Dev agent for code quality
|
||||
2. **Functional Testing**: QA for feature validation
|
||||
3. **User Acceptance**: PO for business requirements
|
||||
4. **Documentation**: Update docs as needed
|
||||
|
||||
### Quality Assurance
|
||||
|
||||
#### Code Quality
|
||||
|
||||
- Use dev agent for code reviews
|
||||
- Implement suggested improvements
|
||||
- Follow established coding standards
|
||||
- Regular refactoring sessions
|
||||
|
||||
#### Documentation Standards
|
||||
|
||||
- Keep docs updated with changes
|
||||
- Use templates for consistency
|
||||
- Regular doc reviews with PO
|
||||
- Clear, actionable user stories
|
||||
|
||||
#### Process Quality
|
||||
|
||||
- Follow Agile ceremonies
|
||||
- Regular retrospectives
|
||||
- Continuous improvement
|
||||
- Stakeholder feedback integration
|
||||
|
||||
### Performance Optimization
|
||||
|
||||
#### Context Management
|
||||
|
||||
- Use specific agents vs. bmad-master
|
||||
- Minimal team configurations
|
||||
- Regular dependency cleanup
|
||||
- Archive completed projects
|
||||
|
||||
#### Resource Efficiency
|
||||
|
||||
- Appropriate bundle sizes
|
||||
- Selective agent usage
|
||||
- Efficient template design
|
||||
- Regular cache clearing
|
||||
|
||||
## Conclusion
|
||||
|
||||
BMAD-METHOD provides a comprehensive framework for AI-assisted software development. By following this guide, you'll be able to:
|
||||
BMad-Method provides a comprehensive framework for AI-assisted software development. By following this guide, you'll be able to:
|
||||
|
||||
- Effectively use specialized AI agents
|
||||
- Create professional documentation
|
||||
@@ -1520,8 +1139,4 @@ BMAD-METHOD provides a comprehensive framework for AI-assisted software developm
|
||||
- Integrate with your preferred tools
|
||||
- Maintain high quality standards
|
||||
|
||||
Remember: BMAD is designed to enhance your development process, not replace your expertise. Use it as a powerful tool to accelerate your projects while maintaining control over design decisions and implementation details.
|
||||
|
||||
---
|
||||
|
||||
For additional support, join our [Discord community](https://discord.gg/g6ypHytrCB) or check out the [YouTube channel](https://www.youtube.com/@BMadCode) for video tutorials and walkthroughs.
|
||||
Remember: BMad is designed to enhance your development process, not replace your expertise. Use it as a powerful tool to accelerate your projects while maintaining control over design decisions and implementation details.
|
||||
|
||||
@@ -2,9 +2,9 @@
|
||||
|
||||
## Previous Versions
|
||||
|
||||
- [Version 3](https://github.com/bmadcode/BMAD-METHOD/tree/V3)
|
||||
- [Version 2](https://github.com/bmadcode/BMAD-METHOD/tree/V2)
|
||||
- [Version 1](https://github.com/bmadcode/BMAD-METHOD/tree/V1)
|
||||
- [Version 3](https://github.com/bmadcode/BMad-Method/tree/V3)
|
||||
- [Version 2](https://github.com/bmadcode/BMad-Method/tree/V2)
|
||||
- [Version 1](https://github.com/bmadcode/BMad-Method/tree/V1)
|
||||
|
||||
## Current Version: V4 - Alpha
|
||||
|
||||
@@ -25,7 +25,7 @@ V3 didn't fix the disconnect, but it did make it easier to maintain them all in
|
||||
|
||||
V3's biggest impact was a full explosion of customizability. Tasks, Personas, Agent Configurations, Doc Templates, data payloads.
|
||||
|
||||
BUT - the BIGGEST change was the realization that we were barely scratching the surface of what could be loaded into Gemini Gems and still have very long chats. The BMAD AGENT arose, and with a single V3 release - the future of the BMad Method was changed forever.
|
||||
BUT - the BIGGEST change was the realization that we were barely scratching the surface of what could be loaded into Gemini Gems and still have very long chats. The BMad AGENT arose, and with a single V3 release - the future of the BMad Method was changed forever.
|
||||
|
||||
Now, instead of configuring 4+ web agents, all needing many files uploaded to create them, a single Agent called BMad, with a whole team, and the ability to switch and maintain personas evolved. Now you could in the same chat thread, talk to the whole team, or anyone on the team. No more exporting and reimporting docs to different chats - all of the sudden, you could finish the PRD, and ask Josh to pass it off to the Architect, and that was it, the architect just had it and we moved on! And all of that with just 7 total files to upload, delivering all power.
|
||||
|
||||
|
||||
@@ -1,12 +1,11 @@
|
||||
# Working in the Brownfield: A Complete Guide
|
||||
|
||||
> 🚀 **HIGHLY RECOMMENDED: Use Gemini Web or Gemini CLI for Brownfield Documentation!**
|
||||
> **HIGHLY RECOMMENDED: Use Gemini Web or Gemini CLI for Brownfield Documentation Generation!**
|
||||
>
|
||||
> Gemini Web's 1M+ token context window or Gemini CLI (when its working) can analyze your ENTIRE codebase at once:
|
||||
> Gemini Web's 1M+ token context window or Gemini CLI (when its working) can analyze your ENTIRE codebase or critical sections of it all at once (obviously within reason):
|
||||
>
|
||||
> - Upload via GitHub URL
|
||||
> - Upload up to 1000 files
|
||||
> - Upload zipped project
|
||||
> - Upload via GitHub URL or use gemini cli in the project folder
|
||||
> - If in the web: Upload up to 1000 files or the zipped project or just give it the github url
|
||||
|
||||
## What is Brownfield Development?
|
||||
|
||||
@@ -21,6 +20,10 @@ Brownfield development refers to adding features, fixing bugs, or modernizing ex
|
||||
- Fix bugs that require architectural understanding
|
||||
- Document undocumented systems
|
||||
|
||||
## When NOT to use a Brownfield Flow
|
||||
|
||||
If you have just completed an MVP with BMad, and you want to continue with post-MVP, its easier to just talk to the PM and ask him to work with you to create a new epic to add into the PRD, shard out the epic, update any architecture documents with the architect, and just go from there.
|
||||
|
||||
## The Complete Brownfield Workflow
|
||||
|
||||
### Choose Your Approach
|
||||
@@ -353,6 +356,6 @@ Is this a major enhancement affecting multiple systems?
|
||||
|
||||
## Conclusion
|
||||
|
||||
Brownfield development with BMAD-METHOD provides structure and safety when modifying existing systems. The key is providing comprehensive context through documentation, using specialized templates that consider integration requirements, and following workflows that respect existing constraints while enabling progress.
|
||||
Brownfield development with BMad-Method provides structure and safety when modifying existing systems. The key is providing comprehensive context through documentation, using specialized templates that consider integration requirements, and following workflows that respect existing constraints while enabling progress.
|
||||
|
||||
Remember: **Document First, Plan Carefully, Integrate Safely**
|
||||
|
||||
@@ -1,3 +1,3 @@
|
||||
# BMAD Method Expansion Packs
|
||||
# BMad Method Expansion Packs
|
||||
|
||||
Expansion packs extend BMAD-METHOD beyond traditional software development, providing specialized agent teams, templates, and workflows for specific domains and industries. Each pack is a self-contained ecosystem designed to bring the power of AI-assisted workflows to any field. Coming soon.
|
||||
Expansion packs extend BMad-Method beyond traditional software development, providing specialized agent teams, templates, and workflows for specific domains and industries. Each pack is a self-contained ecosystem designed to bring the power of AI-assisted workflows to any field. Coming soon.
|
||||
|
||||
@@ -2,6 +2,6 @@ name: bmad-2d-phaser-game-dev
|
||||
version: 1.3.0
|
||||
short-title: 2D game development with Phaser 3 & TypeScript
|
||||
description: >-
|
||||
2D Game Development expansion pack for BMAD Method - Phaser 3 & TypeScript
|
||||
2D Game Development expansion pack for BMad Method - Phaser 3 & TypeScript
|
||||
focused
|
||||
author: Brian (BMad)
|
||||
|
||||
@@ -1,8 +1,8 @@
|
||||
# Game Development BMAD Knowledge Base
|
||||
# Game Development BMad Knowledge Base
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
### Game Development Focus
|
||||
|
||||
@@ -251,4 +251,4 @@ game-project/
|
||||
- Culling and level-of-detail systems
|
||||
- Memory management and garbage collection optimization
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# BMAD Creator Tools
|
||||
# BMad Creator Tools
|
||||
|
||||
Tools for creating and extending BMAD framework components.
|
||||
Tools for creating and extending BMad framework components.
|
||||
|
||||
## Tasks
|
||||
|
||||
|
||||
@@ -11,27 +11,27 @@ activation-instructions:
|
||||
agent:
|
||||
name: The Creator
|
||||
id: bmad-the-creator
|
||||
title: BMAD Framework Extension Specialist
|
||||
title: BMad Framework Extension Specialist
|
||||
icon: 🏗️
|
||||
whenToUse: Use for creating new agents, expansion packs, and extending the BMAD framework
|
||||
whenToUse: Use for creating new agents, expansion packs, and extending the BMad framework
|
||||
customization: null
|
||||
persona:
|
||||
role: Expert BMAD Framework Architect & Creator
|
||||
role: Expert BMad Framework Architect & Creator
|
||||
style: Methodical, creative, framework-aware, systematic
|
||||
identity: Master builder who extends BMAD capabilities through thoughtful design and deep framework understanding
|
||||
focus: Creating well-structured agents, expansion packs, and framework extensions that follow BMAD patterns and conventions
|
||||
identity: Master builder who extends BMad capabilities through thoughtful design and deep framework understanding
|
||||
focus: Creating well-structured agents, expansion packs, and framework extensions that follow BMad patterns and conventions
|
||||
core_principles:
|
||||
- Framework Consistency - All creations follow established BMAD patterns
|
||||
- Framework Consistency - All creations follow established BMad patterns
|
||||
- Modular Design - Create reusable, composable components
|
||||
- Clear Documentation - Every creation includes proper documentation
|
||||
- Convention Over Configuration - Follow BMAD naming and structure patterns
|
||||
- Convention Over Configuration - Follow BMad naming and structure patterns
|
||||
- Extensibility First - Design for future expansion and customization
|
||||
- Numbered Options Protocol - Always use numbered lists for user selections
|
||||
startup:
|
||||
- Greet the user with your name and role, and inform of the *help command
|
||||
- CRITICAL: Do NOT automatically create documents or execute tasks during startup
|
||||
- CRITICAL: Do NOT create or modify any files during startup
|
||||
- Offer to help with BMAD framework extensions but wait for explicit user confirmation
|
||||
- Offer to help with BMad framework extensions but wait for explicit user confirmation
|
||||
- Only execute tasks when user explicitly requests them
|
||||
commands:
|
||||
- '*help" - Show numbered list of available commands for selection'
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
name: bmad-creator-tools
|
||||
version: 1.2.0
|
||||
short-title: Tools for creating BMAD framework components
|
||||
description: Tools for creating and extending BMAD framework components.
|
||||
short-title: Tools for creating BMad framework components
|
||||
description: Tools for creating and extending BMad framework components.
|
||||
author: Brian (BMad)
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
# Create Agent Task
|
||||
|
||||
This task guides you through creating a new BMAD agent following the standard template.
|
||||
This task guides you through creating a new BMad agent following the standard template.
|
||||
|
||||
## Prerequisites
|
||||
|
||||
|
||||
@@ -1,10 +1,10 @@
|
||||
# Create Expansion Pack Task
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Understanding Expansion Packs
|
||||
|
||||
Expansion packs extend BMAD with domain-specific capabilities using sophisticated AI agent orchestration patterns. They are self-contained packages that leverage:
|
||||
Expansion packs extend BMad with domain-specific capabilities using sophisticated AI agent orchestration patterns. They are self-contained packages that leverage:
|
||||
|
||||
- **Advanced Agent Architecture**: YAML-in-Markdown with embedded personas and character consistency
|
||||
- **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
|
||||
- **Quality Assurance**: Multi-level validation with star ratings and comprehensive checklists
|
||||
- **Knowledge Integration**: Domain-specific data organization and best practices embedding
|
||||
|
||||
Every expansion pack MUST include a custom BMAD orchestrator agent with sophisticated command systems and numbered options protocols.
|
||||
Every expansion pack MUST include a custom BMad orchestrator agent with sophisticated command systems and numbered options protocols.
|
||||
|
||||
## CRITICAL REQUIREMENTS
|
||||
|
||||
@@ -83,7 +83,7 @@ Create `expansion-packs/{pack-name}/plan.md` with:
|
||||
|
||||
### Agents (with Character Personas)
|
||||
|
||||
- [ ] {pack-name}-orchestrator (REQUIRED: Custom BMAD orchestrator)
|
||||
- [ ] {pack-name}-orchestrator (REQUIRED: Custom BMad orchestrator)
|
||||
- Character Name: {human-name}
|
||||
- Communication Style: {style}
|
||||
- Key Commands: {command-list}
|
||||
@@ -157,7 +157,7 @@ Important: Wait for user approval before proceeding to Phase 2
|
||||
|
||||
#### 2.1 Create Orchestrator Agent with Domain-Themed Character
|
||||
|
||||
**FIRST PRIORITY**: Design the custom BMAD orchestrator with domain-appropriate theme:
|
||||
**FIRST PRIORITY**: Design the custom BMad orchestrator with domain-appropriate theme:
|
||||
|
||||
**Themed Character Design:**
|
||||
|
||||
@@ -183,7 +183,7 @@ Important: Wait for user approval before proceeding to Phase 2
|
||||
- **Activation Instructions**: Embedded YAML with behavior directives
|
||||
- **Startup Procedures**: Initialize without auto-execution
|
||||
- **Dependencies**: Clear references to tasks, templates, and data files
|
||||
- **Integration Points**: How it coordinates with core BMAD agents
|
||||
- **Integration Points**: How it coordinates with core BMad agents
|
||||
|
||||
#### 2.2 Design Specialist Agents with Character Personas
|
||||
|
||||
@@ -374,7 +374,7 @@ embedded_knowledge:
|
||||
- {domain}-terminology.md
|
||||
- {domain}-standards.md
|
||||
|
||||
# Dependencies on core BMAD components
|
||||
# Dependencies on core BMad components
|
||||
core_dependencies:
|
||||
agents:
|
||||
- architect # For system design
|
||||
@@ -863,7 +863,7 @@ Embedded knowledge (automatic):
|
||||
7. "Where in the workflow should users choose between different paths?"
|
||||
8. "How should the orchestrator hand off to specialist agents?"
|
||||
9. "What quality gates should be built into the workflow?"
|
||||
10. "How should it integrate with core BMAD agents?"
|
||||
10. "How should it integrate with core BMad agents?"
|
||||
|
||||
### Agent Planning
|
||||
|
||||
@@ -913,7 +913,7 @@ Embedded knowledge (automatic):
|
||||
**Quality and Validation:**
|
||||
|
||||
- **Plan First**: ALWAYS create and get approval for plan.md before implementing
|
||||
- **Orchestrator Required**: Every pack MUST have a custom BMAD orchestrator with sophisticated command system
|
||||
- **Orchestrator Required**: Every pack MUST have a custom BMad orchestrator with sophisticated command system
|
||||
- **Verify References**: ALL referenced tasks/templates MUST exist and be tested
|
||||
- **Multi-Level Validation**: Quality systems must provide basic, comprehensive, and expert-level assessment
|
||||
- **Domain Expertise**: Ensure accuracy in specialized fields with embedded best practices
|
||||
|
||||
@@ -70,7 +70,7 @@ Users must add these files to `bmad-core/data/`:
|
||||
|
||||
## Integration Points
|
||||
|
||||
- Depends on core agents: {list any core BMAD agents used}
|
||||
- Depends on core agents: {list any core BMad agents used}
|
||||
- Extends teams: {which teams to update}
|
||||
|
||||
## Success Criteria
|
||||
|
||||
@@ -2,11 +2,11 @@
|
||||
|
||||
## Overview
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Purpose
|
||||
|
||||
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:
|
||||
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:
|
||||
|
||||
- Infrastructure architecture design capabilities
|
||||
- Platform engineering implementation workflows
|
||||
@@ -52,9 +52,9 @@ Install this expansion pack when your project requires:
|
||||
|
||||
- `infrastructure-checklist.md` - Comprehensive 16-section infrastructure validation checklist
|
||||
|
||||
## Integration with Core BMAD
|
||||
## Integration with Core BMad
|
||||
|
||||
This expansion pack integrates with the core BMAD flow at these points:
|
||||
This expansion pack integrates with the core BMad flow at these points:
|
||||
|
||||
1. **After Architecture Phase**: The Architect can trigger infrastructure architecture design
|
||||
2. **Parallel to Development**: Infrastructure implementation can proceed alongside application development
|
||||
@@ -123,7 +123,7 @@ The DevOps agent can be added to team configurations:
|
||||
|
||||
This expansion pack works best when used with:
|
||||
|
||||
- Core BMAD agents (especially Architect)
|
||||
- Core BMad agents (especially Architect)
|
||||
- Technical preferences documentation
|
||||
- Approved PRD and system architecture
|
||||
|
||||
@@ -144,4 +144,4 @@ You can customize this expansion pack by:
|
||||
---
|
||||
|
||||
_Version: 1.0_
|
||||
_Compatible with: BMAD Method v4_
|
||||
_Compatible with: BMad Method v4_
|
||||
|
||||
@@ -270,7 +270,7 @@ This checklist serves as a comprehensive framework for validating infrastructure
|
||||
- [ ] Business stakeholders informed of changes
|
||||
- [ ] Feedback loops established for continuous improvement
|
||||
|
||||
## 11. BMAD WORKFLOW INTEGRATION
|
||||
## 11. BMad WORKFLOW INTEGRATION
|
||||
|
||||
### 11.1 Development Agent Alignment
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@ name: bmad-infrastructure-devops
|
||||
version: 1.2.0
|
||||
short-title: Infrastructure and DevOps capabilities
|
||||
description: >-
|
||||
This expansion pack extends BMAD Method with comprehensive infrastructure and
|
||||
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.
|
||||
author: Brian (BMad)
|
||||
|
||||
@@ -55,13 +55,13 @@ To conduct a thorough review of existing infrastructure to identify improvement
|
||||
- Create an improvement roadmap with suggested timelines
|
||||
- Highlight cost optimization opportunities
|
||||
|
||||
### 5. BMAD Integration Assessment
|
||||
### 5. BMad Integration Assessment
|
||||
|
||||
- Evaluate how current infrastructure supports other BMAD agents:
|
||||
- Evaluate how current infrastructure supports other BMad agents:
|
||||
- **Development Support:** Assess how infrastructure enables Frontend Dev (Mira), Backend Dev (Enrique), and Full Stack Dev workflows
|
||||
- **Product Alignment:** Verify infrastructure supports PRD requirements from Product Owner (Oli)
|
||||
- **Architecture Compliance:** Check if implementation follows Architect (Alphonse) decisions
|
||||
- Document any gaps in BMAD integration
|
||||
- Document any gaps in BMad integration
|
||||
|
||||
### 6. Architectural Escalation Assessment
|
||||
|
||||
@@ -133,7 +133,7 @@ A comprehensive infrastructure review report that includes:
|
||||
2. **Prioritized findings** with severity ratings
|
||||
3. **Detailed recommendations** with effort/impact estimates
|
||||
4. **Cost optimization opportunities**
|
||||
5. **BMAD integration assessment**
|
||||
5. **BMad integration assessment**
|
||||
6. **Architectural escalation assessment** with clear escalation recommendations
|
||||
7. **Action plan** for critical improvements and architectural work
|
||||
8. **Escalation documentation** for Architect Agent collaboration (if applicable)
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
|
||||
## Purpose
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Inputs
|
||||
|
||||
@@ -82,9 +82,9 @@ To comprehensively validate platform infrastructure changes against security, re
|
||||
- Provide validation signoff recommendation based on complete platform assessment
|
||||
- Document platform component integration validation results
|
||||
|
||||
### 6. BMAD Integration Assessment
|
||||
### 6. BMad Integration Assessment
|
||||
|
||||
- Review how platform infrastructure changes support other BMAD agents:
|
||||
- Review how platform infrastructure changes support other BMad agents:
|
||||
- **Development Agent Alignment:** Verify platform infrastructure supports Frontend Dev, Backend Dev, and Full Stack Dev requirements including:
|
||||
- Container platform development environment provisioning
|
||||
- GitOps workflows for application deployment
|
||||
@@ -128,7 +128,7 @@ A comprehensive platform validation report documenting:
|
||||
3. **Detailed findings for each non-compliant item** across foundation and platform components
|
||||
4. **Platform integration validation results** documenting component interoperability
|
||||
5. **Remediation recommendations with priority levels** based on platform impact
|
||||
6. **BMAD integration assessment results** for complete platform stack
|
||||
6. **BMad integration assessment results** for complete platform stack
|
||||
7. **Clear signoff recommendation** for platform deployment readiness or architectural revision requirements
|
||||
8. **Next steps for implementation or remediation** prioritized by platform dependencies
|
||||
|
||||
|
||||
@@ -264,9 +264,9 @@ Create pipeline diagram showing:
|
||||
- Cost Monitoring & Reporting
|
||||
- Optimization Recommendations
|
||||
|
||||
## BMAD Integration Architecture
|
||||
## BMad Integration Architecture
|
||||
|
||||
[[LLM: Design infrastructure to specifically support other BMAD agents and their workflows. This ensures the infrastructure enables the entire BMAD methodology.]]
|
||||
[[LLM: Design infrastructure to specifically support other BMad agents and their workflows. This ensures the infrastructure enables the entire BMad methodology.]]
|
||||
|
||||
### Development Agent Support
|
||||
|
||||
|
||||
4
package-lock.json
generated
4
package-lock.json
generated
@@ -1,12 +1,12 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.24.2",
|
||||
"version": "4.24.4",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "bmad-method",
|
||||
"version": "4.24.2",
|
||||
"version": "4.24.4",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"@kayvan/markdown-tree-parser": "^1.5.0",
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.24.2",
|
||||
"version": "4.24.4",
|
||||
"description": "Breakthrough Method of Agile AI-driven Development",
|
||||
"main": "tools/cli.js",
|
||||
"bin": {
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
/**
|
||||
* BMAD Method CLI - Direct execution wrapper for npx
|
||||
* BMad Method CLI - Direct execution wrapper for npx
|
||||
* This file ensures proper execution when run via npx from GitHub
|
||||
*/
|
||||
|
||||
|
||||
@@ -470,7 +470,7 @@ class WebBuilder {
|
||||
}
|
||||
}
|
||||
} else {
|
||||
// Use core BMAD version
|
||||
// Use core BMad version
|
||||
try {
|
||||
const coreAgentPath = path.join(this.rootDir, "bmad-core", "agents", `${agentId}.md`);
|
||||
const coreAgentContent = await fs.readFile(coreAgentPath, "utf8");
|
||||
|
||||
@@ -10,7 +10,7 @@ const program = new Command();
|
||||
|
||||
program
|
||||
.name('bmad-build')
|
||||
.description('BMAD-METHOD build tool for creating web bundles')
|
||||
.description('BMad-Method build tool for creating web bundles')
|
||||
.version('4.0.0');
|
||||
|
||||
program
|
||||
@@ -136,7 +136,7 @@ program
|
||||
|
||||
program
|
||||
.command('upgrade')
|
||||
.description('Upgrade a BMAD-METHOD V3 project to V4')
|
||||
.description('Upgrade a BMad-Method V3 project to V4')
|
||||
.option('-p, --project <path>', 'Path to V3 project (defaults to current directory)')
|
||||
.option('--dry-run', 'Show what would be changed without making changes')
|
||||
.option('--no-backup', 'Skip creating backup (not recommended)')
|
||||
|
||||
@@ -1,58 +1,8 @@
|
||||
# BMAD Method Installer
|
||||
|
||||
This directory contains the BMAD Method installer implementation.
|
||||
|
||||
## Structure
|
||||
|
||||
```text
|
||||
installer/
|
||||
├── bin/ # CLI entry points
|
||||
│ └── bmad.js # Main CLI executable
|
||||
├── lib/ # Core implementation
|
||||
│ ├── installer.js # Main installation logic
|
||||
│ ├── updater.js # Update management
|
||||
│ ├── config-loader.js # YAML config parsing
|
||||
│ ├── file-manager.js # File operations
|
||||
│ ├── ide-setup.js # IDE-specific setup
|
||||
│ └── prompts.js # Interactive CLI prompts
|
||||
├── config/ # Configuration files
|
||||
│ └── install.config.yaml # Installation profiles
|
||||
├── templates/ # IDE template files
|
||||
│ ├── cursor-rules.md # Cursor template
|
||||
│ ├── claude-commands.md # Claude Code template
|
||||
│ └── windsurf-rules.md # Windsurf template
|
||||
└── package.json # NPM package configuration
|
||||
```
|
||||
|
||||
## Installation Profiles
|
||||
|
||||
- **minimal**: IDE agents only (best for beginners)
|
||||
- **core**: IDE + Web agents
|
||||
- **teams**: Full team workflows
|
||||
- **developer**: Everything including creation tools
|
||||
# BMad Method Installer
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
# Interactive installation
|
||||
npx bmad-method install
|
||||
|
||||
# Direct profile installation
|
||||
npx bmad-method install --profile=minimal
|
||||
|
||||
# Update existing installation
|
||||
npx bmad-method update
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
# Install dependencies
|
||||
npm install
|
||||
|
||||
# Run tests
|
||||
npm test
|
||||
|
||||
# Lint code
|
||||
npm run lint
|
||||
```
|
||||
|
||||
@@ -42,15 +42,15 @@ try {
|
||||
|
||||
program
|
||||
.version(version)
|
||||
.description('BMAD Method installer - Universal AI agent framework for any domain');
|
||||
.description('BMad Method installer - Universal AI agent framework for any domain');
|
||||
|
||||
program
|
||||
.command('install')
|
||||
.description('Install BMAD Method agents and tools')
|
||||
.option('-f, --full', 'Install complete BMAD Method')
|
||||
.description('Install BMad Method agents and tools')
|
||||
.option('-f, --full', 'Install complete BMad Method')
|
||||
.option('-x, --expansion-only', 'Install only expansion packs (no bmad-core)')
|
||||
.option('-d, --directory <path>', 'Installation directory')
|
||||
.option('-i, --ide <ide...>', 'Configure for specific IDE(s) - can specify multiple (cursor, claude-code, windsurf, roo, cline, gemini, vs-code-copilot, other)')
|
||||
.option('-i, --ide <ide...>', 'Configure for specific IDE(s) - can specify multiple (cursor, claude-code, windsurf, roo, cline, gemini, github-copilot, other)')
|
||||
.option('-e, --expansion-packs <packs...>', 'Install specific expansion packs (can specify multiple)')
|
||||
.action(async (options) => {
|
||||
try {
|
||||
@@ -83,7 +83,7 @@ program
|
||||
|
||||
program
|
||||
.command('update')
|
||||
.description('Update existing BMAD installation')
|
||||
.description('Update existing BMad installation')
|
||||
.option('--force', 'Force update, overwriting modified files')
|
||||
.option('--dry-run', 'Show what would be updated without making changes')
|
||||
.action(async () => {
|
||||
@@ -124,7 +124,7 @@ program
|
||||
|
||||
async function promptInstallation() {
|
||||
await initializeModules();
|
||||
console.log(chalk.bold.blue(`\nWelcome to BMAD Method Installer v${version}\n`));
|
||||
console.log(chalk.bold.blue(`\nWelcome to BMad Method Installer v${version}\n`));
|
||||
|
||||
const answers = {};
|
||||
|
||||
@@ -133,7 +133,7 @@ async function promptInstallation() {
|
||||
{
|
||||
type: 'input',
|
||||
name: 'directory',
|
||||
message: 'Enter the full path to your project directory where BMAD should be installed:',
|
||||
message: 'Enter the full path to your project directory where BMad should be installed:',
|
||||
validate: (input) => {
|
||||
if (!input.trim()) {
|
||||
return 'Please enter a valid project path';
|
||||
@@ -162,7 +162,7 @@ async function promptInstallation() {
|
||||
const coreConfig = yaml.load(await fs.readFile(coreConfigPath, 'utf8'));
|
||||
const coreShortTitle = coreConfig['short-title'] || 'BMad Agile Core System';
|
||||
|
||||
// Add BMAD core option
|
||||
// Add BMad core option
|
||||
let bmadOptionText;
|
||||
if (state.type === 'v4_existing') {
|
||||
const currentVersion = state.manifest?.version || 'unknown';
|
||||
@@ -237,7 +237,7 @@ async function promptInstallation() {
|
||||
{ name: 'Roo Code', value: 'roo' },
|
||||
{ name: 'Cline', value: 'cline' },
|
||||
{ name: 'Gemini CLI', value: 'gemini' },
|
||||
{ name: 'VS Code Copilot', value: 'vs-code-copilot' }
|
||||
{ name: 'Github Copilot', value: 'github-copilot' }
|
||||
]
|
||||
}
|
||||
]);
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
installation-options:
|
||||
full:
|
||||
name: Complete BMAD Core
|
||||
name: Complete BMad Core
|
||||
description: Copy the entire .bmad-core folder with all agents, templates, and tools
|
||||
action: copy-folder
|
||||
source: bmad-core
|
||||
@@ -15,7 +15,7 @@ ide-configurations:
|
||||
format: multi-file
|
||||
command-suffix: .mdc
|
||||
instructions: |
|
||||
# To use BMAD agents in Cursor:
|
||||
# To use BMad agents in Cursor:
|
||||
# 1. Press Ctrl+L (Cmd+L on Mac) to open the chat
|
||||
# 2. Type @agent-name (e.g., "@dev", "@pm", "@architect")
|
||||
# 3. The agent will adopt that persona for the conversation
|
||||
@@ -25,7 +25,7 @@ ide-configurations:
|
||||
format: multi-file
|
||||
command-suffix: .md
|
||||
instructions: |
|
||||
# To use BMAD agents in Claude Code:
|
||||
# To use BMad agents in Claude Code:
|
||||
# 1. Type /agent-name (e.g., "/dev", "/pm", "/architect")
|
||||
# 2. Claude will switch to that agent's persona
|
||||
windsurf:
|
||||
@@ -34,7 +34,7 @@ ide-configurations:
|
||||
format: multi-file
|
||||
command-suffix: .md
|
||||
instructions: |
|
||||
# To use BMAD agents in Windsurf:
|
||||
# To use BMad agents in Windsurf:
|
||||
# 1. Type @agent-name (e.g., "@dev", "@pm")
|
||||
# 2. Windsurf will adopt that agent's persona
|
||||
roo:
|
||||
@@ -42,7 +42,7 @@ ide-configurations:
|
||||
format: custom-modes
|
||||
file: .roomodes
|
||||
instructions: |
|
||||
# To use BMAD agents in Roo Code:
|
||||
# To use BMad agents in Roo Code:
|
||||
# 1. Open the mode selector (usually in the status bar)
|
||||
# 2. Select any bmad-{agent} mode (e.g., "bmad-dev", "bmad-pm")
|
||||
# 3. The AI will adopt that agent's full personality and capabilities
|
||||
@@ -52,7 +52,7 @@ ide-configurations:
|
||||
format: multi-file
|
||||
command-suffix: .md
|
||||
instructions: |
|
||||
# To use BMAD agents in Cline:
|
||||
# To use BMad agents in Cline:
|
||||
# 1. Open the Cline chat panel in VS Code
|
||||
# 2. Type @agent-name (e.g., "@dev", "@pm", "@architect")
|
||||
# 3. The agent will adopt that persona for the conversation
|
||||
@@ -62,18 +62,18 @@ ide-configurations:
|
||||
rule-dir: .gemini/agents/
|
||||
format: context-files
|
||||
instructions: |
|
||||
# To use BMAD agents with the Gemini CLI:
|
||||
# To use BMad agents with the Gemini CLI:
|
||||
# 1. The installer creates a .gemini/ directory in your project.
|
||||
# 2. It also configures .gemini/settings.json to load all agent files.
|
||||
# 3. Simply mention the agent in your prompt (e.g., "As @dev, ...").
|
||||
# 4. The Gemini CLI will automatically have the context for that agent.
|
||||
vs-code-copilot:
|
||||
name: VS Code Copilot
|
||||
github-copilot:
|
||||
name: Github Copilot
|
||||
rule-dir: .github/chatmodes/
|
||||
format: multi-file
|
||||
command-suffix: .md
|
||||
instructions: |
|
||||
# To use BMAD agents with VS Code Copilot:
|
||||
# To use BMad agents with Github Copilot:
|
||||
# 1. The installer creates a .github/chatmodes/ directory in your project
|
||||
# 2. Open the Chat view (`⌃⌘I` on Mac, `Ctrl+Alt+I` on Windows/Linux) and select **Agent** from the chat mode selector.
|
||||
# 3. The agent will adopt that persona for the conversation
|
||||
|
||||
@@ -93,7 +93,7 @@ class ConfigLoader {
|
||||
description: config['short-title'] || config.description || 'No description available',
|
||||
fullDescription: config.description || config['short-title'] || 'No description available',
|
||||
version: config.version || '1.0.0',
|
||||
author: config.author || 'BMAD Team',
|
||||
author: config.author || 'BMad Team',
|
||||
packPath: packPath,
|
||||
dependencies: config.dependencies?.agents || []
|
||||
});
|
||||
@@ -113,7 +113,7 @@ class ConfigLoader {
|
||||
description: 'No description available',
|
||||
fullDescription: 'No description available',
|
||||
version: '1.0.0',
|
||||
author: 'BMAD Team',
|
||||
author: 'BMad Team',
|
||||
packPath: packPath,
|
||||
dependencies: []
|
||||
});
|
||||
|
||||
@@ -63,7 +63,7 @@ class IdeSetup {
|
||||
return this.setupCline(installDir, selectedAgent);
|
||||
case "gemini":
|
||||
return this.setupGeminiCli(installDir, selectedAgent);
|
||||
case "vs-code-copilot":
|
||||
case "github-copilot":
|
||||
return this.setupVsCodeCopilot(installDir, selectedAgent, spinner);
|
||||
default:
|
||||
console.log(chalk.yellow(`\nIDE ${ide} not yet supported`));
|
||||
@@ -559,8 +559,8 @@ tools: ['changes', 'codebase', 'fetch', 'findTestFiles', 'githubRepo', 'problems
|
||||
}
|
||||
}
|
||||
|
||||
console.log(chalk.green(`\n✓ VS Code Copilot setup complete!`));
|
||||
console.log(chalk.dim(`You can now find the BMAD agents in the Chat view's mode selector.`));
|
||||
console.log(chalk.green(`\n✓ Github Copilot setup complete!`));
|
||||
console.log(chalk.dim(`You can now find the BMad agents in the Chat view's mode selector.`));
|
||||
|
||||
return true;
|
||||
}
|
||||
@@ -578,7 +578,7 @@ tools: ['changes', 'codebase', 'fetch', 'findTestFiles', 'githubRepo', 'problems
|
||||
try {
|
||||
const existingContent = await fileManager.readFile(settingsPath);
|
||||
existingSettings = JSON.parse(existingContent);
|
||||
console.log(chalk.yellow("Found existing .vscode/settings.json. Merging BMAD settings..."));
|
||||
console.log(chalk.yellow("Found existing .vscode/settings.json. Merging BMad settings..."));
|
||||
} catch (error) {
|
||||
console.warn(chalk.yellow("Could not parse existing settings.json. Creating new one."));
|
||||
existingSettings = {};
|
||||
@@ -587,15 +587,15 @@ tools: ['changes', 'codebase', 'fetch', 'findTestFiles', 'githubRepo', 'problems
|
||||
|
||||
// Clear any previous output and add spacing to avoid conflicts with loaders
|
||||
console.log('\n'.repeat(2));
|
||||
console.log(chalk.blue("🔧 VS Code Copilot Agent Settings Configuration"));
|
||||
console.log(chalk.dim("BMAD works best with specific VS Code settings for optimal agent experience."));
|
||||
console.log(chalk.blue("🔧 Github Copilot Agent Settings Configuration"));
|
||||
console.log(chalk.dim("BMad works best with specific VS Code settings for optimal agent experience."));
|
||||
console.log(''); // Add extra spacing
|
||||
|
||||
const { configChoice } = await inquirer.prompt([
|
||||
{
|
||||
type: 'list',
|
||||
name: 'configChoice',
|
||||
message: 'How would you like to configure VS Code Copilot settings?',
|
||||
message: 'How would you like to configure Github Copilot settings?',
|
||||
choices: [
|
||||
{
|
||||
name: 'Use recommended defaults (fastest setup)',
|
||||
@@ -638,7 +638,7 @@ tools: ['changes', 'codebase', 'fetch', 'findTestFiles', 'githubRepo', 'problems
|
||||
"github.copilot.chat.agent.autoFix": true,
|
||||
"chat.tools.autoApprove": false
|
||||
};
|
||||
console.log(chalk.green("✓ Using recommended BMAD defaults for VS Code Copilot settings"));
|
||||
console.log(chalk.green("✓ Using recommended BMad defaults for Github Copilot settings"));
|
||||
} else {
|
||||
// Manual configuration
|
||||
console.log(chalk.blue("\n📋 Let's configure each setting for your preferences:"));
|
||||
@@ -696,7 +696,7 @@ tools: ['changes', 'codebase', 'fetch', 'findTestFiles', 'githubRepo', 'problems
|
||||
}
|
||||
|
||||
bmadSettings = {
|
||||
"chat.agent.enabled": true, // Always enabled - required for BMAD agents
|
||||
"chat.agent.enabled": true, // Always enabled - required for BMad agents
|
||||
"chat.agent.maxRequests": parseInt(manualSettings.maxRequests),
|
||||
"github.copilot.chat.agent.runTasks": manualSettings.runTasks,
|
||||
"chat.mcp.discovery.enabled": manualSettings.mcpDiscovery,
|
||||
|
||||
@@ -220,7 +220,7 @@ class Installer {
|
||||
});
|
||||
|
||||
if (files.length > 0) {
|
||||
// Directory has other files, but no BMAD installation.
|
||||
// Directory has other files, but no BMad installation.
|
||||
// Treat as clean install but record that it isn't empty.
|
||||
state.hasOtherFiles = true;
|
||||
}
|
||||
@@ -235,7 +235,7 @@ class Installer {
|
||||
async performFreshInstall(config, installDir, spinner, options = {}) {
|
||||
// Ensure modules are initialized
|
||||
await initializeModules();
|
||||
spinner.text = "Installing BMAD Method...";
|
||||
spinner.text = "Installing BMad Method...";
|
||||
|
||||
let files = [];
|
||||
|
||||
@@ -396,7 +396,7 @@ class Installer {
|
||||
const newVersion = await this.getCoreVersion();
|
||||
const versionCompare = this.compareVersions(currentVersion, newVersion);
|
||||
|
||||
console.log(chalk.yellow("\n🔍 Found existing BMAD v4 installation"));
|
||||
console.log(chalk.yellow("\n🔍 Found existing BMad v4 installation"));
|
||||
console.log(` Directory: ${installDir}`);
|
||||
console.log(` Current version: ${currentVersion}`);
|
||||
console.log(` Available version: ${newVersion}`);
|
||||
@@ -446,8 +446,8 @@ class Installer {
|
||||
let choices = [];
|
||||
|
||||
if (versionCompare < 0) {
|
||||
console.log(chalk.cyan("\n⬆️ Upgrade available for BMAD core"));
|
||||
choices.push({ name: `Upgrade BMAD core (v${currentVersion} → v${newVersion})`, value: "upgrade" });
|
||||
console.log(chalk.cyan("\n⬆️ Upgrade available for BMad core"));
|
||||
choices.push({ name: `Upgrade BMad core (v${currentVersion} → v${newVersion})`, value: "upgrade" });
|
||||
} else if (versionCompare === 0) {
|
||||
if (hasIntegrityIssues) {
|
||||
// Offer repair option when files are missing or modified
|
||||
@@ -457,10 +457,10 @@ class Installer {
|
||||
});
|
||||
}
|
||||
console.log(chalk.yellow("\n⚠️ Same version already installed"));
|
||||
choices.push({ name: `Force reinstall BMAD core (v${currentVersion} - reinstall)`, value: "reinstall" });
|
||||
choices.push({ name: `Force reinstall BMad core (v${currentVersion} - reinstall)`, value: "reinstall" });
|
||||
} else {
|
||||
console.log(chalk.yellow("\n⬇️ Installed version is newer than available"));
|
||||
choices.push({ name: `Downgrade BMAD core (v${currentVersion} → v${newVersion})`, value: "reinstall" });
|
||||
choices.push({ name: `Downgrade BMad core (v${currentVersion} → v${newVersion})`, value: "reinstall" });
|
||||
}
|
||||
|
||||
choices.push(
|
||||
@@ -535,7 +535,7 @@ class Installer {
|
||||
spinner.stop();
|
||||
|
||||
console.log(
|
||||
chalk.yellow("\n🔍 Found BMAD v3 installation (bmad-agent/ directory)")
|
||||
chalk.yellow("\n🔍 Found BMad v3 installation (bmad-agent/ directory)")
|
||||
);
|
||||
console.log(` Directory: ${installDir}`);
|
||||
|
||||
@@ -768,7 +768,7 @@ class Installer {
|
||||
}
|
||||
|
||||
async performReinstall(config, installDir, spinner) {
|
||||
spinner.start("Preparing to reinstall BMAD Method...");
|
||||
spinner.start("Preparing to reinstall BMad Method...");
|
||||
|
||||
// Remove existing .bmad-core
|
||||
const bmadCorePath = path.join(installDir, ".bmad-core");
|
||||
@@ -782,7 +782,7 @@ class Installer {
|
||||
}
|
||||
|
||||
showSuccessMessage(config, installDir, options = {}) {
|
||||
console.log(chalk.green("\n✓ BMAD Method installed successfully!\n"));
|
||||
console.log(chalk.green("\n✓ BMad Method installed successfully!\n"));
|
||||
|
||||
const ides = config.ides || (config.ide ? [config.ide] : []);
|
||||
if (ides.length > 0) {
|
||||
@@ -790,7 +790,7 @@ class Installer {
|
||||
const ideConfig = configLoader.getIdeConfiguration(ide);
|
||||
if (ideConfig?.instructions) {
|
||||
console.log(
|
||||
chalk.bold(`To use BMAD agents in ${ideConfig.name}:`)
|
||||
chalk.bold(`To use BMad agents in ${ideConfig.name}:`)
|
||||
);
|
||||
console.log(ideConfig.instructions);
|
||||
}
|
||||
@@ -879,7 +879,7 @@ class Installer {
|
||||
};
|
||||
return await this.install(config);
|
||||
}
|
||||
console.log(chalk.red("No BMAD installation found."));
|
||||
console.log(chalk.red("No BMad installation found."));
|
||||
}
|
||||
|
||||
async listAgents() {
|
||||
@@ -887,7 +887,7 @@ class Installer {
|
||||
await initializeModules();
|
||||
const agents = await configLoader.getAvailableAgents();
|
||||
|
||||
console.log(chalk.bold("\nAvailable BMAD Agents:\n"));
|
||||
console.log(chalk.bold("\nAvailable BMad Agents:\n"));
|
||||
|
||||
for (const agent of agents) {
|
||||
console.log(chalk.cyan(` ${agent.id.padEnd(20)}`), agent.description);
|
||||
@@ -903,7 +903,7 @@ class Installer {
|
||||
await initializeModules();
|
||||
const expansionPacks = await this.getAvailableExpansionPacks();
|
||||
|
||||
console.log(chalk.bold("\nAvailable BMAD Expansion Packs:\n"));
|
||||
console.log(chalk.bold("\nAvailable BMad Expansion Packs:\n"));
|
||||
|
||||
if (expansionPacks.length === 0) {
|
||||
console.log(chalk.yellow("No expansion packs found."));
|
||||
@@ -932,7 +932,7 @@ class Installer {
|
||||
|
||||
if (!installDir) {
|
||||
console.log(
|
||||
chalk.yellow("No BMAD installation found in current directory tree")
|
||||
chalk.yellow("No BMad installation found in current directory tree")
|
||||
);
|
||||
return;
|
||||
}
|
||||
@@ -944,7 +944,7 @@ class Installer {
|
||||
return;
|
||||
}
|
||||
|
||||
console.log(chalk.bold("\nBMAD Installation Status:\n"));
|
||||
console.log(chalk.bold("\nBMad Installation Status:\n"));
|
||||
console.log(` Directory: ${installDir}`);
|
||||
console.log(` Version: ${manifest.version}`);
|
||||
console.log(
|
||||
@@ -1210,7 +1210,7 @@ class Installer {
|
||||
|
||||
async resolveExpansionPackCoreDependencies(installDir, expansionDotFolder, packId, spinner) {
|
||||
const glob = require('glob');
|
||||
const yaml = require('yaml');
|
||||
const yaml = require('js-yaml');
|
||||
const fs = require('fs').promises;
|
||||
|
||||
// Find all agent files in the expansion pack
|
||||
@@ -1265,7 +1265,7 @@ class Installer {
|
||||
|
||||
async resolveExpansionPackCoreAgents(installDir, expansionDotFolder, packId, spinner) {
|
||||
const glob = require('glob');
|
||||
const yaml = require('yaml');
|
||||
const yaml = require('js-yaml');
|
||||
const fs = require('fs').promises;
|
||||
|
||||
// Find all team files in the expansion pack
|
||||
@@ -1399,7 +1399,7 @@ class Installer {
|
||||
await initializeModules();
|
||||
|
||||
try {
|
||||
// Find the dist directory in the BMAD installation
|
||||
// Find the dist directory in the BMad installation
|
||||
const distDir = configLoader.getDistPath();
|
||||
|
||||
if (!(await fileManager.pathExists(distDir))) {
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "bmad-method",
|
||||
"version": "4.24.2",
|
||||
"description": "BMAD Method installer - AI-powered Agile development framework",
|
||||
"version": "4.24.4",
|
||||
"description": "BMad Method installer - AI-powered Agile development framework",
|
||||
"main": "lib/installer.js",
|
||||
"bin": {
|
||||
"bmad": "./bin/bmad.js",
|
||||
@@ -19,7 +19,7 @@
|
||||
"installer",
|
||||
"agents"
|
||||
],
|
||||
"author": "BMAD Team",
|
||||
"author": "BMad Team",
|
||||
"license": "MIT",
|
||||
"dependencies": {
|
||||
"chalk": "^5.4.1",
|
||||
|
||||
@@ -1,7 +0,0 @@
|
||||
# {{AGENT_NAME}} Agent
|
||||
|
||||
{{AGENT_CONTENT}}
|
||||
|
||||
---
|
||||
|
||||
This is a BMAD Method agent. For more information, visit: https://github.com/your-org/bmad-method
|
||||
@@ -1,22 +0,0 @@
|
||||
# BMAD Method Agents for Cursor
|
||||
|
||||
This file contains all BMAD Method agent personas. To use an agent, type its name or alias in the Cursor chat.
|
||||
|
||||
## Available Agents
|
||||
|
||||
{{AGENT_LIST}}
|
||||
|
||||
---
|
||||
|
||||
{{AGENT_RULES}}
|
||||
|
||||
---
|
||||
|
||||
# Agent Switching
|
||||
|
||||
To switch between agents during a conversation:
|
||||
|
||||
1. Simply type the new agent name (e.g., "architect" or "dev")
|
||||
2. The AI will adopt that agent's persona
|
||||
|
||||
For more information about BMAD Method, visit: https://github.com/your-org/bmad-method
|
||||
@@ -1,22 +0,0 @@
|
||||
# BMAD Method Agent Commands
|
||||
|
||||
This file contains all BMAD Method agent commands for Windsurf. Use /agent-name to switch personas.
|
||||
|
||||
## Available Commands
|
||||
|
||||
{{COMMAND_LIST}}
|
||||
|
||||
---
|
||||
|
||||
{{AGENT_SECTIONS}}
|
||||
|
||||
---
|
||||
|
||||
# Usage Tips
|
||||
|
||||
- Type `/dev` to switch to Developer persona
|
||||
- Type `/pm` to switch to Product Manager persona
|
||||
- Type `/architect` to switch to Architect persona
|
||||
- And so on for other agents...
|
||||
|
||||
For more information about BMAD Method, visit: https://github.com/your-org/bmad-method
|
||||
@@ -1,6 +1,6 @@
|
||||
# Web Agent Bundle Instructions
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
## Important Instructions
|
||||
|
||||
@@ -34,6 +34,6 @@ These references map directly to bundle sections:
|
||||
|
||||
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.
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
@@ -26,10 +26,10 @@ class V3ToV4Upgrader {
|
||||
|
||||
// 1. Welcome message
|
||||
console.log(
|
||||
chalk.bold("\nWelcome to BMAD-METHOD V3 to V4 Upgrade Tool\n")
|
||||
chalk.bold("\nWelcome to BMad-Method V3 to V4 Upgrade Tool\n")
|
||||
);
|
||||
console.log(
|
||||
"This tool will help you upgrade your BMAD-METHOD V3 project to V4.\n"
|
||||
"This tool will help you upgrade your BMad-Method V3 project to V4.\n"
|
||||
);
|
||||
console.log(chalk.cyan("What this tool does:"));
|
||||
console.log("- Creates a backup of your V3 files (.bmad-v3-backup/)");
|
||||
|
||||
@@ -15,7 +15,7 @@ async function initializeModules() {
|
||||
}
|
||||
|
||||
/**
|
||||
* Simple version bumping script for BMAD-METHOD
|
||||
* Simple version bumping script for BMad-Method
|
||||
* Usage: node tools/version-bump.js [patch|minor|major]
|
||||
*/
|
||||
|
||||
|
||||
@@ -16,7 +16,7 @@ async function initializeModules() {
|
||||
}
|
||||
|
||||
/**
|
||||
* YAML Formatter and Linter for BMAD-METHOD
|
||||
* YAML Formatter and Linter for BMad-Method
|
||||
* Formats and validates YAML files and YAML embedded in Markdown
|
||||
*/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user