Breakthrough Method for Agile Ai Driven Development
Go to file
Brian Madison 2d99833b9e feat: Add documentation guides, simplify folder structure, and major workflow refactoring
Created two comprehensive guides for v6 features:

**docs/agent-customization-guide.md**
- Complete guide for customizing agent names, personas, memories, and behaviors
- Update-safe customization via bmad/_cfg/agents/ configuration files
- Real-world examples (TDD setup, multilingual agents, custom workflows)
- Troubleshooting and best practices

**docs/web-bundles-gemini-gpt-guide.md**
- Comprehensive guide for using BMad agents in Gemini Gems and Custom GPTs
- Critical setup rules with exact configuration text required
- Cost-saving strategy: web planning → local implementation (60-80% savings)
- Platform comparison (Gemini Gems strongly recommended over Custom GPTs)
- Complete workflow examples showing full planning-to-implementation cycle
- Team bundle guidance (Gemini 2.5 Pro+ only)

**README.md updates**
- Added prominent links in v6 Core Enhancements section
- Created new "Customization & Sharing" documentation category
- Web Bundles feature highlighted with direct guide link

**Unified output folder structure across all modules:**

**Before (confusing):**
- output_folder: Main docs
- game_design_docs: Separate design folder
- tech_docs: Separate technical folder
- dev_ephemeral_location: Separate ephemeral folder outside docs

**After (simplified):**
- output_folder: Single location for ALL AI-generated artifacts (default: "docs")
  - Clearer prompt: "Where should AI Generated Artifacts be saved?"
- sprint_artifacts: Phase 4 ephemeral content now WITHIN output_folder
  - BMM: {output_folder}/stories (stories, context, reports)
  - BMGD: {output_folder}/sprint-artifacts
  - No longer in separate {bmad_folder}-ephemeral location

**Benefits:**
- One clear location for all planning artifacts (PRD, Architecture, UX, etc.)
- Phase 4 ephemeral items logically grouped within output folder
- Eliminated confusing separate folder proliferation
- sprint_artifacts now configurable per module

**Files changed:**
- src/core/_module-installer/install-config.yaml
- src/modules/bmm/_module-installer/install-config.yaml
- src/modules/bmgd/_module-installer/install-config.yaml

**Also cleaned up BMGD config:**
- Renamed: specified_framework → primary_platform (clearer naming)
- Removed: unused data_path variable

Replaced old "project_level" (0-4) system with new "selected_track" terminology:
- **quick-flow**: Bug fixes and small features (replaces Level 0-1)
- **bmad-method**: Full planning track (replaces Level 2-3)
- **enterprise-bmad-method**: Extended planning (replaces Level 4)

**Core workflow updates:**
- solutioning-gate-check: Complete rewrite of validation logic for track-based artifacts
- architecture: Updated context detection, error handling, and messaging for tracks
- workflow-init: Updated artifact detection patterns for track-based paths
- All workflow status paths updated (method-greenfield, method-brownfield, enterprise-*)

Unified variable naming conventions across all workflows:
- {output_folder} → {output-folder} (hyphenated format)
- {dev_ephemeral_location} → {sprint_artifacts} (clearer purpose)
- Hardcoded status file paths → {workflow_status_file} variable

Fixed corrupted variable patterns throughout workflow files:
- {output*folder} → {output-folder}
- {ephemeral*location} → {sprint_artifacts}
- \_prd* → *prd* (escaped underscore artifacts)
- **\*\***\_\_\_**\*\*** → proper field placeholders

Affected patterns included malformed glob patterns, template variables, and markdown formatting artifacts from previous edits.

**Architecture workflow (create-architecture):**
- Fixed: "Decision Architecture" → "Create Architecture" (consistent naming)
- Improved PRD not found handling with exit/continue options
- Better user guidance when running standalone vs. within workflow path
- Removed hardcoded Level checks, now track-aware
- Enhanced validation checklist formatting (□ → - [])
- Typo fixes: "mulitple" → "multiple"

