-
-
- Complete BMad Method workflow showing all phases, agents, and decision points -
- -## 🚀 Get Started in 3 Steps - -### 1. Install BMad Method +**Prerequisites**: [Node.js](https://nodejs.org) v20+ ```bash -# Install v6 RECOMMENDED npx bmad-method@alpha install ``` -```bash -# Install v4 Legacy (not recommended if starting fresh) -npx bmad-method install -# OR -npx bmad-method@latest 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 XYZ?` -### 2. Initialize Your Project +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. -Load any agent in your IDE and run: +### Simple Path (Quick Flow) -``` -*workflow-init -``` +Bug fixes, small features, clear scope — 3 commands: -This analyzes your project and recommends the right workflow track. +1. `/quick-spec` — analyzes your codebase and produces a tech-spec with stories +2. `/dev-story` — implements each story +3. `/code-review` — validates quality -### 3. Choose Your Track +### Full Planning Path (BMad Method) -BMad Method adapts to your needs with three intelligent tracks: +Products, platforms, complex features — structured planning then build: -| Track | Use For | Planning | Time to Start | -| ----------------- | ------------------------- | ----------------------- | ------------- | -| **⚡ Quick Flow** | Bug fixes, small features | Tech spec only | < 5 minutes | -| **📋 BMad Method** | Products, platforms | PRD + Architecture + UX | < 15 minutes | -| **🏢 Enterprise** | Compliance, scale | Full governance suite | < 30 minutes | +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` -> **Not sure?** Run `*workflow-init` and let BMad analyze your project goal. +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](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/). -## 🔄 How It Works: 4-Phase Methodology +## Modules -BMad Method guides you through a proven development lifecycle: +BMad Method extends with official modules for specialized domains. Modules are available during installation and can be added to your project at any time. -1. **📊 Analysis** (Optional) - Brainstorm, research, and explore solutions -2. **📝 Planning** - Create PRDs, tech specs, or game design documents -3. **🏗️ Solutioning** - Design architecture, UX, and technical approach -4. **⚡ Implementation** - Story-driven development with continuous validation +| Module | GitHub | NPM | Purpose | +| ------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | +| **BMad Method (BMM)** | [bmad-code-org/BMAD-METHOD](https://github.com/bmad-code-org/BMAD-METHOD) | [bmad-method](https://www.npmjs.com/package/bmad-method) | Core framework with 34+ workflows across 4 development phases | +| **BMad Builder (BMB)** | [bmad-code-org/bmad-builder](https://github.com/bmad-code-org/bmad-builder) | [bmad-builder](https://www.npmjs.com/package/bmad-builder) | Create custom BMad agents, workflows, and domain-specific modules | +| **Game Dev Studio (BMGD)** | [bmad-code-org/bmad-module-game-dev-studio](https://github.com/bmad-code-org/bmad-module-game-dev-studio) | [bmad-game-dev-studio](https://www.npmjs.com/package/bmad-game-dev-studio) | Game development workflows for Unity, Unreal, and Godot | +| **Creative Intelligence Suite (CIS)** | [bmad-code-org/bmad-module-creative-intelligence-suite](https://github.com/bmad-code-org/bmad-module-creative-intelligence-suite) | [bmad-creative-intelligence-suite](https://www.npmjs.com/package/bmad-creative-intelligence-suite) | Innovation, brainstorming, design thinking, and problem-solving | -Each phase has specialized workflows and agents working together to deliver exceptional results. +## Documentation -## 🤖 Meet Your Team +**[Full Documentation](http://docs.bmad-method.org)** — Tutorials, how-to guides, concepts, and reference -**12 Specialized Agents** working in concert: - -| Development | Architecture | Product | Leadership | -| ----------- | -------------- | ----------- | ------------ | -| Developer | Architect | PM | Scrum Master | -| UX Designer | Test Architect | Analyst | BMad Master | -| | | Tech Writer | | - -**Test Architect** integrates with `@seontechnologies/playwright-utils` for production-ready web app fixture-based utilities. - -Each agent brings deep expertise and can be customized to match your team's style. - -## 📦 What's Included - -### Official Modules - -- **BMad Method (BMM)** - Complete agile development framework - - 12 specialized agents - - 34 workflows across 4 phases - - Stand Along Quick Spec Flow for a streamlined simple implementation process - - [→ Documentation Hub](http://docs.bmad-method.org/explanation/bmm/) - -- **BMad Builder (BMB)** - Create custom agents and workflows - - Build anything from simple agents to complex modules - - Create domain-specific solutions (legal, medical, finance, education) - - [→ Builder Guide](http://docs.bmad-method.org/explanation/bmad-builder/) - -- **Creative Intelligence Suite (CIS)** - Innovation & problem-solving - - Brainstorming, design thinking, storytelling - - 5 creative facilitation workflows - - [→ Creative Workflows](http://docs.bmad-method.org/explanation/creative-intelligence/) - -### Key Features - -- **🎨 Customizable Agents** - Modify personalities, expertise, and communication styles -- **🌐 Multi-Language Support** - Separate settings for communication and code output -- **📄 Document Sharding** - 90% token savings for large projects -- **🔄 Update-Safe** - Your customizations persist through updates -- **🚀 Web Bundles** - Use in ChatGPT, Claude Projects, or Gemini Gems - -## 📚 Documentation - -### Quick Links - -- **[Quick Start Guide](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/)** - 15-minute introduction -- **[Complete BMM Documentation](http://docs.bmad-method.org/explanation/bmm/)** - All guides and references -- **[Agent Customization](http://docs.bmad-method.org/how-to/customization/customize-agents/)** - Personalize your agents -- **[All Documentation](http://docs.bmad-method.org/)** - Complete documentation index +- [Getting Started Tutorial](http://docs.bmad-method.org/tutorials/getting-started/getting-started-bmadv6/) +- [Upgrading from Previous Versions](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/) ### For v4 Users - **[v4 Documentation](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4/docs)** -- **[v4 to v6 Upgrade Guide](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)** -## 💬 Community & Support +## Community -- **[Discord Community](https://discord.gg/gk8jAdXWmj)** - Get help, share projects -- **[GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues)** - Report bugs, request features -- **[YouTube Channel](https://www.youtube.com/@BMadCode)** - Video tutorials and demos -- **[Web Bundles](https://bmad-code-org.github.io/bmad-bundles/)** - Pre-built agent bundles (Currently not functioning, reworking soon) -- **[Code of Conduct](.github/CODE_OF_CONDUCT.md)** - Community guidelines +- [Discord](https://discord.gg/gk8jAdXWmj) — Get help, share ideas, collaborate +- [YouTube](https://www.youtube.com/@BMadCode) — Tutorials, master class, and podcast (launching Feb 2025) +- [GitHub Issues](https://github.com/bmad-code-org/BMAD-METHOD/issues) — Bug reports and feature requests +- [Discussions](https://github.com/bmad-code-org/BMAD-METHOD/discussions) — Community conversations -## 🛠️ Development +## Support BMad -If you would like to contribute, first check the [CONTRIBUTING.md](CONTRIBUTING.md) for full development guidelines. +BMad is free for everyone — and always will be. If you'd like to support development: -## What's New in v6 +- ⭐ [Star us on GitHub](https://github.com/bmad-code-org/BMAD-METHOD/) — Helps others discover BMad +- 📺 [Subscribe on YouTube](https://www.youtube.com/@BMadCode) — Master class launching Feb 2026 +- ☕ [Buy Me a Coffee](https://buymeacoffee.com/bmad) — Fuel the development +- 🏢 Corporate sponsorship — DM on Discord +- 🎤 Speaking & Media — Available for conferences, podcasts, interviews (Discord) -**v6 represents a complete architectural revolution from v4:** +## Contributing -### 🚀 Major Upgrades +We welcome contributions! See [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines. -- **BMad Core Framework** - Modular architecture enabling custom domain solutions -- **Scale-Adaptive Intelligence** - Automatic adjustment from bug fixes to enterprise -- **Visual Workflows** - Beautiful SVG diagrams showing complete methodology -- **BMad Builder Module** - Create and share your own AI agent teams -- **50+ Workflows** - Up from 20 in v4, covering every development scenario -- **19 Specialized Agents** - Enhanced with customizable personalities and expertise -- **Update-Safe Customization** - Your configs persist through all updates -- **Web Bundles** - Use agents in ChatGPT, Claude, and Gemini -- **Multi-Language Support** - Separate settings for communication and code -- **Document Sharding** - 90% token savings for large projects +## License -### 🔄 For v4 Users - -- **[Comprehensive Upgrade Guide](http://docs.bmad-method.org/how-to/installation/upgrade-to-v6/)** - Step-by-step migration -- **[v4 Documentation Archive](https://github.com/bmad-code-org/BMAD-METHOD/tree/V4)** - Legacy reference -- Backwards compatibility where possible -- Smooth migration path with installer detection - -## 📄 License - -MIT License - See [LICENSE](LICENSE) for details. - -**Trademarks:** BMad™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. - -Supported by:
-
-
-
-
- Built with ❤️ for the human-AI collaboration community -
+[](https://github.com/bmad-code-org/BMAD-METHOD/graphs/contributors) + +See [CONTRIBUTORS.md](CONTRIBUTORS.md) for contributor information. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 00000000..2c565ed1 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,85 @@ +# Security Policy + +## Supported Versions + +We release security patches for the following versions: + +| Version | Supported | +| ------- | ------------------ | +| Latest | :white_check_mark: | +| < Latest | :x: | + +We recommend always using the latest version of BMad Method to ensure you have the most recent security updates. + +## Reporting a Vulnerability + +We take security vulnerabilities seriously. If you discover a security issue, please report it responsibly. + +### How to Report + +**Do NOT report security vulnerabilities through public GitHub issues.** + +Instead, please report them via one of these methods: + +1. **GitHub Security Advisories** (Preferred): Use [GitHub's private vulnerability reporting](https://github.com/bmad-code-org/BMAD-METHOD/security/advisories/new) to submit a confidential report. + +2. **Discord**: Contact a maintainer directly via DM on our [Discord server](https://discord.gg/gk8jAdXWmj). + +### What to Include + +Please include as much of the following information as possible: + +- Type of vulnerability (e.g., prompt injection, path traversal, etc.) +- Full paths of source file(s) related to the vulnerability +- Step-by-step instructions to reproduce the issue +- Proof-of-concept or exploit code (if available) +- Impact assessment of the vulnerability + +### Response Timeline + +- **Initial Response**: Within 48 hours of receiving your report +- **Status Update**: Within 7 days with our assessment +- **Resolution Target**: Critical issues within 30 days; other issues within 90 days + +### What to Expect + +1. We will acknowledge receipt of your report +2. We will investigate and validate the vulnerability +3. We will work on a fix and coordinate disclosure timing with you +4. We will credit you in the security advisory (unless you prefer to remain anonymous) + +## Security Scope + +### In Scope + +- Vulnerabilities in BMad Method core framework code +- Security issues in agent definitions or workflows that could lead to unintended behavior +- Path traversal or file system access issues +- Prompt injection vulnerabilities that bypass intended agent behavior +- Supply chain vulnerabilities in dependencies + +### Out of Scope + +- Security issues in user-created custom agents or modules +- Vulnerabilities in third-party AI providers (Claude, GPT, etc.) +- Issues that require physical access to a user's machine +- Social engineering attacks +- Denial of service attacks that don't exploit a specific vulnerability + +## Security Best Practices for Users + +When using BMad Method: + +1. **Review Agent Outputs**: Always review AI-generated code before executing it +2. **Limit File Access**: Configure your AI IDE to limit file system access where possible +3. **Keep Updated**: Regularly update to the latest version +4. **Validate Dependencies**: Review any dependencies added by generated code +5. **Environment Isolation**: Consider running AI-assisted development in isolated environments + +## Acknowledgments + +We appreciate the security research community's efforts in helping keep BMad Method secure. Contributors who report valid security issues will be acknowledged in our security advisories. + +--- + +Thank you for helping keep BMad Method and our community safe. diff --git a/TRADEMARK.md b/TRADEMARK.md new file mode 100644 index 00000000..e6ae5784 --- /dev/null +++ b/TRADEMARK.md @@ -0,0 +1,55 @@ +# Trademark Notice & Guidelines + +## Trademark Ownership + +The following names and logos are trademarks of BMad Code, LLC: + +- **BMad** (word mark, all casings: BMad, bmad, BMAD) +- **BMad Method** (word mark, includes BMadMethod, BMAD-METHOD, and all variations) +- **BMad Core** (word mark, includes BMadCore, BMAD-CORE, and all variations) +- **BMad Code** (word mark) +- BMad Method logo and visual branding +- The "Build More, Architect Dreams" tagline + +**All casings, stylings, and variations** of the above names (with or without hyphens, spaces, or specific capitalization) are covered by these trademarks. + +These trademarks are protected under trademark law and are **not** licensed under the MIT License. The MIT License applies to the software code only, not to the BMad brand identity. + +## What This Means + +You may: + +- Use the BMad software under the terms of the MIT License +- Refer to BMad to accurately describe compatibility or integration (e.g., "Compatible with BMad Method v6") +- Link to