* feat: add link auditor tools and fix broken docs links - Add audit-doc-links.js to scan docs for broken links with auto-resolution - Add fix-doc-links.js to apply suggested fixes (dry-run by default) - Remove stale "Back to Core Concepts" breadcrumb links - Update BMad acronym to "Breakthrough Method of Agile AI Driven Development" - Update README links to docs.bmad-method.org - Simplify upgrade callout in getting-started tutorial Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: reorganize docs structure and archive v4 tutorial - Remove unused section index files (tutorials, how-to, explanation, reference) - Move getting-started-bmadv4.md to _archive - Update quick-start-bmgd.md to remove archived file reference - Update upgrade-to-v6.md - Update astro.config.mjs for new structure Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: ignore underscore directories in link checker Update check-doc-links.js to skip _archive, _planning, and other underscore-prefixed directories when validating links. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: add v4 users section to README Add links to v4 documentation archive and upgrade guide for users migrating from previous versions. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * feat: convert docs to site-relative links and add validation tools - Convert all relative links (./ ../) to site-relative paths (/path/) - Strip .md extensions and use trailing slashes for Astro/Starlight - Add fix-doc-links.js to convert relative links to site-relative - Add validate-doc-links.js to check links point to existing files - Remove old audit-doc-links.js and check-doc-links.js - Update build-docs.js to use new validation script - Add npm scripts: docs:fix-links, docs:validate-links - Update style guide with validation steps Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize acronym to BMad across documentation Replace incorrect "BMAD" with correct "BMad" in text and frontmatter while preserving "BMAD-METHOD" in GitHub URLs. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: fix BMad acronym and remove draft README - Correct acronym to "Breakthrough Method of Agile AI Driven Development" - Remove unused README-draft.md Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize BMad acronym in README Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: standardize FAQ format across all FAQ pages - Add TOC with jump links under "## Questions" - Use ### headers for questions (no Q: prefix) - Direct answers without **A:** prefix - Remove horizontal rules and "Related Documentation" sections - End each FAQ with issue/Discord CTA - Update style guide with new FAQ guidelines - Delete redundant faq/index.md (sidebar handles navigation) Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: use repo-relative links with .md for GitHub compatibility Convert all documentation links to repo-relative format (/docs/path/file.md) so they work when browsing on GitHub. The rehype plugin strips /docs/ prefix and converts .md to trailing slash at build time for Astro/Starlight. - Update rehype-markdown-links.js to strip /docs/ prefix from absolute paths - Update fix-doc-links.js to generate /docs/ prefixed paths with .md extension - Convert 217 links across 64 files to new format Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * fix: handle /docs/ prefix in link validator Update resolveLink to strip /docs/ prefix from repo-relative links before checking if files exist. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> * docs: restore FAQ index page Re-add the FAQ index page that was accidentally deleted, with updated repo-relative link format. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com> Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
8.7 KiB
title, description
| title | description |
|---|---|
| Getting Started with BMad v4 | Install BMad and create your first planning document |
Build software faster using AI-powered workflows with specialized agents that guide you through planning, architecture, and implementation.
:::note[Stable Release] This tutorial covers BMad v4, the current stable release. For the latest features (with potential breaking changes), see the BMad v6 Alpha tutorial. :::
What You'll Learn
- Install and configure BMad for your IDE
- Understand how BMad organizes work into phases and agents
- Initialize a project and choose a planning track
- Create your first requirements document
:::note[Prerequisites]
- Node.js 20+ — Required for the installer
- Git — Recommended for version control
- AI-powered IDE — Claude Code, Cursor, Windsurf, or similar
- A project idea — Even a simple one works for learning :::
:::tip[Quick Path]
Install → npx bmad-method install
Initialize → Load Analyst agent, run workflow-init
Plan → PM creates PRD, Architect creates architecture
Build → SM manages sprints, DEV implements stories
Always use fresh chats for each workflow to avoid context issues.
:::
Understanding BMad
BMad helps you build software through guided workflows with specialized AI agents. The process follows four phases:
| Phase | Name | What Happens |
|---|---|---|
| 1 | Analysis | Brainstorm, research (optional) |
| 2 | Planning | Requirements — PRD or tech-spec (required) |
| 3 | Solutioning | Architecture, design decisions (varies by track) |
| 4 | Implementation | Build code story by story (required) |
Based on your project's complexity, BMad offers three planning tracks:
| Track | Best For | Documents Created |
|---|---|---|
| Quick Flow | Bug fixes, simple features, clear scope | Tech-spec only |
| BMad Method | Products, platforms, complex features | PRD + Architecture + UX |
| Enterprise | Compliance, multi-tenant, enterprise needs | PRD + Architecture + Security + DevOps |
Installation
Open a terminal in your project directory and run:
npx bmad-method install
The interactive installer guides you through setup:
- Choose Installation Location — Select current directory (recommended), subdirectory, or custom path
- Select Your AI Tool — Claude Code, Cursor, Windsurf, or other
- Choose Modules — Select BMM (BMad Method) for this tutorial
- Accept Defaults — Customize later in
_bmad/[module]/config.yaml
Verify your installation:
your-project/
├── _bmad/
│ ├── bmm/ # Method module
│ │ ├── agents/ # Agent files
│ │ ├── workflows/ # Workflow files
│ │ └── config.yaml # Module config
│ └── core/ # Core utilities
├── _bmad-output/ # Generated artifacts (created later)
└── .claude/ # IDE configuration (if using Claude Code)
:::tip[Troubleshooting] Having issues? See Install BMad for common solutions. :::
Step 1: Initialize Your Project
Load the Analyst agent in your IDE:
- Claude Code: Type
/analystor load the agent file directly - Cursor/Windsurf: Open the agent file from
_bmad/bmm/agents/
Wait for the agent's menu to appear, then run:
Run workflow-init
Or use the shorthand: *workflow-init
The workflow asks you to describe:
- Your project and goals — What are you building? What problem does it solve?
- Existing codebase — Is this new (greenfield) or existing code (brownfield)?
- Size and complexity — Roughly how big is this? (adjustable later)
Based on your description, the workflow suggests a planning track. For this tutorial, choose BMad Method.
Once you confirm, the workflow creates bmm-workflow-status.yaml to track your progress.
:::caution[Fresh Chats] Always start a fresh chat for each workflow. This prevents context limitations from causing issues. :::
Step 2: Create Your Plan
With your project initialized, work through the planning phases.
Phase 1: Analysis (Optional)
If you want to brainstorm or research first:
- brainstorm-project — Guided ideation with the Analyst
- research — Market and technical research
- product-brief — Recommended foundation document
Phase 2: Planning (Required)
Start a fresh chat and load the PM agent.
Run prd
Or use shortcuts: *prd, select "create-prd" from the menu, or say "Let's create a PRD".
The PM agent guides you through:
- Project overview — Refine your project description
- Goals and success metrics — What does success look like?
- User personas — Who uses this product?
- Functional requirements — What must the system do?
- Non-functional requirements — Performance, security, scalability needs
When complete, you'll have PRD.md in your _bmad-output/ folder.
:::note[UX Design (Optional)] If your project has a user interface, load the UX-Designer agent and run the UX design workflow after creating your PRD. :::
Phase 3: Solutioning (Required for BMad Method)
Start a fresh chat and load the Architect agent.
Run create-architecture
The architect guides you through technical decisions: tech stack, database design, API patterns, and system structure.
:::tip[Check Your Status]
Unsure what's next? Load any agent and run workflow-status. It tells you the next recommended or required workflow.
:::
Step 3: Build Your Project
Once planning is complete, move to implementation.
Initialize Sprint Planning
Load the SM agent and run sprint-planning. This creates sprint-status.yaml to track all epics and stories.
The Build Cycle
For each story, repeat this cycle with fresh chats:
| Step | Agent | Workflow | Purpose |
|---|---|---|---|
| 1 | SM | create-story |
Create story file from epic |
| 2 | DEV | dev-story |
Implement the story |
| 3 | DEV | code-review |
Quality validation (recommended) |
After completing all stories in an epic, load the SM agent and run retrospective.
What You've Accomplished
You've learned the foundation of building with BMad:
- Installed BMad and configured it for your IDE
- Initialized a project with your chosen planning track
- Created planning documents (PRD, Architecture)
- Understood the build cycle for implementation
Your project now has:
your-project/
├── _bmad/ # BMad configuration
├── _bmad-output/
│ ├── PRD.md # Your requirements document
│ ├── architecture.md # Technical decisions
│ └── bmm-workflow-status.yaml # Progress tracking
└── ...
Quick Reference
| Command | Agent | Purpose |
|---|---|---|
*workflow-init |
Analyst | Initialize a new project |
*workflow-status |
Any | Check progress and next steps |
*prd |
PM | Create Product Requirements Document |
*create-architecture |
Architect | Create architecture document |
*sprint-planning |
SM | Initialize sprint tracking |
*create-story |
SM | Create a story file |
*dev-story |
DEV | Implement a story |
*code-review |
DEV | Review implemented code |
Common Questions
Do I need to create a PRD for every project? Only for BMad Method and Enterprise tracks. Quick Flow projects use a simpler tech-spec instead.
Can I skip Phase 1 (Analysis)? Yes, Phase 1 is optional. If you already know what you're building, start with Phase 2 (Planning).
What if I want to brainstorm first?
Load the Analyst agent and run *brainstorm-project before workflow-init.
Why start fresh chats for each workflow? Workflows are context-intensive. Reusing chats can cause the AI to hallucinate or lose track of details. Fresh chats ensure maximum context capacity.
Getting Help
- During workflows — Agents guide you with questions and explanations
- Check status — Run
workflow-statuswith any agent - Community — Discord (#bmad-method-help, #report-bugs-and-issues)
- Video tutorials — BMad Code YouTube
Key Takeaways
:::tip[Remember These]
- Always use fresh chats — Load agents in new chats for each workflow
- Let workflow-status guide you — Ask any agent for status when unsure
- Track matters — Quick Flow uses tech-spec; Method/Enterprise need PRD and architecture
- Tracking is automatic — Status files update themselves
- Agents are flexible — Use menu numbers, shortcuts (
*prd), or natural language :::
Ready to start? Install BMad, load the Analyst, run workflow-init, and let the agents guide you.