Skip to content
🤖 Consolidated, AI-optimized BMAD docs: llms-full.txt. Fetch this plain text file for complete context.

How to Install BMad

Use the npx bmad-method install command to set up BMad in your project with your choice of modules and AI tools.

  • Starting a new project with BMad
  • Adding BMad to an existing codebase
  • Update the existing BMad Installation
Terminal window
npx bmad-method install

The installer will ask where to install BMad files:

  • Current directory (recommended for new projects if you created the directory yourself and ran from within the directory)
  • Custom path

Pick which AI tools you use:

  • Claude Code
  • Cursor
  • Windsurf
  • Others

Each tool has its own way of integrating commands. The installer creates tiny prompt files to activate workflows and agents — it just puts them where your tool expects to find them.

The installer shows available modules. Select whichever ones you need — most users just want BMad Method (the software development module).

The installer guides you through the rest — custom content, settings, etc.

your-project/
├── _bmad/
│ ├── bmm/ # Your selected modules
│ │ └── config.yaml # Module settings (if you ever need to change them)
│ ├── core/ # Required core module
│ └── ...
├── _bmad-output/ # Generated artifacts
└── .claude/ # Claude Code commands (if using Claude Code)

Run the help workflow (/bmad-help on most platforms) to verify everything works and see what to do next.

Latest from main branch:

Terminal window
npx github:bmad-code-org/BMAD-METHOD install

Use these if you want the newest features before they’re officially released. Things might break.

Installer throws an error — Copy-paste the output into your AI assistant and let it figure it out.

Installer worked but something doesn’t work later — Your AI needs BMad context to help. See How to Get Answers About BMad for how to point your AI at the right sources.