62 lines
2.2 KiB
Markdown
62 lines
2.2 KiB
Markdown
# create-module Workflow Rule
|
|
|
|
This rule defines the create-module workflow.
|
|
|
|
## Workflow Description
|
|
|
|
Interactive workflow to build complete BMAD modules with agents, workflows, tasks, and installation infrastructure
|
|
|
|
## Workflow Definition
|
|
|
|
# Build Module Workflow Configuration
|
|
name: create-module
|
|
description: "Interactive workflow to build complete BMAD modules with agents, workflows, tasks, and installation infrastructure"
|
|
author: "BMad"
|
|
|
|
# Critical variables load from config_source
|
|
config_source: "{project-root}/.bmad/bmb/config.yaml"
|
|
custom_module_location: "{config_source}:custom_module_location"
|
|
communication_language: "{config_source}:communication_language"
|
|
user_name: "{config_source}:user_name"
|
|
|
|
# Reference guides for module building
|
|
module_structure_guide: "{installed_path}/module-structure.md"
|
|
installer_templates: "{installed_path}/installer-templates/"
|
|
|
|
# Use existing build workflows
|
|
agent_builder: "{project-root}/.bmad/bmb/workflows/create-agent/workflow.yaml"
|
|
workflow_builder: "{project-root}/.bmad/bmb/workflows/create-workflow/workflow.yaml"
|
|
brainstorming_workflow: "{project-root}/.bmad/core/workflows/brainstorming/workflow.yaml"
|
|
brainstorming_context: "{installed_path}/brainstorm-context.md"
|
|
|
|
# Optional docs that help understand module patterns
|
|
recommended_inputs:
|
|
- module_brief: "{output_folder}/module-brief-*.md"
|
|
- brainstorming_results: "{output_folder}/brainstorming-*.md"
|
|
- bmm_module: "{project-root}/.bmad/bmm/"
|
|
- cis_module: "{project-root}/.bmad/cis/"
|
|
- existing_agents: "{project-root}/.bmad/*/agents/"
|
|
- existing_workflows: "{project-root}/.bmad/*/workflows/"
|
|
|
|
# Module path and component files
|
|
installed_path: "{project-root}/.bmad/bmb/workflows/create-module"
|
|
template: false # This is an interactive scaffolding workflow
|
|
instructions: "{installed_path}/instructions.md"
|
|
validation: "{installed_path}/checklist.md"
|
|
|
|
# Output configuration - creates entire module structure
|
|
# Save to custom_module_location/{{module_code}}
|
|
installer_output_folder: "{custom_module_location}/{{module_code}}"
|
|
|
|
standalone: true
|
|
|
|
# Web bundle configuration
|
|
|
|
## Usage
|
|
|
|
Reference this workflow with `@workflow-create-module` to execute the guided workflow.
|
|
|
|
## Module
|
|
|
|
Part of the BMAD BMB module.
|