Files
BMAD-METHOD/docs/tutorials/getting-started/getting-started-bmadv6.md
Alex Verkhovsky 2e16650067 feat(docs): Diataxis restructure + Astro/Starlight migration (#1263)
* feat(docs): add Diataxis folder structure and update sidebar styling

- Create tutorials, how-to, explanation, reference directories with subdirectories
- Add index.md files for each main Diataxis section
- Update homepage with Diataxis card navigation layout
- Implement clean React Native-inspired sidebar styling
- Convert sidebar to autogenerated for both Diataxis and legacy sections
- Update docusaurus config with dark mode default and navbar changes

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): migrate Phase 1 files to Diataxis structure

Move 21 files to new locations:
- Tutorials: quick-start guides, agent creation guide
- How-To: installation, customization, workflows
- Explanation: core concepts, features, game-dev, builder
- Reference: merged glossary from BMM and BMGD

Also:
- Copy images to new locations
- Update internal links via migration script (73 links updated)
- Build verified successfully

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(docs): add category labels for sidebar folders

Add _category_.json files to control display labels and position
for autogenerated sidebar categories.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* style(docs): improve welcome page and visual styling

- Rewrite index.md with React Native-inspired welcoming layout
- Add Diataxis section cards with descriptions
- Remove sidebar separator, add spacing instead
- Increase navbar padding with responsive breakpoints
- Add rounded admonitions without left border bar
- Use system font stack for better readability
- Add lighter chevron styling in sidebar
- Constrain max-width to 1600px for wide viewports

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix: use baseUrl in meta tag paths for correct deployment URLs

* feat(docs): complete Phase 2 - split files and fix broken links

Phase 2 of Diataxis migration:
- Split 16 large legacy files into 42+ focused documents
- Created FAQ section with 7 topic-specific files
- Created brownfield how-to guides (3 files)
- Created workflow how-to guides (15+ files)
- Created architecture explanation files (3 files)
- Created TEA/testing explanation files
- Moved remaining legacy module files to proper Diataxis locations

Link fixes:
- Fixed ~50 broken internal links across documentation
- Updated relative paths for new file locations
- Created missing index files for installation, advanced tutorials
- Simplified TOC anchors to fix Docusaurus warnings

Cleanup:
- Removed legacy sidebar entries for deleted folders
- Deleted duplicate and empty placeholder files
- Moved workflow diagram assets to tutorials/images

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(build): use file glob instead of sidebar parsing for llms-full.txt

Replace brittle sidebar.js regex parsing with recursive file glob.
The old approach captured non-file strings like 'autogenerated' and
category labels, resulting in only 5 files being processed.

Now correctly processes all 86+ markdown files (~95k tokens).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(seo): use absolute URLs in AI meta tags for agent discoverability

AI web-browsing agents couldn't follow relative paths in meta tags due to
URL security restrictions. Changed llms-full.txt and llms.txt meta tag
URLs from relative (baseUrl) to absolute (urlParts.origin + baseUrl).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): recategorize misplaced files per Diataxis analysis

Phase 2.5 categorization fixes based on post-migration analysis:

