bmad-method 6.0.0-alpha.0 → 6.0.0-alpha.10

package/src/modules/bmb/workflows/create-agent/workflow.yaml

@@ -1,15 +1,13 @@
 # Build Agent Workflow Configuration
-name: build-agent
-description: "Interactive workflow to build BMAD Core compliant agents (simple, expert, or module types) with optional brainstorming for agent ideas, proper persona development, activation rules, and command structure"
+name: create-agent
+description: "Interactive workflow to build BMAD Core compliant agents (YAML source compiled to .md during install) with optional brainstorming, persona development, and command structure"
 author: "BMad"
 
 # Critical variables load from config_source
-config_source: "{project-root}/bmad/bmb/config.yaml"
-output_folder: "{config_source}:output_folder"
+config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
+custom_agent_location: "{config_source}:custom_agent_location"
 user_name: "{config_source}:user_name"
-src_impact: "{config_source}:src_impact"
 communication_language: "{config_source}:communication_language"
-date: system-generated
 
 # Technical documentation for agent building
 agent_types: "{installed_path}/agent-types.md"
@@ -17,23 +15,34 @@ agent_architecture: "{installed_path}/agent-architecture.md"
 agent_commands: "{installed_path}/agent-command-patterns.md"
 communication_styles: "{installed_path}/communication-styles.md"
 
-# Optional docs that help understand agent patterns
-recommended_inputs:
-  - example_agents: "{project-root}/bmad/bmm/agents/"
-  - agent_activation_rules: "{project-root}/src/utility/models/agent-activation-ide.xml"
+# Reference examples and conventions
+example_agents_dir: "{project-root}/{bmad_folder}/bmm/agents/"
+agent_activation_rules: "{project-root}/src/utility/models/agent-activation-ide.xml"
 
 # Module path and component files
-installed_path: "{project-root}/bmad/bmb/workflows/build-agent"
+installed_path: "{project-root}/{bmad_folder}/bmb/workflows/create-agent"
 template: false # This is an interactive workflow - no template needed
 instructions: "{installed_path}/instructions.md"
 validation: "{installed_path}/checklist.md"
 
-# Output configuration - dynamic based on src_impact and agent type
-# If src_impact=true: Save to src/modules/{{target_module}}/agents/
-# If src_impact=false: Save to output_folder/agents/
-default_output_file: "{output_folder}/agents/{{agent_filename}}.md"
-src_output_file: "{project-root}/src/modules/{{target_module}}/agents/{{agent_filename}}.md"
-config_output_file: "{project-root}/bmad/_cfg/agents/{{agent_config_name}}.md"
+# Output configuration - YAML agents compiled to .md at install time
+# Module agents: Save to {bmad_folder}/{{target_module}}/agents/
+# Standalone agents: Save to custom_agent_location/
+module_output_file: "{project-root}/{bmad_folder}/{{target_module}}/agents/{{agent_filename}}.agent.yaml"
+standalone_output_file: "{custom_agent_location}/{{agent_filename}}.agent.yaml"
+# Optional user override file (auto-created by installer if missing)
+config_output_file: "{project-root}/{bmad_folder}/_cfg/agents/{{target_module}}-{{agent_filename}}.customize.yaml"
 
-# No special tools required for agent building
-required_tools: []
+standalone: true
+
+web_bundle:
+  name: "create-agent"
+  description: "Interactive workflow to build BMAD Core compliant agents (simple, expert, or module types) with optional brainstorming for agent ideas, proper persona development, activation rules, and command structure"
+  author: "BMad"
+  web_bundle_files:
+    - "{bmad_folder}/bmb/workflows/create-agent/instructions.md"
+    - "{bmad_folder}/bmb/workflows/create-agent/checklist.md"
+    - "{bmad_folder}/bmb/workflows/create-agent/agent-types.md"
+    - "{bmad_folder}/bmb/workflows/create-agent/agent-architecture.md"
+    - "{bmad_folder}/bmb/workflows/create-agent/agent-command-patterns.md"
+    - "{bmad_folder}/bmb/workflows/create-agent/communication-styles.md"

