bmad-method 6.0.0-alpha.13 → 6.0.0-alpha.15

package/custom/src/agents/toolsmith/installation-guide.md

@@ -1,36 +0,0 @@
-# Custom Agent Installation
-
-## Quick Install
-
-```bash
-# Interactive
-npx bmad-method agent-install
-
-# Non-interactive
-npx bmad-method agent-install --defaults
-```
-
-## Install Specific Agent
-
-```bash
-# From specific source file
-npx bmad-method agent-install --source ./my-agent.agent.yaml
-
-# With default config (no prompts)
-npx bmad-method agent-install --source ./my-agent.agent.yaml --defaults
-
-# To specific destination
-npx bmad-method agent-install --source ./my-agent.agent.yaml --destination ./my-project
-```
-
-## Batch Install
-
-1. Copy agent YAML to `{bmad folder}/custom/src/agents/` OR `custom/src/agents` at your project folder root
-2. Run `npx bmad-method install` and select `Compile Agents` or `Quick Update`
-
-## What Happens
-
-1. Source YAML compiled to .md
-2. Installed to `custom/agents/{agent-name}/`
-3. Added to agent manifest
-4. Backup saved to `_cfg/custom/agents/`

package/docs/custom-agent-installation.md

@@ -1,183 +0,0 @@
-# Custom Agent Installation
-
-Install and personalize BMAD agents in your project.
-
-## Quick Start
-
-```bash
-# From your project directory with BMAD installed
-npx bmad-method agent-install
-```
-
-Or if you have bmad-cli installed globally:
-
-```bash
-bmad agent-install
-```
-
-## What It Does
-
-1. **Discovers** available agent templates from your custom agents folder
-2. **Prompts** you to personalize the agent (name, behavior, preferences)
-3. **Compiles** the agent with your choices baked in
-4. **Installs** to your project's `.bmad/custom/agents/` directory
-5. **Creates** IDE commands for all your configured IDEs (Claude Code, Codex, Cursor, etc.)
-6. **Saves** your configuration for automatic reinstallation during BMAD updates
-
-## Options
-
-```bash
-bmad agent-install [options]
-
-Options:
-  -p, --path <path>     #Direct path to specific agent YAML file or folder
-  -d, --defaults        #Use default values without prompting
-  -t, --target <path>   #Target installation directory
-```
-
-## Installing from Custom Locations
-
-Use the `-s` / `--source` option to install agents from any location:
-
-```bash
-# Install agent from a custom folder (expert agent with sidecar)
-bmad agent-install -s path/to/my-agent
-
-# Install a specific .agent.yaml file (simple agent)
-bmad agent-install -s path/to/my-agent.agent.yaml
-
-# Install with defaults (non-interactive)
-bmad agent-install -s path/to/my-agent -d
-
-# Install to a specific destination project
-bmad agent-install -s path/to/my-agent --destination /path/to/destination/project
-```
-
-This is useful when:
-
-- Your agent is in a non-standard location (not in `.bmad/custom/agents/`)
-- You're developing an agent outside the project structure
-- You want to install from an absolute path
-
-## Example Session
-
-```
-🔧 BMAD Agent Installer
-
-Found BMAD at: /project/.bmad
-Searching for agents in: /project/.bmad/custom/agents
-
-Available Agents:
-
-  1. 📄 commit-poet (simple)
-  2. 📚 journal-keeper (expert)
-
-Select agent to install (number): 1
-
-Selected: commit-poet
-
-📛 Agent Persona Name
-
-   Agent type: commit-poet
-   Default persona: Inkwell Von Comitizen
-
-   Custom name (or Enter for default): Fred
-
-   Persona: Fred
-   File: fred-commit-poet.md
-
-📝 Agent Configuration
-
-   What's your preferred default commit message style?
-   * 1. Conventional (feat/fix/chore)
-     2. Narrative storytelling
-     3. Poetic haiku
-     4. Detailed explanation
-   Choice (default: 1): 1
-
-   How enthusiastic should the agent be?
-     1. Moderate - Professional with personality
-   * 2. High - Genuinely excited
-     3. EXTREME - Full theatrical drama
-   Choice (default: 2): 3
-
-   Include emojis in commit messages? [Y/n]: y
-
-✨ Agent installed successfully!
-   Name: fred-commit-poet
-   Location: /project/.bmad/custom/agents/fred-commit-poet
-   Compiled: fred-commit-poet.md
-
-   ✓ Source saved for reinstallation
-   ✓ Added to agent-manifest.csv
-   ✓ Created IDE commands:
-      claude-code: /bmad:custom:agents:fred-commit-poet
-      codex: /bmad-custom-agents-fred-commit-poet
-      github-copilot: bmad-agent-custom-fred-commit-poet
-```
-
-## Reinstallation
-
-Custom agents are automatically reinstalled when you run `bmad init --quick`. Your personalization choices are preserved in `.bmad/_cfg/custom/agents/`.
-
-## Installing Reference Agents
-
-The BMAD source includes example agents you can install. **You must copy them to your project first.**
-
-### Step 1: Copy the Agent Template
-
-**For simple agents** (single file):
-
-```bash
-# From your project root
-cp node_modules/bmad-method/src/modules/bmb/reference/agents/stand-alone/commit-poet.agent.yaml \
-   .bmad/custom/agents/
-```
-
-**For expert agents** (folder with sidecar files):
-
-```bash
-# Copy the entire folder
-cp -r node_modules/bmad-method/src/modules/bmb/reference/agents/agent-with-memory/journal-keeper \
-   .bmad/custom/agents/
-```
-
-### Step 2: Install and Personalize
-
-```bash
-npx bmad-method agent-install
-# or: bmad agent-install (if BMAD installed locally)
-```
-
-The installer will:
-
-1. Find the copied template in `.bmad/custom/agents/`
-2. Prompt for personalization (name, behavior, preferences)
-3. Compile and install with your choices baked in
-4. Create IDE commands for immediate use
-
-### Available Reference Agents
-
-**Simple (standalone file):**
-
-- `commit-poet.agent.yaml` - Commit message artisan with style preferences
-
-**Expert (folder with sidecar):**
-
-- `journal-keeper/` - Personal journal companion with memory and pattern recognition
-
-Find these in the BMAD source:
-
-```
-src/modules/bmb/reference/agents/
-├── stand-alone/
-│   └── commit-poet.agent.yaml
-└── agent-with-memory/
-    └── journal-keeper/
-        ├── journal-keeper.agent.yaml
-        └── journal-keeper-sidecar/
-```
-
-## Creating Your Own
-
-Use the BMB agent builder to craft your agents. Once ready to use yourself, place your `.agent.yaml` files or folder in `.bmad/custom/agents/`.

