bmad-method 6.0.0-alpha.9 → 6.0.1

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

@@ -1,35 +0,0 @@
-# Edit Agent - Agent Editor Configuration
-name: "edit-agent"
-description: "Edit existing BMAD agents while following all best practices and conventions"
-author: "BMad"
-
-# Critical variables load from config_source
-config_source: "{project-root}/{bmad_folder}/bmb/config.yaml"
-communication_language: "{config_source}:communication_language"
-user_name: "{config_source}:user_name"
-
-# Required Data Files - Critical for understanding agent conventions
-agent_types: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/agent-types.md"
-agent_architecture: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/agent-architecture.md"
-agent_commands: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/agent-command-patterns.md"
-communication_styles: "{project-root}/{bmad_folder}/bmb/workflows/create-agent/communication-styles.md"
-
-# Workflow execution engine reference
-workflow_execution_engine: "{project-root}/{bmad_folder}/core/tasks/workflow.xml"
-
-# Optional docs that can be used to understand the target agent
-recommended_inputs:
-  - target_agent: "Path to the agent.yaml or agent.md file to edit"
-  - example_agents: "{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_folder}/bmb/workflows/edit-agent"
-template: false # This is an action workflow - no template needed
-instructions: "{installed_path}/instructions.md"
-validation: "{installed_path}/checklist.md"
-
-standalone: true
-
-# Web bundle configuration
-web_bundle: false # BMB workflows run locally in BMAD-METHOD project

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

