bmad-method 5.1.3 → 6.0.0-alpha.1

package/src/modules/bmb/README.md

@@ -0,0 +1,132 @@
+# BMB - BMad Builder Module
+
+The BMB (BMad Builder Module) provides specialized tools and workflows for creating, customizing, and extending BMad Method components, including custom agents, workflows, and integrations.
+
+## Module Structure
+
+### 🤖 `/agents`
+
+Builder-specific agents that help create and customize BMad Method components:
+
+- Agent creation and configuration specialists
+- Workflow designers
+- Integration builders
+
+### 📋 `/workflows`
+
+Specialized workflows for building and extending BMad Method capabilities:
+
+#### Core Builder Workflows
+
+- `create-agent` - Design and implement custom agents
+- `create-workflow` - Build new workflow definitions
+- `create-team` - Configure agent teams
+- `bundle-agent` - Package agents for distribution
+- `create-method` - Design custom development methodologies
+
+#### Integration Workflows
+
+- `integrate-tool` - Connect external tools and services
+- `create-adapter` - Build API adapters
+- `setup-environment` - Configure development environments
+
+## Key Features
+
+### Agent Builder
+
+Create custom agents with:
+
+- Role-specific instructions
+- Tool configurations
+- Behavior patterns
+- Integration points
+
+### Workflow Designer
+
+Design workflows that:
+
+- Orchestrate multiple agents
+- Define process flows
+- Handle different project scales
+- Integrate with existing systems
+
+### Team Configuration
+
+Build teams that:
+
+- Combine complementary agent skills
+- Coordinate on complex tasks
+- Share context effectively
+- Deliver cohesive results
+
+## Quick Start
+
+```bash
+# Create a new custom agent
+bmad bmb create-agent
+
+# Design a new workflow
+bmad bmb create-workflow
+
+# Bundle an agent for sharing
+bmad bmb bundle-agent
+
+# Create a custom team configuration
+bmad bmb create-team
+```
+
+## Use Cases
+
+### Custom Agent Development
+
+Build specialized agents for:
+
+- Domain-specific expertise
+- Company-specific processes
+- Tool integrations
+- Automation tasks
+
+### Workflow Customization
+
+Create workflows for:
+
+- Unique development processes
+- Compliance requirements
+- Quality gates
+- Deployment pipelines
+
+### Team Orchestration
+
+Configure teams for:
+
+- Large-scale projects
+- Cross-functional collaboration
+- Specialized domains
+- Custom methodologies
+
+## Integration with BMM
+
+BMB works alongside BMM to:
+
+- Extend core BMM capabilities
+- Create custom implementations
+- Build domain-specific solutions
+- Integrate with existing tools
+
+## Best Practices
+
+1. **Start with existing patterns** - Study BMM agents and workflows before creating new ones
+2. **Keep it modular** - Build reusable components
+3. **Document thoroughly** - Clear documentation helps others use your creations
+4. **Test extensively** - Validate agents and workflows before production use
+5. **Share and collaborate** - Contribute useful components back to the community
+
+## Related Documentation
+
+- [BMM Module](../bmm/README.md) - Core method implementation
+- [Agent Creation Guide](./workflows/create-agent/README.md) - Detailed agent building instructions
+- [Workflow Design Patterns](./workflows/README.md) - Best practices for workflow creation
+
+---
+
+BMB empowers you to extend and customize the BMad Method to fit your specific needs while maintaining the power and consistency of the core framework.

package/src/modules/bmb/_module-installer/install-config.yaml

@@ -0,0 +1,26 @@
+# BMAD™ Method Core Configuration
+
+code: bmb
+name: "BMB: BMad Builder - Agent, Workflow and Module Builder"
+default_selected: false # This module will not be selected by default for new installations
+
+prompt: "Happy Building - Build the Modules, Workflows and Agents of your dreams."
+# Variables from Core Config inserted:
+## user_name
+## communication_language
+## output_folder
+
+custom_agent_location:
+  prompt: "Where do custom agents get created?"
+  default: "bmad/agents"
+  result: "{project-root}/{value}"
+
+custom_workflow_location:
+  prompt: "Where do custom workflows get stored?"
+  default: "bmad/workflows"
+  result: "{project-root}/{value}"
+
+custom_module_location:
+  prompt: "Where do custom modules get stored?"
+  default: "bmad"
+  result: "{project-root}/{value}"

package/src/modules/bmb/agents/bmad-builder.agent.yaml

