ba890779a2
* feat: add cross-file reference validator for CI
Add tools/validate-file-refs.js that validates cross-file references
in BMAD source files (agents, workflows, tasks, steps). Catches broken
file paths, missing referenced files, wrong extensions, and absolute
path leaks before they reach users.
Addresses broken-file-ref and path-handling bug classes which account
for 25% of all historical bugs (59 closed issues, 129+ comments).
- Scans src/ for YAML, markdown, and XML files
- Validates {project-root}/_bmad/ references against source tree
- Checks relative path references, exec attributes, invoke-task tags
- Detects absolute path leaks (/Users/, /home/, C:\)
- Adds validate:refs npm script and CI step in quality.yaml
* feat: strip JSON example blocks to reduce false-positive broken refs
Add stripJsonExampleBlocks() to the markdown reference extractor so
bare JSON example/template blocks (braces on their own lines) are
removed before pattern matching. This prevents paths inside example
data from being flagged as broken references.
* feat: add line numbers, fix utility/ path mapping, improve verbose output
- Add utility/ to direct path mapping (was incorrectly falling through
to src/modules/utility/)
- Show line numbers for broken references in markdown files
- Show YAML key path for broken references in YAML files
- Print file headers in verbose mode for all files with refs
* fix: correct verbose [OK]/[BROKEN] overlap and line number drift
Broken refs no longer print [OK] before [BROKEN] in --verbose mode.
Code block stripping now preserves newlines so offsetToLine() reports
accurate line numbers when code blocks precede broken references.
* fix: address review feedback, add CI annotations and step summary
Address alexeyv's review findings on PR #1494:
- Fix exec-attr prefix handling for {_bmad}/ and bare _bmad/ paths
- Fix mapInstalledToSource fallback (remove phantom src/modules/ mapping)
- Switch extractYamlRefs to parseDocument() for YAML line numbers
Add CI integration (stories 2-1, 2-2):
- Emit ::warning annotations for broken refs and abs-path leaks
- Write markdown table to $GITHUB_STEP_SUMMARY
- Guard both behind environment variable checks
Harden CI output:
- escapeAnnotation() encodes %, \r, \n per GitHub Actions spec
- escapeTableCell() escapes pipe chars in step summary table
---------
Co-authored-by: Alex Verkhovsky <alexey.verkhovsky@gmail.com>
Co-authored-by: Brian <bmadcode@gmail.com>
|
||
|---|---|---|
| .claude/skills | ||
| .github | ||
| .husky | ||
| .vscode | ||
| docs | ||
| src | ||
| test | ||
| tools | ||
| website | ||
| .coderabbit.yaml | ||
| .gitignore | ||
| .markdownlint-cli2.yaml | ||
| .npmrc | ||
| .nvmrc | ||
| .prettierignore | ||
| CHANGELOG.md | ||
| CNAME | ||
| CONTRIBUTING.md | ||
| CONTRIBUTORS.md | ||
| LICENSE | ||
| README.md | ||
| SECURITY.md | ||
| TRADEMARK.md | ||
| Wordmark.png | ||
| banner-bmad-method.png | ||
| eslint.config.mjs | ||
| package-lock.json | ||
| package.json | ||
| prettier.config.mjs | ||
README.md
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-helpafter 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.
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:
/quick-spec— analyzes your codebase and produces a tech-spec with stories/dev-story— implements each story/code-review— validates quality
Full Planning Path (BMad Method)
Products, platforms, complex features — structured planning then build:
/product-brief— define problem, users, and MVP scope/create-prd— full requirements with personas, metrics, and risks/create-architecture— technical decisions and system design/create-epics-and-stories— break work into prioritized stories/sprint-planning— initialize sprint tracking- 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
- Getting Started Tutorial
- Upgrading from Previous Versions
- Test Architect Migration Guide — Upgrading from BMM-embedded TEA
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
- Discord — Get help, share ideas, collaborate
- Subscribe on YouTube — Tutorials, master class, and podcast (launching Feb 2025)
- GitHub Issues — Bug reports and feature requests
- Discussions — Community conversations
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.
See CONTRIBUTORS.md for contributor information.