Breakthrough Method for Agile Ai Driven Development
Go to file
Alex Verkhovsky a1101534b2
fix(docs): comprehensive documentation site review fixes (#1578)
* fix(docs): comprehensive documentation site review fixes

Rehype plugins:
- Rewrite rehype-markdown-links for correct relative .md resolution
- Handle raw HTML base paths and bare .md links in rehype-base-paths
- Guard protocol-relative URLs (//...) in all link processors
- Use file.path instead of file.history[0] for vfile compatibility
- Fail build when content directory cannot be detected
- Export helpers for testability; add 107 unit tests

Build & CI:
- Revert cancel-in-progress to false to avoid mid-deploy cancellation
- Remove redundant link-validation CI step (build validates internally)
- Remove unnecessary fetch-depth:0 from docs deploy workflow
- Refuse docs build on Windows (platform guard)
- Remove dead build scripts and stale references

Tooling:
- Add DOCS_ROOT boundary check in validate-doc-links.js
- Handle directory paths and prefix stripping in link validator
- Remove dead regex and add // guard in fix-doc-links.js

Accessibility & CSS:
- Darken caution/danger aside title colors for WCAG AA 4.5:1 contrast
- Fix 100vw scrollbar overflow (banner width:100%, html overflow-x:clip)
- Add :focus-visible ring to banner link for keyboard navigation
- Remove dead CSS declaration and add missing code block lang

Documentation content:
- Convert /docs/ absolute links to relative paths and fix llms.txt URLs
- Correct command file paths and naming in commands reference
- Update stale shard-doc command to current /bmad-shard-doc format
- Fix incomplete sentence in install-bmad.md
- Add Quick Flow next steps and fix 404 link path
- Expand thin content pages with substantive detail
- Add sidebar ordering frontmatter to all content pages
- Remove BMGD docs (moved to dedicated repo)
- Remove unused assets and misleading diagram caption
- Add non-iframe fallback link to workflow map diagram
- Remove dead noscript block from workflow-map
- Standardize BMAD to BMad, fix spelling/grammar, normalize headings

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

* fix(docs): add non-interactive installation to sidebar, rewrite and reorder how-to guides

- Move non-interactive-installation.md into how-to/ directory so it appears
  in the sidebar navigation (was orphaned at docs root)
- Rewrite the page based on editorial review: consolidate redundant sections,
  add missing how-to structure (prerequisites, "What You Get"), condense
  installation modes from 5 subsections to a table, cut speculative examples
- Reorder how-to sidebar: Install (1), Non-Interactive (2), Upgrade to v6 (3),
  then the rest following user journey order
- Fix README link to point to docs site instead of repo-internal markdown path

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

* fix(docs): address documentation review findings

Fix broken directory tree, grammar errors, inconsistent naming,
missing admonition/headings, enable lastUpdated timestamps in CI,
and remove footer CSS that misapplied to the content footer.

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

* fix(docs): move bleeding-edge install command out of Verify Installation

The alternative npx command for installing from main was misplaced
inside the "Verify Installation" section. Move it to a tip admonition
under Step 1 where users look for install options.

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

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
2026-02-08 11:58:22 -06:00
.augment chore: configure dual-mode AI code review (#1511) 2026-02-07 09:17:41 -06:00
.claude/skills fix internal project skills and rename to prefix with bmad-os 2026-02-04 17:04:34 -06:00
.github fix(docs): comprehensive documentation site review fixes (#1578) 2026-02-08 11:58:22 -06:00
.husky docs: fix docs build (#1336) 2026-01-15 16:44:14 -06:00
.vscode excorcise the deamons part 1 - remove dead uneeed artifacts and items no longer being supported beyond beta of the BMM or core - but could return later as a module 2026-02-04 15:44:25 -06:00
docs fix(docs): comprehensive documentation site review fixes (#1578) 2026-02-08 11:58:22 -06:00
src fix: update help task path from bmad-help.md to help.md 2026-02-06 21:27:14 -06:00
test fix(docs): comprehensive documentation site review fixes (#1578) 2026-02-08 11:58:22 -06:00
tools fix(docs): comprehensive documentation site review fixes (#1578) 2026-02-08 11:58:22 -06:00
website fix(docs): comprehensive documentation site review fixes (#1578) 2026-02-08 11:58:22 -06:00
.coderabbit.yaml chore: configure dual-mode AI code review (#1511) 2026-02-07 09:17:41 -06:00
.gitignore chore: configure dual-mode AI code review (#1511) 2026-02-07 09:17:41 -06:00
.markdownlint-cli2.yaml refactor: replace 'execute' with 'Read fully and follow:' in workflow prompts (#1387) 2026-01-23 22:25:19 -06:00
.npmrc fix: resolve npm install peer dependency issues 2026-01-30 15:37:42 +00:00
.nvmrc feat: v6.0.0-alpha.0 - the future is now 2025-09-28 23:17:07 -05:00
.prettierignore folder rename from .bmad to _bmad 2025-12-13 16:22:34 +08:00
CHANGELOG.md Update CHANGELOG for v6.0.0-Beta.7 2026-02-04 22:43:22 -06:00
CNAME Add CNAME file 2026-01-07 18:18:12 +08:00
CONTRIBUTING.md feat: extend Layer 1 file-ref validator to scan CSV workflow-file references (#1573) 2026-02-08 09:19:53 -06:00
CONTRIBUTORS.md project licence, contribution and discord noise updates, along with improved simplified issue templates 2026-01-18 17:03:47 -06:00
LICENSE project licence, contribution and discord noise updates, along with improved simplified issue templates 2026-01-18 17:03:47 -06:00
README.md fix(docs): comprehensive documentation site review fixes (#1578) 2026-02-08 11:58:22 -06:00
SECURITY.md Enhance security policy documentation (#1312) 2026-01-14 16:27:52 -06:00
TRADEMARK.md project licence, contribution and discord noise updates, along with improved simplified issue templates 2026-01-18 17:03:47 -06:00
Wordmark.png feat: update website header with new BMAD Method branding (#1352) 2026-01-18 00:25:12 -06:00
banner-bmad-method.png feat: update website header with new BMAD Method branding (#1352) 2026-01-18 00:25:12 -06:00
eslint.config.mjs fix(docs): comprehensive documentation site review fixes (#1578) 2026-02-08 11:58:22 -06:00
package-lock.json refactor: Complete @clack/prompts Migration & Installer Output Consolidation (#1586) 2026-02-08 00:40:13 -06:00
package.json fix(docs): comprehensive documentation site review fixes (#1578) 2026-02-08 11:58:22 -06:00
prettier.config.mjs feat: v6.0.0-alpha.0 - the future is now 2025-09-28 23:17:07 -05:00

README.md

BMad Method

Version License: MIT Node.js Version Discord

Breakthrough Method of Agile AI Driven Development — An AI-driven agile development framework with 21 specialized agents, 50+ guided workflows, and scale-adaptive intelligence that adjusts from bug fixes to enterprise systems.

100% free and open source. No paywalls. No gated content. No gated Discord. We believe in empowering everyone, not just those who can pay.

Why BMad?

Traditional AI tools do the thinking for you, producing average results. BMad agents and facilitated workflow act as expert collaborators who guide you through a structured process to bring out your best thinking in partnership with the AI.

  • AI Intelligent Help: Brand new for beta - AI assisted help will guide you from the beginning to the end - just ask for /bmad-help after you have installed BMad to your project
  • Scale-Domain-Adaptive: Automatically adjusts planning depth and needs based on project complexity, domain and type - a SaaS Mobile Dating App has different planning needs from a diagnostic medical system, BMad adapts and helps you along the way
  • Structured Workflows: Grounded in agile best practices across analysis, planning, architecture, and implementation
  • Specialized Agents: 12+ domain experts (PM, Architect, Developer, UX, Scrum Master, and more)
  • Party Mode: Bring multiple agent personas into one session to plan, troubleshoot, or discuss your project collaboratively, multiple perspectives with maximum fun
  • Complete Lifecycle: From brainstorming to deployment, BMad is there with you every step of the way

Quick Start

Prerequisites: Node.js v20+

npx bmad-method install

Follow the installer prompts, then open your AI IDE (Claude Code, Cursor, Windsurf, etc.) in the project folder.

Non-Interactive Installation: For CI/CD pipelines or automated deployments, use command-line flags:

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

See Non-Interactive Installation Guide for all available options.

Not sure what to do? Run /bmad-help — it tells you exactly what's next and what's optional. You can also ask it questions like:

  • /bmad-help How should I build a web app for my TShirt Business that can scale to millions?
  • /bmad-help I just finished the architecture, I am not sure what to do next

And the amazing thing is BMad Help evolves depending on what modules you install also!

  • /bmad-help Im interested in really exploring creative ways to demo BMad at work, what do you recommend to help plan a great slide deck and compelling narrative?, and if you have the Creative Intelligence Suite installed, it will offer you different or complimentary advice than if you just have BMad Method Module installed!

The workflows below show the fastest path to working code. You can also load agents directly for a more structured process, extensive planning, or to learn about agile development practices — the agents guide you with menus, explanations, and elicitation at each step.

Simple Path (Quick Flow)

Bug fixes, small features, clear scope — 3 commands - 1 Optional Agent:

  1. /quick-spec — analyzes your codebase and produces a tech-spec with stories
  2. /dev-story — implements each story
  3. /code-review — validates quality

Full Planning Path (BMad Method)

Products, platforms, complex features — structured planning then build:

  1. /product-brief — define problem, users, and MVP scope
  2. /create-prd — full requirements with personas, metrics, and risks
  3. /create-architecture — technical decisions and system design
  4. /create-epics-and-stories — break work into prioritized stories
  5. /sprint-planning — initialize sprint tracking
  6. Repeat per story: /create-story/dev-story/code-review

Every step tells you what's next. Optional phases (brainstorming, research, UX design) are available when you need them — ask /bmad-help anytime. For a detailed walkthrough, see the Getting Started Tutorial.

Modules

BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time. After the V6 beta period these will also be available as Plugins and Granular Skills.

Module GitHub NPM Purpose
BMad Method (BMM) bmad-code-org/BMAD-METHOD bmad-method Core framework with 34+ workflows across 4 development phases
BMad Builder (BMB) bmad-code-org/bmad-builder bmad-builder Create custom BMad agents, workflows, and domain-specific modules
Test Architect (TEA) 🆕 bmad-code-org/tea tea Risk-based test strategy, automation, and release gates (8 workflows)
Game Dev Studio (BMGD) bmad-code-org/bmad-module-game-dev-studio bmad-game-dev-studio Game development workflows for Unity, Unreal, and Godot
Creative Intelligence Suite (CIS) bmad-code-org/bmad-module-creative-intelligence-suite bmad-creative-intelligence-suite Innovation, brainstorming, design thinking, and problem-solving
  • More modules are coming in the next 2 weeks from BMad Official, and a community marketplace for the installer also will be coming with the final V6 release!

Testing Agents

BMad provides two testing options to fit your needs:

Quinn (QA) - Built-in

Quick test automation for rapid coverage

  • Always available in BMM module (no separate install)
  • Simple: One workflow (QA - Automate)
  • Beginner-friendly: Standard test framework patterns
  • Fast: Generate tests and ship

Use Quinn for: Small projects, quick coverage, standard patterns

Test Architect (TEA) - Optional Module

Enterprise-grade test strategy and quality engineering

  • 🆕 Standalone module (install separately)
  • 🏗️ Comprehensive: 8 workflows covering full test lifecycle
  • 🎯 Advanced: Risk-based planning, quality gates, NFR assessment
  • 📚 Knowledge-driven: 34 testing patterns and best practices
  • 📖 Test Architect Documentation

Use TEA for: Enterprise projects, test strategy, compliance, release gates


Documentation

BMad Documentation — Tutorials, how-to guides, concepts, and reference Test Architect Documentation — TEA standalone module documentation

For v4 Users

  • v4 Documentation
  • If you need to install V4, you can do this with npx bmad-method@4.44.3 install - similar for any past version.

Community

Support BMad

BMad is free for everyone — and always will be. If you'd like to support development:

  • Please click the star project icon near the top right of this page
  • Buy Me a Coffee — Fuel the development
  • 🏢 Corporate sponsorship — DM on Discord
  • 🎤 Speaking & Media — Available for conferences, podcasts, interviews (BM on Discord)

Contributing

We welcome contributions! See CONTRIBUTING.md for guidelines.

License

MIT License — see LICENSE for details.


BMad and BMAD-METHOD are trademarks of BMad Code, LLC. See TRADEMARK.md for details.

Contributors

See CONTRIBUTORS.md for contributor information.