Documentation Index

Fetch the complete documentation index at: https://mintlify.com/bmad-code-org/BMAD-METHOD/llms.txt

Use this file to discover all available pages before exploring further.

​

Getting Support

​

Quick Help Options

​

AI-Powered Help (Best First Step)

/bmad-help
/bmad-help I just finished the architecture, what do I do next?
/bmad-help How do I start a new project?
/bmad-help What workflows are available?

• What to do next in your workflow
• Available commands and workflows
• Project status and progress
• Optional vs required steps

​

Support Channels

​

Discord Community (Real-Time Help)

• General questions and discussions
• Implementation help and guidance
• Sharing ideas and getting feedback
• Community collaboration
• Quick questions that don’t require long investigation

• #general — General BMad Method discussions
• #bmad-development — Development questions and help
• #showcase — Share your projects and workflows
• #ideas — Suggest features and improvements

​

GitHub Issues (Bug Reports & Features)

• Bug reports
• Feature requests
• Tracking known issues
• Official issue documentation

1. Search existing issues (open and closed)
2. Check GitHub Discussions
3. Review documentation

• Bug Report Template
• Feature Request Template

​

GitHub Discussions

• Open-ended questions
• Community conversations
• Sharing workflows and tips
• Proposing ideas for discussion
• Questions that aren’t bugs or feature requests

​

Documentation Resources

​

Official Documentation

• Getting Started
• Step-by-step guides for beginners

• Installation
• Upgrading
• Non-Interactive Installation
• Specific task instructions

• Understanding BMad architecture
• Agents, workflows, and modules
• Philosophy and methodology

• Complete API reference
• Agent documentation
• Workflow specifications

​

Module-Specific Documentation

• TEA Documentation
• Testing workflows and automation

• BMad Builder GitHub
• Agent and workflow creation

• BMGD GitHub
• Game development workflows

• CIS GitHub
• Innovation and brainstorming

​

Common Issues & Solutions

​

Installation Issues

# Solution: Specify exact version
npx bmad-method@6.0.4 install

# Solution: Check for existing BMAD installations in parent directories
# The installer will refuse if ancestor has BMAD to prevent duplicate autocomplete

# Solution: Recompile agents
npx bmad-method
# Select: "Recompile Agents"

​

Workflow Issues

# Solution: Use bmad-help
/bmad-help What should I do to start a new feature?

# Solution: Check workflow status
/bmad-help workflow status

# Solution: Review project status
/bmad-help What have I completed so far?

​

Configuration Issues

# Solution: Reconfigure core module
npx bmad-method
# Select: "Configure Modules" → "Core"

# Solution: Reinstall with custom content flag
npx bmad-method install --custom-content /path/to/content

​

Troubleshooting Steps

​

1. Check Documentation

• Search the official docs
• Review relevant how-to guides
• Check module-specific documentation

​

2. Use AI Help

/bmad-help [describe your issue]

​

3. Search Existing Issues

• Search GitHub Issues
• Check both open and closed issues
• Review GitHub Discussions

​

4. Ask the Community

• Post in Discord
• Start a GitHub Discussion

​

5. Report a Bug

• Use the bug report template
• Include reproduction steps
• Provide environment details

​

What to Include in Support Requests

​

Environment Information

- BMad version: (run `npx bmad-method --version`)
- IDE: (Claude Code, Cursor, etc.)
- AI Model: (Claude 3.5 Sonnet, GPT-4, etc.)
- OS: (macOS 14.1, Windows 11, Ubuntu 22.04, etc.)
- Node version: (run `node --version`)

​

Issue Details

• What you’re trying to do
• What you expected to happen
• What actually happened
• Steps to reproduce
• Error messages (full text, not screenshots when possible)
• Screenshots (if UI-related)

​

Example Support Request

**Issue:** Workflow-status crashes when checking project status

**Environment:**
- BMad: 6.0.4
- IDE: Claude Code
- Model: Claude 3.5 Sonnet
- OS: macOS 14.1
- Node: v20.10.0

**Steps to reproduce:**
1. Install BMad in new project
2. Run `/bmad-help workflow status`
3. Select "Check current status"

**Expected:** Should show project status
**Actual:** Error: "Cannot read property 'branch' of undefined"

**Error message:**
[paste full error]

​

Response Times

​

Enterprise Support

• Dedicated support
• Custom training
• Priority bug fixes
• Custom module development
• Consulting and implementation

​

Community Resources

​

Video Tutorials

• Getting started videos
• Workflow demonstrations
• Master class content (coming soon)
• Podcast episodes (launching March 1, 2026)

​

Learning Resources

• Tutorials — Step-by-step guides
• How-To Guides — Task-specific instructions
• Glossary — Terms and concepts
• Contributing Guide — How to contribute

​

Giving Feedback

​

Feature Requests

• Submit feature request
• Share ideas in Discord #ideas channel
• Participate in GitHub Discussions

​

Documentation Feedback

• Open documentation issue
• Suggest improvements in Discord
• Submit documentation PRs

​

General Feedback

• Share in Discord #general
• Email: contact@bmadcode.com
• GitHub Discussions

​

Still Need Help?

1. 💬 Join Discord — Most active support channel
2. 🐛 Create GitHub Issue — For bugs and features
3. 💡 Start Discussion — For questions
4. 📧 Email contact@bmadcode.com — For enterprise inquiries