Package Exports

bmad-method
bmad-method/tools/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-METHOD

AI-Powered Agile Development Framework - Transform your software development with specialized AI agents that work as your complete Agile team.

📺 Subscribe to BMadCode on YouTube - V4 walkthrough and comprehensive guide coming soon!

⭐ If you find this project helpful or useful, please give it a star! It helps others discover BMAD-METHOD and you will be notified of updates!

🔄 Important: Keeping Your BMAD Installation Updated

Stay up-to-date effortlessly! If you already have BMAD-METHOD installed in your project, simply run:

npx bmad-method install

The installer will:

✅ Automatically detect your existing v4 installation
✅ Update only the files that have changed
✅ Create .bak backup files for any custom modifications you've made
✅ Preserve your project-specific configurations

This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!

🚀 Quick Start

Fastest Start: Web UI (2 minutes) 🏃‍♂️

Get the bundle: Copy dist/teams/team-fullstack.txt (from this repository)
Create AI agent: Create a new Gemini Gem or CustomGPT
Upload & configure: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
Start Ideating and Planning: Start chatting! Type *help to see available commands or pick an agent like *analyst to start right in on creating a brief.

💡 All pre-built bundles are in the dist/ folder - ready to copy and use immediately!

IDE Quick Start (5 minutes) 💻

Prerequisites: Install Node.js (v20 or higher)

Run npx bmad-method install

This installs all agents and configures them for your IDE. If you have an existing v3 installation, it will offer to upgrade it automatically.

Overview

BMAD-METHOD (Breakthrough Method of Agile AI-Driven Development) revolutionizes software development by providing specialized AI agents for every role in an Agile team. Each agent has deep expertise in their domain and can collaborate to deliver complete software projects.

Why BMAD?

🎯 Specialized Expertise: Each agent is an expert in their specific role
🔄 True Agile Workflow: Follows real Agile methodologies and best practices
📦 Modular Design: Use one agent or an entire team
🛠️ IDE Integration: Works seamlessly with Cursor, Claude Code, and Windsurf
🌐 Platform Agnostic: Use with ChatGPT, Claude, Gemini, or any AI platform

Installation

Method 1: Pre-Built Web Bundles (Fastest) 📦

For ChatGPT, Claude, or Gemini web interfaces:

Choose a bundle:
- Recommended: dist/teams/team-fullstack.txt (complete development team)
- Or pick from individual agents in dist/agents/
Upload to your AI platform (Gemini Gem, CustomGPT, or directly in chat)
Set instructions: "Your critical operating instructions are attached, do not break character as directed"
Type /help to see available commands

Method 2: CLI Installer (For IDEs) 🎯

Prerequisites: Install Node.js v20+ first

Install directly into your project: npx bmad-method install

Supported IDEs:

The BMad Method works with any IDE, but has built-in integration for:

cursor - Cursor IDE with @agent commands
claude-code - Claude Code with /agent commands
windsurf - Windsurf with @agent commands
roo - Roo Code with custom modes (see .roomodes)
More coming soon - BUT ITS easy to use with ANY IDE - just copy the bmad-code folder to your project, and rename it .bmad-code.

Available Agents

Core Development Team

Agent	Role	Specialty
`analyst`	Business Analyst	market analysis, brainstorming, project brief
`pm`	Product Manager	Product strategy, roadmaps, PRDs
`architect`	Solution Architect	System design, technical architecture
`dev`	Developer	Code implementation across all technologies
`qa`	QA Specialist	Testing strategies, quality assurance
`ux-expert`	UX Designer	User experience, UI design, prototypes
`po`	Product Owner	Backlog management, story validation
`sm`	Scrum Master	Sprint planning, story creation

Meta Agents

Agent	Role	Specialty
`bmad-orchestrator`	Team Coordinator	Multi-agent workflows, role switching, is part of every team bundle
`bmad-master`	Universal Expert	All capabilities without switching

Usage

With IDE Integration

After installation with --ide flag:

# In Cursor
@pm Create a PRD for a task management app

# In Claude Code
/architect Design a microservices architecture

# In Windsurf
@dev Implement story 1.3

With Web UI (ChatGPT/Claude/Gemini)

After uploading a bundle you can ask /help of the agent to learn what it can do

CLI Commands

# List all available agents
npx bmad-method list

# Install or update (automatically detects existing installations)
npx bmad-method install

# Check installation status
npx bmad-method status