**Solutioning gate check:**
- Complete validation logic rewrite for track-based system
- Removed Level-specific artifact expectations
- Simplified document discovery (track determines what exists)
- Better analysis prompts and user feedback

**Workflow-init:**
- Updated artifact detection patterns for new folder structure
- Fixed corrupt glob patterns throughout
- Better sprint_artifacts location detection
- Improved workflow path assignment logic

**Various workflows:**
- Consistent variable naming across 40+ workflow files
- Improved error messages and user guidance
- Better markdown formatting (checkboxes, lists)
- Removed redundant validation criteria files (now inline)

Removed duplicate BMGD 4-production workflows (12 workflows):
- code-review, correct-course, create-story, dev-story
- epic-tech-context, retrospective, sprint-planning
- story-context, story-done, story-ready

**Why:** BMGD now uses shared BMM Phase 4 implementation workflows
**Benefit:** Single source of truth, no duplication to maintain

Also removed:
- validation-criteria.yaml (validation now inline in instructions)
- architecture-patterns.yaml references (patterns now managed differently)
- AUDIT-REPORT.md files (stale audit artifacts)

**BMB workflows:**
- Updated checklists for workflow and module creation
- Improved agent architecture documentation
- Minor instruction clarifications

**Core brainstorming workflow:**
- Updated README with usage examples
- Enhanced instructions and template clarity
- Better integration with other modules

**BMM installer:**
- Updated for track-based system
- sprint_artifacts configuration

**Tech Writer agent:**
- Minor configuration update for documentation workflows

Removed 200+ files that should not be in repository:
- Installed agent markdown files (analyst, architect, dev, pm, sm, tea, etc.)
- Complete workflow instruction copies
- Documentation duplicates (quick-start, agents-guide, workflows-*)
- Test architecture knowledge base (22 files, 14,000+ lines)
- Configuration files (config.yaml, team definitions)

These are generated during installation and should not be version controlled.

Removed 21 pre-generated XML bundles:
- BMM agents (analyst, architect, dev, pm, sm, tea, tech-writer, ux-designer)
- BMGD agents (game-architect, game-designer, game-dev, game-scrum-master)
- CIS agents (brainstorming-coach, creative-problem-solver, etc.)
- Team bundles (team-fullstack, team-gamedev, creative-squad)

**Why:** Users should generate fresh bundles via `npm run bundle` to get latest changes and customizations.

