bmad-method 6.0.0-alpha.21 → 6.0.0-alpha.23

package/src/modules/bmb/workflows/agent/steps-c/step-08-celebrate.md

@@ -0,0 +1,249 @@
+---
+name: 'step-08-celebrate'
+description: 'Celebrate completion and guide next steps for using the agent'
+
+# File References
+thisStepFile: ./step-08-celebrate.md
+workflowFile: ../workflow.md
+outputFile: {bmb_creations_output_folder}/agent-completion-{agent_name}.md
+
+# Task References
+advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
+partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
+installationDocs: 'https://github.com/bmad-code-org/BMAD-METHOD/blob/main/docs/modules/bmb-bmad-builder/custom-content-installation.md#standalone-content-agents-workflows-tasks-tools-templates-prompts'
+validationWorkflow: '{project-root}/src/modules/bmb/workflows/agent/steps-v/v-01-load-review.md'
+---
+
+# Step 8: Celebration and Installation Guidance
+
+## STEP GOAL:
+
+Celebrate the successful agent creation, recap the agent's capabilities, provide installation guidance, and mark workflow completion.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER generate content without user input
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 📋 YOU ARE A FACILITATOR, not a content generator
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are a celebration coordinator who guides users through agent installation and activation
+- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring installation expertise, user brings their excitement about their new agent, together we ensure successful agent installation and usage
+- ✅ Maintain collaborative celebratory tone throughout
+
+### Step-Specific Rules:
+
+- 🎯 Focus only on celebrating completion and guiding installation
+- 🚫 FORBIDDEN to end without marking workflow completion in frontmatter
+- 💬 Approach: Celebrate enthusiastically while providing practical installation guidance
+- 📋 Ensure user understands installation steps and agent capabilities
+- 🔗 Always provide installation documentation link for reference
+
+## EXECUTION PROTOCOLS:
+
+- 🎉 Celebrate agent creation achievement enthusiastically
+- 💾 Mark workflow completion in frontmatter
+- 📖 Provide clear installation guidance
+- 🔗 Share installation documentation link
+- 🚫 FORBIDDEN to end workflow without proper completion marking
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Complete, validated, and built agent from previous steps
+- Focus: Celebration, installation guidance, and workflow completion
+- Limits: No agent modifications, only installation guidance and celebration
+- Dependencies: Complete agent ready for installation
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change. (Do not deviate, skip, or optimize)
+
+### 1. Grand Celebration
+
+Present enthusiastic celebration:
+
+"🎉 Congratulations! We did it! {agent_name} is complete and ready to help users with {agent_purpose}!"
+
+**Journey Celebration:**
+"Let's celebrate what we accomplished together:
+
+- Started with an idea and discovered its true purpose
+- Crafted a unique personality with the four-field persona system
+- Built powerful capabilities and commands
+- Established a perfect name and identity
+- Created complete YAML configuration
+- Validated quality and prepared for deployment"
+
+### 2. Agent Capabilities Showcase
+
+**Agent Introduction:**
+"Meet {agent_name} - your {agent_type} agent ready to {agent_purpose}!"
+
+**Key Features:**
+"✨ **What makes {agent_name} special:**
+
+- {unique_personality_trait} personality that {communication_style_benefit}
+- Expert in {domain_expertise} with {specialized_knowledge}
+- {number_commands} powerful commands including {featured_command}
+- Ready to help with {specific_use_cases}"
+
+### 3. Activation Guidance
+
+**Getting Started:**
+"Here's how to start using {agent_name}:"
+
+**Activation Steps:**
+
+1. **Locate your agent files:** `{agent_file_location}`
+2. **If compiled:** Use the compiled version at `{compiled_location}`
+3. **For customization:** Edit the customization file at `{customization_location}`
+4. **First interaction:** Start by asking for help to see available commands
+
+**First Conversation Suggestions:**
+"Try starting with:
+
+- 'Hi {agent_name}, what can you help me with?'
+- 'Tell me about your capabilities'
+- 'Help me with [specific task related to agent purpose]'"
+
+### 4. Installation Guidance
+
+**Making Your Agent Installable:**
+"Now that {agent_name} is complete, let's get it installed and ready to use!"
+
+**Installation Overview:**
+"To make your agent installable and sharable, you'll need to package it as a standalone BMAD content module. Here's what you need to know:"
+
+**Key Steps:**
+1. **Create a module folder:** Name it something descriptive (e.g., `my-custom-stuff`)
+2. **Add module.yaml:** Include a `module.yaml` file with `unitary: true`
+3. **Structure your agent:** Place your agent file in `agents/{agent-name}/{agent-name}.agent.yaml`
+4. **Include sidecar (if Expert):** For Expert agents, include the `_memory/{sidecar-folder}/` structure
+
+**Module Structure Example:**
+```
+my-custom-stuff/
+├── module.yaml          # Contains: unitary: true
+├── agents/              # Custom agents go here
+│   └── {agent-name}/
+│       ├── {agent-name}.agent.yaml
+│       └── _memory/              # Expert agents only
+│           └── {sidecar-folder}/
+│               ├── memories.md
+│               └── instructions.md
+└── workflows/           # Optional: standalone custom workflows
+    └── {workflow-name}/
+        └── workflow.md
+```
+
+**Note:** Your custom module can contain agents, workflows, or both. The `agents/` and `workflows/` folders are siblings alongside `module.yaml`.
+
+**Installation Methods:**
+- **New projects:** The BMAD installer will prompt for local custom modules
+- **Existing projects:** Use "Modify BMAD Installation" to add your module
+
+**Full Documentation:**
+"For complete details on packaging, sharing, and installing your custom agent, including all the configuration options and troubleshooting tips, see the official installation guide:"
+
+📖 **[BMAD Custom Content Installation Guide]({installationDocs})**
+
+### 5. Final Documentation
+
+#### Content to Append (if applicable):
+
+```markdown
+## Agent Creation Complete! 🎉
+
+### Agent Summary
+
+- **Name:** {agent_name}
+- **Type:** {agent_type}
+- **Purpose:** {agent_purpose}
+- **Status:** Ready for installation
+
+### File Locations
+
+- **Agent Config:** {agent_file_path}
+- **Compiled Version:** {compiled_agent_path}
+- **Customization:** {customization_file_path}
+
+### Installation
+
+Package your agent as a standalone module with `module.yaml` containing `unitary: true`.
+See: {installationDocs}
+
+### Quick Start
+
+1. Create a module folder
+2. Add module.yaml with `unitary: true`
+3. Place agent in `agents/{agent-name}/` structure
+4. Include sidecar folder for Expert agents
+5. Install via BMAD installer
+```
+
+Save this content to `{outputFile}` for reference.
+
+### 6. Workflow Completion
+
+**Mark Complete:**
+"Agent creation workflow completed successfully! {agent_name} is ready to be installed and used. Amazing work!"
+
+**Final Achievement:**
+"You've successfully created a custom BMAD agent from concept to installation-ready configuration. The journey from idea to deployable agent is complete!"
+
+### 7. Present MENU OPTIONS
+
+Display: "**✅ Agent Build Complete! Select an Option:** [V] Run Validation [S] Skip - Complete Now [A] Advanced Elicitation [P] Party Mode"
+
+#### Menu Handling Logic:
+
+- IF V: "Loading validation phase..." → Save celebration content to {outputFile}, update frontmatter with build completion, then load, read entire file, then execute {validationWorkflow}
+- IF S: "Skipping validation. Completing workflow..." → Save content to {outputFile}, update frontmatter with workflow completion, then end workflow gracefully
+- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu
+- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#7-present-menu-options)
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- User can choose validation (V), skip to complete (S), or use advanced elicitation (A) or party mode (P)
+- After other menu items execution (A/P), return to this menu
+- User can chat or ask questions - always respond and then end with display again of the menu options
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN [S skip option] is selected and [workflow completion marked in frontmatter], will the workflow end gracefully with agent ready for installation.
+IF [V validation option] is selected, the validation workflow will be loaded to perform comprehensive validation checks.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Enthusiastic celebration of agent creation achievement
+- Clear installation guidance provided
+- Agent capabilities and value clearly communicated
+- Installation documentation link shared with context
+- Module structure and packaging explained
+- User confidence in agent installation established
+- Workflow properly marked as complete in frontmatter
+- Content properly saved to output file
+- Menu presented with exit option
+
+### ❌ SYSTEM FAILURE:
+
+- Ending without marking workflow completion
+- Not providing clear installation guidance
+- Missing celebration of achievement
+- Not sharing installation documentation link
+- Not ensuring user understands installation steps
+- Failing to update frontmatter completion status
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

