Installation

Get BMAD up and running in your project.

Upgrading?

If you're upgrading from v4, see the Upgrade Guide.

Quick Install

npx bmad-method install

This interactive installer will:

Let you choose a location to install to
Let you choose which Agentic LLM Tools you would like to use (Such as Claude Code, Cursor, Windsurf, etc...)
Let you choose which official modules to install (BMad Method, Creative Intelligence suite, BMad Builder)
Let you choose any custom local modules, workflows or agents to install
Let you configure each module or quickly accept the default recommended settings for each selected model

Requirements

Node.js 20+ (for the installer)
Git (recommended for version control)
An AI-powered Agent and/or IDE or access to Claude/ChatGPT/Gemini

Module Options

During installation, you'll choose which modules to install:

Module	Description	Best For
BMM	BMAD Method Core	Software development projects
BMGD	Game Development	Game projects with specialized workflows
CIS	Creative Intel Suite	Creativity Unlocking Suite, not software dev specific
BMB	Builder	Creating custom agents and workflows

You will also be asked if you would like to install custom content (agents, workflows or modules) you have created with the BMB, or shared from others in the community.

Post-Installation

After installation, your project will have:

your-project/
├── _bmad/              # BMAD configuration and agents
│   ├── bmm/            # Method module (if installed)
│   ├── bmgd/           # Game dev module (if installed)
│   ├── core/           # Always installed, includes party mode, advanced elicitation, and other core generic utils
│   ├── {others}/       # etc...
├── _bmad-output/       # BMAD default output folder - configurable during install
├── .claude/            # IDE-specific setup (varies by IDE)
└── ... your code       # maybe nothing else yet if a fresh new folder

Next Steps

Read the Quick Start Guide to build your first feature
Explore Workflows to understand the methodology
Learn about Agents to understand BMAD's core building blocks

Troubleshooting

Common Issues

"Command not found: npx": Install Node.js 20+ from nodejs.org
"Permission denied": Run with appropriate permissions or check your npm configuration

For more help, join our Discord.

2.9 KiB Raw Blame History