@@ -1,187 +0,0 @@
-# Edit Module Workflow
-
-Interactive workflow for editing existing BMAD modules, including structure, agents, workflows, configuration, and documentation.
-
-## Purpose
-
-This workflow helps you improve and maintain BMAD modules by:
-
-- Analyzing module structure against best practices
-- Managing agents and workflows within the module
-- Updating configuration and documentation
-- Ensuring cross-module integration works correctly
-- Maintaining installer configuration (for source modules)
-
-## When to Use
-
-Use this workflow when you need to:
-
-- Add new agents or workflows to a module
-- Update module configuration
-- Improve module documentation
-- Reorganize module structure
-- Set up cross-module workflow sharing
-- Fix issues in module organization
-- Update installer configuration
-
-## What You'll Need
-
-- Path to the module directory you want to edit
-- Understanding of what changes you want to make
-- Access to module documentation (loaded automatically)
-
-## Workflow Steps
-
-1. **Load and analyze target module** - Provide path to module directory
-2. **Analyze against best practices** - Automatic audit of module structure
-3. **Select editing focus** - Choose what aspect to edit
-4. **Load relevant documentation and tools** - Auto-loads guides and workflows
-5. **Perform edits** - Review and approve changes iteratively
-6. **Validate all changes** - Comprehensive validation checklist
-7. **Generate change summary** - Summary of improvements made
-
-## Editing Options
-
-The workflow provides 12 focused editing options:
-
-1. **Fix critical issues** - Address missing files, broken references
-2. **Update module config** - Edit config.yaml fields
-3. **Manage agents** - Add, edit, or remove agents
-4. **Manage workflows** - Add, edit, or remove workflows
-5. **Update documentation** - Improve README files and guides
-6. **Reorganize structure** - Fix directory organization
-7. **Add new agent** - Create and integrate new agent
-8. **Add new workflow** - Create and integrate new workflow
-9. **Update installer** - Modify installer configuration (source only)
-10. **Cross-module integration** - Set up workflow sharing with other modules
-11. **Remove deprecated items** - Delete unused agents, workflows, or files
-12. **Full module review** - Comprehensive analysis and improvements
-
-## Integration with Other Workflows
-
-This workflow integrates with:
-
-- **edit-agent** - For editing individual agents
-- **edit-workflow** - For editing individual workflows
-- **create-agent** - For adding new agents
-- **create-workflow** - For adding new workflows
-
-When you select options to manage agents or workflows, the appropriate specialized workflow is invoked automatically.
-
-## Module Structure
-
-A proper BMAD module has:
-
-```
-module-code/
-├── agents/              # Agent definitions
-│   └── *.agent.yaml
-├── workflows/           # Workflow definitions
-│   └── workflow-name/
-│       ├── workflow.yaml
-│       ├── instructions.md
-│       ├── checklist.md
-│       └── README.md
-├── config.yaml          # Module configuration
-└── README.md           # Module documentation
-```
-
-## Standard Module Config
-
-Every module config.yaml should have:
-
-```yaml
-module_name: 'Full Module Name'
-module_code: 'xyz'
-user_name: 'User Name'
-communication_language: 'english'
-output_folder: 'path/to/output'
-```
-
-Optional fields may be added for module-specific needs.
-
-## Cross-Module Integration
-
-Modules can share workflows:
-
-```yaml
-# In agent menu item:
-workflow: '{project-root}/{bmad_folder}/other-module/workflows/shared-workflow/workflow.yaml'
-```
-
-Common patterns:
-
-- BMM uses CIS brainstorming workflows
-- All modules can use core workflows
-- Modules can invoke each other's workflows
-
-## Output
-
-The workflow modifies module files in place, including:
-
-- config.yaml
-- Agent files
-- Workflow files
-- README and documentation files
-- Directory structure (if reorganizing)
-
-Changes are reviewed and approved by you before being applied.
-
-## Best Practices
-
-- **Start with analysis** - Let the workflow audit your module first
-- **Use specialized workflows** - Let edit-agent and edit-workflow handle detailed edits
-- **Update documentation** - Keep README files current with changes
-- **Validate thoroughly** - Use the validation step to catch structural issues
-- **Test after editing** - Invoke agents and workflows to verify they work
-
-## Tips
-
-- For adding agents/workflows, use options 7-8 to create and integrate in one step
-- For quick config changes, use option 2 (update module config)
-- Cross-module integration (option 10) helps set up workflow sharing
-- Full module review (option 12) is great for inherited or legacy modules
-- The workflow handles path updates when you reorganize structure
-
-## Source vs Installed Modules
-
-**Source modules** (in src/modules/):
-
-- Have installer files in tools/cli/installers/
-- Can configure web bundles
-- Are the development source of truth
-
-**Installed modules** (in {bmad_folder}/):
-
-- Are deployed to target projects
-- Use config.yaml for user customization
-- Are compiled from source during installation
-
-This workflow works with both, but installer options only apply to source modules.
-
-## Example Usage
-
-```
-User: I want to add a new workflow to BMM for API design
-Workflow: Analyzes BMM → You choose option 8 (add new workflow)
-          → Invokes create-workflow → Creates workflow
-          → Integrates it into module → Updates README → Done
-```
-
-## Activation
-
-Invoke via BMad Builder agent:
-
-```
-/bmad:bmb:agents:bmad-builder
-Then select: *edit-module
-```
-
-Or directly via workflow.xml with this workflow config.
-
-## Related Resources
-
-- **Module Structure Guide** - Comprehensive module architecture documentation
-- **BMM Module** - Example of full-featured module
-- **BMB Module** - Example of builder/tooling module
-- **CIS Module** - Example of workflow library module

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

