bmad-method 4.37.0-beta.2 → 4.37.0-beta.3

package/README.md

@@ -1,219 +1,8 @@
-# BMad-Method: Universal AI Agent Framework
+# BMad Method Installer
 
-[![Version](https://img.shields.io/npm/v/bmad-method?color=blue&label=version)](https://www.npmjs.com/package/bmad-method)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
-[![Node.js Version](https://img.shields.io/badge/node-%3E%3D20.0.0-brightgreen)](https://nodejs.org)
-[![Discord](https://img.shields.io/badge/Discord-Join%20Community-7289da?logo=discord&logoColor=white)](https://discord.gg/gk8jAdXWmj)
-
-Foundations 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.
-
-**[Subscribe to BMadCode on YouTube](https://www.youtube.com/@BMadCode?sub_confirmation=1)**
-
-**[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.**
-
-⭐ **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!
-
-## Overview
-
-**BMad Method's Two Key Innovations:**
-
-**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.
-
-**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.
-
-This 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.
-
-**📖 [See the complete workflow in the User Guide](docs/user-guide.md)** - Planning phase, development cycle, and all agent roles
-
-## Quick Navigation
-
-### Understanding the BMad Workflow
-
-**Before diving in, review these critical workflow diagrams that explain how BMad works:**
-
-1. **[Planning Workflow (Web UI)](docs/user-guide.md#the-planning-workflow-web-ui)** - How to create PRD and Architecture documents
-2. **[Core Development Cycle (IDE)](docs/user-guide.md#the-core-development-cycle-ide)** - How SM, Dev, and QA agents collaborate through story files
-
-> ⚠️ **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!
-
-### What would you like to do?
-
-- **[Install and Build software with Full Stack Agile AI Team](#quick-start)** → Quick Start Instruction
-- **[Learn how to use BMad](docs/user-guide.md)** → Complete user guide and walkthrough
-- **[See available AI agents](/bmad-core/agents))** → Specialized roles for your team
-- **[Explore non-technical uses](#-beyond-software-development---expansion-packs)** → Creative writing, business, wellness, education
-- **[Create my own AI agents](docs/expansion-packs.md)** → Build agents for your domain
-- **[Browse ready-made expansion packs](expansion-packs/)** → Game dev, DevOps, infrastructure and get inspired with ideas and examples
-- **[Understand the architecture](docs/core-architecture.md)** → Technical deep dive
-- **[Join the community](https://discord.gg/gk8jAdXWmj)** → Get help and share ideas
-
-## Important: Keep Your BMad Installation Updated
-
-**Stay up-to-date effortlessly!** If you already have BMad-Method installed in your project, simply run:
+## Usage
 
 ```bash
+# Interactive installation
 npx bmad-method install
-# OR
-git pull
-npm run install:bmad
-```
-
-This will:
-
-- ✅ Automatically detect your existing v4 installation
-- ✅ Update only the files that have changed and add new files
-- ✅ Create `.bak` backup files for any custom modifications you've made
-- ✅ Preserve your project-specific configurations
-
-This makes it easy to benefit from the latest improvements, bug fixes, and new agents without losing your customizations!
-
-## Quick Start
-
-### One Command for Everything (IDE Installation)
-
-**Just run one of these commands:**
-
-```bash
-npx bmad-method install
-# OR if you already have BMad installed:
-git pull
-npm run install:bmad
-```
-
-This single command handles:
-
-- **New installations** - Sets up BMad in your project
-- **Upgrades** - Updates existing installations automatically
-- **Expansion packs** - Installs any expansion packs you've added to package.json
-
-> **That's it!** Whether you're installing for the first time, upgrading, or adding expansion packs - these commands do everything.
-
-**Prerequisites**: [Node.js](https://nodejs.org) v20+ required
-
-### Fastest Start: Web UI Full Stack Team at your disposal (2 minutes)
-
-1. **Get the bundle**: Save or clone the [full stack team file](dist/teams/team-fullstack.txt) or choose another team
-2. **Create AI agent**: Create a new Gemini Gem or CustomGPT
-3. **Upload & configure**: Upload the file and set instructions: "Your critical operating instructions are attached, do not break character as directed"
-4. **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.
-5. **CRITICAL**: Talk to BMad Orchestrator in the web at ANY TIME (#bmad-orchestrator command) and ask it questions about how this all works!
-6. **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
-
-### Alternative: Clone and Build
-
-```bash
-git clone https://github.com/bmadcode/bmad-method.git
-npm run install:bmad # build and install all to a destination folder
-```
-
-## 🌟 Beyond Software Development - Expansion Packs
-
-BMad'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!
-
-## Codebase Flattener Tool
-
-The 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.
-
-### Features
-
-- **AI-Optimized Output**: Generates clean XML format specifically designed for AI model consumption
-- **Smart Filtering**: Automatically respects `.gitignore` patterns to exclude unnecessary files
-- **Binary File Detection**: Intelligently identifies and excludes binary files, focusing on source code
-- **Progress Tracking**: Real-time progress indicators and comprehensive completion statistics
-- **Flexible Output**: Customizable output file location and naming
-
-### Usage
-
-```bash
-# Basic usage - creates flattened-codebase.xml in current directory
-npx bmad-method flatten
-
-# Specify custom input directory
-npx bmad-method flatten --input /path/to/source/directory
-npx bmad-method flatten -i /path/to/source/directory
-
-# Specify custom output file
-npx bmad-method flatten --output my-project.xml
-npx bmad-method flatten -o /path/to/output/codebase.xml
-
-# Combine input and output options
-npx bmad-method flatten --input /path/to/source --output /path/to/output/codebase.xml
-```
-
-### Example Output
-
-The tool will display progress and provide a comprehensive summary:
-
-```text
-📊 Completion Summary:
-✅ Successfully processed 156 files into flattened-codebase.xml
-📁 Output file: /path/to/your/project/flattened-codebase.xml
-📏 Total source size: 2.3 MB
-📄 Generated XML size: 2.1 MB
-📝 Total lines of code: 15,847
-🔢 Estimated tokens: 542,891
-📊 File breakdown: 142 text, 14 binary, 0 errors
 ```
-
-The 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.
-
-#### Advanced Usage & Options
-
-- CLI options
-  - `-i, --input <path>`: Directory to flatten. Default: current working directory or auto-detected project root when run interactively.
-  - `-o, --output <path>`: Output file path. Default: `flattened-codebase.xml` in the chosen directory.
-- Interactive mode
-  - 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.
-  - 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.
-- File discovery and ignoring
-  - Uses `git ls-files` when inside a git repository for speed and correctness; otherwise falls back to a glob-based scan.
-  - 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).
-- Binary handling
-  - Binary files are detected and excluded from the XML content. They are counted in the final summary but not embedded in the output.
-- XML format and safety
-  - UTF-8 encoded file with root element `<files>`.
-  - Each text file is emitted as a `<file path="relative/path">` element whose content is wrapped in `<![CDATA[ ... ]]>`.
-  - The tool safely handles occurrences of `]]>` inside content by splitting the CDATA to preserve correctness.
-  - File contents are preserved as-is and indented for readability inside the XML.
-- Performance
-  - Concurrency is selected automatically based on your CPU and workload size. No configuration required.
-  - Running inside a git repo improves discovery performance.
-
-#### Minimal XML example
-
-```xml
-<?xml version="1.0" encoding="UTF-8"?>
-<files>
-  <file path="src/index.js"><![CDATA[
-    // your source content
-  ]]></file>
-</files>
-```
-
-## Documentation & Resources
-
-### Essential Guides
-
-- 📖 **[User Guide](docs/user-guide.md)** - Complete walkthrough from project inception to completion
-- 🏗️ **[Core Architecture](docs/core-architecture.md)** - Technical deep dive and system design
-- 🚀 **[Expansion Packs Guide](docs/expansion-packs.md)** - Extend BMad to any domain beyond software development
-
-## Support
-
-- 💬 [Discord Community](https://discord.gg/gk8jAdXWmj)
-- 🐛 [Issue Tracker](https://github.com/bmadcode/bmad-method/issues)
-- 💬 [Discussions](https://github.com/bmadcode/bmad-method/discussions)
-
-## Contributing
-
-**We're excited about contributions and welcome your ideas, improvements, and expansion packs!** 🎉
-
-📋 **[Read CONTRIBUTING.md](CONTRIBUTING.md)** - Complete guide to contributing, including guidelines, process, and requirements
-
-## License
-
-MIT License - see [LICENSE](LICENSE) for details.
-
-[![Contributors](https://contrib.rocks/image?repo=bmadcode/bmad-method)](https://github.com/bmadcode/bmad-method/graphs/contributors)
-
-<sub>Built with ❤️ for the AI-assisted development community</sub>

package/package.json

@@ -1,81 +1,44 @@
 {
   "name": "bmad-method",
-  "version": "4.37.0-beta.2",
-  "description": "Breakthrough Method of Agile AI-driven Development",
-  "main": "tools/cli.js",
+  "version": "4.37.0-beta.3",
+  "description": "BMad Method installer - AI-powered Agile development framework",
+  "main": "lib/installer.js",
   "bin": {
-    "bmad": "tools/bmad-npx-wrapper.js",
-    "bmad-method": "tools/bmad-npx-wrapper.js"
+    "bmad": "./bin/bmad.js",
+    "bmad-method": "./bin/bmad.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",
-    "list:agents": "node tools/cli.js list:agents",
-    "validate": "node tools/cli.js validate",
-    "flatten": "node tools/flattener/main.js",
-    "install:bmad": "node tools/installer/bin/bmad.js install",
-    "format": "prettier --write \"**/*.md\"",
-    "version:patch": "node tools/version-bump.js patch",
-    "version:minor": "node tools/version-bump.js minor",
-    "version:major": "node tools/version-bump.js major",
-    "version:expansion": "node tools/bump-expansion-version.js",
-    "version:expansion:set": "node tools/update-expansion-version.js",
-    "version:all": "node tools/bump-all-versions.js",
-    "version:all:minor": "node tools/bump-all-versions.js minor",
-    "version:all:major": "node tools/bump-all-versions.js major",
-    "version:all:patch": "node tools/bump-all-versions.js patch",
-    "version:expansion:all": "node tools/bump-all-versions.js",
-    "version:expansion:all:minor": "node tools/bump-all-versions.js minor",
-    "version:expansion:all:major": "node tools/bump-all-versions.js major",
-    "version:expansion:all:patch": "node tools/bump-all-versions.js patch",
-    "release": "semantic-release",
-    "release:test": "semantic-release --dry-run --no-ci || echo 'Config test complete - authentication errors are expected locally'",
-    "prepare": "husky"
-  },
-  "dependencies": {
-    "@kayvan/markdown-tree-parser": "^1.5.0",
-    "bmad-method": "^4.30.3",
-    "chalk": "^4.1.2",
-    "commander": "^14.0.0",
-    "fs-extra": "^11.3.0",
-    "glob": "^11.0.3",
-    "ignore": "^7.0.5",
-    "inquirer": "^8.2.6",
-    "js-yaml": "^4.1.0",
-    "ora": "^5.4.1"
+    "test": "echo \"Error: no test specified\" && exit 1"
   },
   "keywords": [
+    "bmad",
     "agile",
     "ai",
-    "orchestrator",
     "development",
-    "methodology",
-    "agents",
-    "bmad"
+    "framework",
+    "installer",
+    "agents"
   ],
-  "author": "Brian (BMad) Madison",
+  "author": "BMad Team",
   "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/bmadcode/BMAD-METHOD.git"
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "commander": "^14.0.0",
+    "fs-extra": "^11.3.0",
+    "inquirer": "^8.2.6",
+    "js-yaml": "^4.1.0",
+    "ora": "^5.4.1",
+    "semver": "^7.6.3"
   },
   "engines": {
     "node": ">=20.0.0"
   },
-  "devDependencies": {
-    "@semantic-release/changelog": "^6.0.3",
-    "@semantic-release/git": "^10.0.1",
-    "husky": "^9.1.7",
-    "jest": "^30.0.4",
-    "lint-staged": "^16.1.1",
-    "prettier": "^3.5.3",
-    "semantic-release": "^22.0.0",
-    "yaml-lint": "^1.7.0"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/bmad-team/bmad-method.git"
+  },
+  "bugs": {
+    "url": "https://github.com/bmad-team/bmad-method/issues"
   },
-  "lint-staged": {
-    "**/*.md": [
-      "prettier --write"
-    ]
-  }
+  "homepage": "https://github.com/bmad-team/bmad-method#readme"
 }

package/.github/FUNDING.yaml

@@ -1,15 +0,0 @@
-# These are supported funding model platforms
-
-github: # Replace with up to 4 GitHub Sponsors-enabled usernames e.g., [user1, user2]
-patreon: # Replace with a single Patreon username
-open_collective: # Replace with a single Open Collective username
-ko_fi: # Replace with a single Ko-fi username
-tidelift: # Replace with a single Tidelift platform-name/package-name e.g., npm/babel
-community_bridge: # Replace with a single Community Bridge project-name e.g., cloud-foundry
-liberapay: # Replace with a single Liberapay username
-issuehunt: # Replace with a single IssueHunt username
-lfx_crowdfunding: # Replace with a single LFX Crowdfunding project-name e.g., cloud-foundry
-polar: # Replace with a single Polar username
-buy_me_a_coffee: bmad
-thanks_dev: # Replace with a single thanks.dev username
-custom: # Replace with up to 4 custom sponsorship URLs e.g., ['link1', 'link2']

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,32 +0,0 @@
----
-name: Bug report
-about: Create a report to help us improve
-title: ""
-labels: ""
-assignees: ""
----
-
-**Describe the bug**
-A clear and concise description of what the bug is.
-
-**Steps to Reproduce**
-What lead to the bug and can it be reliable recreated - if so with what steps.
-
-**PR**
-If you have an idea to fix and would like to contribute, please indicate here you are working on a fix, or link to a proposed PR to fix the issue. Please review the contribution.md - contributions are always welcome!
-
-**Expected behavior**
-A clear and concise description of what you expected to happen.
-
-**Please be Specific if relevant**
-Model(s) Used:
-Agentic IDE Used:
-WebSite Used:
-Project Language:
-BMad Method version:
-
-**Screenshots or Links**
-If applicable, add screenshots or links (if web sharable record) to help explain your problem.
-
-**Additional context**
-Add any other context about the problem here. The more information you can provide, the easier it will be to suggest a fix or resolve

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,22 +0,0 @@
----
-name: Feature request
-about: Suggest an idea for this project
-title: ""
-labels: ""
-assignees: ""
----
-
-**Did you discuss the idea first in Discord Server (#general-dev)**
-Yes/No - Link to thread. If no, please after posting request also share the link in the channel so it can be easily discussed.
-
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
-
-**Describe the solution you'd like**
-A clear and concise description of what you want to happen.
-
-**Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
-
-**Additional context**
-Add any other context or screenshots about the feature request here.

package/.github/workflows/discord.yaml

@@ -1,16 +0,0 @@
-name: Discord Notification
-
-on: [pull_request, release, create, delete, issue_comment, pull_request_review, pull_request_review_comment]
-
-jobs:
-  notify:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Notify Discord
-        uses: sarisia/actions-status-discord@v1
-        if: always()
-        with:
-          webhook: ${{ secrets.DISCORD_WEBHOOK }}
-          status: ${{ job.status }}
-          title: "Triggered by ${{ github.event_name }}"
-          color: 0x5865F2

package/.github/workflows/release.yaml

@@ -1,60 +0,0 @@
-name: Release
-'on':
-  push:
-    branches:
-      - main
-      - stable
-  workflow_dispatch:
-    inputs:
-      version_type:
-        description: Version bump type
-        required: true
-        default: patch
-        type: choice
-        options:
-          - patch
-          - minor
-          - major
-permissions:
-  contents: write
-  issues: write
-  pull-requests: write
-  packages: write
-jobs:
-  release:
-    runs-on: ubuntu-latest
-    if: '!contains(github.event.head_commit.message, ''[skip ci]'')'
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-        with:
-          fetch-depth: 0
-          token: ${{ secrets.GITHUB_TOKEN }}
-      - name: Setup Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20'
-          cache: npm
-          registry-url: https://registry.npmjs.org
-      - name: Install dependencies
-        run: npm ci
-      - name: Run tests and validation
-        run: |
-          npm run validate
-          npm run format
-      - name: Debug permissions
-        run: |
-          echo "Testing git permissions..."
-          git config user.name "github-actions[bot]"
-          git config user.email "github-actions[bot]@users.noreply.github.com"
-          echo "Git config set successfully"
-      - name: Manual version bump
-        if: github.event_name == 'workflow_dispatch'
-        run: npm run version:${{ github.event.inputs.version_type }}
-      - name: Semantic Release
-        if: github.event_name == 'push'
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
-        run: npm run release

package/.releaserc.json

@@ -1,21 +0,0 @@
-{
-  "branches": [
-    {
-      "name": "main",
-      "prerelease": "beta",
-      "channel": "beta"
-    },
-    {
-      "name": "stable",
-      "channel": "latest"
-    }
-  ],
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/changelog",
-    "@semantic-release/npm",
-    "./tools/semantic-release-sync-installer.js",
-    "@semantic-release/github"
-  ]
-}

package/.vscode/settings.json

@@ -1,44 +0,0 @@
-{
-  "cSpell.words": [
-    "Agentic",
-    "atlasing",
-    "Biostatistician",
-    "Cordova",
-    "customresourcedefinitions",
-    "dashboarded",
-    "Decisioning",
-    "eksctl",
-    "elicitations",
-    "filecomplete",
-    "fintech",
-    "fluxcd",
-    "gamedev",
-    "gitops",
-    "implementability",
-    "inclusivity",
-    "ingressgateway",
-    "istioctl",
-    "metroidvania",
-    "NACLs",
-    "nodegroup",
-    "platformconfigs",
-    "Playfocus",
-    "playtesting",
-    "pointerdown",
-    "pointerup",
-    "Polyrepo",
-    "replayability",
-    "roguelike",
-    "roomodes",
-    "Runbook",
-    "runbooks",
-    "Shardable",
-    "Softlock",
-    "speedrunner",
-    "tekton",
-    "tilemap",
-    "tileset",
-    "Trae",
-    "VNET"
-  ]
-}