36c21dbada
* feat: add custom GitHub Copilot installer handler Adds a dedicated GitHub Copilot handler that generates: - Agent files with .agent.md extension and enriched descriptions - Prompt files (.prompt.md) for workflows, tasks, and agent activators - copilot-instructions.md with project config and agent reference table Replaces the generic config-driven handler with a custom one that properly supports Copilot's agent/prompt file conventions. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: escape YAML descriptions and preserve user copilot-instructions - Escape single quotes in YAML frontmatter descriptions across all prompt generators (createWorkflowPromptContent, createTechWriterPromptContent, createAgentActivatorPromptContent) to match createAgentContent behavior - Make copilot-instructions.md non-destructive using BMAD markers (<!-- BMAD:START --> / <!-- BMAD:END -->) to preserve user content - On cleanup, only remove content between markers; skip files without markers - Back up existing unmarked files before overwriting Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: add error handling for CSV read/parse in loadAgentManifest and loadBmadHelp Wrap file read and csv.parse in try/catch blocks so malformed or unreadable CSV files gracefully degrade instead of aborting setup. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: use specific detection paths instead of .github configDir Set configDir to null and use detectionPaths with .github/copilot-instructions.md and .github/agents/ so the base detect() doesn't false-positive on every GitHub repo. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: add comments explaining hardcoded bmm/config.yaml in prompts Clarify that bmm/config.yaml is safe to hardcode in generated prompt content because these prompts are only created when bmm module data (bmad-help.csv, agent artifacts) exists. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: guard against missing workflow-file in bmad-help.csv entries Skip entries where workflow-file is empty/undefined to prevent workflowFile.endsWith() from throwing during prompt generation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: guard escapeYamlSingleQuote against undefined input Default to empty string when value is undefined/null to prevent replaceAll from throwing on missing CSV fields. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: preserve customised tool permissions across reinstalls Before this change, reinstalling would overwrite any user-customised tools arrays in agent and prompt frontmatter with the hardcoded default. Now the installer reads existing tool permissions from .agent.md and .prompt.md files before cleanup, and re-applies them to the regenerated files. Falls back to the default ['read', 'edit', 'search', 'execute'] for new files or files without prior customisation. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: prevent cleanup from stripping copilot-instructions.md markers before generation The cleanup() method was removing the BMAD marker section from copilot-instructions.md, leaving user content without markers. generateCopilotInstructions() then treated the markerless file as legacy, backed it up, and overwrote user content. Fix: remove the copilot-instructions.md block from cleanup() entirely. generateCopilotInstructions() already handles marker-based replacement in a single read-modify-write pass that correctly preserves user content. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * docs: update manager.js comments to include github-copilot.js Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * feat: make agent capabilities data-driven via agent YAML metadata Replace the hardcoded getAgentCapabilities() map with a data-driven pipeline. Capabilities are now defined in each .agent.yaml source file, compiled into the XML output, extracted into agent-manifest.csv by the manifest generator, and read by the GitHub Copilot handler at install time. New agents automatically get their capabilities without code changes. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * fix: use this.bmadFolderName instead of hardcoded _bmad in template paths Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com> |
||
|---|---|---|
| .augment | ||
| .claude/skills | ||
| .github | ||
| .husky | ||
| .vscode | ||
| docs | ||
| src | ||
| test | ||
| tools | ||
| website | ||
| .coderabbit.yaml | ||
| .gitignore | ||
| .markdownlint-cli2.yaml | ||
| .npmrc | ||
| .nvmrc | ||
| .prettierignore | ||
| CHANGELOG.md | ||
| CNAME | ||
| CONTRIBUTING.md | ||
| CONTRIBUTORS.md | ||
| LICENSE | ||
| README.md | ||
| SECURITY.md | ||
| TRADEMARK.md | ||
| Wordmark.png | ||
| banner-bmad-method.png | ||
| eslint.config.mjs | ||
| package-lock.json | ||
| package.json | ||
| prettier.config.mjs | ||
README.md
Breakthrough Method of Agile AI Driven Development — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.
100% free and open source. No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.
Why BMad?
Traditional AI tools do the thinking for you, producing average results. BMad agents and facilitated workflow act as expert collaborators who guide you through a structured process to bring out your best thinking in partnership with the AI.
- AI Intelligent Help: Brand new for beta - AI assisted help will guide you from the beginning to the end - just ask for
/bmad-helpafter you have installed BMad to your project - Scale-Domain-Adaptive: Automatically adjusts planning depth and needs based on project complexity, domain and type - a SaaS Mobile Dating App has different planning needs from a diagnostic medical system, BMad adapts and helps you along the way
- Structured Workflows: Grounded in agile best practices across analysis, planning, architecture, and implementation
- Specialized Agents: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
- Party Mode: Bring multiple agent personas into one session to plan, troubleshoot, or discuss your project collaboratively, multiple perspectives with maximum fun
- Complete Lifecycle: From brainstorming to deployment, BMad is there with you every step of the way
Quick Start
Prerequisites: Node.js v20+
npx bmad-method install
Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder.
Non-Interactive Installation: For CI/CD pipelines or automated deployments, use command-line flags:
npx bmad-method install --directory /path/to/project --modules bmm --tools claude-code --yes
See Non-Interactive Installation Guide for all available options.
Not sure what to do? Run
/bmad-help— it tells you exactly what's next and what's optional. You can also ask it questions like:
/bmad-help How should I build a web app for my TShirt Business that can scale to millions?/bmad-help I just finished the architecture, I am not sure what to do next
And the amazing thing is BMad Help evolves depending on what modules you install also!
/bmad-help Im interested in really exploring creative ways to demo BMad at work, what do you recommend to help plan a great slide deck and compelling narrative?, and if you have the Creative Intelligence Suite installed, it will offer you different or complimentary advice than if you just have BMad Method Module installed!
The workflows below show the fastest path to working code. You can also load agents directly for a more structured process, extensive planning, or to learn about agile development practices — the agents guide you with menus, explanations, and elicitation at each step.
Simple Path (Quick Flow)
Bug fixes, small features, clear scope — 3 commands - 1 Optional Agent:
/quick-spec— analyzes your codebase and produces a tech-spec with stories/dev-story— implements each story/code-review— validates quality
Full Planning Path (BMad Method)
Products, platforms, complex features — structured planning then build:
/product-brief— define problem, users, and MVP scope/create-prd— full requirements with personas, metrics, and risks/create-architecture— technical decisions and system design/create-epics-and-stories— break work into prioritized stories/sprint-planning— initialize sprint tracking- Repeat per story:
/create-story→/dev-story→/code-review
Every step tells you what's next. Optional phases (brainstorming, research, UX design) are available when you need them — ask /bmad-help anytime. For a detailed walkthrough, see the Getting Started Tutorial.
Modules
BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time. After the V6 beta period these will also be available as Plugins and Granular Skills.
| Module | GitHub | NPM | Purpose |
|---|---|---|---|
| BMad Method (BMM) | bmad-code-org/BMAD-METHOD | bmad-method | Core framework with 34+ workflows across 4 development phases |
| BMad Builder (BMB) | bmad-code-org/bmad-builder | bmad-builder | Create custom BMad agents, workflows, and domain-specific modules |
| Test Architect (TEA) 🆕 | bmad-code-org/tea | tea | Risk-based test strategy, automation, and release gates (8 workflows) |
| Game Dev Studio (BMGD) | bmad-code-org/bmad-module-game-dev-studio | bmad-game-dev-studio | Game development workflows for Unity, Unreal, and Godot |
| Creative Intelligence Suite (CIS) | bmad-code-org/bmad-module-creative-intelligence-suite | bmad-creative-intelligence-suite | Innovation, brainstorming, design thinking, and problem-solving |
- More modules are coming in the next 2 weeks from BMad Official, and a community marketplace for the installer also will be coming with the final V6 release!
Testing Agents
BMad provides two testing options to fit your needs:
Quinn (QA) - Built-in
Quick test automation for rapid coverage
- ✅ Always available in BMM module (no separate install)
- ✅ Simple: One workflow (
QA- Automate) - ✅ Beginner-friendly: Standard test framework patterns
- ✅ Fast: Generate tests and ship
Use Quinn for: Small projects, quick coverage, standard patterns
Test Architect (TEA) - Optional Module
Enterprise-grade test strategy and quality engineering
- 🆕 Standalone module (install separately)
- 🏗️ Comprehensive: 8 workflows covering full test lifecycle
- 🎯 Advanced: Risk-based planning, quality gates, NFR assessment
- 📚 Knowledge-driven: 34 testing patterns and best practices
- 📖 Test Architect Documentation
Use TEA for: Enterprise projects, test strategy, compliance, release gates
Documentation
BMad Documentation — Tutorials, how-to guides, concepts, and reference Test Architect Documentation — TEA standalone module documentation
- Getting Started Tutorial
- Upgrading from Previous Versions
- Test Architect Migration Guide — Upgrading from BMM-embedded TEA
For v4 Users
- v4 Documentation
- If you need to install V4, you can do this with
npx bmad-method@4.44.3 install- similar for any past version.
Community
- Discord — Get help, share ideas, collaborate
- Subscribe on YouTube — Tutorials, master class, and podcast (launching Feb 2025)
- GitHub Issues — Bug reports and feature requests
- Discussions — Community conversations
Support BMad
BMad is free for everyone — and always will be. If you'd like to support development:
- ⭐ Please click the star project icon near the top right of this page
- ☕ Buy Me a Coffee — Fuel the development
- 🏢 Corporate sponsorship — DM on Discord
- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (BM on Discord)
Contributing
We welcome contributions! See CONTRIBUTING.md for guidelines.
License
MIT License — see LICENSE for details.
BMad and BMAD-METHOD are trademarks of BMad Code, LLC. See TRADEMARK.md for details.
See CONTRIBUTORS.md for contributor information.