npm - bmad-method - Versions diffs - 6.0.0-alpha.9 → 6.0.2 - Mend

bmad-method 6.0.0-alpha.9 → 6.0.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (933) hide show

package/docs/installers-bundlers/installers-modules-platforms-reference.md DELETED Viewed

@@ -1,388 +0,0 @@
-# BMAD Installation & Module System Reference
-## Table of Contents
-1. [Overview](#overview)
-2. [Quick Start](#quick-start)
-3. [Architecture](#architecture)
-4. [Modules](#modules)
-5. [Configuration System](#configuration-system)
-6. [Platform Integration](#platform-integration)
-7. [Development Guide](#development-guide)
-8. [Troubleshooting](#troubleshooting)
-## Overview
-BMad Core is a modular AI agent framework with intelligent installation, platform-agnostic support, and configuration inheritance.
-### Key Features
-- **Modular Design**: Core + optional modules (BMB, BMM, CIS)
-- **Smart Installation**: Interactive configuration with dependency resolution
-- **Clean Architecture**: Centralized `{bmad_folder}` directory add to project, no source pollution with multiple folders added
-## Architecture
-### Directory Structure upon installation
-```
-project-root/
-├── {bmad_folder}/             # Centralized installation
-│   ├── _cfg/                  # Configuration
-│   │   ├── agents/            # Agent configs
-│   │   └── agent-manifest.csv # Agent manifest
-│   ├── core/                  # Core module
-│   │   ├── agents/
-│   │   ├── tasks/
-│   │   └── config.yaml
-│   ├── bmm/                   # BMad Method module
-│   │   ├── agents/
-│   │   ├── tasks/
-│   │   ├── workflows/
-│   │   └── config.yaml
-│   └── cis/                   # Creative Innovation Studio
-│       └── ...
-└── .claude/                   # Platform-specific (example)
-    └── agents/
-```
-### Installation Flow
-1. **Detection**: Check existing installation
-2. **Selection**: Choose modules interactively or via CLI
-3. **Configuration**: Collect module-specific settings
-4. **Installation**: Compile Process and copy files
-5. **Generation**: Create config files with inheritance
-6. **Post-Install**: Run module installers
-7. **Manifest**: Track installed components
-### Key Exclusions
-- `_module-installer/` directories are never copied to destination
-- `localskip="true"` agents are filtered out
-- Source `config.yaml` templates are replaced with generated configs
-## Modules
-### Core Module (Required)
-Foundation framework with C.O.R.E. (Collaboration Optimized Reflection Engine)
-- **Components**: Base agents, activation system, advanced elicitation
-- **Config**: `user_name`, `communication_language`
-### BMM Module
-BMad Method for software development workflows
-- **Components**: PM agent, dev tasks, PRD templates, story generation
-- **Config**: `project_name`, `tech_docs`, `output_folder`, `story_location`
-- **Dependencies**: Core
-### CIS Module
-Creative Innovation Studio for design workflows
-- **Components**: Design agents, creative tasks
-- **Config**: `output_folder`, design preferences
-- **Dependencies**: Core
-### Module Structure
-```
-src/modules/{module}/
-├── _module-installer/       # Not copied to destination
-│   ├── installer.js        # Post-install logic
-│   └── install-config.yaml
-├── agents/
-├── tasks/
-├── templates/
-└── sub-modules/            # Platform-specific content
-    └── {platform}/
-        ├── injections.yaml
-        └── sub-agents/
-```
-## Configuration System
-### Collection Process
-Modules define prompts in `install-config.yaml`:
-```yaml
-project_name:
-  prompt: 'Project title?'
-  default: 'My Project'
-  result: '{value}'
-output_folder:
-  prompt: 'Output location?'
-  default: 'docs'
-  result: '{project-root}/{value}'
-tools:
-  prompt: 'Select tools:'
-  multi-select:
-    - 'Tool A'
-    - 'Tool B'
-```
-### Configuration Inheritance
-Core values cascade to ALL modules automatically:
-```yaml
-# core/config.yaml
-user_name: "Jane"
-communication_language: "English"
-# bmm/config.yaml (generated)
-project_name: "My App"
-tech_docs: "/path/to/docs"
-# Core Configuration Values (inherited)
-user_name: "Jane"
-communication_language: "English"
-```
-**Reserved Keys**: Core configuration keys cannot be redefined by other modules.
-### Path Placeholders
-- `{project-root}`: Project directory path
-- `{value}`: User input
-- `{module}`: Module name
-- `{core:field}`: Reference core config value
-### Config Generation Rules
-1. ALL installed modules get a `config.yaml` (even without prompts)
-2. Core values are ALWAYS included in module configs
-3. Module-specific values come first, core values appended
-4. Source templates are never copied, only generated configs
-## Platform Integration
-### Supported Platforms
-**Preferred** (Full Integration):
-- Claude Code
-- Cursor
-- Windsurf
-**Additional**:
-Cline, Roo, Auggie, GitHub Copilot, Codex, Gemini, Qwen, Trae, Kilo, Crush, iFlow
-### Platform Features
-1. **Setup Handler** (`tools/cli/installers/lib/ide/{platform}.js`)
-   - Directory creation
-   - Configuration generation
-   - Agent processing
-2. **Content Injection** (`sub-modules/{platform}/injections.yaml`)
-   ```yaml
-   injections:
-     - file: '{bmad_folder}/bmm/agents/pm.md'
-       point: 'pm-agent-instructions'
-       content: |
-         <i>Platform-specific instruction</i>
-   subagents:
-     source: 'sub-agents'
-     target: '.claude/agents'
-     files: ['agent.md']
-   ```
-3. **Interactive Config**
-   - Subagent selection
-   - Installation scope (project/user)
-   - Feature toggles
-### Injection System
-Platform-specific content without source modification:
-- Inject points marked in source: `<!-- IDE-INJECT-POINT:name -->`
-- Content added during installation only
-- Source files remain clean
-## Development Guide
-### Creating a Module
-1. **Structure**
-   ```
-   src/modules/mymod/
-   ├── _module-installer/
-   │   ├── installer.js
-   │   └── install-config.yaml
-   ├── agents/
-   └── tasks/
-   ```
-2. **Configuration** (`install-config.yaml`)
-   ```yaml
-   code: mymod
-   name: 'My Module'
-   prompt: 'Welcome message'
-   setting_name:
-     prompt: 'Configure X?'
-     default: 'value'
-   ```
-3. **Installer** (`installer.js`)
-   ```javascript
-   async function install(options) {
-     const { projectRoot, config, installedIDEs, logger } = options;
-     // Custom logic
-     return true;
-   }
-   module.exports = { install };
-   ```
-### Adding Platform Support
-1. Create handler: `tools/cli/installers/lib/ide/myplatform.js`
-2. Extend `BaseIdeSetup` class
-3. Add sub-module: `src/modules/{mod}/sub-modules/myplatform/`
-4. Define injections and platform agents
-### Agent Configuration
-Extractable config nodes:
-```xml
-<agent>
-  <setting agentConfig="true">
-    Default value
-  </setting>
-</agent>
-```
-Generated in: `bmad/_cfg/agents/{module}-{agent}.md`
-## Troubleshooting
-### Common Issues
-| Issue                   | Solution                                     |
-| ----------------------- | -------------------------------------------- |
-| Existing installation   | Use `bmad update` or remove `{bmad_folder}/` |
-| Module not found        | Check `src/modules/` exists                  |
-| Config not applied      | Verify `{bmad_folder}/{module}/config.yaml`  |
-| Missing config.yaml     | Fixed: All modules now get configs           |
-| Agent unavailable       | Check for `localskip="true"`                 |
-| module-installer copied | Fixed: Now excluded from copy                |
-### Debug Commands
-```bash
-bmad install -v     # Verbose installation
-bmad status -v      # Detailed status
-```
-### Best Practices
-1. Run from project root
-2. Backup `{bmad_folder}/_cfg/` before updates
-3. Use interactive mode for guidance
-4. Review generated configs post-install
-## Migration from v4
-| v4                  | v6                           |
-| ------------------- | ---------------------------- |
-| Scattered files     | Centralized `{bmad_folder}/` |
-| Monolithic          | Modular                      |
-| Manual config       | Interactive setup            |
-| Limited IDE support | 15+ platforms                |
-| Source modification | Clean injection              |
-## Technical Notes
-### Dependency Resolution
-- Direct dependencies (module → module)
-- Agent references (cross-module)
-- Template dependencies
-- Partial module installation (only required files)
-- Workflow vendoring for standalone module operation
-## Workflow Vendoring
-**Problem**: Modules that reference workflows from other modules create dependencies, forcing users to install multiple modules even when they only need one.
-**Solution**: Workflow vendoring allows modules to copy workflows from other modules during installation, making them fully standalone.
-### How It Works
-Agents can specify both `workflow` (source location) and `workflow-install` (destination location) in their menu items:
-```yaml
-menu:
-  - trigger: create-story
-    workflow: '{project-root}/{bmad_folder}/bmm/workflows/4-implementation/create-story/workflow.yaml'
-    workflow-install: '{project-root}/{bmad_folder}/bmgd/workflows/4-production/create-story/workflow.yaml'
-    description: 'Create a game feature story'
-```
-**During Installation:**
-1. **Vendoring Phase**: Before copying module files, the installer:
-   - Scans source agent YAML files for `workflow-install` attributes
-   - Copies entire workflow folders from `workflow` path to `workflow-install` path
-   - Updates vendored `workflow.yaml` files to reference target module's config
-2. **Compilation Phase**: When compiling agents:
-   - If `workflow-install` exists, uses its value for the `workflow` attribute
-   - `workflow-install` is build-time metadata only, never appears in final XML
-   - Compiled agent references vendored workflow location
-3. **Config Update**: Vendored workflows get their `config_source` updated:
-   ```yaml
-   # Source workflow (in bmm):
-   config_source: "{project-root}/{bmad_folder}/bmm/config.yaml"
-   # Vendored workflow (in bmgd):
-   config_source: "{project-root}/{bmad_folder}/bmgd/config.yaml"
-   ```
-**Result**: Modules become completely standalone with their own copies of needed workflows, configured for their specific use case.
-### Example Use Case: BMGD Module
-The BMad Game Development module vendors implementation workflows from BMM:
-- Game Dev Scrum Master agent references BMM workflows
-- During installation, workflows are copied to `bmgd/workflows/4-production/`
-- Vendored workflows use BMGD's config (with game-specific settings)
-- BMGD can be installed without BMM dependency
-### Benefits
-✅ **Module Independence** - No forced dependencies
-✅ **Clean Namespace** - Workflows live in their module
-✅ **Config Isolation** - Each module uses its own configuration
-✅ **Customization Ready** - Vendored workflows can be modified independently
-✅ **No User Confusion** - Avoid partial module installations
-### File Processing
-- Filters `localskip="true"` agents
-- Excludes `_module-installer/` directories
-- Replaces path placeholders at runtime
-- Injects activation blocks
-- Vendors cross-module workflows (see Workflow Vendoring below)
-### Web Bundling
-```bash
-bmad bundle --web           # Filter for web deployment
-npm run validate:bundles    # Validate bundles
-```

package/docs/installers-bundlers/web-bundler-usage.md DELETED Viewed

@@ -1,54 +0,0 @@
-# Web Bundler Usage
-ALPHA NOTE: Bundling of individual agents might work, team bundling is being reworked and will come with Beta release soon.
-The web bundler creates self-contained XML bundles for BMAD agents, packaging all dependencies for web deployment.
-## Quick Start
-```bash
-# Bundle all agents from all modules
-npm run bundle
-# Clean and rebundle (removes old bundles first)
-npm run rebundle
-```
-## Custom Output Directory
-```bash
-# Bundle to custom directory
-node tools/cli/bundlers/bundle-web.js all --output ./my-bundles
-# Rebundle to custom directory (auto-cleans first)
-node tools/cli/bundlers/bundle-web.js rebundle --output /absolute/path/to/custom/directory
-# Bundle specific module to custom directory
-node tools/cli/bundlers/bundle-web.js module bmm --output ./custom-folder
-# Bundle specific agent to custom directory
-node tools/cli/bundlers/bundle-web.js agent bmm analyst -o ./custom-folder
-```
-## Output
-Bundles are generated in `web-bundles/` directory by default when run from the root of the clones project:
-```
-web-bundles/
-├── [module-name]/
-│   └── agents/
-│       └── [agent-name].xml
-```
-## Skipping Agents
-Agents with `bundle="false"` attribute are automatically skipped during bundling.
-## Bundle Contents
-Each bundle includes:
-- Agent definition with web activation
-- All resolved dependencies
-- Manifests for agent/team discovery

package/docs/v4-to-v6-upgrade.md DELETED Viewed

@@ -1,227 +0,0 @@
-# BMad v4 to v6 Upgrade Guide
-## Overview
-BMad v6 represents a complete ground-up rewrite with significant architectural changes. This guide will help you migrate your v4 project to v6.
----
-## Automatic V4 Detection
-When you run `npm run install:bmad` on a project with v4 installed, the installer automatically detects:
-- **Legacy folders**: Any folders starting with `.bmad`, `bmad` (lowercase), or `Bmad`
-- **IDE command artifacts**: Legacy bmad folders in IDE configuration directories (`.claude/commands/`, `.cursor/commands/`, etc.)
-### What Happens During Detection
-1. **Automatic Backup of v4 Modules**: All `.bmad-*` folders are moved to `v4-backup/` in your project root
-   - If a backup already exists, a timestamp is added to avoid conflicts
-   - Example: `.bmad-core` → `v4-backup/.bmad-core`
-   - Your project files and data are NOT affected
-2. **IDE Command Cleanup Recommended**: Legacy v4 IDE commands should be manually removed
-   - Located in IDE config folders: `.claude/commands/`, `.cursor/commands/`, etc.
-   - These old commands would still reference v4 folder structure if left in place
-   - The installer provides copy/paste terminal commands for your platform
-   - You can proceed without cleanup, but removing them prevents confusion with old v4 commands
----
-## Module Migration
-### Deprecated Modules
-| v4 Module                     | v6 Status                                        |
-| ----------------------------- | ------------------------------------------------ |
-| `.bmad-2d-phaser-game-dev`    | Integrated into BMM                              |
-| `.bmad-2d-unity-game-dev`     | Integrated into BMM                              |
-| `.bmad-godot-game-dev`        | Integrated into BMM                              |
-| `.bmad-*-game-dev` (any)      | Integrated into BMM                              |
-| `.bmad-infrastructure-devops` | Deprecated - New core devops agent coming in BMM |
-| `.bmad-creative-writing`      | Not adapted - New module releasing soon          |
-**Game Development**: All game development functionality has been consolidated and expanded within the BMM (BMad Method) module. Game-specific workflows now adapt to your game type and engine.
----
-## Architecture Changes
-### Folder Structure
-**v4 "Expansion Packs" Structure:**
-```
-your-project/
-├── .bmad-core/           # Was actually the BMad Method
-├── .bmad-game-dev/       # Separate expansion packs
-├── .bmad-creative-writing/
-└── .bmad-infrastructure-devops/
-```
-**v6 Unified Structure:**
-```
-your-project/
-└── {bmad_folder}/       # Single installation folder, default .bmad
-    ├── core/            # Real core framework (applies to all modules)
-    ├── bmm/             # BMad Method (software/game dev)
-    ├── bmb/             # BMad Builder (create agents/workflows)
-    ├── cis/             # Creative Intelligence Suite
-    └── _cfg/            # Your customizations
-        └── agents/      # Agent customization files
-```
-### Key Concept Changes
-- **v4 `.bmad-core`**: Was actually the BMad Method
-- **v6 `{bmad_folder}/core/`**: Is the real universal core framework
-- **v6 `{bmad_folder}/bmm/`**: Is the BMad Method module
-- **Module identification**: All modules now have a `config.yaml` file
----
-## Project Progress Migration
-### If You've Completed Planning Phase (PRD/Architecture) with the BMad Method:
-After running the v6 installer:
-1. **Run `workflow-init`** workflow to set up the guided workflow system
-2. **Specify your project level** when prompted:
-   - If you followed v4's full workflow (PRD → Architecture → Stories), select **Level 3 or 4**
-   - This tells v6 you've already completed planning and solutioning phases
-3. **Document paths**: Keep your existing paths during installation
-   - Default PRD/Architecture location: `docs/`
-   - Default stories location: `docs/sprint-artifacts/`
-   - **Accept these defaults** if you're already using them in v4
-> **Important**: v6 workflows can handle both sharded and unsharded documents. You don't need to restructure your existing PRD or architecture files.
-### If You're Mid-Development (Stories Created/Implemented)
-1. Complete the v6 installation as above
-2. Run `workflow-init` and specify Level 3 or 4
-3. When ready to continue development, run the **`sprint-planning`** workflow (Phase 4)
----
-## Agent Customization Migration
-### v4 Agent Customization
-In v4, you may have modified agent files directly in `.bmad-*` folders.
-### v6 Agent Customization
-**All customizations** now go in `{bmad_folder}/_cfg/agents/` using customize files:
-**Example: Renaming an agent and changing communication style**
-File: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
-```yaml
-# Customize the PM agent
-persona:
-  name: 'Captain Jack' # Override agent name
-  role: 'Swashbuckling Product Owner'
-  communication_style: |
-    - Talk like a pirate
-    - Use nautical metaphors for software concepts
-    - Always upbeat and adventurous
-```
-**How it works:**
-- Base agent: `{bmad_folder}/bmm/agents/pm.md`
-- Customization: `{bmad_folder}/_cfg/agents/bmm-pm.customize.yaml`
-- Result: Agent uses your custom name and style, but updates don't overwrite your changes
----
-## Document Compatibility
-### Sharded vs Unsharded Documents
-**Good news**: Unlike v4, v6 workflows are **fully flexible** with document structure:
-- ✅ Sharded documents (split into multiple files)
-- ✅ Unsharded documents (single file per section)
-- ✅ Custom sections for your project type
-- ✅ Mixed approaches
-All workflow files are scanned automatically. No manual configuration needed.
----
-## Installation Steps
-### 1. Clone Repository
-```bash
-git clone https://github.com/bmad-code-org/BMAD-METHOD
-cd BMAD-METHOD
-npm install
-```
-### 2. Run Installer on Your v4 Project
-```bash
-npx bmad-method install
-```
-**Enter the full path to your v4 project** when prompted.
-### 3. Follow Interactive Prompts
-The installer will:
-1. Detect v4 installation and offer to backup `.bmad-*` folders
-2. Prompt for recommended cleanup (you can skip)
-3. Let you select modules (recommend: BMM for software and or game development)
-4. Configure core settings (name, language, etc.)
-5. Configure module-specific options
-6. Configure IDE integrations
-### 4. Accept Default Paths
-If you're using:
-- `docs/` for PRD and architecture
-- `docs/sprint-artifacts/` for story files
-**Accept these defaults** during installation.
-### 5. Initialize Workflow
-After installation:
-1. **Load the Analyst agent** - See your IDE-specific instructions in [docs/ide-info](./ide-info/) for how to activate agents:
-   - [Claude Code](./ide-info/claude-code.md)
-   - [Cursor](./ide-info/cursor.md)
-   - [VS Code/Windsurf](./ide-info/) - Check your IDE folder
-2. **Wait for the agent's menu** to appear
-3. **Tell the agent**: `*workflow-init` - v6 supports excellent natural language fuzzy matching, so you could also say "workflow init" or "please init the workflow"
-Since you are migrating an existing project from v4, it's most likely **Level 3 or 4** you will want to suggest when asked - if you've already completed PRD/architecture in v4.
----
-## Post-Migration Checklist
-- [ ] v4 folders backed up to `v4-backup/`
-- [ ] v6 installed to `{bmad_folder}/` folder
-- [ ] `workflow-init` run with correct project level selected
-- [ ] Agent customizations migrated to `{bmad_folder}/_cfg/agents/` if needed
-- [ ] IDE integration working (test by listing agents)
-- [ ] For active development: `sprint-planning` workflow executed
----
-## Getting Help
-- **Discord**: [Join the BMad Community](https://discord.gg/gk8jAdXWmj)
-- **Issues**: [GitHub Issue Tracker](https://github.com/bmad-code-org/BMAD-METHOD/issues)
-- **Docs**: Check `{bmad_folder}/docs/` in your installation for IDE-specific instructions