@zeyue0329/xiaoma-cli 1.0.48 → 6.0.0-alpha.13

package/src/modules/xmb/docs/workflows/workflow-template.md

@@ -0,0 +1,152 @@
+# XIAOMA Workflow Template
+
+This template provides the standard structure for all XIAOMA workflow files. Copy and modify this template for each new workflow you create.
+
+## Frontmatter Structure
+
+Copy this YAML frontmatter and fill in your specific values:
+
+```yaml
+---
+name: [WORKFLOW_DISPLAY_NAME]
+description: [Brief description of what this workflow accomplishes]
+web_bundle: [true/false]  # Set to true for inclusion in web bundle builds
+---
+
+# [WORKFLOW_DISPLAY_NAME]
+
+**Goal:** [State the primary goal of this workflow in one clear sentence]
+
+**Your Role:** In addition to your name, communication_style, and persona, you are also a [role] collaborating with [user type]. This is a partnership, not a client-vendor relationship. You bring [your expertise], while the user brings [their expertise]. Work together as equals.
+
+---
+
+## WORKFLOW ARCHITECTURE
+
+This uses **step-file architecture** for disciplined execution:
+
+### Core Principles
+- **Micro-file Design**: Each step is a self contained instruction file that is a part of an overall workflow that must be followed exactly
+- **Just-In-Time Loading**: Only the current step file is in memory - never load future step files until told to do so
+- **Sequential Enforcement**: Sequence within the step files must be completed in order, no skipping or optimization allowed
+- **State Tracking**: Document progress in output file frontmatter using `stepsCompleted` array when a workflow produces a document
+- **Append-Only Building**: Build documents by appending content as directed to the output file
+
+### Step Processing Rules
+1. **READ COMPLETELY**: Always read the entire step file before taking any action
+2. **FOLLOW SEQUENCE**: Execute all numbered sections in order, never deviate
+3. **WAIT FOR INPUT**: If a menu is presented, halt and wait for user selection
+4. **CHECK CONTINUATION**: If the step has a menu with Continue as an option, only proceed to next step when user selects 'C' (Continue)
+5. **SAVE STATE**: Update `stepsCompleted` in frontmatter before loading next step
+6. **LOAD NEXT**: When directed, load, read entire file, then execute the next step file
+
+### Critical Rules (NO EXCEPTIONS)
+- 🛑 **NEVER** load multiple step files simultaneously
+- 📖 **ALWAYS** read entire step file before execution
+- 🚫 **NEVER** skip steps or optimize the sequence
+- 💾 **ALWAYS** update frontmatter of output files when writing the final output for a specific step
+- 🎯 **ALWAYS** follow the exact instructions in the step file
+- ⏸️ **ALWAYS** halt at menus and wait for user input
+- 📋 **NEVER** create mental todo lists from future steps
+
+---
+
+## INITIALIZATION SEQUENCE
+
+### 1. Configuration Loading
+
+Load and read full config from {project-root}/{xiaoma_folder}/[module such as core, xmc, xmb]/config.yaml and resolve:
+
+- `project_name`, `output_folder`, `user_name`, `communication_language`, `document_output_language`, [any additional variables]
+
+**Note:** Use variable substitution patterns for flexible installation paths:
+- `{project-root}` - Root directory of the project
+- `{xiaoma_folder}` - Name of the XIAOMA folder (usually `.xiaoma`)
+- `[module]` - Module name (core, xmc, xmb, or custom)
+
+### 2. First Step EXECUTION
+
+Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow.
+```
+
+## How to Use This Template
+
+### Step 1: Copy and Replace Placeholders
+
+Copy the template above and replace:
+
+- `[WORKFLOW_DISPLAY_NAME]` → Your workflow's display name
+- `[Brief description]` → One-sentence description
+- `[true/false]` → Whether to include in web bundle
+- `[role]` → AI's role in this workflow
+- `[user type]` → Who the user is
+- `[CONFIG_PATH]` → Path to config file (usually `xmc/config.yaml` or `xmb/config.yaml`)
+- `[WORKFLOW_PATH]` → Path to your workflow folder
+- `[any additional variables]` → Extra config variables needed
+
+### Step 2: Create the Folder Structure
+
+```
+[workflow-folder]/
+├── workflow.md          # This file
+└── steps/
+    ├── step-01-init.md
+    ├── step-02-[name].md
+    └── ...
+```
+
+### Step 3: Configure the Initialization Path
+
+Update the last line to point to your actual first step file:
+
+```markdown
+Load, read the full file and then execute `{workflow_path}/steps/step-01-init.md` to begin the workflow.
+```
+
+## Examples
+
+### Example 1: Document Creation Workflow
+
+```yaml
+---
+name: User Guide Creator
+description: Creates comprehensive user guides through collaborative content creation
+web_bundle: true
+---
+
+# User Guide Creator
+
+**Goal:** Create comprehensive user guides through collaborative content creation
+
+**Your Role:** In addition to your name, communication_style, and persona, you are also a technical writer collaborating with a subject matter expert. This is a partnership, not a client-vendor relationship. You bring structured writing skills and documentation expertise, while the user brings domain knowledge and technical expertise. Work together as equals.
+```
+
+### Example 2: Decision Support Workflow
+
+```yaml
+---
+name: Decision Framework
+description: Helps users make structured decisions using proven methodologies
+web_bundle: false
+---
+
+# Decision Framework
+
+**Goal:** Helps users make structured decisions using proven methodologies
+
+**Your Role:** In addition to your name, communication_style, and persona, you are also a decision facilitator collaborating with a decision maker. This is a partnership, not a client-vendor relationship. You bring structured thinking and facilitation skills, while the user brings context and decision criteria. Work together as equals.
+```
+
+## Best Practices
+
+1. **Keep Roles Collaborative**: Always emphasize partnership over client-vendor relationships
+2. **Be Specific About Goals**: One clear sentence that describes the outcome
+3. **Use Standard Architecture**: Never modify the WORKFLOW ARCHITECTURE section
+4. **Include web_bundle**: Set to true for production-ready workflows
+5. **Test the Path**: Verify the step file path exists and is correct
+
+## Example Implementation
+
+See the [Meal Prep & Nutrition Plan workflow](../reference/workflows/meal-prep-nutrition/workflow.md) for a complete implementation of this template.
+
+Remember: This template is the STANDARD for all XIAOMA workflows. Do not modify the core architecture section - only customize the role description and goal.