package/src/modules/bmb/workflows/agent/steps-e/e-01-load-existing.md

@@ -0,0 +1,221 @@
+---
+name: 'e-01-load-existing'
+description: 'Load and analyze existing agent for editing'
+
+# File References
+thisStepFile: ./e-01-load-existing.md
+workflowFile: ../workflow.md
+nextStepFile: './e-02-discover-edits.md'
+editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md'
+agentMetadata: ../data/agent-metadata.md
+agentMenuPatterns: ../data/agent-menu-patterns.md
+
+advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
+partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
+---
+
+# Edit Step 1: Load Existing Agent
+
+## STEP GOAL:
+
+Load the existing agent file, parse its structure, and create an edit plan tracking document.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER proceed without loading the complete agent file
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: When loading next step with 'C', ensure entire file is read
+- 📋 YOU ARE A FACILITATOR, not an autonomous editor
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are an agent analyst who helps users understand and modify existing agents
+- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring agent architecture expertise, user brings their modification goals, together we achieve successful edits
+- ✅ Maintain collaborative analytical tone throughout
+
+### Step-Specific Rules:
+
+- 🎯 Focus only on loading and analyzing the existing agent
+- 🚫 FORBIDDEN to make any modifications in this step
+- 💬 Approach: Analytical and informative, present findings clearly
+- 📋 Ensure edit plan is created with complete agent snapshot
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Load the complete agent YAML file
+- 📊 Parse and analyze all agent components
+- 💾 Create edit plan tracking document
+- 🚫 FORBIDDEN to proceed without confirming file loaded successfully
+
+## CONTEXT BOUNDARIES:
+
+- Available context: User provided agent file path from workflow
+- Focus: Load and understand the existing agent structure
+- Limits: Analysis only, no modifications
+- Dependencies: Agent file must exist and be valid YAML
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Load Agent File
+
+**Load the agent file:**
+Read the complete YAML from the agent file path provided by the user.
+
+**If file does not exist or is invalid:**
+Inform the user and request a valid path:
+"The agent file could not be loaded. Please verify the path and try again.
+
+Expected format: `{path-to-agent}/{agent-name}.agent.yaml`"
+
+### 2. Parse Agent Structure
+
+If the module property of the agent metadata is `stand-alone`, it is not a module agent.
+If the module property of the agent is a module code (like bmm, bmb, etc...) it is a module agent.
+If the property hasSidecar: true exists in the metadata, then it is an expert agent.
+Else it is a simple agent.
+If a module agent also hasSidecar: true - this means it is a modules expert agent, thus it can have sidecar.
+
+**Extract and categorize all agent components:**
+
+```yaml
+# Basic Metadata
+- name: {agent-name}
+- description: {agent-description}
+- module: {stand-alone|bmm|cis|bmgd|custom}
+- hasSidecar: {true|false}
+
+# Persona
+- persona: {full persona text}
+- system-context: {if present}
+
+# Commands/Menu
+- commands: {full command structure}
+
+# Critical Actions (if present)
+- critical-actions: {list}
+
+# Metadata
+- metadata: {all metadata fields}
+```
+
+### 3. Display Agent Summary
+
+**Present a clear summary to the user:**
+
+```markdown
+## Agent Analysis: {agent-name}
+
+**Type:** {simple|expert|module}  (derived from module + hasSidecar)
+**Status:** ready-for-edit
+
+### Current Structure:
+
+**Persona:** {character count} characters
+**Commands:** {count} commands defined
+**Critical Actions:** {count} critical actions
+
+### Editable Components:
+
+- [ ] Persona (role, identity, communication_style, principles)
+- [ ] Commands and menu structure
+- [ ] Critical actions
+- [ ] Metadata (name, description, version, tags)
+```
+
+### 4. Create Edit Plan Document
+
+**Initialize the edit plan tracking file:**
+
+```markdown
+---
+mode: edit
+originalAgent: '{agent-file-path}'
+agentName: '{agent-name}'
+agentType: '{simple|expert|module}'
+editSessionDate: '{YYYY-MM-DD}'
+stepsCompleted:
+  - e-01-load-existing.md
+---
+
+# Edit Plan: {agent-name}
+
+## Original Agent Snapshot
+
+**File:** {agent-file-path}
+**Type:** {simple|expert|module}
+**Version:** {version}
+
+### Current Persona
+
+{full persona text or truncated if very long}
+
+### Current Commands
+
+{list all commands with names and descriptions}
+
+### Current Metadata
+
+{all metadata fields}
+
+---
+
+## Edits Planned
+
+*This section will be populated in subsequent steps*
+
+---
+
+## Edits Applied
+
+*This section will track completed edits*
+```
+
+Write to `{editPlan}`.
+
+### 5. Present MENU OPTIONS
+
+Display: "**Is this the correct agent to edit?** [C] Yes, Continue to Discovery"
+
+#### Menu Handling Logic:
+
+- IF C: Save content to {editPlan}, then only then load, read entire file, then execute {nextStepFile}
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options)
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution, return to this menu
+- User can chat or ask questions - always respond and then end with display again of the menu options
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN [C continue option] is selected and [agent file loaded, analyzed, and edit plan created], will you then load and read fully `{nextStepFile}` to execute and begin edit discovery.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Agent file loaded successfully
+- YAML structure parsed correctly
+- Edit plan document created with agent snapshot
+- User has clear understanding of current agent structure
+- Menu presented and user input handled correctly
+
+### ❌ SYSTEM FAILURE:
+
+- Failed to load entire exist agent file (and potential sidecar content)
+- Invalid YAML format that prevents parsing
+- Edit plan not created
+- Proceeding without user confirmation of loaded agent
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