@@ -1,165 +0,0 @@
-# Edit Module - Validation Checklist
-
-Use this checklist to validate module edits meet BMAD Core standards.
-
-## Module Structure Validation
-
-- [ ] Module has clear 3-letter code (bmm, bmb, cis, etc.)
-- [ ] Module is in correct location (src/modules/ for source, {bmad_folder}/ for installed)
-- [ ] agents/ directory exists
-- [ ] workflows/ directory exists
-- [ ] config.yaml exists in module root
-- [ ] README.md exists in module root
-- [ ] Directory structure follows BMAD conventions
-
-## Configuration Validation
-
-### Required Fields
-
-- [ ] module_name is descriptive and clear
-- [ ] module_code is 3-letter code matching directory name
-- [ ] user_name field present
-- [ ] communication_language field present
-- [ ] output_folder field present
-
-### Optional Fields (if used)
-
-- [ ] custom_agent_location documented
-- [ ] custom_module_location documented
-- [ ] Module-specific fields documented in README
-
-### File Quality
-
-- [ ] config.yaml is valid YAML syntax
-- [ ] No duplicate keys
-- [ ] Values are appropriate types (strings, paths, etc.)
-- [ ] Comments explain non-obvious fields
-
-## Agent Validation
-
-### Agent Files
-
-- [ ] All agents in agents/ directory
-- [ ] Agent files follow naming: {agent-name}.agent.yaml or .md
-- [ ] Agent filenames use kebab-case
-- [ ] No orphaned or temporary agent files
-
-### Agent Content
-
-- [ ] Each agent has clear role and purpose
-- [ ] Agents reference workflows correctly
-- [ ] Agent workflow paths are valid
-- [ ] Agents load module config correctly (if needed)
-- [ ] Agent menu items reference existing workflows
-
-### Agent Integration
-
-- [ ] All agents listed in module README
-- [ ] Agent relationships documented (if applicable)
-- [ ] Cross-agent workflows properly linked
-
-## Workflow Validation
-
-### Workflow Structure
-
-- [ ] All workflows in workflows/ directory
-- [ ] Each workflow directory has workflow.yaml
-- [ ] Each workflow directory has instructions.md
-- [ ] Workflow directories use kebab-case naming
-- [ ] No orphaned or incomplete workflow directories
-
-### Workflow Content
-
-- [ ] workflow.yaml is valid YAML
-- [ ] workflow.yaml has name field
-- [ ] workflow.yaml has description field
-- [ ] workflow.yaml has author field
-- [ ] instructions.md has proper <workflow> structure
-- [ ] Workflow steps are numbered and logical
-
-### Workflow Integration
-
-- [ ] All workflows listed in module README
-- [ ] Workflow paths in agents are correct
-- [ ] Cross-module workflow references are valid
-- [ ] Sub-workflow references exist
-
-## Documentation Validation
-
-### Module README
-
-- [ ] Module README describes purpose clearly
-- [ ] README lists all agents with descriptions
-- [ ] README lists all workflows with descriptions
-- [ ] README includes installation instructions (if applicable)
-- [ ] README explains module's role in BMAD ecosystem
-
-### Workflow READMEs
-
-- [ ] Each workflow has its own README.md
-- [ ] Workflow READMEs explain purpose
-- [ ] Workflow READMEs list inputs/outputs
-- [ ] Workflow READMEs include usage examples
-
-### Other Documentation
-
-- [ ] Usage guides present (if needed)
-- [ ] Architecture docs present (if complex module)
-- [ ] Examples provided (if applicable)
-
-## Cross-References Validation
-
-- [ ] Agent workflow references point to existing workflows
-- [ ] Workflow sub-workflow references are valid
-- [ ] Cross-module references use correct paths
-- [ ] Config file paths use {project-root} correctly
-- [ ] No hardcoded absolute paths
-
-## Installer Validation (Source Modules Only)
-
-- [ ] Installer script exists in tools/cli/installers/
-- [ ] Installer script name: install-{module-code}.js
-- [ ] Module metadata in installer is correct
-- [ ] Web bundle configuration valid (if applicable)
-- [ ] Installation paths are correct
-- [ ] Dependencies documented in installer
-
-## Web Bundle Validation (If Applicable)
-
-- [ ] Web bundles configured in workflow.yaml files
-- [ ] All referenced files included in web_bundle_files
-- [ ] Paths are {bmad_folder}/-relative (not project-root)
-- [ ] No config_source references in web bundles
-- [ ] Invoked workflows included in dependencies
-
-## Quality Checks
-
-- [ ] No placeholder text remains ({MODULE_NAME}, {CODE}, etc.)
-- [ ] No broken file references
-- [ ] No duplicate content across files
-- [ ] Consistent naming conventions throughout
-- [ ] Module purpose is clear from README alone
-
-## Integration Checks
-
-- [ ] Module doesn't conflict with other modules
-- [ ] Shared resources properly documented
-- [ ] Dependencies on other modules explicit
-- [ ] Module can be installed independently (if designed that way)
-
-## User Experience
-
-- [ ] Module purpose is immediately clear
-- [ ] Agents have intuitive names
-- [ ] Workflows have descriptive names
-- [ ] Menu items are logically organized
-- [ ] Error messages are helpful
-- [ ] Success messages confirm actions
-
-## Final Checks
-
-- [ ] All files have been saved
-- [ ] File permissions are correct
-- [ ] Git status shows expected changes
-- [ ] Module is ready for testing
-- [ ] Documentation accurately reflects changes