Moved to correct Diataxis categories:
- tutorials/installation.md → deleted (duplicate of how-to/install-bmad.md)
- tutorials/brownfield-onboarding.md → how-to/brownfield/index.md
- reference/faq/* (8 files) → explanation/faq/
- reference/agents/barry-quick-flow.md → explanation/agents/
- reference/agents/bmgd-agents.md → explanation/game-dev/agents.md

Created:
- explanation/agents/index.md

Fixed all broken internal links (14 total)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): add Getting Started tutorial and simplify build script

- Add comprehensive Getting Started tutorial with installation as Step 1
- Simplify build-docs.js to read directly from docs/ (no consolidation)
- Remove backup/restore dance that could corrupt docs folder on build failure
- Remove ~150 lines of unused consolidation code

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* fix(css): use fixed width layout to prevent content shifting

Apply React Native docs approach: set both width and max-width at
largest breakpoint (1400px) so content area maintains consistent
size regardless of content length. Switches to fluid 100% below
1416px breakpoint.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): restructure tutorials with renamed entry point

- Rename index.md to bmad-tutorial.md for clearer navigation
- Remove redundant tutorials/index.md
- Update sidebar and config references

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): add tutorial style guide and AI agent announcement bar

- Add docs/_contributing/ with tutorial style guide
- Reformat quick-start-bmm.md and bmad-tutorial.md per style guide
- Remove horizontal separators, add strategic admonitions
- Add persistent announcement bar for AI agents directing to llms-full.txt
- Fix footer broken link to tutorials

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): add markdown demo page and UI refinements

- Add comprehensive markdown-demo.md for style testing
- Remove doc category links from navbar (use sidebar instead)
- Remove card buttons from welcome page
- Add dark mode styling for announcement bar
- Clean up index.md card layout

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* feat(docs): apply unified tutorial style and update references

- Reformat create-custom-agent.md to follow tutorial style guide
- Update tutorial-style.md with complete unified structure
- Update all internal references to renamed tutorial files
- Remove obsolete advanced/index.md

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

* refactor(docs): migrate from Docusaurus to Astro+Starlight

Replace Docusaurus with Astro and the Starlight documentation theme
for improved performance, better customization, and modern tooling.

Build pipeline changes:
- New build-docs.js orchestrates link checking, artifact generation,
  and Astro build in sequence
- Add check-doc-links.js for validating internal links and anchors
- Generate llms.txt and llms-full.txt for LLM-friendly documentation
- Create downloadable source bundles (bmad-sources.zip, bmad-prompts.zip)
- Suppress MODULE_TYPELESS_PACKAGE_JSON warning in Astro build
- Output directly to build/site for cleaner deployment

Website architecture:
- Add rehype-markdown-links.js plugin to transform .md links to routes
- Add site-url.js helper for GitHub Pages URL resolution with strict
  validation (throws on invalid GITHUB_REPOSITORY format)
- Custom Astro components: Banner, Header, MobileMenuFooter
- Symlink docs/ into website/src/content/docs for Starlight

Documentation cleanup:
- Remove Docusaurus _category_.json files (Starlight uses frontmatter)
- Convert all docs to use YAML frontmatter with title field
- Move downloads.md from website/src/pages to docs/
- Consolidate style guide and workflow diagram docs
- Add 404.md and tutorials/index.md

---------

Co-authored-by: forcetrainer <bryan@inagaki.us>
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
2026-01-07 14:42:15 +08:00

9.2 KiB

title, description
title description
Getting Started with BMad v6 Alpha Install BMad v6 Alpha and build your first project

Build software faster using AI-powered workflows with specialized agents that guide you through planning, architecture, and implementation.

:::caution[Alpha Software] BMad v6 is currently in alpha. Expect breaking changes, incomplete features, and evolving documentation. For a stable experience, use the BMad v4 tutorial instead. :::

What You'll Learn

  • Install and initialize BMad Method for a new project
  • Choose the right planning track for your project size
  • Progress through phases from requirements to working code
  • Use agents and workflows effectively

:::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] Installnpx bmad-method@alpha 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 Brainstorming, research, product brief (optional)
2 Planning Create requirements (PRD or tech-spec)
3 Solutioning Design architecture (BMad Method/Enterprise only)
4 Implementation Build epic by epic, story by story

BMad Method Workflow - Standard Greenfield

Complete visual flowchart showing all phases, workflows, and agents for the standard greenfield track.

Based on your project's complexity, BMad offers three planning tracks:

Track Best For Documents Created
Quick Flow Bug fixes, simple features, clear scope (1-15 stories) Tech-spec only
BMad Method Products, platforms, complex features (10-50+ stories) PRD + Architecture + UX
Enterprise Compliance, multi-tenant systems (30+ stories) PRD + Architecture + Security + DevOps

:::note Story counts are guidance, not definitions. Choose your track based on planning needs, not story math. :::

Installation

Open a terminal in your project directory and run:

npx bmad-method@alpha install

The interactive installer guides you through setup and creates a _bmad/ folder with all agents and workflows.

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, wait for the menu, then run workflow-init.

:::note[How to Load Agents] Type /<agent-name> in your IDE and use autocomplete. Not sure what's available? Start with /bmad to see all agents and workflows. :::

The workflow asks you to describe your project, whether it's new or existing, and the general complexity. Based on your description, it recommends a planning track.

Once you confirm, the workflow creates bmm-workflow-status.yaml to track your progress through all phases.

:::caution[Fresh Chats] Always start a fresh chat for each workflow. This prevents context limitations from causing issues. :::

Step 2: Create Your Plan

After initialization, work through phases 1-3. Use fresh chats for each workflow.

:::tip[Check Your Status] Unsure what's next? Load any agent and ask for workflow-status. It tells you the next recommended or required workflow. :::

Phase 1: Analysis (Optional)

All workflows in this phase are optional:

  • brainstorm-project — Guided ideation
  • research — Market and technical research
  • product-brief — Recommended foundation document

Phase 2: Planning (Required)

For BMad Method and Enterprise tracks:

  1. Load the PM agent in a new chat
  2. Run the PRD workflow: *prd
  3. Output: PRD.md

For Quick Flow track:

  • Use tech-spec instead of PRD, then skip to implementation

:::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 (BMad Method/Enterprise)

Create Architecture

  1. Load the Architect agent in a new chat
  2. Run create-architecture
  3. Output: Architecture document with technical decisions

Create Epics and Stories

:::tip[V6 Improvement] Epics and stories are now created after architecture. This produces better quality stories because architecture decisions (database, API patterns, tech stack) directly affect how work should be broken down. :::

  1. Load the PM agent in a new chat
  2. Run create-epics-and-stories
  3. The workflow uses both PRD and Architecture to create technically-informed stories

Implementation Readiness Check (Highly Recommended)

  1. Load the Architect agent in a new chat
  2. Run implementation-readiness
  3. Validates cohesion across all planning documents

Step 3: Build Your Project

Once planning is complete, move to implementation. Each workflow should run in a fresh chat.

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 TEA automate Generate guardrail tests (optional)
4 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, Epics & Stories)
  • 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
│   ├── epics/                     # Epic and story files
│   ├── bmm-workflow-status.yaml   # Phase progress tracking
│   └── sprint-status.yaml         # Sprint 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
*create-epics-and-stories PM Break down PRD into epics
*implementation-readiness Architect Validate planning cohesion
*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 always need architecture? Only for BMad Method and Enterprise tracks. Quick Flow skips from tech-spec to implementation.

Can I change my plan later? Yes. The SM agent has a correct-course workflow for handling scope changes.

What if I want to brainstorm first? Load the Analyst agent and run brainstorm-project before workflow-init.

Can I skip workflow-init and workflow-status? Yes, once you learn the flow. Use the Quick Reference to go directly to needed workflows.

Getting Help

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.