package/src/modules/bmb/workflows/agent/steps-e/e-02-discover-edits.md

@@ -0,0 +1,193 @@
+---
+name: 'e-02-discover-edits'
+description: 'Discover what user wants to change about the agent'
+
+nextStepFile: './e-04-type-metadata.md'
+editPlan: '{bmb_creations_output_folder}/edit-plan-{agent-name}.md'
+
+advancedElicitationTask: '{project-root}/_bmad/core/workflows/advanced-elicitation/workflow.xml'
+partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
+---
+
+# Edit Step 2: Discover Edits
+
+## STEP GOAL:
+
+Conduct targeted discovery to understand exactly what the user wants to change about their agent. Document all requested edits in structured format.
+
+## MANDATORY EXECUTION RULES (READ FIRST):
+
+### Universal Rules:
+
+- 🛑 NEVER assume what edits are needed - ask explicitly
+- 📖 CRITICAL: Read the complete step file before taking any action
+- 🔄 CRITICAL: Read editPlan first to understand agent context
+- 📋 YOU ARE A FACILITATOR, not an autonomous editor
+- ✅ YOU MUST ALWAYS SPEAK OUTPUT In your Agent communication style with the config `{communication_language}`
+
+### Role Reinforcement:
+
+- ✅ You are an agent editor consultant who helps users clarify their modification goals
+- ✅ If you already have been given a name, communication_style and identity, continue to use those while playing this new role
+- ✅ We engage in collaborative dialogue, not command-response
+- ✅ You bring agent architecture expertise, user brings their vision for improvements, together we define precise edits
+- ✅ Maintain collaborative inquisitive tone throughout
+
+### Step-Specific Rules:
+
+- 🎯 Focus only on discovering what to edit, not how to implement yet
+- 🚫 FORBIDDEN to make any modifications in this step
+- 💬 Approach: Ask probing questions to understand edit scope
+- 📋 Ensure all edits are documented to edit plan before proceeding
+
+## EXECUTION PROTOCOLS:
+
+- 🎯 Guide conversation to uncover all desired changes
+- 📊 Categorize edits by component (persona, commands, metadata, etc.)
+- 💾 Document all edits to edit plan
+- 🚫 FORBIDDEN to proceed without confirming all edits are captured
+
+## CONTEXT BOUNDARIES:
+
+- Available context: editPlan with agent snapshot from previous step
+- Focus: Discover what changes user wants to make
+- Limits: Discovery and documentation only, no implementation
+- Dependencies: Agent must be loaded in editPlan
+
+## MANDATORY SEQUENCE
+
+**CRITICAL:** Follow this sequence exactly. Do not skip, reorder, or improvise unless user explicitly requests a change.
+
+### 1. Read Edit Plan Context
+
+**Load the editPlan file first:**
+Read `{editPlan}` to understand the current agent structure and context.
+
+### 2. Present Edit Categories
+
+**Guide the user through potential edit areas:**
+
+"What would you like to change about **{agent-name}**?
+
+I can help you modify:
+
+**[P]ersona** - Role, identity, communication style, principles
+**[C]ommands** - Add, remove, or modify commands and menu structure
+**[M]etadata** - Name, description, version, tags, category
+**[A]ctions** - Critical actions and activation behaviors
+**[T]ype** - Convert between Simple/Expert/Module types
+**[O]ther** - Configuration, capabilities, system context
+
+Which areas would you like to edit? (You can select multiple)"
+
+### 3. Deep Dive Discovery
+
+**For each selected category, ask targeted questions:**
+
+#### If Persona selected:
+- "What aspect of the persona needs change?"
+- "Should the role be more specific or expanded?"
+- "Is the communication style hitting the right tone?"
+- "Do the principles need refinement?"
+
+#### If Commands selected:
+- "Do you want to add new commands, remove existing ones, or modify?"
+- "Are current command names and descriptions clear?"
+- "Should command steps be adjusted?"
+- "Is the menu structure working well?"
+
+#### If Metadata selected:
+- "What metadata fields need updating?"
+- "Is the description accurate and compelling?"
+- "Should version be bumped?"
+- "Are tags still relevant?"
+
+#### If Actions selected:
+- "What critical actions need modification?"
+- "Should new activation behaviors be added?"
+- "Are current actions executing as expected?"
+
+#### If Type conversion selected:
+- "What type are you converting from/to?"
+- "What's driving this conversion?"
+- "Are you aware of the implications (e.g., Expert needs sidecar)?"
+
+### 4. Document Edits to Plan
+
+**After discovery, append to editPlan:**
+
+```markdown
+## Edits Planned
+
+### Persona Edits
+- [ ] {edit description}
+- [ ] {edit description}
+
+### Command Edits
+- [ ] {edit description}
+- [ ] {edit description}
+
+### Metadata Edits
+- [ ] {edit description}
+- [ ] {edit description}
+
+### Critical Action Edits
+- [ ] {edit description}
+- [ ] {edit description}
+
+### Type Conversion
+- [ ] {from: X, to: Y, rationale: ...}
+
+### Other Edits
+- [ ] {edit description}
+```
+
+**Present summary for confirmation:**
+
+"Here's what I heard you want to change:
+
+{Summarize all edits in clear bulleted list}
+
+Did I capture everything? Any edits to add, remove, or clarify?"
+
+### 5. Present MENU OPTIONS
+
+Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Continue to Validation"
+
+#### Menu Handling Logic:
+
+- IF A: Execute {advancedElicitationTask}, and when finished redisplay the menu
+- IF P: Execute {partyModeWorkflow}, and when finished redisplay the menu
+- IF C: Save edits to {editPlan}, then only then load, read entire file, then execute {nextStepFile}
+- IF Any other comments or queries: help user respond then [Redisplay Menu Options](#5-present-menu-options)
+
+#### EXECUTION RULES:
+
+- ALWAYS halt and wait for user input after presenting menu
+- ONLY proceed to next step when user selects 'C'
+- After other menu items execution, return to this menu
+- User can chat or ask questions - always respond and then end with display again of the menu options
+
+## CRITICAL STEP COMPLETION NOTE
+
+ONLY WHEN [C continue option] is selected and [all edits documented and confirmed by user], will you then load and read fully `{nextStepFile}` to execute and checks.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- All desired edits discovered and documented
+- Edits categorized by component type
+- User confirmed edit list is complete
+- Edit plan updated with structured edits
+
+### ❌ SYSTEM FAILURE:
+
+- Proceeding without documenting edits
+- Missing edits that user mentioned
+- Unclear or ambiguous edit descriptions
+- User not given opportunity to review/edit list
+
+**Master Rule:** Skipping steps, optimizing sequences, or not following exact instructions is FORBIDDEN and constitutes SYSTEM FAILURE.

package/src/modules/bmb/workflows/agent/steps-e/e-03-placeholder.md

@@ -0,0 +1 @@
+# Placeholder - do not load this step.