ldy26098
/
BMAD-METHOD
mirror of https://github.com/bmad-code-org/BMAD-METHOD.git
1
0
Fork 0
Code Packages Projects Releases Wiki Activity
BMAD-METHOD/docs/how-to/install-bmad.md

3.5 KiB
Raw Blame History

title description sidebar
How to Install BMad Step-by-step guide to installing BMad in your project
order
1

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

If you want to use a non interactive installer and provide all install options on the command line, see this guide.

When to Use This

  • Starting a new project with BMad
  • Adding BMad to an existing codebase
  • Update the existing BMad Installation

:::note[Prerequisites]

  • Node.js 20+ (required for the installer)
  • Git (recommended)
  • AI tool (Claude Code, Cursor, or similar) :::

Steps

1. Run the Installer

npx bmad-method install

:::tip[Want the newest prerelease build?] Use the next dist-tag:

npx bmad-method@next install

This gets you newer changes earlier, with a higher chance of churn than the default install. :::

:::tip[Bleeding edge] To install the latest from the main branch (may be unstable):

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

:::

2. Choose Installation Location

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

3. Select Your AI Tools

Pick which AI tools you use:

  • Claude Code
  • Cursor
  • Mistral Vibe
  • Others

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

:::note[Enabling Skills] Some platforms require skills to be explicitly enabled in settings before they appear. If you install BMad and don't see the skills, check your platform's settings or ask your AI assistant how to enable skills. :::

4. Choose Modules

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

5. Follow the Prompts

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

What You Get

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 skills (if using Claude Code)
│   └── skills/
│       ├── bmad-help/
│       ├── bmad-persona/
│       └── ...
├── .cursor/            # Cursor skills (if using Cursor)
│   └── skills/
│       └── ...
└── .vibe/              # Mistral Vibe skills (if using Mistral Vibe)
    └── skills/
        └── ...

Verify Installation

Run bmad-help to verify everything works and see what to do next.

BMad-Help is your intelligent guide that will:

  • Confirm your installation is working
  • Show what's available based on your installed modules
  • Recommend your first step

You can also ask it questions:

bmad-help I just installed, what should I do first?
bmad-help What are my options for a SaaS project?

Troubleshooting

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.