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

package/src/modules/xmb/workflows-legacy/create-module/README.md

@@ -0,0 +1,229 @@
+# Create Module Workflow
+
+Interactive scaffolding system creating complete XiaoMa modules with agents, workflows, tasks, and installation infrastructure.
+
+## Table of Contents
+
+- [Quick Start](#quick-start)
+- [Workflow Phases](#workflow-phases)
+- [Output Structure](#output-structure)
+- [Module Components](#module-components)
+- [Best Practices](#best-practices)
+
+## Quick Start
+
+```bash
+# Basic invocation
+workflow create-module
+
+# With module brief input
+workflow create-module --input module-brief-{name}-{date}.md
+
+# Via XiaoMa Builder
+*create-module
+```
+
+## Workflow Phases
+
+### Phase 1: Concept Definition
+
+- Define module purpose and audience
+- Establish module code (kebab-case) and name
+- Choose category (Domain, Creative, Technical, Business, Personal)
+- Plan component architecture
+
+**Module Brief Integration:**
+
+- Auto-detects existing briefs
+- Uses as pre-populated blueprint
+- Accelerates planning phase
+
+### Phase 2: Architecture Planning
+
+- Create directory hierarchy
+- Setup configuration system
+- Define installer structure
+- Establish component folders
+
+### Phase 3: Component Creation
+
+- Optional first agent creation
+- Optional first workflow creation
+- Component placeholder generation
+- Integration validation
+
+### Phase 4: Installation Setup
+
+- Create install-config.yaml
+- Configure deployment questions
+- Setup installer logic
+- Post-install messaging
+
+### Phase 5: Documentation
+
+- Generate comprehensive README
+- Create development roadmap
+- Provide quick commands
+- Document next steps
+
+## Output Structure
+
+### Generated Directory
+
+```
+{xiaoma_folder}/{module-code}/
+├── agents/              # Agent definitions
+├── workflows/           # Workflow processes
+├── tasks/              # Reusable tasks
+├── templates/          # Document templates
+├── data/               # Module data files
+├── _module-installer/  # Installation logic
+│   ├── install-config.yaml
+│   └── installer.js
+├── README.md           # Module documentation
+├── TODO.md            # Development roadmap
+└── config.yaml        # Runtime configuration
+```
+
+### Configuration Files
+
+**install-config.yaml** - Installation questions
+
+```yaml
+questions:
+  - id: user_name
+    prompt: 'Your name?'
+    default: 'User'
+  - id: output_folder
+    prompt: 'Output location?'
+    default: './output'
+```
+
+**config.yaml** - Generated from user answers during install
+
+```yaml
+user_name: 'John Doe'
+output_folder: './my-output'
+```
+
+## Module Components
+
+### Agents
+
+- Full module agents with workflows
+- Expert agents with sidecars
+- Simple utility agents
+
+### Workflows
+
+- Multi-step guided processes
+- Configuration-driven
+- Web bundle support
+
+### Tasks
+
+- Reusable operations
+- Agent-agnostic
+- Modular components
+
+### Templates
+
+- Document structures
+- Output formats
+- Report templates
+
+## Best Practices
+
+### Planning
+
+1. **Use module-brief workflow first** - Creates comprehensive blueprint
+2. **Define clear scope** - Avoid feature creep
+3. **Plan component interactions** - Map agent/workflow relationships
+
+### Structure
+
+1. **Follow conventions** - Use established patterns
+2. **Keep components focused** - Single responsibility
+3. **Document thoroughly** - Clear README and inline docs
+
+### Development
+
+1. **Start with core agent** - Build primary functionality first
+2. **Create key workflows** - Essential processes before edge cases
+3. **Test incrementally** - Validate as you build
+
+### Installation
+
+1. **Minimal config questions** - Only essential settings
+2. **Smart defaults** - Sensible out-of-box experience
+3. **Clear post-install** - Guide users to first steps
+
+## Integration Points
+
+### With Other Workflows
+
+- **module-brief** - Strategic planning input
+- **create-agent** - Agent component creation
+- **create-workflow** - Workflow building
+- **redoc** - Documentation maintenance
+
+### With XiaoMa Core
+
+- Uses core framework capabilities
+- Integrates with module system
+- Follows XiaoMa conventions
+
+## Examples
+
+### Domain-Specific Module
+
+```
+Category: Domain-Specific
+Code: legal-advisor
+Components:
+- Contract Review Agent
+- Compliance Workflow
+- Legal Templates
+```
+
+### Creative Module
+
+```
+Category: Creative
+Code: story-builder
+Components:
+- Narrative Agent
+- Plot Workflow
+- Character Templates
+```
+
+### Technical Module
+
+```
+Category: Technical
+Code: api-tester
+Components:
+- Test Runner Agent
+- API Validation Workflow
+- Test Report Templates
+```
+
+## Workflow Files
+
+```
+create-module/
+├── workflow.yaml          # Configuration
+├── instructions.md        # Step guide
+├── checklist.md          # Validation
+├── module-structure.md   # Architecture
+├── installer-templates/  # Install files
+└── README.md            # This file
+```
+
+## Related Documentation
+
+- [Module Structure](module-structure.md)
+- [Module Brief Workflow](../module-brief/README.md)
+- [Create Agent](../create-agent/README.md)
+- [Create Workflow](../create-workflow/README.md)
+- [XMB Module](../../README.md)

package/src/modules/xmb/workflows-legacy/create-module/brainstorm-context.md

@@ -0,0 +1,137 @@
+# Module Brainstorming Context
+
+_Context provided to brainstorming workflow when creating a new XIAOMA module_
+
+## Session Focus
+
+You are brainstorming ideas for a **complete XIAOMA module** - a self-contained package that extends the XIAOMA Method with specialized domain expertise and capabilities.
+
+## What is a XIAOMA Module?
+
+A module is a cohesive package that provides:
+
+- **Domain Expertise**: Specialized knowledge in a specific area (RPG, DevOps, Content Creation, etc.)
+- **Agent Team**: Multiple AI personas with complementary skills
+- **Workflows**: Guided processes for common tasks in the domain
+- **Templates**: Document structures for consistent outputs
+- **Integration**: Components that work together seamlessly
+
+## Brainstorming Goals
+
+Explore and define:
+
+### 1. Domain and Purpose
+
+- **What domain/problem space?** (e.g., game development, marketing, personal productivity)
+- **Who is the target user?** (developers, writers, managers, hobbyists)
+- **What pain points does it solve?** (tedious tasks, missing structure, need for expertise)
+- **What makes this domain exciting?** (creativity, efficiency, empowerment)
+
+### 2. Agent Team Composition
+
+- **How many agents?** (typically 3-7 for a module)
+- **What roles/personas?** (architect, researcher, reviewer, specialist)
+- **How do they collaborate?** (handoffs, reviews, ensemble work)
+- **What personality theme?** (Star Trek crew, superhero team, fantasy party, professional squad)
+
+### 3. Core Workflows
+
+- **What documents need creating?** (plans, specs, reports, creative outputs)
+- **What processes need automation?** (analysis, generation, review, deployment)
+- **What workflows enable the vision?** (3-10 key workflows that define the module)
+
+### 4. Value Proposition
+
+- **What becomes easier?** (specific tasks that get 10x faster)
+- **What becomes possible?** (new capabilities previously unavailable)
+- **What becomes better?** (quality improvements, consistency gains)
+
+## Creative Constraints
+
+A good XIAOMA module should be:
+
+- **Focused**: Serves a specific domain well (not generic)
+- **Complete**: Provides end-to-end capabilities for that domain
+- **Cohesive**: Agents and workflows complement each other
+- **Fun**: Personality and creativity make it enjoyable to use
+- **Practical**: Solves real problems, delivers real value
+
+## Module Architecture Questions
+
+1. **Module Identity**
+   - Module code (kebab-case, e.g., "rpg-toolkit")
+   - Module name (friendly, e.g., "RPG Toolkit")
+   - Module purpose (one sentence)
+   - Target audience
+
+2. **Agent Lineup**
+   - Agent names and roles
+   - Communication styles and personalities
+   - Expertise areas
+   - Command sets (what each agent can do)
+
+3. **Workflow Portfolio**
+   - Document generation workflows
+   - Action/automation workflows
+   - Analysis/research workflows
+   - Creative/ideation workflows
+
+4. **Integration Points**
+   - How agents invoke workflows
+   - How workflows use templates
+   - How components pass data
+   - Dependencies on other modules
+
+## Example Module Patterns
+
+### Professional Domains
+
+- **DevOps Suite**: Deploy, Monitor, Troubleshoot agents + deployment workflows
+- **Marketing Engine**: Content, SEO, Analytics agents + campaign workflows
+- **Legal Assistant**: Contract, Research, Review agents + document workflows
+
+### Creative Domains
+
+- **RPG Toolkit**: DM, NPC, Quest agents + adventure creation workflows
+- **Story Crafter**: Plot, Character, World agents + writing workflows
+- **Music Producer**: Composer, Arranger, Mixer agents + production workflows
+
+### Personal Domains
+
+- **Life Coach**: Planner, Tracker, Mentor agents + productivity workflows
+- **Learning Companion**: Tutor, Quiz, Reviewer agents + study workflows
+- **Health Guide**: Nutrition, Fitness, Wellness agents + tracking workflows
+
+## Suggested Brainstorming Techniques
+
+Particularly effective for module ideation:
+
+1. **Domain Immersion**: Deep dive into target domain's problems
+2. **Persona Mapping**: Who needs this and what do they struggle with?
+3. **Workflow Mapping**: What processes exist today? How could they improve?
+4. **Team Building**: What personalities would make a great team?
+5. **Integration Thinking**: How do pieces connect and amplify each other?
+
+## Key Questions to Answer
+
+1. What domain expertise should this module embody?
+2. What would users be able to do that they can't do now?
+3. Who are the 3-7 agents and what are their personalities?
+4. What are the 5-10 core workflows?
+5. What makes this module delightful to use?
+6. How is this different from existing tools?
+7. What's the "killer feature" that makes this essential?
+
+## Output Goals
+
+Generate:
+
+- **Module concept**: Clear vision and purpose
+- **Agent roster**: Names, roles, personalities for each agent
+- **Workflow list**: Core workflows with brief descriptions
+- **Unique angle**: What makes this module special
+- **Use cases**: 3-5 concrete scenarios where this module shines
+
+---
+
+_This focused context helps create cohesive, valuable XIAOMA modules_

package/src/modules/xmb/workflows-legacy/create-module/checklist.md

@@ -0,0 +1,235 @@
+# Build Module Validation Checklist
+
+## Module Identity and Metadata
+
+### Basic Information
+
+- [ ] Module code follows kebab-case convention (e.g., "rpg-toolkit")
+- [ ] Module name is descriptive and title-cased
+- [ ] Module purpose is clearly defined (1-2 sentences)
+- [ ] Target audience is identified
+- [ ] Version number follows semantic versioning (e.g., "1.0.0")
+- [ ] Author information is present
+
+### Naming Consistency
+
+- [ ] Module code used consistently throughout all files
+- [ ] No naming conflicts with existing modules
+- [ ] All paths use consistent module code references
+
+## Directory Structure
+
+### Source Directories ({xiaoma_folder}/{module-code}/)
+
+- [ ] `/agents` directory created (even if empty)
+- [ ] `/workflows` directory created (even if empty)
+- [ ] `/tasks` directory exists (if tasks planned)
+- [ ] `/templates` directory exists (if templates used)
+- [ ] `/data` directory exists (if data files needed)
+- [ ] `/_module-installer/install-config.yaml` present (defines configuration questions)
+- [ ] `README.md` present with documentation
+
+### Installed Module Structure (generated in target after installation)
+
+- [ ] `/agents` directory for compiled agents
+- [ ] `/workflows` directory for workflow instances
+- [ ] `/data` directory for user data
+- [ ] `config.yaml` generated from install-config.yaml during installation
+
+## Component Planning
+
+### Agents
+
+- [ ] At least one agent defined or planned
+- [ ] Agent purposes are distinct and clear
+- [ ] Agent types (Simple/Expert/Module) identified
+- [ ] No significant overlap between agents
+- [ ] Primary agent is identified
+
+### Workflows
+
+- [ ] At least one workflow defined or planned
+- [ ] Workflow purposes are clear
+- [ ] Workflow types identified (Document/Action/Interactive)
+- [ ] Primary workflow is identified
+- [ ] Workflow complexity is appropriate
+
+### Tasks (if applicable)
+
+- [ ] Tasks have single, clear purposes
+- [ ] Tasks don't duplicate workflow functionality
+- [ ] Task files follow naming conventions
+
+## Configuration Files
+
+### Installation Configuration (install-config.yaml)
+
+- [ ] `install-config.yaml` exists in `_module-installer`
+- [ ] Module metadata present (code, name, version)
+- [ ] Configuration questions defined for user input
+- [ ] Default values provided for all questions
+- [ ] Prompt text is clear and helpful
+- [ ] Result templates use proper variable substitution
+- [ ] Paths use proper variables ({project-root}, {value}, etc.)
+
+### Generated Config (config.yaml in target)
+
+- [ ] Generated during installation from install-config.yaml
+- [ ] Contains all user-provided configuration values
+- [ ] Module metadata included
+- [ ] No config.yaml should exist in source module
+
+## Installation Infrastructure
+
+### Installer Files
+
+- [ ] Install configuration validates against schema
+- [ ] All source paths exist or are marked as templates
+- [ ] Destination paths use correct variables
+- [ ] Optional vs required steps clearly marked
+
+### installer.js (if present)
+
+- [ ] Main `installModule` function exists
+- [ ] Error handling implemented
+- [ ] Console logging for user feedback
+- [ ] Exports correct function names
+- [ ] Placeholder code replaced with actual logic (or logged as TODO)
+
+### External Assets (if any)
+
+- [ ] Asset files exist in assets directory
+- [ ] Copy destinations are valid
+- [ ] Permissions requirements documented
+
+## Documentation
+
+### README.md
+
+- [ ] Module overview section present
+- [ ] Installation instructions included
+- [ ] Component listing with descriptions
+- [ ] Quick start guide provided
+- [ ] Configuration options documented
+- [ ] At least one usage example
+- [ ] Directory structure shown
+- [ ] Author and date information
+
+### Component Documentation
+
+- [ ] Each agent has purpose documentation
+- [ ] Each workflow has description
+- [ ] Tasks are documented (if present)
+- [ ] Examples demonstrate typical usage
+
+### Development Roadmap
+
+- [ ] TODO.md or roadmap section exists
+- [ ] Planned components listed
+- [ ] Development phases identified
+- [ ] Quick commands for adding components
+
+## Integration
+
+### Cross-component References
+
+- [ ] Agents reference correct workflow paths
+- [ ] Workflows reference correct task paths
+- [ ] All internal paths use module variables
+- [ ] External dependencies declared
+
+### Module Boundaries
+
+- [ ] Module scope is well-defined
+- [ ] No feature creep into other domains
+- [ ] Clear separation from other modules
+
+## Quality Checks
+
+### Completeness
+
+- [ ] At least one functional component (not all placeholders)
+- [ ] Core functionality is implementable
+- [ ] Module provides clear value
+
+### Consistency
+
+- [ ] Formatting consistent across files
+- [ ] Variable naming follows conventions
+- [ ] Communication style appropriate for domain
+
+### Scalability
+
+- [ ] Structure supports future growth
+- [ ] Component organization is logical
+- [ ] No hard-coded limits
+
+## Testing and Validation
+
+### Structural Validation
+
+- [ ] YAML files parse without errors
+- [ ] JSON files (if any) are valid
+- [ ] XML files (if any) are well-formed
+- [ ] No syntax errors in JavaScript files
+
+### Path Validation
+
+- [ ] All referenced paths exist or are clearly marked as TODO
+- [ ] Variable substitutions are correct
+- [ ] No absolute paths (unless intentional)
+
+### Installation Testing
+
+- [ ] Installation steps can be simulated
+- [ ] No circular dependencies
+- [ ] Uninstall process defined (if complex)
+
+## Final Checks
+
+### Ready for Use
+
+- [ ] Module can be installed without errors
+- [ ] At least one component is functional
+- [ ] User can understand how to get started
+- [ ] Next steps are clear
+
+### Professional Quality
+
+- [ ] No placeholder text remains (unless marked TODO)
+- [ ] No obvious typos or grammar issues
+- [ ] Professional tone throughout
+- [ ] Contact/support information provided
+
+## Issues Found
+
+### Critical Issues
+
+<!-- List any issues that MUST be fixed before module can be used -->
+
+### Warnings
+
+<!-- List any issues that should be addressed but won't prevent basic usage -->
+
+### Improvements
+
+<!-- List any optional enhancements that would improve the module -->
+
+### Missing Components
+
+<!-- List any planned components not yet implemented -->
+
+## Module Complexity Assessment
+
+### Complexity Rating
+
+- [ ] Simple (1-2 agents, 2-3 workflows)
+- [ ] Standard (3-5 agents, 5-10 workflows)
+- [ ] Complex (5+ agents, 10+ workflows)
+
+### Readiness Level
+
+- [ ] Prototype (Basic structure, mostly placeholders)
+- [ ] Alpha (Core functionality works)
+- [ ] Beta (Most features complete, needs testing)
+- [ ] Release (Full functionality, documented)

package/src/modules/xmb/workflows-legacy/create-module/installer-templates/install-config.yaml

@@ -0,0 +1,92 @@
+# {{MODULE_NAME}} Module Configuration
+# This file defines installation questions and module configuration values
+
+code: "{{MODULE_CODE}}"
+name: "{{MODULE_NAME}}"
+default_selected: "{{DEFAULT_SELECTED}}" # true if this should be selected by default
+
+# Welcome message shown during installation
+prompt:
+  - "{{WELCOME_MESSAGE_LINE_1}}"
+  - "{{WELCOME_MESSAGE_LINE_2}}"
+# Core config values are automatically inherited:
+## user_name
+## communication_language
+## document_output_language
+## output_folder
+
+# ============================================================================
+# CONFIGURATION FIELDS
+# ============================================================================
+#
+# Each field can be:
+# 1. INTERACTIVE (has 'prompt' - asks user during installation)
+# 2. STATIC (no 'prompt' - just uses 'result' value)
+#
+# Field structure:
+#   field_name:
+#     prompt: "Question to ask user" (optional - omit for static values)
+#     default: "default_value" (optional)
+#     result: "{value}" or "static-value"
+#     single-select: [...] (optional - for dropdown)
+#     multi-select: [...] (optional - for checkboxes)
+#
+# Special placeholders in result:
+#   {value} - replaced with user's answer
+#   {project-root} - replaced with project root path
+#   {directory_name} - replaced with project directory name
+#   {module_code} - replaced with this module's code
+# ============================================================================
+
+# EXAMPLE: Interactive text input
+# example_project_name:
+#   prompt: "What is your project name?"
+#   default: "{directory_name}"
+#   result: "{value}"
+
+# EXAMPLE: Interactive single-select dropdown
+# example_skill_level:
+#   prompt: "What is your experience level?"
+#   default: "intermediate"
+#   result: "{value}"
+#   single-select:
+#     - value: "beginner"
+#       label: "Beginner - New to this domain"
+#     - value: "intermediate"
+#       label: "Intermediate - Familiar with basics"
+#     - value: "expert"
+#       label: "Expert - Deep knowledge"
+
+# EXAMPLE: Interactive multi-select checkboxes
+# example_features:
+#   prompt:
+#     - "Which features do you want to enable?"
+#     - "(Select all that apply)"
+#   result: "{value}"
+#   multi-select:
+#     - "Feature A"
+#     - "Feature B"
+#     - "Feature C"
+
+# EXAMPLE: Interactive path input
+# example_output_path:
+#   prompt: "Where should outputs be saved?"
+#   default: "output/{{MODULE_CODE}}"
+#   result: "{project-root}/{value}"
+
+# EXAMPLE: Static value (no user prompt)
+# example_static_setting:
+#   result: "hardcoded-value"
+
+# EXAMPLE: Static path
+# module_data_path:
+#   result: "{project-root}/{xiaoma_folder}/{{MODULE_CODE}}/data"
+
+# ============================================================================
+# YOUR MODULE CONFIGURATION FIELDS
+# ============================================================================
+# Replace examples above with your module's actual configuration needs.
+# Delete this comment block and the examples when implementing.
+# ============================================================================
+
+# TODO: INSERT {MODULE_CONFIG_FIELDS} HERE