Upgrading from V3 to V4

If you have an existing BMAD-METHOD V3 project, simply run the installer in your project directory:

npx bmad-method install
# The installer will automatically detect your V3 installation and offer to upgrade

The upgrade process will:

Create a backup of your V3 files in .bmad-v3-backup/
Install the new V4 .bmad-core/ structure
Migrate your documents (PRD, Architecture, Stories, Epics)
Set up IDE integration for all V4 agents
Create an install manifest for future updates

After upgrading:

Review your documents in the docs/ folder
Use @bmad-master agent to run the doc-migration-task to align your documents with V4 templates
If you have separate front-end and backend architecture docs, the migration task will help merge them into a unified full-stack-architecture.md

Note: The agents in .bmad-core/ fully replace the items in bmad-agent/.

Teams & Workflows

Pre-Configured Teams

Save context by using specialized teams:

Team All: Complete Agile team with all 10 agents
Team Fullstack: Frontend + Backend development focus
Team No-UI: Backend/API development without UX

Workflows

Structured approaches for different scenarios:

Greenfield: Starting new projects (fullstack/service/UI)
Brownfield: Enhancing existing projects
Simple: Quick prototypes and MVPs
Complex: Enterprise and large-scale projects

Project Structure

.bmad-core/
├── agents/          # Individual agent definitions
├── agent-teams/     # Team configurations
├── workflows/       # Development workflows
├── templates/       # Document templates (PRD, Architecture, etc.)
├── tasks/           # Reusable task definitions
├── checklists/      # Quality checklists
├── data/            # Knowledge base
└── web-bundles/     # Optional can be added if you use the install command and select this folder as a destination for the build bundle files

tools/
├── cli.js           # Build tool
├── installer/       # NPX installer
└── lib/             # Build utilities

expansion-packs/     # Optional add-ons (DevOps, Mobile, etc.)

dist/                # 📦 PRE-BUILT BUNDLES (Ready to use!)
├── agents/          # Individual agent bundles (.txt files)
├── teams/           # Team bundles (.txt files)
└── expansion-packs/ # Expansion pack bundles

📦 Pre-Built Bundles (dist/ folder)

All ready-to-use bundles are in the dist/ directory!

Teams: dist/teams/ - Complete team configurations
- team-fullstack.txt - Full-stack development team
- team-ide-minimal.txt - Minimal IDE workflow team
- team-no-ui.txt - Backend-only team
- team-all.txt - All agents included
Individual Agents: dist/agents/ - Single agent files
- One .txt file per agent (analyst, architect, dev, etc.)
Expansion Packs: dist/expansion-packs/ - Specialized domains
- Game development, DevOps, etc.

For Web UI usage: Simply copy any .txt file from dist/ and upload to your AI platform!`

Advanced Features

Dynamic Dependencies

Each agent only loads the resources it needs, keeping context windows lean.

Template System

Rich templates for all document types:

Product Requirements (PRD)
Architecture Documents
User Stories
Test Plans
And more...

Slash Star Commands

Ask the agent you are using for help with /help (in the web) or *help in the ide to see what commands are available!

Contributing

We welcome contributions!

🆕 New to GitHub? Start with our Pull Request Guide
See CONTRIBUTING.md for detailed guidelines

Development Setup

git clone https://github.com/bmadcode/bmad-method.git
cd bmad-method
npm install

Documentation & Guides

Architecture & Technical

🏗️ Core Architecture - Complete technical architecture and system design
📖 User Guide - Comprehensive guide to using BMAD-METHOD effectively

Workflow Guides

📚 Universal BMAD Workflow Guide - Core workflow that applies to all IDEs
🎯 Cursor Guide - Complete workflow for Cursor users
🤖 Claude Code Guide - Complete workflow for Claude Code users
🌊 Windsurf Guide - Complete workflow for Windsurf users
🦘 Roo Code Guide - Complete workflow for Roo Code users

Support

License

MIT License - see LICENSE for details.

Version History

Current: v4 - Complete framework rewrite with CLI installer, dynamic dependencies, and expansion packs
Previous Versions:
- Version 3 - Introduced the unified BMAD Agent and Gemini optimization
- Version 2 - Added web agents and template separation
- Version 1 - Original 7-file proof of concept

See versions.md for detailed version history and migration guides.

Author

Created by Brian (BMad) Madison

_{Built with ❤️ for the AI-assisted development community}