2.9 KiB
2.9 KiB
| sidebar_label | description |
|---|---|
| Installation | Getting started with BMAD installation |
Installation Tutorial
Get BMAD up and running in your project with this step-by-step guide.
Prerequisites
Before you begin, ensure you have:
- Node.js 20+ (for the installer)
- Git (recommended for version control)
- An AI-powered IDE or access to Claude/ChatGPT/Gemini
Quick Install
Run the interactive installer:
npx bmad-method install
This will guide you through the installation process interactively.
What the Installer Does
The interactive installer will:
- Choose location - Where to install BMAD files
- Select AI tools - Claude Code, Cursor, Windsurf, etc.
- Choose modules - BMad Method, Creative Intelligence, BMad Builder
- Add custom content - Your own agents, workflows, or modules
- Configure settings - Accept defaults or customize each module
Module Options
During installation, 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, not software dev specific |
| BMB | Builder | Creating custom agents and workflows |
Post-Installation Structure
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/ # Core utilities (always installed)
│ └── {others}/ # Additional modules
├── _bmad-output/ # Default output folder
├── .claude/ # IDE-specific setup (varies)
└── ... your code
Upgrading?
If you're upgrading from a previous version, see the Upgrade Guide.
Next Steps
After installation:
- Quick Start Guide - Build your first feature
- Understanding Workflows - Learn the methodology
- Understanding Agents - BMAD's core building blocks
Troubleshooting
"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, see Install BMAD or join our Discord.