Quick Start Guide

Get BMad Method running in your project in 5-10 minutes with this step-by-step guide

Quick Start Guide

Get BMad Method installed and running in your project in just a few minutes. This guide will walk you through installation, first commands, and basic usage.

Prerequisites: You need Node.js v20 or higher installed on your system.

Installation

1. Run the installer

   Open your terminal and navigate to your project directory, then run:

   npx bmad-method install
   

   If you’re getting a stale beta version, use: npx bmad-method@6.0.1 install

2. Answer configuration prompts

   The installer will ask you a few questions to configure BMad for your project:

   Core Configuration:

   • What should agents call you? (Your name or team name)
   • What language should agents use when chatting?
   • Preferred document output language?
   • Where should output files be saved? (default: _bmad-output)

   BMad Method Configuration:

   • Project name (defaults to your directory name)
   • Your development experience level (beginner/intermediate/expert)
   • Where to store planning artifacts (default: _bmad-output/planning-artifacts)
   • Where to store implementation artifacts (default: _bmad-output/implementation-artifacts)
   • Where to store project knowledge (default: docs)

   Example: Solo Developer

   What should agents call you? Alex
   What language should agents use? English  
   Project name: my-saas-app
   Experience level: Intermediate
   
3. Select modules to install

   Choose which BMad modules you want to install:

   • BMad Method (BMM) — Core framework with 34+ workflows (recommended)
   • BMad Builder (BMB) — Create custom agents and workflows
   • Test Architect (TEA) — Risk-based test strategy and automation
   • Game Dev Studio (BMGD) — Game development workflows
   • Creative Intelligence Suite (CIS) — Innovation and brainstorming

   Start with just BMM (the core framework). You can add other modules anytime by running the installer again.

4. Select your AI IDE

   Choose which AI IDE(s) you’re using:

   • Claude Code (recommended)
   • Cursor
   • GitHub Copilot
   • Windsurf
   • And more…

   The installer will configure slash commands for your selected IDE(s).

5. Wait for installation to complete

   The installer will:

   • Create necessary directories
   • Install selected modules
   • Generate agent files
   • Configure IDE integrations
   • Set up workflow commands

   This usually takes 30-60 seconds.

Verify Installation

After installation completes, verify everything is working:

1. Check for the _bmad directory

   You should see a new _bmad directory in your project with this structure:

   _bmad/
   ├── core/              # Core BMad functionality
   ├── bmm/               # BMad Method module
   │   ├── agents/        # Agent definitions
   │   └── workflows/     # Workflow files
   └── manifest.yaml      # Installation manifest
   
2. Check for IDE integration

   Depending on your IDE, you should see:

   Claude Code:

   .claude/
   └── commands/
       └── bmad/          # BMad slash commands
   

   Cursor:

   .cursor/
   └── commands/
       └── bmad/          # BMad slash commands
   
3. Open your AI IDE

   Open your AI IDE (Claude Code, Cursor, etc.) in your project directory.

Your First Commands

Now you’re ready to use BMad Method! Here are your first commands:

Get Help

The most important command is /bmad-help — it tells you exactly what to do next:

/bmad-help

You can also ask questions:

/bmad-help I just finished the architecture, what do I do next?

Invoke an Agent

Agents are your specialized collaborators. Try invoking the Product Manager:

/pm

You’ll see a menu with options like:

• [CP] Create PRD — Create a Product Requirements Document
• [VP] Validate PRD — Validate an existing PRD
• [EP] Edit PRD — Update your PRD
• [CE] Create Epics and Stories — Break down requirements

Run a Workflow

Workflows can also be called directly:

/create-prd

This launches the PRD creation workflow with guided facilitation.

Quick Development Flow

For rapid iteration on small features or bug fixes:

/quick-flow-solo-dev

This specialized agent helps you ship quickly while maintaining quality.

Common First Tasks

Here are typical first tasks based on your project stage:

New Project

Starting from Scratch

1. Brainstorm ideas

   /bmad-help brainstorming
   
2. Create a product brief

   /pm
   # Select "Create Product Brief"
   
3. Write a PRD

   /create-prd
   
4. Design UX

   /ux-designer
   # Select "[CU] Create UX Design"
   
5. Create architecture

   /architect
   # Select "[CA] Create Architecture"
   

Existing Project

Adding BMad to an Existing Project

1. Document your project

   /generate-project-context
   

   This creates a comprehensive project overview.

2. Plan a new feature

   /create-prd
   

   Document requirements for your next feature.

3. Quick development

   /quick-flow-solo-dev
   

   Jump straight into implementing small features.

4. Set up sprints

   /sm
   # Select "Sprint Planning"
   

Bug Fix / Small Feature

Quick Flow Development

1. Start quick-flow

   /quick-flow-solo-dev
   
2. Choose your mode

   The agent will detect whether you need:

   • Quick spec (plan before implementing)
   • Quick dev (implement with review)
3. Follow the workflow

   The agent guides you through:

   1. Understanding requirements
   2. Implementation
   3. Self-check
   4. Adversarial review
   5. Resolving findings

Understanding the Workflow

BMad Method organizes work into 4 phases:

Phase 1: Analysis

Research and Discovery

• Domain research
• Market research
• Technical research
• Competitive analysis

Phase 2: Planning

Requirements & Design

• Product briefs
• PRD creation
• UX design
• Validation

Phase 3: Solutioning

Architecture & Breakdown

• Architecture documentation
• Epics and stories
• Implementation readiness

Phase 4: Implementation

Development & Delivery

• Sprint planning
• Story development
• Code review
• Retrospectives

You don’t need to follow all phases for every project! Small features can jump straight to quick-flow. The framework adapts to your needs.

Pro Tips

Use Party Mode

Bring multiple agents into a discussion:

/party-mode

Example: Get PM, Architect, and Dev in the same conversation to discuss a complex feature.

Customize Agent Behavior

You can customize how agents communicate with you by editing:

_bmad/core/config.yaml

Change experience level, language, or output preferences.

Non-Interactive Installation

For CI/CD pipelines or automation:

npx bmad-method install \
  --directory /path/to/project \
  --modules bmm \
  --tools claude-code \
  --yes

Check Installation Status

See what’s currently installed:

npx bmad-method status

What’s Next?

Installation Guide

Learn about all installation options and troubleshooting

Agent Reference

Meet all the specialized agents and their capabilities

Workflow Guide

Explore all 34+ workflows in detail

Tutorials

Step-by-step tutorials for common scenarios

Need Help?

Stuck or confused? Remember: /bmad-help is your friend! It provides context-aware guidance based on your current project state.

• Ask /bmad-help in your IDE for intelligent guidance
• Join our Discord community for help and discussion
• Report issues on GitHub
• Check the documentation site for detailed guides

---

Congratulations! You’re now ready to use BMad Method to build better software faster. Start with /bmad-help and let the agents guide you.