package/src/modules/bmb/docs/workflows/workflow-template.md

@@ -1,152 +0,0 @@
-# BMAD Workflow Template
-
-This template provides the standard structure for all BMAD workflow files. Copy and modify this template for each new workflow you create.
-
-## Frontmatter Structure
-
-Copy this YAML frontmatter and fill in your specific values:
-
-```yaml
----
-name: [WORKFLOW_DISPLAY_NAME]
-description: [Brief description of what this workflow accomplishes]
-web_bundle: [true/false]  # Set to true for inclusion in web bundle builds
----
-
-# [WORKFLOW_DISPLAY_NAME]
-
-**Goal:** [State the primary goal of this workflow in one clear sentence]
-
-**Your Role:** In addition to your name, communication_style, and persona, you are also a [role] collaborating with [user type]. This is a partnership, not a client-vendor relationship. You bring [your expertise], while the user brings [their expertise]. Work together as equals.
-
----
-
-## WORKFLOW ARCHITECTURE
-
-This uses **step-file architecture** for disciplined execution:
-
-### Core Principles
-- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
-- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
-- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
-- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
-- **Append-Only Building**: Build documents by appending content as directed to the output file
-
-### Step Processing Rules
-1. **READ COMPLETELY**: Always read the entire step file before taking any action
-2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
-3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
-4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
-5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
-6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
-
-### Critical Rules (NO EXCEPTIONS)
-- 🛑 **NEVER** load multiple step files simultaneously
-- 📖 **ALWAYS** read entire step file before execution
-- 🚫 **NEVER** skip steps or optimize the sequence
-- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
-- 🎯 **ALWAYS** follow the exact instructions in the step file
-- ⏸️ **ALWAYS** halt at menus and wait for user input
-- 📋 **NEVER** create mental todo lists from future steps
-
----
-
-## INITIALIZATION SEQUENCE
-
-### 1. Configuration Loading
-
-Load and read full config from {project-root}/{bmad_folder}/[module such as core, bmm, bmb]/config.yaml and resolve:
-
-- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, [any additional variables]
-
-**Note:** Use variable substitution patterns for flexible installation paths:
-- `{project-root}` - Root directory of the project
-- `{bmad_folder}` - Name of the BMAD folder (usually `.bmad`)
-- `[module]` - Module name (core, bmm, bmb, or custom)
-
-### 2. First Step EXECUTION
-
-Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow.
-```
-
-## How to Use This Template
-
-### Step 1: Copy and Replace Placeholders
-
-Copy the template above and replace:
-
-- `[WORKFLOW_DISPLAY_NAME]` → Your workflow's display name
-- `[Brief description]` → One-sentence description
-- `[true/false]` → Whether to include in web bundle
-- `[role]` → AI's role in this workflow
-- `[user type]` → Who the user is
-- `[CONFIG_PATH]` → Path to config file (usually `bmm/config.yaml` or `bmb/config.yaml`)
-- `[WORKFLOW_PATH]` → Path to your workflow folder
-- `[any additional variables]` → Extra config variables needed
-
-### Step 2: Create the Folder Structure
-
-```
-[workflow-folder]/
-├── workflow.md          # This file
-└── steps/
-    ├── step-01-init.md
-    ├── step-02-[name].md
-    └── ...
-```
-
-### Step 3: Configure the Initialization Path
-
-Update the last line to point to your actual first step file:
-
-```markdown
-Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow.
-```
-
-## Examples
-
-### Example 1: Document Creation Workflow
-
-```yaml
----
-name: User Guide Creator
-description: Creates comprehensive user guides through collaborative content creation
-web_bundle: true
----
-
-# User Guide Creator
-
-**Goal:** Create comprehensive user guides through collaborative content creation
-
-**Your Role:** In addition to your name, communication_style, and persona, you are also a technical writer collaborating with a subject matter expert. This is a partnership, not a client-vendor relationship. You bring structured writing skills and documentation expertise, while the user brings domain knowledge and technical expertise. Work together as equals.
-```
-
-### Example 2: Decision Support Workflow
-
-```yaml
----
-name: Decision Framework
-description: Helps users make structured decisions using proven methodologies
-web_bundle: false
----
-
-# Decision Framework
-
-**Goal:** Helps users make structured decisions using proven methodologies
-
-**Your Role:** In addition to your name, communication_style, and persona, you are also a decision facilitator collaborating with a decision maker. This is a partnership, not a client-vendor relationship. You bring structured thinking and facilitation skills, while the user brings context and decision criteria. Work together as equals.
-```
-
-## Best Practices
-
-1. **Keep Roles Collaborative**: Always emphasize partnership over client-vendor relationships
-2. **Be Specific About Goals**: One clear sentence that describes the outcome
-3. **Use Standard Architecture**: Never modify the WORKFLOW ARCHITECTURE section
-4. **Include web_bundle**: Set to true for production-ready workflows
-5. **Test the Path**: Verify the step file path exists and is correct
-
-## Example Implementation
-
-See the [Meal Prep & Nutrition Plan workflow](../reference/workflows/meal-prep-nutrition/workflow.md) for a complete implementation of this template.
-
-Remember: This template is the STANDARD for all BMAD workflows. Do not modify the core architecture section - only customize the role description and goal.

