{"_id":"@airclear/bmad-method","_rev":"2-c26fd0ded5a46406842226233636ae0d","name":"@airclear/bmad-method","dist-tags":{"latest":"0.2.1"},"versions":{"0.2.0":{"name":"@airclear/bmad-method","version":"0.2.0","keywords":["agile","ai","orchestrator","development","methodology","agents","bmad"],"author":{"name":"airclear"},"license":"MIT","_id":"@airclear/bmad-method@0.2.0","maintainers":[{"name":"airclear","email":"lihang4work@gmail.com"}],"homepage":"https://github.com/airclear/BMAD-METHOD#readme","bugs":{"url":"https://github.com/airclear/BMAD-METHOD/issues"},"bin":{"bmad":"tools/bmad-npx-wrapper.js","bmad-method":"tools/bmad-npx-wrapper.js"},"dist":{"shasum":"8ed216715498b0794bb173bf1c0cf054f9e7a5ee","tarball":"https://registry.npmjs.org/@airclear/bmad-method/-/bmad-method-0.2.0.tgz","fileCount":320,"integrity":"sha512-pr1R6a0+V0HMKSwlUS2ejrYTGU0WRt+X64QrbgGgQQ3C2UuJEEsHhdfd1dJaoRf1fEZ2TYTlAqWaIlGDN9v1gQ==","signatures":[{"sig":"MEYCIQDM4F47MzM3mqVqMZYWIlqRxbeBd9N5/2suxd9WHRLORAIhAMdqdLaOlJ+7tcinVDaiSZNrPBlnVRQzQas5EKe2+fQ/","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":6653322},"main":"tools/cli.js","$schema":"https://json.schemastore.org/package.json","engines":{"node":">=20.10.0"},"gitHead":"01a45397296377f75be27affe432d3419f48944d","scripts":{"lint":"eslint . --ext .js,.cjs,.mjs,.yaml --max-warnings=0","build":"node tools/cli.js build","format":"prettier --write \"**/*.{js,cjs,mjs,json,md,yaml}\"","flatten":"node tools/flattener/main.js","prepare":"husky","lint:fix":"eslint . --ext .js,.cjs,.mjs,.yaml --fix","validate":"node tools/cli.js validate","build:teams":"node tools/cli.js build --teams-only","list:agents":"node tools/cli.js list:agents","version:all":"node tools/bump-all-versions.js","build:agents":"node tools/cli.js build --agents-only","format:check":"prettier --check \"**/*.{js,cjs,mjs,json,md,yaml}\"","install:bmad":"node tools/installer/bin/bmad.js install","release:major":"gh workflow run \"Manual Release\" -f version_bump=major","release:minor":"gh workflow run \"Manual Release\" -f version_bump=minor","release:patch":"gh workflow run \"Manual Release\" -f version_bump=patch","release:watch":"gh run watch","version:major":"node tools/version-bump.js major","version:minor":"node tools/version-bump.js minor","version:patch":"node tools/version-bump.js patch","preview:release":"node tools/preview-release-notes.js","version:all:major":"node tools/bump-all-versions.js major","version:all:minor":"node tools/bump-all-versions.js minor","version:all:patch":"node tools/bump-all-versions.js patch","version:expansion":"node tools/bump-expansion-version.js","version:expansion:all":"node tools/bump-all-versions.js","version:expansion:set":"node tools/update-expansion-version.js","version:expansion:all:major":"node tools/bump-all-versions.js major","version:expansion:all:minor":"node tools/bump-all-versions.js minor","version:expansion:all:patch":"node tools/bump-all-versions.js patch"},"_npmUser":{"name":"airclear","email":"lihang4work@gmail.com"},"repository":{"url":"git+https://github.com/airclear/BMAD-METHOD.git","type":"git"},"_npmVersion":"10.7.0","description":"Breakthrough Method of Agile AI-driven Development","directories":{},"lint-staged":{"**/*.yaml":["eslint --fix","prettier --write"],"**/*.{json,md}":["prettier --write"],"**/*.{js,cjs,mjs}":["eslint --fix --max-warnings=0","prettier --write"]},"_nodeVersion":"20.14.0","dependencies":{"ora":"^5.4.1","glob":"^11.0.3","chalk":"^4.1.2","ignore":"^7.0.5","semver":"^7.7.2","js-yaml":"^4.1.0","fs-extra":"^11.3.1","inquirer":"^8.2.6","commander":"^14.0.0","@kayvan/markdown-tree-parser":"^1.6.1"},"publishConfig":{"access":"public"},"_hasShrinkwrap":false,"devDependencies":{"jest":"^30.0.5","husky":"^9.1.7","eslint":"^9.34.0","prettier":"^3.6.2","yaml-lint":"^1.7.0","@eslint/js":"^9.34.0","lint-staged":"^16.1.5","eslint-plugin-n":"^17.21.3","semantic-release":"24.2.7","eslint-plugin-yml":"^1.18.0","yaml-eslint-parser":"^1.3.0","@semantic-release/git":"^10.0.1","eslint-plugin-unicorn":"^60.0.0","eslint-config-prettier":"^10.1.8","@semantic-release/changelog":"6.0.3","prettier-plugin-packagejson":"^2.5.19"},"_npmOperationalInternal":{"tmp":"tmp/bmad-method_0.2.0_1756258683082_0.2852585304702455","host":"s3://npm-registry-packages-npm-production"}},"0.2.1":{"$schema":"https://json.schemastore.org/package.json","name":"@airclear/bmad-method","version":"0.2.1","description":"Breakthrough Method of Agile AI-driven Development","keywords":["agile","ai","orchestrator","development","methodology","agents","bmad"],"repository":{"type":"git","url":"git+https://github.com/airclear/BMAD-METHOD.git"},"license":"MIT","author":{"name":"airclear"},"main":"tools/cli.js","bin":{"bmad":"tools/bmad-npx-wrapper.js","bmad-method":"tools/bmad-npx-wrapper.js"},"scripts":{"build":"node tools/cli.js build","build:agents":"node tools/cli.js build --agents-only","build:teams":"node tools/cli.js build --teams-only","flatten":"node tools/flattener/main.js","format":"prettier --write \"**/*.{js,cjs,mjs,json,md,yaml}\"","format:check":"prettier --check \"**/*.{js,cjs,mjs,json,md,yaml}\"","install:bmad":"node tools/installer/bin/bmad.js install","lint":"eslint . --ext .js,.cjs,.mjs,.yaml --max-warnings=0","lint:fix":"eslint . --ext .js,.cjs,.mjs,.yaml --fix","list:agents":"node tools/cli.js list:agents","prepare":"husky","preview:release":"node tools/preview-release-notes.js","release:major":"gh workflow run \"Manual Release\" -f version_bump=major","release:minor":"gh workflow run \"Manual Release\" -f version_bump=minor","release:patch":"gh workflow run \"Manual Release\" -f version_bump=patch","release:watch":"gh run watch","validate":"node tools/cli.js validate","version:all":"node tools/bump-all-versions.js","version:all:major":"node tools/bump-all-versions.js major","version:all:minor":"node tools/bump-all-versions.js minor","version:all:patch":"node tools/bump-all-versions.js patch","version:expansion":"node tools/bump-expansion-version.js","version:expansion:all":"node tools/bump-all-versions.js","version:expansion:all:major":"node tools/bump-all-versions.js major","version:expansion:all:minor":"node tools/bump-all-versions.js minor","version:expansion:all:patch":"node tools/bump-all-versions.js patch","version:expansion:set":"node tools/update-expansion-version.js","version:major":"node tools/version-bump.js major","version:minor":"node tools/version-bump.js minor","version:patch":"node tools/version-bump.js patch"},"lint-staged":{"**/*.{js,cjs,mjs}":["eslint --fix --max-warnings=0","prettier --write"],"**/*.yaml":["eslint --fix","prettier --write"],"**/*.{json,md}":["prettier --write"]},"dependencies":{"@kayvan/markdown-tree-parser":"^1.6.1","chalk":"^4.1.2","commander":"^14.0.0","fs-extra":"^11.3.1","glob":"^11.0.3","ignore":"^7.0.5","inquirer":"^8.2.6","js-yaml":"^4.1.0","ora":"^5.4.1","semver":"^7.7.2"},"devDependencies":{"@eslint/js":"^9.34.0","@semantic-release/changelog":"6.0.3","@semantic-release/git":"^10.0.1","eslint":"^9.34.0","eslint-config-prettier":"^10.1.8","eslint-plugin-n":"^17.21.3","eslint-plugin-unicorn":"^60.0.0","eslint-plugin-yml":"^1.18.0","husky":"^9.1.7","jest":"^30.0.5","lint-staged":"^16.1.5","prettier":"^3.6.2","prettier-plugin-packagejson":"^2.5.19","semantic-release":"24.2.7","yaml-eslint-parser":"^1.3.0","yaml-lint":"^1.7.0"},"engines":{"node":">=20.10.0"},"publishConfig":{"access":"public"},"_id":"@airclear/bmad-method@0.2.1","gitHead":"01a45397296377f75be27affe432d3419f48944d","bugs":{"url":"https://github.com/airclear/BMAD-METHOD/issues"},"homepage":"https://github.com/airclear/BMAD-METHOD#readme","_nodeVersion":"20.14.0","_npmVersion":"10.7.0","dist":{"integrity":"sha512-hZpFxGiWRoh0l8q1nimd5X/8uulKprEpn2oliJuCWRkGkGrdGN6ktk+sPlzTodniiW1d84lkrvIfmpyNyanS9Q==","shasum":"2b8949426acc0e9205ce435cca937a9f80372477","tarball":"https://registry.npmjs.org/@airclear/bmad-method/-/bmad-method-0.2.1.tgz","fileCount":320,"unpackedSize":6657782,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIFk1bNTtLuV2xtoa4d/KuI+XNmlPTEIk5ztCfzlxQsBzAiA9EnkT6SankErZcEfWqx5fHyjw7kWtug8FxYwpHVZtTg=="}]},"_npmUser":{"name":"airclear","email":"lihang4work@gmail.com"},"directories":{},"maintainers":[{"name":"airclear","email":"lihang4work@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/bmad-method_0.2.1_1756275818052_0.6812497611782018"},"_hasShrinkwrap":false}},"time":{"created":"2025-08-27T01:38:03.020Z","modified":"2025-08-27T06:23:38.459Z","0.2.0":"2025-08-27T01:38:03.350Z","0.2.1":"2025-08-27T06:23:38.290Z"},"bugs":{"url":"https://github.com/airclear/BMAD-METHOD/issues"},"author":{"name":"airclear"},"license":"MIT","homepage":"https://github.com/airclear/BMAD-METHOD#readme","keywords":["agile","ai","orchestrator","development","methodology","agents","bmad"],"repository":{"type":"git","url":"git+https://github.com/airclear/BMAD-METHOD.git"},"description":"Breakthrough Method of Agile AI-driven Development","maintainers":[{"name":"airclear","email":"lihang4work@gmail.com"}],"readme":"# BMAD-METHOD™: Universal AI Agent Framework\n\n[![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=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&logoColor=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 & 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> ⚠️ **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 explicitly use stable tag:\nnpx bmad-method@stable 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> **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 & 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 & 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 & Options\n\n- CLI options\n  - `-i, --input <path>`: Directory to flatten. Default: current working directory or auto-detected project root when run interactively.\n  - `-o, --output <path>`: 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 `<files>`.\n  - Each text file is emitted as a `<file path=\"relative/path\">` element whose content is wrapped in `<![CDATA[ ... ]]>`.\n  - The tool safely handles occurrences of `]]>` 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<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<files>\n  <file path=\"src/index.js\"><![CDATA[\n    // your source content\n  ]]></file>\n</files>\n```\n\n## Documentation & 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## Trademark Notice\n\nBMAD™ and BMAD-METHOD™ are trademarks of BMad Code, LLC. All rights reserved.\n\n[![Contributors](https://contrib.rocks/image?repo=bmadcode/bmad-method)](https://github.com/bmadcode/bmad-method/graphs/contributors)\n\n<sub>Built with ❤️ for the AI-assisted development community</sub>\n","readmeFilename":"README.md"}