@@ -0,0 +1,58 @@
+# BMad Builder Agent Definition
+# Master BMad Module Agent Team and Workflow Builder and Maintainer
+
+agent:
+  metadata:
+    id: bmad/bmb/agents/bmad-builder.md
+    name: BMad Builder
+    title: BMad Builder
+    icon: 🧙
+    module: bmb
+
+  persona:
+    role: Master BMad Module Agent Team and Workflow Builder and Maintainer
+    identity: Lives to serve the expansion of the BMad Method
+    communication_style: Talks like a pulp super hero
+    principles:
+      - Execute resources directly
+      - Load resources at runtime never pre-load
+      - Always present numbered lists for choices
+
+  # Menu items - triggers will be prefixed with * at build time
+  # help and exit are auto-injected, don't define them here
+  menu:
+    - trigger: audit-workflow
+      workflow: "{project-root}/bmad/bmb/workflows/audit-workflow/workflow.yaml"
+      description: Audit existing workflows for BMAD Core compliance and best practices
+
+    - trigger: convert
+      workflow: "{project-root}/bmad/bmb/workflows/convert-legacy/workflow.yaml"
+      description: Convert v4 or any other style task agent or template to a workflow
+
+    - trigger: create-agent
+      workflow: "{project-root}/bmad/bmb/workflows/create-agent/workflow.yaml"
+      description: Create a new BMAD Core compliant agent
+
+    - trigger: create-module
+      workflow: "{project-root}/bmad/bmb/workflows/create-module/workflow.yaml"
+      description: Create a complete BMAD compatible module (custom agents and workflows)
+
+    - trigger: create-workflow
+      workflow: "{project-root}/bmad/bmb/workflows/create-workflow/workflow.yaml"
+      description: Create a new BMAD Core workflow with proper structure
+
+    - trigger: edit-agent
+      workflow: "{project-root}/bmad/bmb/workflows/edit-agent/workflow.yaml"
+      description: Edit existing agents while following best practices
+
+    - trigger: edit-module
+      workflow: "{project-root}/bmad/bmb/workflows/edit-module/workflow.yaml"
+      description: Edit existing modules (structure, agents, workflows, documentation)
+
+    - trigger: edit-workflow
+      workflow: "{project-root}/bmad/bmb/workflows/edit-workflow/workflow.yaml"
+      description: Edit existing workflows while following best practices
+
+    - trigger: redoc
+      workflow: "{project-root}/bmad/bmb/workflows/redoc/workflow.yaml"
+      description: Create or update module documentation

package/src/modules/bmb/workflows/audit-workflow/checklist.md