package/src/modules/bmb/workflows/create-workflow/steps/step-03-tools-overview.md

@@ -1,127 +0,0 @@
----
-name: 'step-03-tools-overview'
-description: 'Present available tools from CSV and gather initial user requirements'
-
-# Path Definitions
-workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
-
-# File References
-thisStepFile: '{workflow_path}/steps/step-03-tools-overview.md'
-nextStepFile: '{workflow_path}/steps/step-04-core-tools.md'
-workflowFile: '{workflow_path}/workflow.md'
-workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
-
-# Documentation References
-commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
----
-
-# Step 3: Tools Overview
-
-## STEP GOAL:
-
-Load and present available tools from the CSV, then gather the user's general tool requirements for their workflow.
-
-## MANDATORY EXECUTION RULES (READ FIRST):
-
-### Universal Rules:
-
-- 🛑 NEVER generate content without user input
-- 📖 CRITICAL: Read the complete step file before taking any action
-- 📋 YOU ARE A FACILITATOR, not a content generator
-
-### Role Reinforcement:
-
-- ✅ You are a workflow architect and integration specialist
-- ✅ We engage in collaborative dialogue, not command-response
-- ✅ You bring expertise in BMAD tools and workflow optimization
-- ✅ User brings their workflow requirements
-
-## EXECUTION PROTOCOLS:
-
-- 🎯 Load CSV and present tools dynamically
-- 💾 Gather user's general tool requirements
-- 📖 Document requirements in workflow plan
-- 🚫 FORBIDDEN to proceed without user input
-
-## SEQUENCE OF INSTRUCTIONS:
-
-### 1. Initialize Tools Discussion
-
-"Beginning **Tools Integration and Configuration**
-
-Based on your workflow requirements, I'll help identify the best tools and integrations. Let me first load the available tools from our reference."
-
-### 2. Load and Present Available Tools
-
-Load `{commonToolsCsv}` and present tools organized by type:
-
-"**Available BMAD Tools and Integrations:**
-
-**Always Available (Recommended for Most Workflows):**
-
-- [List tools from CSV where propose='always', organized by type]
-
-**Example Tools (Available When Needed):**
-
-- [List tools from CSV where propose='example', organized by type]
-
-\*\*Tools requiring installation will be noted."
-
-### 3. Gather Initial Requirements
-
-"**Your Tool Requirements:**
-
-Based on your workflow type and goals, what tools do you anticipate needing?
-
-1. **Core BMAD Tools:** Do you want collaborative idea generation, critical evaluation, or brainstorming capabilities?
-2. **LLM Features:** Will you need web access, file management, sub-agents, or parallel processing?
-3. **Memory:** Does your workflow need persistent state across sessions?
-4. **External Tools:** Will you need MCP integrations like documentation access, browser automation, or database connections?
-
-**Initial Tool Preferences:** [gather user's general requirements]"
-
-### 4. Document Requirements
-
-Append to {workflowPlanFile}:
-
-```markdown
-## Tool Requirements Summary
-
-**Initial Tool Preferences:**
-
-- Core BMAD Tools: [user selections]
-- LLM Features: [user selections]
-- Memory Requirements: [user selections]
-- External Tools: [user selections]
-  **Installation Willingness:** [user comfort level with installing tools]
-```
-
-### 5. Menu Options
-
-Display: **Select an Option:** [C] Continue to Core Tools [M] Modify Requirements
-
-#### Menu Handling Logic:
-
-- IF C: Append tools overview to {workflowPlanFile}, update frontmatter, then load {nextStepFile}
-- IF M: Refine requirements discussion
-
-## CRITICAL STEP COMPLETION NOTE
-
-ONLY WHEN C is selected and requirements are documented will you load {nextStepFile} to configure core tools.
-
----
-
-## 🚨 SYSTEM SUCCESS/FAILURE METRICS
-
-### ✅ SUCCESS:
-
-- CSV loaded and tools presented clearly
-- User's initial tool requirements gathered
-- Requirements documented in workflow plan
-- User ready to proceed to detailed configuration
-
-### ❌ SYSTEM FAILURE:
-
-- Not loading tools from CSV
-- Duplicating CSV content in step file
-- Proceeding without user requirements input

package/src/modules/bmb/workflows/create-workflow/steps/step-04-core-tools.md

@@ -1,145 +0,0 @@
----
-name: 'step-04-core-tools'
-description: 'Configure always-available core tools and their integration points'
-
-# Path Definitions
-workflow_path: '{project-root}/{bmad_folder}/bmb/workflows/create-workflow'
-
-# File References
-thisStepFile: '{workflow_path}/steps/step-04-core-tools.md'
-nextStepFile: '{workflow_path}/steps/step-05-memory-requirements.md'
-workflowFile: '{workflow_path}/workflow.md'
-workflowPlanFile: '{output_folder}/workflow-plan-{new_workflow_name}.md'
-
-# Documentation References
-commonToolsCsv: '{project-root}/{bmad_folder}/bmb/docs/workflows/common-workflow-tools.csv'
----
-
-# Step 4: Core Tools Configuration
-
-## STEP GOAL:
-
-Configure always-available core tools (party-mode, advanced-elicitation, brainstorming, and LLM features) with specific integration points in the workflow.
-
-## MANDATORY EXECUTION RULES (READ FIRST):
-
-### Universal Rules:
-
-- 🛑 NEVER generate content without user input
-- 📖 CRITICAL: Read the complete step file before taking any action
-- 📋 YOU ARE A FACILITATOR, not a content generator
-
-### Role Reinforcement:
-
-- ✅ You are a workflow architect and integration specialist
-- ✅ We engage in collaborative dialogue, not command-response
-- ✅ You bring expertise in BMAD tools and integration patterns
-
-## EXECUTION PROTOCOLS:
-
-- 🎯 Load core tools from CSV and configure integration points
-- 💾 Confirm user choices for each core tool
-- 📖 Document configuration in workflow plan
-- 🚫 FORBIDDEN to proceed without user confirmation
-
-## SEQUENCE OF INSTRUCTIONS:
-
-### 1. Initialize Core Tools Configuration
-
-"Configuring **Core BMAD Tools and Features**
-
-These core tools significantly enhance workflow quality. Let's configure each one for optimal integration into your workflow."
-
-### 2. Present Core Tools from CSV
-
-Load `{commonToolsCsv}` and filter for `propose='always'`:
-
-"**Core Tools (Always Available):**
-
-**Workflows & Tasks:**
-
-- **Party-Mode:** [description from CSV]
-- **Advanced Elicitation:** [description from CSV]
-- **Brainstorming:** [description from CSV]
-
-**LLM Tool Features:**
-
-- **Web-Browsing:** [description from CSV]
-- **File I/O:** [description from CSV]
-- **Sub-Agents:** [description from CSV]
-- **Sub-Processes:** [description from CSV]
-
-**Tool-Memory:**
-
-- **Sidecar File:** [description from CSV]"
-
-### 3. Configure Integration Points
-
-For each tool, ask about integration:
-
-"**Core Tools Integration:**
-
-**Workflows & Tasks:**
-
-1. **Party-Mode** - Where should collaborative AI sessions be offered? [decision points, creative phases]
-2. **Advanced Elicitation** - Where should critical evaluation checkpoints be placed? [after content creation, quality gates]
-3. **Brainstorming** - Where should creative ideation be integrated? [idea generation phases, innovation points]
-
-**LLM Features:** 4. **Web-Browsing** - When is current information needed? [real-time data, current events] 5. **File I/O** - What document operations are required? [file creation, data management] 6. **Sub-Agents** - Where would specialized delegation help? [complex tasks, parallel processing] 7. **Sub-Processes** - Where would parallel processing improve performance? [long operations, resource optimization]
-
-**Tool-Memory:** 8. **Sidecar File** - Does your workflow need persistent state? [session continuity, agent initialization]"
-
-### 4. Document Core Tools Configuration
-
-Append to {workflowPlanFile}:
-
-```markdown
-## Core Tools Configuration
-
-### Workflows & Tasks
-
-**Party-Mode:** [included/excluded] - Integration points: [specific phases]
-**Advanced Elicitation:** [included/excluded] - Integration points: [specific phases]
-**Brainstorming:** [included/excluded] - Integration points: [specific phases]
-
-### LLM Tool Features
-
-**Web-Browsing:** [included/excluded] - Integration points: [specific phases]
-**File I/O:** [included/excluded] - Integration points: [specific phases]
-**Sub-Agents:** [included/excluded] - Integration points: [specific phases]
-**Sub-Processes:** [included/excluded] - Integration points: [specific phases]
-
-### Tool-Memory
-
-**Sidecar File:** [included/excluded] - Use case: [history tracking, agent initialization]
-```
-
-### 5. Menu Options
-
-Display: **Select an Option:** [C] Continue to Memory Configuration [M] Modify Core Tools
-
-#### Menu Handling Logic:
-
-- IF C: Append core tools configuration to {workflowPlanFile}, update frontmatter, then load {nextStepFile}
-- IF M: Return to tool configuration
-
-## CRITICAL STEP COMPLETION NOTE
-
-ONLY WHEN C is selected and core tools are documented will you load {nextStepFile} to configure memory requirements.
-
----
-
-## 🚨 SYSTEM SUCCESS/FAILURE METRICS
-
-### ✅ SUCCESS:
-
-- Core tools presented using CSV descriptions
-- Integration points configured for each selected tool
-- Configuration documented in workflow plan
-- User understands how tools enhance workflow
-
-### ❌ SYSTEM FAILURE:
-
-- Duplicating CSV content instead of referencing it
-- Not confirming integration points with user
-- Proceeding without user confirmation of configuration