Files
pig-farm-controller/bmad/bmb/README.md
2025-11-01 19:22:39 +08:00

4.5 KiB

BMB - BMad Builder Module

Specialized tools and workflows for creating, customizing, and extending BMad components including agents, workflows, and complete modules.

Table of Contents

Module Structure

🤖 Agents

BMad Builder - Master builder agent orchestrating all creation workflows with deep knowledge of BMad architecture and conventions.

📋 Workflows

Comprehensive suite for building and maintaining BMad components.

Core Workflows

Creation Workflows

create-agent - Build BMad agents

  • Interactive persona development
  • Command structure design
  • YAML source compilation to .md

create-workflow - Design workflows

  • Structured multi-step processes
  • Configuration validation
  • Web bundle support

create-module - Build complete modules

  • Full module infrastructure
  • Agent and workflow integration
  • Installation automation

module-brief - Strategic planning

  • Module blueprint creation
  • Vision and architecture
  • Comprehensive analysis

Editing Workflows

edit-agent - Modify existing agents

  • Persona refinement
  • Command updates
  • Best practice compliance

edit-workflow - Update workflows

  • Structure maintenance
  • Configuration updates
  • Documentation sync

edit-module - Module enhancement

  • Component modifications
  • Dependency management
  • Version control

Maintenance Workflows

convert-legacy - Migration tool

  • v4 to v6 conversion
  • Structure compliance
  • Convention updates

audit-workflow - Quality validation

  • Structure verification
  • Config standards check
  • Bloat detection
  • Web bundle completeness

redoc - Auto-documentation

  • Reverse-tree approach
  • Technical writer quality
  • Convention compliance

Agent Types

BMB creates three agent architectures:

Full Module Agent

  • Complete persona and role definition
  • Command structure with fuzzy matching
  • Workflow integration
  • Module-specific capabilities

Hybrid Agent

  • Shared core capabilities
  • Module-specific extensions
  • Cross-module compatibility

Standalone Agent

  • Independent operation
  • Minimal dependencies
  • Specialized single purpose

Quick Start

  1. Load BMad Builder agent in your IDE
  2. Choose creation type:
    *create-agent     # New agent
    *create-workflow  # New workflow
    *create-module    # Complete module
    
  3. Follow interactive prompts

Example: Creating an Agent

User: I need a code review agent
Builder: *create-agent

[Interactive session begins]
- Brainstorming phase (optional)
- Persona development
- Command structure
- Integration points

Use Cases

Custom Development Teams

Build specialized agents for:

  • Domain expertise (legal, medical, finance)
  • Company processes
  • Tool integrations
  • Automation tasks

Workflow Extensions

Create workflows for:

  • Compliance requirements
  • Quality gates
  • Deployment pipelines
  • Custom methodologies

Complete Solutions

Package modules for:

  • Industry verticals
  • Technology stacks
  • Business processes
  • Educational frameworks

Best Practices

  1. Study existing patterns - Review BMM/CIS implementations
  2. Follow conventions - Use established structures
  3. Document thoroughly - Clear instructions essential
  4. Test iteratively - Validate during creation
  5. Consider reusability - Build modular components

Integration

BMB components integrate with:

  • BMad Core - Framework foundation
  • BMM - Extend development capabilities
  • CIS - Leverage creative workflows
  • Custom Modules - Your domain solutions

BMB empowers you to extend BMad Method for your specific needs while maintaining framework consistency and power.