@@ -0,0 +1,143 @@
+# Audit Workflow - Validation Checklist
+
+## Structure
+
+- [ ] workflow.yaml file loads without YAML syntax errors
+- [ ] instructions.md file exists and is properly formatted
+- [ ] template.md file exists (if document workflow) with valid markdown
+- [ ] All critical headers present in instructions (workflow engine reference, workflow.yaml reference)
+- [ ] Workflow type correctly identified (document/action/interactive/autonomous/meta)
+- [ ] All referenced files actually exist at specified paths
+- [ ] No placeholder text remains (like {TITLE}, {WORKFLOW_CODE}, TODO, etc.)
+
+## Standard Config Block
+
+- [ ] workflow.yaml contains `config_source` pointing to correct module config
+- [ ] `output_folder` pulls from `{config_source}:output_folder`
+- [ ] `user_name` pulls from `{config_source}:user_name`
+- [ ] `communication_language` pulls from `{config_source}:communication_language`
+- [ ] `date` is set to `system-generated`
+- [ ] Config source uses {project-root} variable (not hardcoded path)
+- [ ] Standard config comment present: "Critical variables from config"
+
+## Config Variable Usage
+
+- [ ] Instructions communicate in {communication_language} where appropriate
+- [ ] Instructions address {user_name} in greetings or summaries where appropriate
+- [ ] All file outputs write to {output_folder} or subdirectories (no hardcoded paths)
+- [ ] Template includes {{user_name}} in metadata (optional for document workflows)
+- [ ] Template includes {{date}} in metadata (optional for document workflows)
+- [ ] Template does NOT use {{communication_language}} in headers (agent-only variable)
+- [ ] No hardcoded language-specific text that should use {communication_language}
+- [ ] Date used for agent date awareness (not confused with training cutoff)
+
+## YAML/Instruction/Template Alignment
+
+- [ ] Every workflow.yaml variable (excluding standard config) is used in instructions OR template
+- [ ] No unused yaml fields present (bloat removed)
+- [ ] No duplicate fields between top-level and web_bundle section
+- [ ] All template variables ({{variable}}) have corresponding yaml definitions OR <template-output> tags
+- [ ] All <template-output> tags have corresponding template variables (if document workflow)
+- [ ] Template variables use snake_case naming convention
+- [ ] Variable names are descriptive (not abbreviated like {{puj}} instead of {{primary_user_journey}})
+- [ ] No hardcoded values in instructions that should be yaml variables
+
+## Web Bundle Validation (if applicable)
+
+- [ ] web_bundle section present if workflow needs deployment
+- [ ] All paths in web_bundle use bmad/-relative format (NOT {project-root})
+- [ ] No {config_source} variables in web_bundle section
+- [ ] instructions file listed in web_bundle_files array
+- [ ] template file listed in web_bundle_files (if document workflow)
+- [ ] validation/checklist file listed in web_bundle_files (if exists)
+- [ ] All data files (CSV, JSON, YAML) listed in web_bundle_files
+- [ ] All <invoke-workflow> called workflows have their .yaml files in web_bundle_files
+- [ ] **CRITICAL**: If workflow invokes other workflows, existing_workflows field is present
+- [ ] existing_workflows maps workflow variables to bmad/-relative paths correctly
+- [ ] All files referenced in instructions <action> tags listed in web_bundle_files
+- [ ] No files listed in web_bundle_files that don't exist
+- [ ] Web bundle metadata (name, description, author) matches top-level metadata
+
+## Template Validation (if document workflow)
+
+- [ ] Template variables match <template-output> tags in instructions exactly
+- [ ] All required sections present in template structure
+- [ ] Template uses {{variable}} syntax (double curly braces)
+- [ ] Template variables use snake_case (not camelCase or PascalCase)
+- [ ] Standard metadata header format correct (optional usage of {{date}}, {{user_name}})
+- [ ] No placeholders remain in template (like {SECTION_NAME})
+- [ ] Template structure matches document purpose
+
+## Instructions Quality
+
+- [ ] Each step has n="X" attribute with sequential numbering
+- [ ] Each step has goal="clear goal statement" attribute
+- [ ] Optional steps marked with optional="true"
+- [ ] Repeating steps have appropriate repeat attribute (repeat="3", repeat="for-each-X", repeat="until-approved")
+- [ ] Conditional steps have if="condition" attribute
+- [ ] XML tags used correctly (<action>, <ask>, <check>, <goto>, <invoke-workflow>, <template-output>)
+- [ ] No nested tag references in content (use "action tags" not "<action> tags")
+- [ ] Tag references use descriptive text without angle brackets for clarity
+- [ ] No conditional execution antipattern (no self-closing <check> tags)
+- [ ] Single conditionals use <action if="condition"> (inline)
+- [ ] Multiple conditionals use <check if="condition">...</check> (wrapper block with closing tag)
+- [ ] Steps are focused (single goal per step)
+- [ ] Instructions are specific with limits ("Write 1-2 paragraphs" not "Write about")
+- [ ] Examples provided where helpful
+- [ ] <template-output> tags save checkpoints for document workflows
+- [ ] Flow control is logical and clear
+
+## Bloat Detection
+
+- [ ] Bloat percentage under 10% (unused yaml fields / total fields)
+- [ ] No commented-out variables that should be removed
+- [ ] No duplicate metadata between sections
+- [ ] No variables defined but never referenced
+- [ ] No redundant configuration that duplicates web_bundle
+
+## Final Validation
+
+### Critical Issues (Must fix immediately)
+
+_List any critical issues found:_
+
+- Issue 1:
+- Issue 2:
+- Issue 3:
+
+### Important Issues (Should fix soon)
+
+_List any important issues found:_
+
+- Issue 1:
+- Issue 2:
+- Issue 3:
+
+### Cleanup Recommendations (Nice to have)
+
+_List any cleanup recommendations:_
+
+- Recommendation 1:
+- Recommendation 2:
+- Recommendation 3:
+
+---
+
+## Audit Summary
+
+**Total Checks:** 72
+**Passed:** **\_** / 72
+**Failed:** **\_** / 72
+**Pass Rate:** **\_**%
+
+**Recommendation:**
+
+- Pass Rate ≥ 95%: Excellent - Ready for production
+- Pass Rate 85-94%: Good - Minor fixes needed
+- Pass Rate 70-84%: Fair - Important issues to address
+- Pass Rate < 70%: Poor - Significant work required
+
+---
+
+**Audit Completed:** {{date}}
+**Auditor:** Audit Workflow (BMAD v6)