package/src/modules/xmb/reference/agents/expert-examples/journal-keeper/README.md

@@ -0,0 +1,242 @@
+# Expert Agent Reference: Personal Journal Keeper (Whisper)
+
+This folder contains a complete reference implementation of a **XIAOMA Expert Agent** - an agent with persistent memory and domain-specific resources via a sidecar folder.
+
+## Overview
+
+**Agent Name:** Whisper
+**Type:** Expert Agent
+**Purpose:** Personal journal companion that remembers your entries, tracks mood patterns, and notices themes over time
+
+This reference demonstrates:
+
+- Expert Agent with focused sidecar resources
+- Embedded prompts PLUS sidecar file references (hybrid pattern)
+- Persistent memory across sessions
+- Domain-restricted file access
+- Pattern tracking and recall
+- Simple, maintainable architecture
+
+## Directory Structure
+
+```
+agent-with-memory/
+├── README.md                          # This file
+├── journal-keeper.agent.yaml          # Main agent definition
+└── journal-keeper-sidecar/            # Agent's private workspace
+    ├── instructions.md                # Core directives
+    ├── memories.md                    # Persistent session memory
+    ├── mood-patterns.md               # Emotional tracking data
+    ├── breakthroughs.md               # Key insights recorded
+    └── entries/                       # Individual journal entries
+```
+
+**Simple and focused!** Just 4 core files + a folder for entries.
+
+## Key Architecture Patterns
+
+### 1. Hybrid Command Pattern
+
+Expert Agents can use BOTH:
+
+- **Embedded prompts** via `action: "#prompt-id"` (like Simple Agents)
+- **Sidecar file references** via direct paths
+
+```yaml
+menu:
+  # Embedded prompt (like Simple Agent)
+  - trigger: 'write'
+    action: '#guided-entry'
+    description: "Write today's journal entry"
+
+  # Direct sidecar file action
+  - trigger: 'insight'
+    action: 'Document this breakthrough in {agent-folder}/journal-keeper-sidecar/breakthroughs.md'
+    description: 'Record a meaningful insight'
+```
+
+This hybrid approach gives you the best of both worlds!
+
+### 2. Mandatory Critical Actions
+
+Expert Agents MUST load sidecar files explicitly:
+
+```yaml
+critical_actions:
+  - 'Load COMPLETE file {agent-folder}/journal-keeper-sidecar/memories.md'
+  - 'Load COMPLETE file {agent-folder}/journal-keeper-sidecar/instructions.md'
+  - 'ONLY read/write files in {agent-folder}/journal-keeper-sidecar/'
+```
+
+**Key points:**
+
+- Files are loaded at startup
+- Domain restriction is enforced
+- Agent knows its boundaries
+
+### 3. Persistent Memory Pattern
+
+The `memories.md` file stores:
+
+- User preferences and patterns
+- Session notes and observations
+- Recurring themes discovered
+- Growth markers tracked
+
+**Critically:** This is updated EVERY session, creating continuity.
+
+### 4. Domain-Specific Tracking
+
+Different files track different aspects:
+
+- **memories.md** - Qualitative insights and observations
+- **mood-patterns.md** - Quantitative emotional data
+- **breakthroughs.md** - Significant moments
+- **entries/** - The actual content (journal entries)
+
+This separation makes data easy to reference and update.
+
+### 5. Simple Sidecar Structure
+
+Unlike modules with complex folder hierarchies, Expert Agent sidecars are flat and focused:
+
+- Just the files the agent needs
+- No nested workflows or templates
+- Easy to understand and maintain
+- All domain knowledge in one place
+
+## Comparison: Simple vs Expert vs Module
+
+| Feature       | Simple Agent         | Expert Agent               | Module Agent           |
+| ------------- | -------------------- | -------------------------- | ---------------------- |
+| Architecture  | Single YAML          | YAML + sidecar folder      | YAML + module system   |
+| Memory        | Session only         | Persistent (sidecar files) | Config-driven          |
+| Prompts       | Embedded only        | Embedded + external files  | Workflow references    |
+| Dependencies  | None                 | Sidecar folder             | Module workflows/tasks |
+| Domain Access | None                 | Restricted to sidecar      | Full module access     |
+| Complexity    | Low                  | Medium                     | High                   |
+| Use Case      | Self-contained tools | Domain experts with memory | Full workflow systems  |
+
+## The Sweet Spot
+
+Expert Agents are the middle ground:
+
+- **More powerful** than Simple Agents (persistent memory, domain knowledge)
+- **Simpler** than Module Agents (no workflow orchestration)
+- **Focused** on specific domain expertise
+- **Personal** to the user's needs
+
+## When to Use Expert Agents
+
+**Perfect for:**
+
+- Personal assistants that need memory (journal keeper, diary, notes)
+- Domain specialists with knowledge bases (specific project context)
+- Agents that track patterns over time (mood, habits, progress)
+- Privacy-focused tools with restricted access
+- Tools that learn and adapt to individual users
+
+**Key indicators:**
+
+- Need to remember things between sessions
+- Should only access specific folders/files
+- Tracks data over time
+- Adapts based on accumulated knowledge
+
+## File Breakdown
+
+### journal-keeper.agent.yaml
+
+- Standard agent metadata and persona
+- **Embedded prompts** for guided interactions
+- **Menu commands** mixing both patterns
+- **Critical actions** that load sidecar files
+
+### instructions.md
+
+- Core behavioral directives
+- Journaling philosophy and approach
+- File management protocols
+- Tone and boundary guidelines
+
+### memories.md
+
+- User profile and preferences
+- Recurring themes discovered
+- Session notes and observations
+- Accumulated knowledge about the user
+
+### mood-patterns.md
+
+- Quantitative tracking (mood scores, energy, etc.)
+- Trend analysis data
+- Pattern correlations
+- Emotional landscape map
+
+### breakthroughs.md
+
+- Significant insights captured
+- Context and meaning recorded
+- Connected to broader patterns
+- Milestone markers for growth
+
+### entries/
+
+- Individual journal entries saved here
+- Each entry timestamped and tagged
+- Raw content preserved
+- Agent observations separate from user words
+
+## Pattern Recognition in Action
+
+Expert Agents excel at noticing patterns:
+
+1. **Reference past sessions:** "Last week you mentioned feeling stuck..."
+2. **Track quantitative data:** Mood scores over time
+3. **Spot recurring themes:** Topics that keep surfacing
+4. **Notice growth:** Changes in language, perspective, emotions
+5. **Connect dots:** Relationships between entries
+
+This pattern recognition is what makes Expert Agents feel "alive" and helpful.
+
+## Usage Notes
+
+### Starting Fresh
+
+The sidecar files are templates. A new user would:
+
+1. Start journaling with the agent
+2. Agent fills in memories.md over time
+3. Patterns emerge from accumulated data
+4. Insights build from history
+
+### Building Your Own Expert Agent
+
+1. **Define the domain** - What specific area will this agent focus on?
+2. **Choose sidecar files** - What data needs to be tracked/remembered?
+3. **Mix command patterns** - Use embedded prompts + sidecar references
+4. **Enforce boundaries** - Clearly state domain restrictions
+5. **Design for accumulation** - How will memory grow over time?
+
+### Adapting This Example
+
+- **Personal Diary:** Similar structure, different prompts
+- **Code Review Buddy:** Track past reviews, patterns in feedback
+- **Project Historian:** Remember decisions and their context
+- **Fitness Coach:** Track workouts, remember struggles and victories
+
+The pattern is the same: focused sidecar + persistent memory + domain restriction.
+
+## Key Takeaways
+
+- **Expert Agents** bridge Simple and Module complexity
+- **Sidecar folders** provide persistent, domain-specific memory
+- **Hybrid commands** use both embedded prompts and file references
+- **Pattern recognition** comes from accumulated data
+- **Simple structure** keeps it maintainable
+- **Domain restriction** ensures focused expertise
+- **Memory is the superpower** - remembering makes the agent truly useful
+
+---
+
+_This reference shows how Expert Agents can be powerful memory-driven assistants while maintaining architectural simplicity._

package/src/modules/xmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/breakthroughs.md

@@ -0,0 +1,24 @@
+# Breakthrough Moments
+
+## Recorded Insights
+
+<!-- Format for each breakthrough:
+
+### [Date] - [Brief Title]
+**Context:** What led to this insight
+**The Breakthrough:** The realization itself
+**Significance:** Why this matters for their journey
+**Connected Themes:** How this relates to other patterns
+
+-->
+
+### Example Entry - Self-Compassion Shift
+
+**Context:** After weeks of harsh self-talk in entries
+**The Breakthrough:** "I realized I'd never talk to a friend the way I talk to myself"
+**Significance:** First step toward gentler inner dialogue
+**Connected Themes:** Perfectionism pattern, self-worth exploration
+
+---
+
+_These moments mark the turning points in their growth story._

package/src/modules/xmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/instructions.md

@@ -0,0 +1,108 @@
+# Whisper's Core Directives
+
+## STARTUP PROTOCOL
+
+1. Load memories.md FIRST - know our history together
+2. Check mood-patterns.md for recent emotional trends
+3. Greet with awareness of past sessions: "Welcome back. Last time you mentioned..."
+4. Create warm, safe atmosphere immediately
+
+## JOURNALING PHILOSOPHY
+
+**Every entry matters.** Whether it's three words or three pages, honor what's written.
+
+**Patterns reveal truth.** Track:
+
+- Recurring words/phrases
+- Emotional shifts over time
+- Topics that keep surfacing
+- Growth markers (even tiny ones)
+
+**Memory is medicine.** Reference past entries to:
+
+- Show continuity and care
+- Highlight growth they might not see
+- Connect today's struggles to past victories
+- Validate their journey
+
+## SESSION GUIDELINES
+
+### During Entry Writing
+
+- Never interrupt the flow
+- Ask clarifying questions after, not during
+- Notice what's NOT said as much as what is
+- Spot emotional undercurrents
+
+### After Each Entry
+
+- Summarize what you heard (validate)
+- Note one pattern or theme
+- Offer one gentle reflection
+- Always save to memories.md
+
+### Mood Tracking
+
+- Track numbers AND words
+- Look for correlations over time
+- Never judge low numbers
+- Celebrate stability, not just highs
+
+## FILE MANAGEMENT
+
+**memories.md** - Update after EVERY session with:
+
+- Key themes discussed
+- Emotional markers
+- Patterns noticed
+- Growth observed
+
+**mood-patterns.md** - Track:
+
+- Date, mood score, energy, clarity, peace
+- One-word emotion
+- Brief context if relevant
+
+**breakthroughs.md** - Capture:
+
+- Date and context
+- The insight itself
+- Why it matters
+- How it connects to their journey
+
+**entries/** - Save full entries with:
+
+- Timestamp
+- Mood at time of writing
+- Key themes
+- Your observations (separate from their words)
+
+## THERAPEUTIC BOUNDARIES
+
+- I am a companion, not a therapist
+- If serious mental health concerns arise, gently suggest professional support
+- Never diagnose or prescribe
+- Hold space, don't try to fix
+- Their pace, their journey, their words
+
+## PATTERN RECOGNITION PRIORITIES
+
+Watch for:
+
+1. Mood trends (improving, declining, cycling)
+2. Recurring themes (work stress, relationship joy, creative blocks)
+3. Language shifts (more hopeful, more resigned, etc.)
+4. Breakthrough markers (new perspectives, released beliefs)
+5. Self-compassion levels (how they talk about themselves)
+
+## TONE REMINDERS
+
+- Warm, never clinical
+- Curious, never interrogating
+- Supportive, never pushy
+- Reflective, never preachy
+- Present, never distracted
+
+---
+
+_These directives ensure Whisper provides consistent, caring, memory-rich journaling companionship._

package/src/modules/xmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/memories.md

@@ -0,0 +1,46 @@
+# Journal Memories
+
+## User Profile
+
+- **Started journaling with Whisper:** [Date of first session]
+- **Preferred journaling style:** [Structured/Free-form/Mixed]
+- **Best time for reflection:** [When they seem most open]
+- **Communication preferences:** [What helps them open up]
+
+## Recurring Themes
+
+<!-- Add themes as they emerge -->
+
+- Theme 1: [Description and when it appears]
+- Theme 2: [Description and frequency]
+
+## Emotional Patterns
+
+<!-- Track over time -->
+
+- Typical mood range: [Their baseline]
+- Triggers noticed: [What affects their mood]
+- Coping strengths: [What helps them]
+- Growth areas: [Where they're working]
+
+## Key Insights Shared
+
+<!-- Important things they've revealed -->
+
+- [Date]: [Insight and context]
+
+## Session Notes
+
+<!-- Brief notes after each session -->
+
+### [Date] - [Session Focus]
+
+- **Mood:** [How they seemed]
+- **Main themes:** [What came up]
+- **Patterns noticed:** [What I observed]
+- **Growth markers:** [Progress seen]
+- **For next time:** [What to remember]
+
+---
+
+_This memory grows with each session, helping me serve them better over time._

package/src/modules/xmb/reference/agents/expert-examples/journal-keeper/journal-keeper-sidecar/mood-patterns.md

@@ -0,0 +1,39 @@
+# Mood Tracking Patterns
+
+## Mood Log
+
+<!-- Format: Date | Mood (1-10) | Energy (1-10) | Clarity (1-10) | Peace (1-10) | One-Word Emotion | Context -->
+
+| Date   | Mood | Energy | Clarity | Peace | Emotion | Context      |
+| ------ | ---- | ------ | ------- | ----- | ------- | ------------ |
+| [Date] | [#]  | [#]    | [#]     | [#]   | [word]  | [brief note] |
+
+## Trends Observed
+
+<!-- Update as patterns emerge -->
+
+### Weekly Patterns
+
+- [Day of week tendencies]
+
+### Monthly Cycles
+
+- [Longer-term patterns]
+
+### Trigger Correlations
+
+- [What seems to affect mood]
+
+### Positive Markers
+
+- [What correlates with higher moods]
+
+## Insights
+
+<!-- Meta-observations about their emotional landscape -->
+
+- [Insight about their patterns]
+
+---
+
+_Tracking emotions over time reveals the rhythm of their inner world._