{"id":30216179,"url":"https://github.com/bmad-code-org/BMAD-METHOD","last_synced_at":"2025-08-14T03:03:13.558Z","repository":{"id":297147787,"uuid":"965615190","full_name":"bmad-code-org/BMAD-METHOD","owner":"bmad-code-org","description":"Breakthrough Method for Agile Ai Driven Development","archived":false,"fork":false,"pushed_at":"2025-08-09T20:49:44.000Z","size":5798,"stargazers_count":8240,"open_issues_count":28,"forks_count":1434,"subscribers_count":174,"default_branch":"main","last_synced_at":"2025-08-09T22:14:12.891Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bmad-code-org.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":".github/FUNDING.yaml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":null,"open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"lfx_crowdfunding":null,"polar":null,"buy_me_a_coffee":"bmad","thanks_dev":null,"custom":null}},"created_at":"2025-04-13T14:54:25.000Z","updated_at":"2025-08-09T22:04:36.000Z","dependencies_parsed_at":"2025-06-04T09:55:53.083Z","dependency_job_id":"f40e6518-83d5-4977-9e1d-ed6b6b18f2d1","html_url":"https://github.com/bmad-code-org/BMAD-METHOD","commit_stats":null,"previous_names":["bmadcode/bmad-method","bmad-code-org/bmad-method"],"tags_count":89,"template":false,"template_full_name":null,"purl":"pkg:github/bmad-code-org/BMAD-METHOD","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmad-code-org%2FBMAD-METHOD","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmad-code-org%2FBMAD-METHOD/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmad-code-org%2FBMAD-METHOD/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmad-code-org%2FBMAD-METHOD/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bmad-code-org","download_url":"https://codeload.github.com/bmad-code-org/BMAD-METHOD/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bmad-code-org%2FBMAD-METHOD/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":270353322,"owners_count":24569521,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-14T02:00:10.309Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-14T03:01:20.603Z","updated_at":"2025-08-14T03:03:13.490Z","avatar_url":"https://github.com/bmad-code-org.png","language":"JavaScript","funding_links":["https://buymeacoffee.com/bmad"],"categories":["JavaScript","🙏 Acknowledgments","others","Extensions, Skills \u0026 Rules","Spec-Driven Development","🧠 Workflow Systems \u0026 Spec-Driven Development","🤖 AI Agents"],"sub_categories":["What We're Looking For","Methodologies \u0026 Spec-Driven Workflows","Commercial Offering"],"readme":"# BMad-Method: Universal AI Agent Framework\n\n[![Version](https://img.shields.io/npm/v/bmad-method?color=blue\u0026label=version)](https://www.npmjs.com/package/bmad-method)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)\n[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org)\n[![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord\u0026logoColor=white)](https://discord.gg/gk8jAdXWmj)\n\nFoundations in Agentic Agile Driven Development, known as the Breakthrough Method of Agile AI-Driven Development, yet so much more. Transform any domain with specialized AI expertise: software development, entertainment, creative writing, business strategy to personal wellness just to name a few.\n\n**[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)**\n\n**[Join our Discord Community](https://discord.gg/gk8jAdXWmj)** - A growing community for AI enthusiasts! Get help, share ideas, explore AI agents \u0026 frameworks, collaborate on tech projects, enjoy hobbies, and help each other succeed. Whether you're stuck on BMad, building your own agents, or just want to chat about the latest in AI - we're here for you! **Some mobile and VPN may have issue joining the discord, this is a discord issue - if the invite does not work, try from your own internet or another network, or non-VPN.**\n\n⭐ **If you find this project helpful or useful, please give it a star in the upper right hand corner!** It helps others discover BMad-Method and you will be notified of updates!\n\n## Overview\n\n**BMad Method's Two Key Innovations:**\n\n**1. Agentic Planning:** Dedicated agents (Analyst, PM, Architect) collaborate with you to create detailed, consistent PRDs and Architecture documents. Through advanced prompt engineering and human-in-the-loop refinement, these planning agents produce comprehensive specifications that go far beyond generic AI task generation.\n\n**2. Context-Engineered Development:** The Scrum Master agent then transforms these detailed plans into hyper-detailed development stories that contain everything the Dev agent needs - full context, implementation details, and architectural guidance embedded directly in story files.\n\nThis two-phase approach eliminates both **planning inconsistency** and **context loss** - the biggest problems in AI-assisted development. Your Dev agent opens a story file with complete understanding of what to build, how to build it, and why.\n\n**📖 [See the complete workflow in the User Guide](docs/user-guide.md)** - Planning phase, development cycle, and all agent roles\n\n## Quick Navigation\n\n### Understanding the BMad Workflow\n\n**Before diving in, review these critical workflow diagrams that explain how BMad works:**\n\n1. **[Planning Workflow (Web UI)](docs/user-guide.md#the-planning-workflow-web-ui)** - How to create PRD and Architecture documents\n2. **[Core Development Cycle (IDE)](docs/user-guide.md#the-core-development-cycle-ide)** - How SM, Dev, and QA agents collaborate through story files\n\n\u003e ⚠️ **These diagrams explain 90% of BMad Method Agentic Agile flow confusion** - Understanding the PRD+Architecture creation and the SM/Dev/QA workflow and how agents pass notes through story files is essential - and also explains why this is NOT taskmaster or just a simple task runner!\n\n### What would you like to do?\n\n- **[Install and Build software with Full Stack Agile AI Team](#quick-start)** → Quick Start Instruction\n- **[Learn how to use BMad](docs/user-guide.md)** → Complete user guide and walkthrough\n- **[See available AI agents](/bmad-core/agents))** → Specialized roles for your team\n- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education\n- **[Create my own AI agents](docs/expansion-packs.md)** → Build agents for your domain\n- **[Browse ready-made expansion packs](expansion-packs/)** → Game dev, DevOps, infrastructure and get inspired with ideas and examples\n- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive\n- **[Join the community](https://discord.gg/gk8jAdXWmj)** → Get help and share ideas\n\n## Important: Keep Your BMad Installation Updated\n\n**Stay up-to-date effortlessly!** If you already have BMad-Method installed in your project, simply run:\n\n```bash\nnpx bmad-method install\n# OR\ngit pull\nnpm run install:bmad\n```\n\nThis will:\n\n- ✅ Automatically detect your existing v4 installation\n- ✅ Update only the files that have changed and add new files\n- ✅ Create `.bak` backup files for any custom modifications you've made\n- ✅ Preserve your project-specific configurations\n\nThis makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!\n\n## Quick Start\n\n### One Command for Everything (IDE Installation)\n\n**Just run one of these commands:**\n\n```bash\nnpx bmad-method install\n# OR if you already have BMad installed:\ngit pull\nnpm run install:bmad\n```\n\nThis single command handles:\n\n- **New installations** - Sets up BMad in your project\n- **Upgrades** - Updates existing installations automatically\n- **Expansion packs** - Installs any expansion packs you've added to package.json\n\n\u003e **That's it!** Whether you're installing for the first time, upgrading, or adding expansion packs - these commands do everything.\n\n**Prerequisites**: [Node.js](https://nodejs.org) v20+ required\n\n### Fastest Start: Web UI Full Stack Team at your disposal (2 minutes)\n\n1. **Get the bundle**: Save or clone the [full stack team file](dist/teams/team-fullstack.txt) or choose another team\n2. **Create AI agent**: Create a new Gemini Gem or CustomGPT\n3. **Upload \u0026 configure**: Upload the file and set instructions: \"Your critical operating instructions are attached, do not break character as directed\"\n4. **Start Ideating and Planning**: Start chatting! Type `*help` to see available commands or pick an agent like `*analyst` to start right in on creating a brief.\n5. **CRITICAL**: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!\n6. **When to move to the IDE**: Once you have your PRD, Architecture, optional UX and Briefs - its time to switch over to the IDE to shard your docs, and start implementing the actual code! See the [User guide](docs/user-guide.md) for more details\n\n### Alternative: Clone and Build\n\n```bash\ngit clone https://github.com/bmadcode/bmad-method.git\nnpm run install:bmad # build and install all to a destination folder\n```\n\n## 🌟 Beyond Software Development - Expansion Packs\n\nBMad's natural language framework works in ANY domain. Expansion packs provide specialized AI agents for creative writing, business strategy, health \u0026 wellness, education, and more. Also expansion packs can expand the core BMad-Method with specific functionality that is not generic for all cases. [See the Expansion Packs Guide](docs/expansion-packs.md) and learn to create your own!\n\n## Codebase Flattener Tool\n\nThe BMad-Method includes a powerful codebase flattener tool designed to prepare your project files for AI model consumption. This tool aggregates your entire codebase into a single XML file, making it easy to share your project context with AI assistants for analysis, debugging, or development assistance.\n\n### Features\n\n- **AI-Optimized Output**: Generates clean XML format specifically designed for AI model consumption\n- **Smart Filtering**: Automatically respects `.gitignore` patterns to exclude unnecessary files\n- **Binary File Detection**: Intelligently identifies and excludes binary files, focusing on source code\n- **Progress Tracking**: Real-time progress indicators and comprehensive completion statistics\n- **Flexible Output**: Customizable output file location and naming\n\n### Usage\n\n```bash\n# Basic usage - creates flattened-codebase.xml in current directory\nnpx bmad-method flatten\n\n# Specify custom input directory\nnpx bmad-method flatten --input /path/to/source/directory\nnpx bmad-method flatten -i /path/to/source/directory\n\n# Specify custom output file\nnpx bmad-method flatten --output my-project.xml\nnpx bmad-method flatten -o /path/to/output/codebase.xml\n\n# Combine input and output options\nnpx bmad-method flatten --input /path/to/source --output /path/to/output/codebase.xml\n```\n\n### Example Output\n\nThe tool will display progress and provide a comprehensive summary:\n\n```text\n📊 Completion Summary:\n✅ Successfully processed 156 files into flattened-codebase.xml\n📁 Output file: /path/to/your/project/flattened-codebase.xml\n📏 Total source size: 2.3 MB\n📄 Generated XML size: 2.1 MB\n📝 Total lines of code: 15,847\n🔢 Estimated tokens: 542,891\n📊 File breakdown: 142 text, 14 binary, 0 errors\n```\n\nThe generated XML file contains your project's text-based source files in a structured format that AI models can easily parse and understand, making it perfect for code reviews, architecture discussions, or getting AI assistance with your BMad-Method projects.\n\n#### Advanced Usage \u0026 Options\n\n- CLI options\n  - `-i, --input \u003cpath\u003e`: Directory to flatten. Default: current working directory or auto-detected project root when run interactively.\n  - `-o, --output \u003cpath\u003e`: Output file path. Default: `flattened-codebase.xml` in the chosen directory.\n- Interactive mode\n  - If you do not pass `--input` and `--output` and the terminal is interactive (TTY), the tool will attempt to detect your project root (by looking for markers like `.git`, `package.json`, etc.) and prompt you to confirm or override the paths.\n  - In non-interactive contexts (e.g., CI), it will prefer the detected root silently; otherwise it falls back to the current directory and default filename.\n- File discovery and ignoring\n  - Uses `git ls-files` when inside a git repository for speed and correctness; otherwise falls back to a glob-based scan.\n  - Applies your `.gitignore` plus a curated set of default ignore patterns (e.g., `node_modules`, build outputs, caches, logs, IDE folders, lockfiles, large media/binaries, `.env*`, and previously generated XML outputs).\n- Binary handling\n  - Binary files are detected and excluded from the XML content. They are counted in the final summary but not embedded in the output.\n- XML format and safety\n  - UTF-8 encoded file with root element `\u003cfiles\u003e`.\n  - Each text file is emitted as a `\u003cfile path=\"relative/path\"\u003e` element whose content is wrapped in `\u003c![CDATA[ ... ]]\u003e`.\n  - The tool safely handles occurrences of `]]\u003e` inside content by splitting the CDATA to preserve correctness.\n  - File contents are preserved as-is and indented for readability inside the XML.\n- Performance\n  - Concurrency is selected automatically based on your CPU and workload size. No configuration required.\n  - Running inside a git repo improves discovery performance.\n\n#### Minimal XML example\n\n```xml\n\u003c?xml version=\"1.0\" encoding=\"UTF-8\"?\u003e\n\u003cfiles\u003e\n  \u003cfile path=\"src/index.js\"\u003e\u003c![CDATA[\n    // your source content\n  ]]\u003e\u003c/file\u003e\n\u003c/files\u003e\n```\n\n## Documentation \u0026 Resources\n\n### Essential Guides\n\n- 📖 **[User Guide](docs/user-guide.md)** - Complete walkthrough from project inception to completion\n- 🏗️ **[Core Architecture](docs/core-architecture.md)** - Technical deep dive and system design\n- 🚀 **[Expansion Packs Guide](docs/expansion-packs.md)** - Extend BMad to any domain beyond software development\n\n## Support\n\n- 💬 [Discord Community](https://discord.gg/gk8jAdXWmj)\n- 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)\n- 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)\n\n## Contributing\n\n**We're excited about contributions and welcome your ideas, improvements, and expansion packs!** 🎉\n\n📋 **[Read CONTRIBUTING.md](CONTRIBUTING.md)** - Complete guide to contributing, including guidelines, process, and requirements\n\n## License\n\nMIT License - see [LICENSE](LICENSE) for details.\n\n[![Contributors](https://contrib.rocks/image?repo=bmadcode/bmad-method)](https://github.com/bmadcode/bmad-method/graphs/contributors)\n\n\u003csub\u003eBuilt with ❤️ for the AI-assisted development community\u003c/sub\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbmad-code-org%2FBMAD-METHOD","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbmad-code-org%2FBMAD-METHOD","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbmad-code-org%2FBMAD-METHOD/lists"}