Package Exports
- bmad-method
- bmad-method/package.json
- bmad-method/tools/cli/bmad-cli.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (bmad-method) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
BMad CORE + BMad Method
π¨ Alpha Version Notice
v6-alpha is near-beta qualityβstable and vastly improved over v4, but documentation is still being refined. New videos coming soon to the BMadCode YouTube channelβsubscribe for updates!
Getting Started:
- Install v6 Alpha:
npx bmad-method@alpha install- Install stable v4:
npx bmad-method install- Not sure what to do? Load any agent and run
*workflow-initfor guided setup- v4 Users: View v4 documentation or upgrade guide
Universal Human-AI Collaboration Platform
BMad-CORE (Collaboration Optimized Reflection Engine) amplifies human potential through specialized AI agents. Unlike tools that replace thinking, BMad-CORE guides reflective workflows that bring out your best ideas and AI's full capabilities.
The BMad-CORE powers the BMad Method (probably why you're here!), but you can also use BMad Builder to create custom agents, workflows, and modules for any domainβsoftware development, business strategy, creativity, learning, and more.
π― Human Amplification β’ π¨ Domain Agnostic β’ β‘ Agent-Powered
Table of Contents
- BMad CORE + BMad Method
What is BMad-CORE?
Foundation framework powering all BMad modules:
- Agent Orchestration - Specialized AI personas with domain expertise
- Workflow Engine - Guided multi-step processes with built-in best practices
- Modular Architecture - Extend with domain-specific modules (BMM, BMB, CIS, custom)
- IDE Integration - Works with Claude Code, Cursor, Windsurf, VS Code, and more
- Update-Safe Customization - Your configs persist through all updates
v6 Core Enhancements
- π¨ Agent Customization - Modify names, roles, personalities via
bmad/_cfg/agents/ - π Multi-Language - Independent language settings for communication and output
- π€ Personalization - Agents adapt to your name, skill level, and preferences
- π Persistent Config - Customizations survive module updates
- βοΈ Flexible Settings - Configure per-module or globally
C.O.R.E. Philosophy
- Collaboration: Human-AI partnership leveraging complementary strengths
- Optimized: Battle-tested processes for maximum effectiveness
- Reflection: Strategic questioning that unlocks breakthrough solutions
- Engine: Framework orchestrating 19+ specialized agents and 50+ workflows
BMad-CORE doesn't give you answersβit helps you discover better solutions through guided reflection.
Modules
BMad Method (BMM) - AI-Driven Agile Development
Revolutionary AI-driven agile framework for software and game development. Automatically adapts from single bug fixes to enterprise-scale systems.
v6 Highlights
π― Scale-Adaptive Intelligence (3 Planning Tracks)
Automatically adjusts planning depth and documentation based on project needs:
- Quick Flow Track: Fast implementation (tech-spec only) - bug fixes, small features, clear scope
- BMad Method Track: Full planning (PRD + Architecture + UX) - products, platforms, complex features
- Enterprise Method Track: Extended planning (BMad Method + Security/DevOps/Test) - enterprise requirements, compliance
ποΈ Four-Phase Methodology
- Phase 1: Analysis (Optional) - Brainstorming, research, product briefs
- Phase 2: Planning (Required) - Scale-adaptive PRD/tech-spec/GDD
- Phase 3: Solutioning (Track-dependent) - Architecture, (Coming soon: security, DevOps, test strategy)
- Phase 4: Implementation (Iterative) - Story-centric development with just-in-time context
π€ 12 Specialized Agents
PM β’ Analyst β’ Architect β’ Scrum Master β’ Developer β’ Test Architect (TEA) β’ UX Designer β’ Technical Writer β’ Game Designer β’ Game Developer β’ Game Architect β’ BMad Master (Orchestrator)
π Documentation
- Complete Documentation Hub - Start here for all BMM guides
- Quick Start Guide - Get building in 15 minutes
- Agents Guide - Meet all 12 agents (45 min read)
- 34 Workflow Guides - Complete phase-by-phase reference
- BMM Module Overview - Module structure and quick links
π Quick Start
After installation (see Installation below), choose your path:
Three Planning Tracks:
β‘ Quick Flow Track - Bug fixes and small features
- π Bug fixes in minutes
- β¨ Small features (2-3 related changes)
- π Rapid prototyping
- β Quick Spec Flow Guide
π BMad Method Track - Products and platforms
- Complete planning (PRD/GDD)
- Architecture decisions
- Story-centric implementation
- β Complete Quick Start Guide
π’ Brownfield Projects - Add to existing codebases
- Document existing code first
- Then choose Quick Flow or BMad Method
- β Brownfield Guide
Not sure which path? Run *workflow-init and let BMM analyze your project goal and recommend the right track.
π Learn More: Scale Adaptive System - How BMM adapts across three planning tracks
BMad Builder (BMB) - Create Custom Solutions
Build your own agents, workflows, and modules using the BMad-CORE framework.
What You Can Build:
- Custom Agents - Domain experts with specialized knowledge
- Guided Workflows - Multi-step processes for any task
- Complete Modules - Full solutions for specific domains
- Three Agent Types - Full module, hybrid, or standalone
Perfect For: Creating domain-specific solutions (legal, medical, finance, education, creative, etc.) or extending BMM with custom development workflows.
Documentation:
- BMB Module Overview - Complete reference
- Create Agent Workflow - Build custom agents
- Create Workflow - Design guided processes
- Create Module - Package complete solutions
Creative Intelligence Suite (CIS) - Innovation & Creativity
AI-powered creative facilitation using proven methodologies and techniques.
5 Interactive Workflows:
- Brainstorming - Generate and refine ideas with 30+ techniques
- Design Thinking - Human-centered problem solving
- Problem Solving - Systematic breakthrough techniques
- Innovation Strategy - Disruptive business model thinking
- Storytelling - Compelling narrative frameworks
5 Specialized Agents: Each with unique facilitation styles and domain expertise
Shared Resource: CIS workflows are used by other modules (BMM's brainstorm-project uses CIS brainstorming)
Documentation:
- CIS Module Overview - Complete reference
- CIS Workflows Guide - All 5 creative workflows
Installation
Prerequisites: Node.js v20+ (Download)
# v6 Alpha (recommended for new projects)
npx bmad-method@alpha install
# Stable v4 (production)
npx bmad-method installThe installer provides:
- Module Selection - Choose BMM, BMB, CIS (or all)
- Configuration - Your name, language preferences, game dev options
- IDE Integration - Automatic setup for your IDE
Installation creates:
your-project/
βββ bmad/
βββ core/ # Core framework + BMad Master agent
βββ bmm/ # BMad Method (12 agents, 34 workflows)
βββ bmb/ # BMad Builder (1 agent, 7 workflows)
βββ cis/ # Creative Intelligence (5 agents, 5 workflows)
βββ _cfg/ # Your customizations (survives updates)
βββ agents/ # Agent customization filesNext Steps:
- Load any agent in your IDE
- Run
*workflow-initto set up your project workflow path - Follow the Quick Start guide above to choose your planning track
π― Working with Agents & Commands
Multiple Ways to Execute Workflows:
BMad is flexible - you can execute workflows in several ways depending on your preference and IDE:
Method 1: Agent Menu (Recommended for Beginners)
- Load an agent in your IDE (see IDE-specific instructions)
- Wait for the menu to appear showing available workflows
- Tell the agent what to run using natural language or shortcuts:
- Natural: "Run workflow-init"
- Shortcut:
*workflow-init - Menu number: "Run option 2"
Method 2: Direct Slash Commands
Execute workflows directly using slash commands:
/bmad:bmm:workflows:workflow-init
/bmad:bmm:workflows:prd
/bmad:bmm:workflows:dev-storyTip: While you can run these without loading an agent first, loading an agent is still recommended - it can make a difference with certain workflows.
Benefits:
- β Mix and match any agent with any workflow
- β Run workflows not in the loaded agent's menu
- β Faster access for experienced users who know the command names
Method 3: Party Mode Execution
Run workflows with multi-agent collaboration:
- Start party mode:
/bmad:core:workflows:party-mode - Execute any workflow - the entire team collaborates on it
- Get diverse perspectives from multiple specialized agents
Perfect for: Strategic decisions, complex workflows, cross-functional tasks
π IDE-Specific Note:
Slash command format varies by IDE:
- Claude Code:
/bmad:bmm:workflows:prd- Cursor/Windsurf: May use different syntax - check your IDE's documentation
- VS Code with Copilot Chat: Syntax may differ
See IDE Integration Guides for your specific IDE's command format.
Key Features
π¨ Update-Safe Customization
Modify agents without touching core files:
- Override agent names, personalities, expertise via
bmad/_cfg/agents/ - Customizations persist through all updates
- Multi-language support (communication + output)
- Module-level or global configuration
π Intelligent Installation
Smart setup that adapts to your environment:
- Auto-detects v4 installations for smooth upgrades
- Configures IDE integrations (Claude Code, Cursor, Windsurf, VS Code)
- Resolves cross-module dependencies
- Generates unified agent/workflow manifests
π Clean Architecture
Everything in one place:
- Single
bmad/folder (no scattered files) - Modules live side-by-side (core, bmm, bmb, cis)
- Your configs in
_cfg/(survives updates) - Easy to version control or exclude
π Document Sharding (Advanced)
Optional optimization for large projects (BMad Method and Enterprise tracks):
- Massive Token Savings - Phase 4 workflows load only needed sections (90%+ reduction)
- Automatic Support - All workflows handle whole or sharded documents seamlessly
- Easy Setup - Built-in tool splits documents by headings
- Smart Discovery - Workflows auto-detect format
Documentation
Module Documentation:
- BMM Complete Documentation Hub - All BMM guides, FAQs, troubleshooting
- BMB Module Reference - Build custom agents and workflows
- CIS Workflows Guide - Creative facilitation workflows
Additional Resources:
- Documentation Index - All project documentation
- v4 to v6 Upgrade Guide - Migration instructions
- CLI Tool Guide - Installer and build tool reference
- Contributing Guide - How to contribute
Community & Support
- π¬ Discord Community - Get help, share projects (#general-dev, #bugs-issues)
- π GitHub Issues - Report bugs, request features
- π₯ YouTube Channel - Video tutorials and walkthroughs
- β Star this repo - Stay updated on releases
Development & Quality Checks
For contributors working on the BMAD codebase:
Requirements: Node.js 22+ (see .nvmrc). Run nvm use to switch to the correct version.
Testing & Validation
# Run all quality checks (comprehensive - use before pushing)
npm test
# Individual test suites
npm run test:schemas # Agent schema validation (fixture-based)
npm run test:install # Installation component tests (compilation)
npm run validate:schemas # YAML schema validation
npm run validate:bundles # Web bundle integrityCode Quality
# Lint check
npm run lint
# Auto-fix linting issues
npm run lint:fix
# Format check
npm run format:check
# Auto-format all files
npm run format:fixBuild & Development
# Bundle for web deployment
npm run bundle
# Test local installation
npm run install:bmadPre-commit Hook: Auto-fixes changed files (lint-staged) + validates everything (npm test) CI: GitHub Actions runs all quality checks in parallel on every PR
Contributing
We welcome contributions! See CONTRIBUTING.md for:
- Code contribution guidelines
- Documentation improvements
- Module development
- Issue reporting
License
MIT License - See LICENSE for details
Trademarks: BMADβ’ and BMAD-METHODβ’ are trademarks of BMad Code, LLC.
Built with β€οΈ for the human-AI collaboration community