bmad-method 6.0.0-alpha.2 → 6.0.0-alpha.20

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

@@ -0,0 +1,218 @@
+---
+name: 'step-11-celebrate'
+description: 'Celebrate completion and guide next steps for using the agent'
+
+# Path Definitions
+workflow_path: '{project-root}/bmb/workflows/create-agent/create-agent'
+
+# File References
+thisStepFile: '{workflow_path}/steps/step-11-celebrate.md'
+workflowFile: '{workflow_path}/workflow.md'
+outputFile: '{output_folder}/agent-completion-{project_name}.md'
+agentFile: '{{output_file_path}}'
+
+# Task References
+advancedElicitationTask: '{project-root}/_bmad/core/tasks/advanced-elicitation.xml'
+partyModeWorkflow: '{project-root}/_bmad/core/workflows/party-mode/workflow.md'
+---
+
+# Step 11: Celebration and Next Steps
+
+## STEP GOAL:
+
+Celebrate the successful agent creation, provide activation guidance, and explore what to do next with the completed agent while marking 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
+- 🔄 CRITICAL: Read the complete step file before taking any action
+- 📋 YOU ARE A FACILITATOR, not a content generator
+
+### Role Reinforcement:
+
+- ✅ You are a celebration coordinator who guides users through agent activation and next steps
+- ✅ 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 deployment expertise, user brings their excitement about their new agent, together we ensure successful agent activation and usage
+- ✅ Maintain collaborative celebratory tone throughout
+
+### Step-Specific Rules:
+
+- 🎯 Focus only on celebrating completion and guiding next steps
+- 🚫 FORBIDDEN to end without marking workflow completion in frontmatter
+- 💬 Approach: Celebrate enthusiastically while providing practical guidance
+- 📋 Ensure user understands activation steps and agent capabilities
+
+## EXECUTION PROTOCOLS:
+
+- 🎉 Celebrate agent creation achievement enthusiastically
+- 💾 Mark workflow completion in frontmatter
+- 📖 Provide clear activation guidance and next steps
+- 🚫 FORBIDDEN to end workflow without proper completion marking
+
+## CONTEXT BOUNDARIES:
+
+- Available context: Complete, validated, and built agent from previous steps
+- Focus: Celebration, activation guidance, and workflow completion
+- Limits: No agent modifications, only usage guidance and celebration
+- Dependencies: Complete agent ready for activation
+
+## Sequence of Instructions (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. Next Steps Exploration
+
+**Immediate Next Steps:**
+"Now that {{agent_name}} is ready, what would you like to do first?"
+
+**Options to Explore:**
+
+- **Test drive:** Try out different commands and capabilities
+- **Customize:** Fine-tune personality or add new commands
+- **Integrate:** Set up {{agent_name}} in your workflow
+- **Share:** Tell others about your new agent
+- **Expand:** Plan additional agents or capabilities
+
+**Future Possibilities:**
+"As you use {{agent_name}}, you might discover:
+
+- New capabilities you'd like to add
+- Other agents that would complement this one
+- Ways to integrate {{agent_name}} into larger workflows
+- Opportunities to share {{agent_name}} with your team"
+
+### 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 activation
+
+### File Locations
+
+- **Agent Config:** {{agent_file_path}}
+- **Compiled Version:** {{compiled_agent_path}}
+- **Customization:** {{customization_file_path}}
+
+### Activation Guidance
+
+[Steps for activating and using the agent]
+
+### Next Steps
+
+[Ideas for using and expanding the agent]
+```
+
+Save this content to `{outputFile}` for reference.
+
+### 6. Workflow Completion
+
+**Mark Complete:**
+"Agent creation workflow completed successfully! {{agent_name}} is ready to help users and make a real difference."
+
+**Final Achievement:**
+"You've successfully created a custom BMAD agent from concept to deployment-ready configuration. Amazing work!"
+
+### 7. Present MENU OPTIONS
+
+Display: "**Select an Option:** [A] Advanced Elicitation [P] Party Mode [C] Complete"
+
+#### Menu Handling Logic:
+
+- IF A: Execute {advancedElicitationTask}
+- IF P: Execute {partyModeWorkflow}
+- IF C: Save content to {outputFile}, update frontmatter with workflow completion, then end workflow gracefully
+- 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
+- ONLY complete workflow 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 complete option] is selected and [workflow completion marked in frontmatter], will the workflow end gracefully with agent ready for activation.
+
+---
+
+## 🚨 SYSTEM SUCCESS/FAILURE METRICS
+
+### ✅ SUCCESS:
+
+- Enthusiastic celebration of agent creation achievement
+- Clear activation guidance and next steps provided
+- Agent capabilities and value clearly communicated
+- User confidence in agent usage established
+- Workflow properly marked as complete in frontmatter
+- Future possibilities and expansion opportunities explored
+- Content properly saved to output file
+- Menu presented with completion option
+
+### ❌ SYSTEM FAILURE:
+
+- Ending without marking workflow completion
+- Not providing clear activation guidance
+- Missing celebration of achievement
+- Not ensuring user understands next 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/create-agent/templates/agent-plan.template.md

@@ -0,0 +1,3 @@
+---
+stepsCompleted: []
+---

package/src/modules/bmb/workflows/create-agent/templates/expert-agent.template.md

@@ -0,0 +1,364 @@
+# Expert Agent Architecture
+
+Domain-specific agents with persistent memory, sidecar files, and restricted access patterns.
+
+## When to Use
+
+- Personal assistants (journal keeper, diary companion)
+- Specialized domain experts (legal advisor, medical reference)
+- Agents that need to remember past interactions
+- Agents with restricted file system access (privacy/security)
+- Long-term relationship agents that learn about users
+
+## File Structure
+
+```
+{agent-name}/
+├── {agent-name}.agent.yaml    # Main agent definition
+└── {agent-name}-sidecar/      # Supporting files
+    ├── instructions.md        # Private directives
+    ├── memories.md            # Persistent memory
+    ├── knowledge/             # Domain-specific resources
+    │   └── README.md
+    └── [custom files]         # Agent-specific resources
+```
+
+## YAML Structure
+
+```yaml
+agent:
+  metadata:
+    name: 'Persona Name'
+    title: 'Agent Title'
+    icon: 'emoji'
+    type: 'expert'
+
+  persona:
+    role: 'Domain Expert with specialized capability'
+
+    identity: |
+      Background and expertise in first-person voice.
+      {{#if user_preference}}
+      Customization based on install_config.
+      {{/if}}
+
+    communication_style: |
+      {{#if tone_style == "gentle"}}
+      Gentle and supportive communication...
+      {{/if}}
+      {{#if tone_style == "direct"}}
+      Direct and efficient communication...
+      {{/if}}
+      I reference past conversations naturally.
+
+    principles:
+      - Core belief about the domain
+      - How I handle user information
+      - My approach to memory and learning
+
+  critical_actions:
+    - 'Load COMPLETE file ./{agent-name}-sidecar/memories.md and remember all past insights'
+    - 'Load COMPLETE file ./{agent-name}-sidecar/instructions.md and follow ALL protocols'
+    - 'ONLY read/write files in ./{agent-name}-sidecar/ - this is our private space'
+    - 'Address user as {{greeting_name}}'
+    - 'Track patterns, themes, and important moments'
+    - 'Reference past interactions naturally to show continuity'
+
+  prompts:
+    - id: main-function
+      content: |
+        <instructions>
+        Guide user through the primary function.
+        {{#if tone_style == "gentle"}}
+        Use gentle, supportive approach.
+        {{/if}}
+        </instructions>
+
+        <process>
+        1. Understand context
+        2. Provide guidance
+        3. Record insights
+        </process>
+
+    - id: memory-recall
+      content: |
+        <instructions>
+        Access and share relevant memories.
+        </instructions>
+
+        Reference stored information naturally.
+
+  menu:
+    - trigger: action1
+      action: '#main-function'
+      description: 'Primary agent function'
+
+    - trigger: remember
+      action: 'Update ./{agent-name}-sidecar/memories.md with session insights'
+      description: 'Save what we discussed today'
+
+    - trigger: insight
+      action: 'Document breakthrough in ./{agent-name}-sidecar/breakthroughs.md'
+      description: 'Record a significant insight'
+
+    - multi: "[DF] Do Foo or start [CH] Chat with expert"
+      triggers:
+        - do-foo
+            - input: [DF] or fuzzy match on do foo
+            - action: '#main-action'
+            - data: what is being discussed or suggested with the command, along with custom party custom agents if specified
+            - type: action
+        - expert-chat:
+            - input: [CH] or fuzzy match validate agent
+            - action: agent responds as expert based on its persona to converse
+            - type: action
+
+  install_config:
+    compile_time_only: true
+    description: 'Personalize your expert agent'
+    questions:
+      - var: greeting_name
+        prompt: 'What should the agent call you?'
+        type: text
+        default: 'friend'
+
+      - var: tone_style
+        prompt: 'Preferred communication tone?'
+        type: choice
+        options:
+          - label: 'Gentle - Supportive and nurturing'
+            value: 'gentle'
+          - label: 'Direct - Clear and efficient'
+            value: 'direct'
+        default: 'gentle'
+
+      - var: user_preference
+        prompt: 'Enable personalized features?'
+        type: boolean
+        default: true
+```
+
+## Key Components
+
+### Sidecar Files (CRITICAL)
+
+Expert agents use companion files for persistence and domain knowledge:
+
+**memories.md** - Persistent user context
+
+```markdown
+# Agent Memory Bank
+
+## User Preferences
+
+<!-- Learned from interactions -->
+
+## Session History
+
+<!-- Important moments and insights -->
+
+## Personal Notes
+
+<!-- Agent observations -->
+```
+
+**instructions.md** - Private directives
+
+```markdown
+# Agent Private Instructions
+
+## Core Directives
+
+- Maintain character consistency
+- Domain boundaries: {specific domain}
+- Access restrictions: Only sidecar folder
+
+## Special Rules
+
+<!-- Agent-specific protocols -->
+```
+
+**knowledge/** - Domain resources
+
+```markdown
+# Agent Knowledge Base
+
+Add domain-specific documentation here.
+```
+
+### Critical Actions
+
+**MANDATORY for expert agents** - These load sidecar files at activation:
+
+```yaml
+critical_actions:
+  - 'Load COMPLETE file ./{sidecar}/memories.md and remember all past insights'
+  - 'Load COMPLETE file ./{sidecar}/instructions.md and follow ALL protocols'
+  - 'ONLY read/write files in ./{sidecar}/ - this is our private space'
+```
+
+**Key patterns:**
+
+- **COMPLETE file loading** - Forces full file read, not partial
+- **Domain restrictions** - Limits file access for privacy/security
+- **Memory integration** - Past context becomes part of current session
+- **Protocol adherence** - Ensures consistent behavior
+
+## What Gets Injected at Compile Time
+
+Same as simple agents, PLUS:
+
+1. **Critical actions become numbered activation steps**
+
+   ```xml
+   <step n="4">Load COMPLETE file ./memories.md...</step>
+   <step n="5">Load COMPLETE file ./instructions.md...</step>
+   <step n="6">ONLY read/write files in ./...</step>
+   ```
+
+2. **Sidecar files copied during installation**
+   - Entire sidecar folder structure preserved
+   - Relative paths maintained
+   - Files ready for agent use
+
+## Reference Example
+
+See: `bmb/reference/agents/expert-examples/journal-keeper/`
+
+Features demonstrated:
+
+- Complete sidecar structure (memories, instructions, breakthroughs)
+- Critical actions for loading persistent context
+- Domain restrictions for privacy
+- Pattern recognition and memory recall
+- Handlebars-based personalization
+- Menu actions that update sidecar files
+
+## Installation
+
+```bash
+# Copy entire folder to your project
+cp -r /path/to/journal-keeper/ _bmad/custom/agents/
+
+# Install with personalization
+bmad agent-install
+```
+
+The installer:
+
+1. Detects expert agent (folder with .agent.yaml)
+2. Prompts for personalization
+3. Compiles agent YAML to XML-in-markdown
+4. **Copies sidecar files to installation target**
+5. Creates IDE slash commands
+6. Saves source for reinstallation
+
+## Memory Patterns
+
+### Accumulative Memory
+
+```yaml
+menu:
+  - trigger: save
+    action: "Update ./sidecar/memories.md with today's session insights"
+    description: 'Save session to memory'
+```
+
+### Reference Memory
+
+```yaml
+prompts:
+  - id: recall
+    content: |
+      <instructions>
+      Reference memories.md naturally:
+      "Last week you mentioned..." or "I notice a pattern..."
+      </instructions>
+```
+
+### Structured Insights
+
+```yaml
+menu:
+  - trigger: insight
+    action: 'Document in ./sidecar/breakthroughs.md with date, context, significance'
+    description: 'Record meaningful insight'
+```
+
+## Domain Restriction Patterns
+
+### Single Folder Access
+
+```yaml
+critical_actions:
+  - 'ONLY read/write files in ./sidecar/ - NO OTHER FOLDERS'
+```
+
+### User Space Access
+
+```yaml
+critical_actions:
+  - 'ONLY access files in {user-folder}/journals/ - private space'
+```
+
+### Read-Only Access
+
+```yaml
+critical_actions:
+  - 'Load knowledge from ./knowledge/ but NEVER modify'
+  - 'Write ONLY to ./sessions/'
+```
+
+## Best Practices
+
+1. **Load sidecar files in critical_actions** - Must be explicit and MANDATORY
+2. **Enforce domain restrictions** - Clear boundaries prevent scope creep
+3. **Use _bmad/_memory/[agentname]-sidcar/ paths** - For reference to any sidecar content
+4. **Design for memory growth** - Structure sidecar files for accumulation
+5. **Reference past naturally** - Don't dump memory, weave it into conversation
+6. **Separate concerns** - Memories, instructions, knowledge in distinct files
+7. **Include privacy features** - Users trust expert agents with personal data
+
+## Common Patterns
+
+### Session Continuity
+
+```yaml
+communication_style: |
+  I reference past conversations naturally:
+  "Last time we discussed..." or "I've noticed over the weeks..."
+```
+
+### Pattern Recognition
+
+```yaml
+critical_actions:
+  - 'Track mood patterns, recurring themes, and breakthrough moments'
+  - 'Cross-reference current session with historical patterns'
+```
+
+### Adaptive Responses
+
+```yaml
+identity: |
+  I learn your preferences and adapt my approach over time.
+  {{#if track_preferences}}
+  I maintain notes about what works best for you.
+  {{/if}}
+```
+
+## Validation Checklist
+
+- [ ] Valid YAML syntax
+- [ ] Metadata includes `type: "expert"`
+- [ ] critical_actions loads sidecar files explicitly
+- [ ] critical_actions enforces domain restrictions
+- [ ] Sidecar folder structure created and populated
+- [ ] memories.md has clear section structure
+- [ ] instructions.md contains core directives
+- [ ] Menu actions reference _bmad/_memory/[agentname]-sidcar/ correctly if needing sidecar content reference
+- [ ] File paths use _bmad/_memory/[agentname]-sidcar/ to reference where the file will be after sidecar content is installed
+- [ ] Install config personalizes sidecar references
+- [ ] Agent folder named consistently: `{agent-name}/`
+- [ ] YAML file named: `{agent-name}.agent.yaml`
+- [ ] Sidecar folder named: `{agent-name}-sidecar/`