package/src/modules/bmb/workflows/create-module/README.md

@@ -1,218 +1,229 @@
-# Build Module Workflow
+# Create Module Workflow
 
-## Overview
+Interactive scaffolding system creating complete BMad modules with agents, workflows, tasks, and installation infrastructure.
 
-The Build Module workflow is an interactive scaffolding system that creates complete BMAD modules with agents, workflows, tasks, and installation infrastructure. It serves as the primary tool for building new modules in the BMAD ecosystem, guiding users through the entire module creation process from concept to deployment-ready structure.
+## Table of Contents
 
-## Key Features
+- [Quick Start](#quick-start)
+- [Workflow Phases](#workflow-phases)
+- [Output Structure](#output-structure)
+- [Module Components](#module-components)
+- [Best Practices](#best-practices)
 
-- **Interactive Module Planning** - Collaborative session to define module concept, scope, and architecture
-- **Intelligent Scaffolding** - Automatic creation of proper directory structures and configuration files
-- **Component Integration** - Seamless integration with build-agent and build-workflow workflows
-- **Installation Infrastructure** - Complete installer setup with configuration templates
-- **Module Brief Integration** - Can use existing module briefs as blueprints for accelerated development
-- **Validation & Documentation** - Built-in validation checks and comprehensive README generation
-
-## Usage
-
-### Basic Invocation
+## Quick Start
 
 ```bash
-workflow build-module
-```
+# Basic invocation
+workflow create-module
 
-### With Module Brief Input
+# With module brief input
+workflow create-module --input module-brief-{name}-{date}.md
 
-```bash
-# If you have a module brief from the module-brief workflow
-workflow build-module --input module-brief-my-module-2024-09-26.md
+# Via BMad Builder
+*create-module
 ```
 
-### Configuration
-
-The workflow loads critical variables from the BMB configuration:
-
-- **output_folder**: Where the module will be created
-- **user_name**: Module author information
-- **date**: Automatic timestamp for versioning
-
-## Workflow Structure
-
-### Files Included
-
-```
-build-module/
-├── workflow.yaml           # Configuration and metadata
-├── instructions.md         # Step-by-step execution guide
-├── checklist.md           # Validation criteria
-├── module-structure.md    # Module architecture guide
-├── installer-templates/   # Installation templates
-│   ├── install-config.yaml
-│   └── installer.js
-└── README.md             # This file
-```
-
-## Workflow Process
-
-### Phase 1: Concept Definition (Steps 1-2)
+## Workflow Phases
 
-**Module Vision & Identity**
+### Phase 1: Concept Definition
 
-- Define module concept, purpose, and target audience
-- Establish module code (kebab-case) and friendly name
-- Choose module category (Domain-Specific, Creative, Technical, Business, Personal)
-- Plan component architecture with agent and workflow specifications
+- Define module purpose and audience
+- Establish module code (kebab-case) and name
+- Choose category (Domain, Creative, Technical, Business, Personal)
+- Plan component architecture
 
-**Module Brief Integration**
+**Module Brief Integration:**
 
-- Automatically detects existing module briefs in output folder
-- Can load and use briefs as pre-populated blueprints
-- Accelerates planning when comprehensive brief exists
+- Auto-detects existing briefs
+- Uses as pre-populated blueprint
+- Accelerates planning phase
 
-### Phase 2: Architecture Planning (Steps 3-4)
+### Phase 2: Architecture Planning
 
-**Directory Structure Creation**
+- Create directory hierarchy
+- Setup configuration system
+- Define installer structure
+- Establish component folders
 
-- Creates complete module directory hierarchy
-- Sets up agent, workflow, task, template, and data folders
-- Establishes installer directory with proper configuration
+### Phase 3: Component Creation
 
-**Module Configuration**
+- Optional first agent creation
+- Optional first workflow creation
+- Component placeholder generation
+- Integration validation
 
-- Generates main config.yaml with module metadata
-- Configures component counts and references
-- Sets up output and data folder specifications
+### Phase 4: Installation Setup
 
-### Phase 3: Component Creation (Steps 5-6)
+- Create install-config.yaml
+- Configure deployment questions
+- Setup installer logic
+- Post-install messaging
 
-**Interactive Component Building**
+### Phase 5: Documentation
 
-- Optional creation of first agent using build-agent workflow
-- Optional creation of first workflow using build-workflow workflow
-- Creates placeholders for components to be built later
+- Generate comprehensive README
+- Create development roadmap
+- Provide quick commands
+- Document next steps
 
-**Workflow Integration**
+## Output Structure
 
-- Seamlessly invokes sub-workflows for component creation
-- Ensures proper file placement and structure
-- Maintains module consistency across components
+### Generated Directory
 
-### Phase 4: Installation & Documentation (Steps 7-9)
-
-**Installer Infrastructure**
+```
+{bmad_folder}/{module-code}/
+├── agents/              # Agent definitions
+├── workflows/           # Workflow processes
+├── tasks/              # Reusable tasks
+├── templates/          # Document templates
+├── data/               # Module data files
+├── _module-installer/  # Installation logic
+│   ├── install-config.yaml
+│   └── installer.js
+├── README.md           # Module documentation
+├── TODO.md            # Development roadmap
+└── config.yaml        # Runtime configuration
+```
 
-- Creates install-module-config.yaml for deployment
-- Sets up optional installer.js for complex installation logic
-- Configures post-install messaging and instructions
+### Configuration Files
 
-**Comprehensive Documentation**
+**install-config.yaml** - Installation questions
 
-- Generates detailed README.md with usage examples
-- Creates development roadmap for remaining components
-- Provides quick commands for continued development
+```yaml
+questions:
+  - id: user_name
+    prompt: 'Your name?'
+    default: 'User'
+  - id: output_folder
+    prompt: 'Output location?'
+    default: './output'
+```
 
-### Phase 5: Validation & Finalization (Step 10)
+**config.yaml** - Generated from user answers during install
 
-**Quality Assurance**
+```yaml
+user_name: 'John Doe'
+output_folder: './my-output'
+```
 
-- Validates directory structure and configuration files
-- Checks component references and path consistency
-- Ensures installer configuration is deployment-ready
-- Provides comprehensive module summary and next steps
+## Module Components
 
-## Output
+### Agents
 
-### Generated Files
+- Full module agents with workflows
+- Expert agents with sidecars
+- Simple utility agents
 
-- **Module Directory**: Complete module structure at `{project-root}/bmad/{module_code}/`
-- **Configuration Files**: config.yaml, install-module-config.yaml
-- **Documentation**: README.md, TODO.md development roadmap
-- **Component Placeholders**: Structured folders for agents, workflows, and tasks
+### Workflows
 
-### Output Structure
+- Multi-step guided processes
+- Configuration-driven
+- Web bundle support
 
-The workflow creates a complete module ready for development:
+### Tasks
 
-1. **Module Identity** - Name, code, version, and metadata
-2. **Directory Structure** - Proper BMAD module hierarchy
-3. **Configuration System** - Runtime and installation configs
-4. **Component Framework** - Ready-to-use agent and workflow scaffolding
-5. **Installation Infrastructure** - Deployment-ready installer
-6. **Documentation Suite** - README, roadmap, and development guides
+- Reusable operations
+- Agent-agnostic
+- Modular components
 
-## Requirements
+### Templates
 
-- **Module Brief** (optional but recommended) - Use module-brief workflow first for best results
-- **BMAD Core Configuration** - Properly configured BMB config.yaml
-- **Build Tools Access** - build-agent and build-workflow workflows must be available
+- Document structures
+- Output formats
+- Report templates
 
 ## Best Practices
 
-### Before Starting
+### Planning
 
-1. **Create a Module Brief** - Run module-brief workflow for comprehensive planning
-2. **Review Existing Modules** - Study similar modules in `/bmad/` for patterns and inspiration
-3. **Define Clear Scope** - Have a concrete vision of what the module will accomplish
+1. **Use module-brief workflow first** - Creates comprehensive blueprint
+2. **Define clear scope** - Avoid feature creep
+3. **Plan component interactions** - Map agent/workflow relationships
 
-### During Execution
+### Structure
 
-1. **Use Module Briefs** - Load existing briefs when prompted for accelerated development
-2. **Start Simple** - Create one core agent and workflow, then expand iteratively
-3. **Leverage Sub-workflows** - Use build-agent and build-workflow for quality components
-4. **Validate Early** - Review generated structure before proceeding to next phases
+1. **Follow conventions** - Use established patterns
+2. **Keep components focused** - Single responsibility
+3. **Document thoroughly** - Clear README and inline docs
 
-### After Completion
+### Development
 
-1. **Follow the Roadmap** - Use generated TODO.md for systematic development
-2. **Test Installation** - Validate installer with `bmad install {module_code}`
-3. **Iterate Components** - Use quick commands to add agents and workflows
-4. **Document Progress** - Update README.md as the module evolves
+1. **Start with core agent** - Build primary functionality first
+2. **Create key workflows** - Essential processes before edge cases
+3. **Test incrementally** - Validate as you build
 
-## Troubleshooting
+### Installation
 
-### Common Issues
+1. **Minimal config questions** - Only essential settings
+2. **Smart defaults** - Sensible out-of-box experience
+3. **Clear post-install** - Guide users to first steps
 
-**Issue**: Module already exists at target location
+## Integration Points
 
-- **Solution**: Choose a different module code or remove existing module
-- **Check**: Verify output folder permissions and available space
+### With Other Workflows
 
-**Issue**: Sub-workflow invocation fails
+- **module-brief** - Strategic planning input
+- **create-agent** - Agent component creation
+- **create-workflow** - Workflow building
+- **redoc** - Documentation maintenance
 
-- **Solution**: Ensure build-agent and build-workflow workflows are available
-- **Check**: Validate workflow paths in config.yaml
+### With BMad Core
 
-**Issue**: Installation configuration invalid
+- Uses core framework capabilities
+- Integrates with module system
+- Follows BMad conventions
 
-- **Solution**: Review install-module-config.yaml syntax and paths
-- **Check**: Ensure all referenced paths use {project-root} variables correctly
+## Examples
 
-## Customization
+### Domain-Specific Module
 
-To customize this workflow:
+```
+Category: Domain-Specific
+Code: legal-advisor
+Components:
+- Contract Review Agent
+- Compliance Workflow
+- Legal Templates
+```
 
-1. **Modify Instructions** - Update instructions.md to adjust scaffolding steps
-2. **Extend Templates** - Add new installer templates in installer-templates/
-3. **Update Validation** - Enhance checklist.md with additional quality checks
-4. **Add Components** - Integrate additional sub-workflows for specialized components
+### Creative Module
 
-## Version History
+```
+Category: Creative
+Code: story-builder
+Components:
+- Narrative Agent
+- Plot Workflow
+- Character Templates
+```
 
-- **v1.0.0** - Initial release
-  - Interactive module scaffolding
-  - Component integration with build-agent and build-workflow
-  - Complete installation infrastructure
-  - Module brief integration support
+### Technical Module
 
-## Support
+```
+Category: Technical
+Code: api-tester
+Components:
+- Test Runner Agent
+- API Validation Workflow
+- Test Report Templates
+```
 
-For issues or questions:
+## Workflow Files
 
-- Review the workflow creation guide at `/bmad/bmb/workflows/build-workflow/workflow-creation-guide.md`
-- Study module structure patterns at `module-structure.md`
-- Validate output using `checklist.md`
-- Consult existing modules in `/bmad/` for examples
+```
+create-module/
+├── workflow.yaml          # Configuration
+├── instructions.md        # Step guide
+├── checklist.md          # Validation
+├── module-structure.md   # Architecture
+├── installer-templates/  # Install files
+└── README.md            # This file
+```
 
----
+## Related Documentation
 
-_Part of the BMad Method v5 - BMB (Builder) Module_
+- [Module Structure](./module-structure.md)
+- [Module Brief Workflow](../module-brief/README.md)
+- [Create Agent](../create-agent/README.md)
+- [Create Workflow](../create-workflow/README.md)
+- [BMB Module](../../README.md)

package/src/modules/bmb/workflows/create-module/brainstorm-context.md

@@ -20,7 +20,7 @@ A module is a cohesive package that provides:
 
 Explore and define:
 
-### 1. Domain & Purpose
+### 1. Domain and Purpose
 
 - **What domain/problem space?** (e.g., game development, marketing, personal productivity)
 - **Who is the target user?** (developers, writers, managers, hobbyists)

package/src/modules/bmb/workflows/create-module/checklist.md

@@ -1,6 +1,6 @@
 # Build Module Validation Checklist
 
-## Module Identity & Metadata
+## Module Identity and Metadata
 
 ### Basic Information
 
@@ -19,23 +19,22 @@
 
 ## Directory Structure
 
-### Source Directories (bmad/{module-code}/)
+### Source Directories ({bmad_folder}/{module-code}/)
 
 - [ ] `/agents` directory created (even if empty)
 - [ ] `/workflows` directory created (even if empty)
 - [ ] `/tasks` directory exists (if tasks planned)
 - [ ] `/templates` directory exists (if templates used)
 - [ ] `/data` directory exists (if data files needed)
-- [ ] `config.yaml` present in module root
+- [ ] `/_module-installer/install-config.yaml` present (defines configuration questions)
 - [ ] `README.md` present with documentation
 
-### Runtime Directories (bmad/{module-code}/)
+### Installed Module Structure (generated in target after installation)
 
-- [ ] `/_module-installer` directory created
+- [ ] `/agents` directory for compiled agents
+- [ ] `/workflows` directory for workflow instances
 - [ ] `/data` directory for user data
-- [ ] `/agents` directory for overrides
-- [ ] `/workflows` directory for instances
-- [ ] Runtime `config.yaml` present
+- [ ] `config.yaml` generated from install-config.yaml during installation
 
 ## Component Planning
 
@@ -63,22 +62,22 @@
 
 ## Configuration Files
 
-### Module config.yaml
+### Installation Configuration (install-config.yaml)
 
-- [ ] All required fields present (name, code, version, author)
-- [ ] Component lists accurate (agents, workflows, tasks)
-- [ ] Paths use proper variables ({project-root}, etc.)
-- [ ] Output folders configured
-- [ ] Custom settings documented
+- [ ] `install-config.yaml` exists in `_module-installer`
+- [ ] Module metadata present (code, name, version)
+- [ ] Configuration questions defined for user input
+- [ ] Default values provided for all questions
+- [ ] Prompt text is clear and helpful
+- [ ] Result templates use proper variable substitution
+- [ ] Paths use proper variables ({project-root}, {value}, etc.)
 
-### Install Configuration
+### Generated Config (config.yaml in target)
 
-- [ ] `install-module-config.yaml` exists in `_module-installer`
-- [ ] Installation steps defined
-- [ ] Directory creation steps present
-- [ ] File copy operations specified
-- [ ] Module registration included
-- [ ] Post-install message defined
+- [ ] Generated during installation from install-config.yaml
+- [ ] Contains all user-provided configuration values
+- [ ] Module metadata included
+- [ ] No config.yaml should exist in source module
 
 ## Installation Infrastructure
 
@@ -165,7 +164,7 @@
 - [ ] Component organization is logical
 - [ ] No hard-coded limits
 
-## Testing & Validation
+## Testing and Validation
 
 ### Structural Validation
 
@@ -234,12 +233,3 @@
 - [ ] Alpha (Core functionality works)
 - [ ] Beta (Most features complete, needs testing)
 - [ ] Release (Full functionality, documented)
-
-## Sign-off
-
-**Module Name:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
-**Module Code:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
-**Version:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
-**Validated By:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
-**Date:** \***\*\*\*\*\***\_\_\***\*\*\*\*\***
-**Status:** ⬜ Pass / ⬜ Pass with Issues / ⬜ Fail

package/src/modules/bmb/workflows/create-module/installer-templates/install-config.yaml

@@ -0,0 +1,92 @@
+# {{MODULE_NAME}} Module Configuration
+# This file defines installation questions and module configuration values
+
+code: "{{MODULE_CODE}}"
+name: "{{MODULE_NAME}}"
+default_selected: "{{DEFAULT_SELECTED}}" # true if this should be selected by default
+
+# Welcome message shown during installation
+prompt:
+  - "{{WELCOME_MESSAGE_LINE_1}}"
+  - "{{WELCOME_MESSAGE_LINE_2}}"
+# Core config values are automatically inherited:
+## user_name
+## communication_language
+## document_output_language
+## output_folder
+
+# ============================================================================
+# CONFIGURATION FIELDS
+# ============================================================================
+#
+# Each field can be:
+# 1. INTERACTIVE (has 'prompt' - asks user during installation)
+# 2. STATIC (no 'prompt' - just uses 'result' value)
+#
+# Field structure:
+#   field_name:
+#     prompt: "Question to ask user" (optional - omit for static values)
+#     default: "default_value" (optional)
+#     result: "{value}" or "static-value"
+#     single-select: [...] (optional - for dropdown)
+#     multi-select: [...] (optional - for checkboxes)
+#
+# Special placeholders in result:
+#   {value} - replaced with user's answer
+#   {project-root} - replaced with project root path
+#   {directory_name} - replaced with project directory name
+#   {module_code} - replaced with this module's code
+# ============================================================================
+
+# EXAMPLE: Interactive text input
+# example_project_name:
+#   prompt: "What is your project name?"
+#   default: "{directory_name}"
+#   result: "{value}"
+
+# EXAMPLE: Interactive single-select dropdown
+# example_skill_level:
+#   prompt: "What is your experience level?"
+#   default: "intermediate"
+#   result: "{value}"
+#   single-select:
+#     - value: "beginner"
+#       label: "Beginner - New to this domain"
+#     - value: "intermediate"
+#       label: "Intermediate - Familiar with basics"
+#     - value: "expert"
+#       label: "Expert - Deep knowledge"
+
+# EXAMPLE: Interactive multi-select checkboxes
+# example_features:
+#   prompt:
+#     - "Which features do you want to enable?"
+#     - "(Select all that apply)"
+#   result: "{value}"
+#   multi-select:
+#     - "Feature A"
+#     - "Feature B"
+#     - "Feature C"
+
+# EXAMPLE: Interactive path input
+# example_output_path:
+#   prompt: "Where should outputs be saved?"
+#   default: "output/{{MODULE_CODE}}"
+#   result: "{project-root}/{value}"
+
+# EXAMPLE: Static value (no user prompt)
+# example_static_setting:
+#   result: "hardcoded-value"
+
+# EXAMPLE: Static path
+# module_data_path:
+#   result: "{project-root}/{bmad_folder}/{{MODULE_CODE}}/data"
+
+# ============================================================================
+# YOUR MODULE CONFIGURATION FIELDS
+# ============================================================================
+# Replace examples above with your module's actual configuration needs.
+# Delete this comment block and the examples when implementing.
+# ============================================================================
+
+# TODO: INSERT {MODULE_CONFIG_FIELDS} HERE

package/src/modules/bmb/workflows/create-module/installer-templates/installer.js

@@ -178,7 +178,7 @@ async function initDatabase(/* config */) {
   console.log('   Initializing database...');
 
   // TODO: Add database initialization
-  // This function can be called from install-module-config.yaml
+  // This function can be called from install-config.yaml
 
   console.log('   ✓ Database initialized');
 }