- **2 new documentation files** (comprehensive guides)
- **98 source files modified** (299 insertions, 6,567 deletions)
- **3 installer config files simplified** (major folder structure improvement)
- **200+ .bmad/ artifacts removed** (should not be in repo)
- **21 web-bundle files removed** (users regenerate as needed)
- **12 duplicate workflows removed** (BMGD consolidation)
- **40+ workflows updated** (track system, variable standardization, corruption fixes)
2025-11-11 17:30:43 -06:00
.bmad feat: Add documentation guides, simplify folder structure, and major workflow refactoring 2025-11-11 17:30:43 -06:00
.claude/commands/bmad Major Enhancements: 2025-11-09 17:39:05 -06:00
.github chore: fixed directory browsing + zip Downloads (#902) 2025-11-11 16:48:03 -06:00
.husky chore: added CC PR review (#871) 2025-11-05 14:14:31 -06:00
.vscode Major Enhancements: 2025-11-09 17:39:05 -06:00
docs feat: Add documentation guides, simplify folder structure, and major workflow refactoring 2025-11-11 17:30:43 -06:00
src feat: Add documentation guides, simplify folder structure, and major workflow refactoring 2025-11-11 17:30:43 -06:00
test Major Enhancements: 2025-11-09 17:39:05 -06:00
tools agents now are not duplicated and isntead cli commmands load from installed agent files 2025-11-09 20:24:56 -06:00
.gitignore chore: github pages for web bundle (#898) 2025-11-11 13:35:30 -06:00
.npmrc feat: v6.0.0-alpha.0 - the future is now 2025-09-28 23:17:07 -05:00
.nvmrc feat: v6.0.0-alpha.0 - the future is now 2025-09-28 23:17:07 -05:00
.prettierignore feat: add agent schema validation with comprehensive testing (#774) 2025-10-20 07:14:50 -05:00
CHANGELOG.md release: bump to v6.0.0-alpha.5 2025-11-04 00:15:34 -06:00
CONTRIBUTING.md release: bump to v6.0.0-alpha.6 2025-11-04 22:28:28 -06:00
LICENSE feat: v6.0.0-alpha.0 - the future is now 2025-09-28 23:17:07 -05:00
README.md feat: Add documentation guides, simplify folder structure, and major workflow refactoring 2025-11-11 17:30:43 -06:00
eslint.config.mjs feat: add agent schema validation with comprehensive testing (#774) 2025-10-20 07:14:50 -05:00
package-lock.json chore: added CC PR review (#871) 2025-11-05 14:14:31 -06:00
package.json Release v6.0.0-alpha.8 2025-11-09 23:24:25 -06:00
prettier.config.mjs feat: v6.0.0-alpha.0 - the future is now 2025-09-28 23:17:07 -05:00
v6-open-items.md fix: Add missing adv-elicit-methods.csv to workflow bundles 2025-11-07 00:38:28 -06:00

README.md

BMad CORE + BMad Method

Stable Version Alpha Version License: MIT Node.js Version Discord

🚨 Alpha Version Notice

v6-alpha is near-beta quality—stable and vastly improved over v4, but documentation is still being refined. New videos coming soon to the BMadCode YouTube channel—subscribe for updates!

Getting Started:

  • Install v6 Alpha: npx bmad-method@alpha install
  • Install stable v4: npx bmad-method install
  • Not sure what to do? Load any agent and run *workflow-init for guided setup
  • v4 Users: View v4 documentation or upgrade guide

Universal Human-AI Collaboration Platform

BMad-CORE (Collaboration Optimized Reflection Engine) amplifies human potential through specialized AI agents. Unlike tools that replace thinking, BMad-CORE guides reflective workflows that bring out your best ideas and AI's full capabilities.

The BMad-CORE powers the BMad Method (probably why you're here!), but you can also use BMad Builder to create custom agents, workflows, and modules for any domain—software development, business strategy, creativity, learning, and more.

🎯 Human Amplification🎨 Domain Agnostic Agent-Powered

Table of Contents


What is BMad-CORE?

Foundation framework powering all BMad modules:

  • Agent Orchestration - Specialized AI personas with domain expertise
  • Workflow Engine - Guided multi-step processes with built-in best practices
  • Modular Architecture - Extend with domain-specific modules (BMM, BMB, CIS, custom)
  • IDE Integration - Works with Claude Code, Cursor, Windsurf, VS Code, and more
  • Update-Safe Customization - Your configs persist through all updates

v6 Core Enhancements

  • 🎨 Agent Customization - Modify names, roles, personalities via bmad/_cfg/agents/ → Customization Guide
  • 🌐 Multi-Language - Independent language settings for communication and output
  • 👤 Personalization - Agents adapt to your name, skill level, and preferences
  • 🔄 Persistent Config - Customizations survive module updates
  • ⚙️ Flexible Settings - Configure per-module or globally
  • 📦 Web Bundles - Share agents in Gemini Gems and Custom GPTs → Web Bundles Guide

C.O.R.E. Philosophy

  • Collaboration: Human-AI partnership leveraging complementary strengths
  • Optimized: Battle-tested processes for maximum effectiveness
  • Reflection: Strategic questioning that unlocks breakthrough solutions
  • Engine: Framework orchestrating 19+ specialized agents and 50+ workflows

BMad-CORE doesn't give you answers—it helps you discover better solutions through guided reflection.

Modules

BMad Method (BMM) - AI-Driven Agile Development

Revolutionary AI-driven agile framework for software and game development. Automatically adapts from single bug fixes to enterprise-scale systems.

v6 Highlights

🎯 Scale-Adaptive Intelligence (3 Planning Tracks)

Automatically adjusts planning depth and documentation based on project needs:

  • Quick Flow Track: Fast implementation (tech-spec only) - bug fixes, small features, clear scope
  • BMad Method Track: Full planning (PRD + Architecture + UX) - products, platforms, complex features
  • Enterprise Method Track: Extended planning (BMad Method + Security/DevOps/Test) - enterprise requirements, compliance

🏗️ Four-Phase Methodology

  1. Phase 1: Analysis (Optional) - Brainstorming, research, product briefs
  2. Phase 2: Planning (Required) - Scale-adaptive PRD/tech-spec/GDD
  3. Phase 3: Solutioning (Track-dependent) - Architecture, (Coming soon: security, DevOps, test strategy)
  4. Phase 4: Implementation (Iterative) - Story-centric development with just-in-time context

🤖 12 Specialized Agents

PM • Analyst • Architect • Scrum Master • Developer • Test Architect (TEA) • UX Designer • Technical Writer • Game Designer • Game Developer • Game Architect • BMad Master (Orchestrator)

📚 Documentation


🚀 Quick Start

After installation (see Installation below), choose your path:

Three Planning Tracks:

  1. Quick Flow Track - Bug fixes and small features

  2. 📋 BMad Method Track - Products and platforms

  3. 🏢 Brownfield Projects - Add to existing codebases

Not sure which path? Run *workflow-init and let BMM analyze your project goal and recommend the right track.

📚 Learn More: Scale Adaptive System - How BMM adapts across three planning tracks


BMad Builder (BMB) - Create Custom Solutions

Build your own agents, workflows, and modules using the BMad-CORE framework.

What You Can Build:

  • Custom Agents - Domain experts with specialized knowledge
  • Guided Workflows - Multi-step processes for any task
  • Complete Modules - Full solutions for specific domains
  • Three Agent Types - Full module, hybrid, or standalone

Perfect For: Creating domain-specific solutions (legal, medical, finance, education, creative, etc.) or extending BMM with custom development workflows.

Documentation:

Creative Intelligence Suite (CIS) - Innovation & Creativity

AI-powered creative facilitation using proven methodologies and techniques.

5 Interactive Workflows:

  • Brainstorming - Generate and refine ideas with 30+ techniques
  • Design Thinking - Human-centered problem solving
  • Problem Solving - Systematic breakthrough techniques
  • Innovation Strategy - Disruptive business model thinking
  • Storytelling - Compelling narrative frameworks

5 Specialized Agents: Each with unique facilitation styles and domain expertise

Shared Resource: CIS workflows are used by other modules (BMM's brainstorm-project uses CIS brainstorming)

Documentation:


Installation

Prerequisites: Node.js v20+ (Download)

# v6 Alpha (recommended for new projects)
npx bmad-method@alpha install

# Stable v4 (production)
npx bmad-method install

The installer provides:

  1. Module Selection - Choose BMM, BMB, CIS (or all)
  2. Configuration - Your name, language preferences, game dev options
  3. IDE Integration - Automatic setup for your IDE

Installation creates:

your-project/
└── bmad/
    ├── core/         # Core framework + BMad Master agent
    ├── bmm/          # BMad Method (12 agents, 34 workflows)
    ├── bmb/          # BMad Builder (1 agent, 7 workflows)
    ├── cis/          # Creative Intelligence (5 agents, 5 workflows)
    └── _cfg/         # Your customizations (survives updates)
        └── agents/   # Agent customization files

Next Steps:

  1. Load any agent in your IDE
  2. Run *workflow-init to set up your project workflow path
  3. Follow the Quick Start guide above to choose your planning track

Alternative: Web Bundles - Use BMAD agents in Claude Projects, ChatGPT, or Gemini without installation


🎯 Working with Agents & Commands

Multiple Ways to Execute Workflows:

BMad is flexible - you can execute workflows in several ways depending on your preference and IDE:

  1. Load an agent in your IDE (see IDE-specific instructions)
  2. Wait for the menu to appear showing available workflows
  3. Tell the agent what to run using natural language or shortcuts:
    • Natural: "Run workflow-init"
    • Shortcut: *workflow-init
    • Menu number: "Run option 2"

Method 2: Direct Slash Commands

Execute workflows directly using slash commands:

/bmad:bmm:workflows:workflow-init
/bmad:bmm:workflows:prd
/bmad:bmm:workflows:dev-story

Tip: While you can run these without loading an agent first, loading an agent is still recommended - it can make a difference with certain workflows.

Benefits:

  • Mix and match any agent with any workflow
  • Run workflows not in the loaded agent's menu
  • Faster access for experienced users who know the command names

Method 3: Party Mode Execution

Run workflows with multi-agent collaboration:

  1. Start party mode: /bmad:core:workflows:party-mode
  2. Execute any workflow - the entire team collaborates on it
  3. Get diverse perspectives from multiple specialized agents

Perfect for: Strategic decisions, complex workflows, cross-functional tasks


📌 IDE-Specific Note:

Slash command format varies by IDE:

  • Claude Code: /bmad:bmm:workflows:prd
  • Cursor/Windsurf: May use different syntax - check your IDE's documentation
  • VS Code with Copilot Chat: Syntax may differ

See IDE Integration Guides for your specific IDE's command format.


Key Features

🎨 Update-Safe Customization

Modify agents without touching core files:

  • Override agent names, personalities, expertise via bmad/_cfg/agents/
  • Customizations persist through all updates
  • Multi-language support (communication + output)
  • Module-level or global configuration

🚀 Intelligent Installation

Smart setup that adapts to your environment:

  • Auto-detects v4 installations for smooth upgrades
  • Configures IDE integrations (Claude Code, Cursor, Windsurf, VS Code)
  • Resolves cross-module dependencies
  • Generates unified agent/workflow manifests

📁 Clean Architecture

Everything in one place:

  • Single bmad/ folder (no scattered files)
  • Modules live side-by-side (core, bmm, bmb, cis)
  • Your configs in _cfg/ (survives updates)
  • Easy to version control or exclude

📄 Document Sharding (Advanced)

Optional optimization for large projects (BMad Method and Enterprise tracks):

  • Massive Token Savings - Phase 4 workflows load only needed sections (90%+ reduction)
  • Automatic Support - All workflows handle whole or sharded documents seamlessly
  • Easy Setup - Built-in tool splits documents by headings
  • Smart Discovery - Workflows auto-detect format

→ Document Sharding Guide


Documentation

Module Documentation:

Customization & Sharing:

Additional Resources:


Community & Support


Development & Quality Checks

For contributors working on the BMAD codebase:

Requirements: Node.js 22+ (see .nvmrc). Run nvm use to switch to the correct version.

Testing & Validation

# Run all quality checks (comprehensive - use before pushing)
npm test

# Individual test suites
npm run test:schemas     # Agent schema validation (fixture-based)
npm run test:install     # Installation component tests (compilation)
npm run validate:schemas # YAML schema validation
npm run validate:bundles # Web bundle integrity

Code Quality

# Lint check
npm run lint

# Auto-fix linting issues
npm run lint:fix

# Format check
npm run format:check

# Auto-format all files
npm run format:fix

Build & Development

# Bundle for web deployment
npm run bundle

# Test local installation
npm run install:bmad

Pre-commit Hook: Auto-fixes changed files (lint-staged) + validates everything (npm test) CI: GitHub Actions runs all quality checks in parallel on every PR


Contributing

We welcome contributions! See CONTRIBUTING.md for:

  • Code contribution guidelines
  • Documentation improvements
  • Module development
  • Issue reporting

License

MIT License - See LICENSE for details

Trademarks: BMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC.


Contributors

Built with ❤️ for the human-AI collaboration community