4fdabfca0d
Implements comprehensive Text-to-Speech integration for BMAD agents using a generic
TTS_INJECTION marker system. When AgentVibes (or any compatible TTS provider) is
installed, all BMAD agents can speak their responses with unique AI voices.
## Key Features
**Provider-Agnostic Architecture**
- Uses generic `TTS_INJECTION` markers instead of vendor-specific naming
- Future-proof for multiple TTS providers beyond AgentVibes
- Clean separation - BMAD stays TTS-agnostic, providers handle injection
**Installation Flow**
- BMAD → AgentVibes: TTS instructions injected when AgentVibes detects existing BMAD installation
- AgentVibes → BMAD: TTS instructions injected during BMAD installation when AgentVibes detected
- User must manually create voice assignment file when AgentVibes installs first (documented limitation)
**Party Mode Voice Support**
- Each agent speaks with unique assigned voice in multi-agent discussions
- PM, Architect, Developer, Analyst, UX Designer, etc. - all with distinct voices
**Zero Breaking Changes**
- Fully backward compatible - works without any TTS provider
- `TTS_INJECTION` markers are benign HTML comments if not processed
- No changes to existing agent behavior or non-TTS workflows
## Implementation Details
**Files Modified:**
- `tools/cli/installers/lib/core/installer.js` - TTS injection processing logic
- `tools/cli/lib/ui.js` - AgentVibes detection and installation prompts
- `tools/cli/commands/install.js` - Post-install guidance for AgentVibes setup
- `src/utility/models/fragments/activation-rules.xml` - TTS_INJECTION marker for agents
- `src/core/workflows/party-mode/instructions.md` - TTS_INJECTION marker for party mode
**Injection Point System:**
```xml
<rules>
- ALWAYS communicate in {communication_language}
<!-- TTS_INJECTION:agent-tts -->
- Stay in character until exit selected
</rules>
```
When AgentVibes is detected, the installer replaces this marker with:
```
- When responding to user messages, speak your responses using TTS:
Call: `.claude/hooks/bmad-speak.sh '{agent-id}' '{response-text}'` after each response
IMPORTANT: Use single quotes - do NOT escape special characters like ! or $
```
**Special Character Handling:**
- Explicit guidance to use single quotes without escaping
- Prevents "backslash exclamation" artifacts in speech
**User Experience:**
```
User: "How should we architect this feature?"
Architect: [Text response] + 🔊 [Professional voice explains architecture]
```
Party Mode:
```
PM (John): "I'll focus on user value..." 🔊 [Male professional voice]
UX Designer (Sara): "From a user perspective..." 🔊 [Female voice]
Architect (Marcus): "The technical approach..." 🔊 [Male technical voice]
```
## Testing
**Unit Tests:** ✅ 62/62 passing
- 49/49 schema validation tests
- 13/13 installation component tests
**Integration Testing:**
- ✅ BMAD → AgentVibes (automatic injection)
- ✅ AgentVibes → BMAD (automatic injection)
- ✅ No TTS provider (markers remain as comments)
## Documentation
Comprehensive testing guide created with:
- Both installation scenario walkthroughs
- Verification commands and expected outputs
- Troubleshooting guidance
## Known Limitations
**AgentVibes → BMAD Installation Order:**
When AgentVibes installs first, voice assignment file must be created manually:
```bash
mkdir -p .bmad/_cfg
cat > .bmad/_cfg/agent-voice-map.csv << 'EOF'
agent_id,voice_name
pm,en_US-ryan-high
architect,en_US-danny-low
dev,en_US-joe-medium
EOF
```
This limitation exists to prevent false legacy v4 detection warnings from BMAD installer.
**Recommended:** Install BMAD first, then AgentVibes for automatic voice assignment.
## Related Work
**Companion Implementation:**
- Repository: paulpreibisch/AgentVibes
- Commits: 6 commits implementing injection processing and voice routing
- Features: Retroactive injection, file path extraction, escape stripping
**GitHub Issues:**
- paulpreibisch/AgentVibes#36 - BMAD agent ID support
## Breaking Changes
None. Feature is opt-in and requires separate TTS provider installation.
🤖 Generated with [Claude Code](https://claude.com/claude-code)
Co-Authored-By: Claude <noreply@anthropic.com>
|
||
|---|---|---|
| .github | ||
| .husky | ||
| .vscode | ||
| docs | ||
| src | ||
| test | ||
| tools | ||
| .gitignore | ||
| .npmrc | ||
| .nvmrc | ||
| .prettierignore | ||
| CHANGELOG.md | ||
| CONTRIBUTING.md | ||
| LICENSE | ||
| README.md | ||
| eslint.config.mjs | ||
| package-lock.json | ||
| package.json | ||
| prettier.config.mjs | ||
| v6-open-items.md | ||
README.md
BMad CORE + BMad Method
🚨 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! (There is no v5).
Getting Started:
- Install v6 Alpha:
npx bmad-method install- Install stable v4:
npx bmad-method@latest install- Not sure what to do? Load any agent and run
*workflow-initfor 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
- BMad CORE + BMad Method
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_folder}/_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
- Phase 1: Analysis (Optional) - Brainstorming, research, product briefs
- Phase 2: Planning (Required) - Scale-adaptive PRD/tech-spec/GDD
- Phase 3: Solutioning (Track-dependent) - Architecture, (Coming soon: security, DevOps, test strategy)
- 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
- Complete Documentation Hub - Start here for all BMM guides
- Quick Start Guide - Get building in 15 minutes
- Agents Guide - Meet all 12 agents (45 min read)
- 34 Workflow Guides - Complete phase-by-phase reference
- BMM Module Overview - Module structure and quick links
🚀 Quick Start
After installation (see Installation below), choose your path:
Three Planning Tracks:
-
⚡ Quick Flow Track - Bug fixes and small features
- 🐛 Bug fixes in minutes
- ✨ Small features (2-3 related changes)
- 🚀 Rapid prototyping
- → Quick Spec Flow Guide
-
📋 BMad Method Track - Products and platforms
- Complete planning (PRD/GDD)
- Architecture decisions
- Story-centric implementation
- → Complete Quick Start Guide
-
🏢 Brownfield Projects - Add to existing codebases
- Document existing code first
- Then choose Quick Flow or BMad Method
- → Brownfield Guide
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:
- BMB Module Overview - Complete reference
- Create Agent Workflow - Build custom agents
- Create Workflow - Design guided processes
- Create Module - Package complete solutions
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:
- CIS Module Overview - Complete reference
- CIS Workflows Guide - All 5 creative workflows
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:
- Module Selection - Choose BMM, BMB, CIS (or all)
- Configuration - Your name, language preferences, game dev options
- IDE Integration - Automatic setup for your IDE
Installation creates:
your-project/
└── {bmad_folder}/
├── 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:
- Load any agent in your IDE
- Run
*workflow-initto set up your project workflow path - Follow the Quick Start guide above to choose your planning track
Alternative: Web Bundles - Download pre-built agent bundles for use in Claude Projects, ChatGPT, or Gemini without installation (automatically updated on every commit to main)
🎯 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:
Method 1: Agent Menu (Recommended for Beginners)
- Load an agent in your IDE (see IDE-specific instructions)
- Wait for the menu to appear showing available workflows
- 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:
- Start party mode:
/bmad:core:workflows:party-mode - Execute any workflow - the entire team collaborates on it
- 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_folder}/_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}/folder (no scattered files, default folder name is .bmad) - 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
Documentation
Module Documentation:
- BMM Complete Documentation Hub - All BMM guides, FAQs, troubleshooting
- BMB Module Reference - Build custom agents and workflows
- CIS Workflows Guide - Creative facilitation workflows
Customization & Sharing:
- Agent Customization Guide - Customize agent names, personas, and behaviors
- Web Bundles for Gemini & GPT - Use BMad agents in Gemini Gems and Custom GPTs
Additional Resources:
- Documentation Index - All project documentation
- v4 to v6 Upgrade Guide - Migration instructions
- CLI Tool Guide - Installer and build tool reference
- Contributing Guide - How to contribute
Community & Support
- 💬 Discord Community - Get help, share projects (#general-dev, #bugs-issues)
- 🐛 GitHub Issues - Report bugs, request features
- 🎥 YouTube Channel - Video tutorials and walkthroughs
- ⭐ Star this repo - Stay updated on releases
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.
Built with ❤️ for the human-AI collaboration community