@zeyue0329/xiaoma-cli 1.0.49 → 1.6.5

package/docs/ide-info/codex.md

@@ -0,0 +1,21 @@
+# XIAOMA Method - Codex Instructions
+
+## Activating Agents
+
+XIAOMA agents, tasks and workflows are installed as custom prompts in
+`$CODEX_HOME/prompts/xiaoma-*.md` files. If `CODEX_HOME` is not set, it
+defaults to `$HOME/.codex/`.
+
+### Examples
+
+```
+/xiaoma-xmc-agents-dev - Activate development agent
+/xiaoma-xmc-agents-architect - Activate architect agent
+/xiaoma-xmc-workflows-dev-story - Execute dev-story workflow
+```
+
+### Notes
+
+Prompts are autocompleted when you type /
+Agent remains active for the conversation
+Start a new conversation to switch agents

package/docs/ide-info/crush.md

@@ -0,0 +1,30 @@
+# XIAOMA Method - Crush Instructions
+
+## Activating Agents
+
+XIAOMA agents are installed as commands in `.crush/commands/xiaoma/`.
+
+### How to Use
+
+1. **Open Command Palette**: Use Crush command interface
+2. **Navigate**: Browse to `{xiaoma_folder}/{module}/agents/`
+3. **Select Agent**: Choose the agent command
+4. **Execute**: Run to activate agent persona
+
+### Command Structure
+
+```
+.crush/commands/xiaoma/
+├── agents/          # All agents
+├── tasks/           # All tasks
+├── core/            # Core module
+│   ├── agents/
+│   └── tasks/
+└── {module}/        # Other modules
+```
+
+### Notes
+
+- Commands organized by module
+- Can browse hierarchically
+- Agent activates for session

package/docs/ide-info/cursor.md

@@ -0,0 +1,25 @@
+# XIAOMA Method - Cursor Instructions
+
+## Activating Agents
+
+XIAOMA agents are installed in `.cursor/rules/xiaoma/` as MDC rules.
+
+### How to Use
+
+1. **Reference in Chat**: Use `@{xiaoma_folder}/{module}/agents/{agent-name}`
+2. **Include Entire Module**: Use `@{xiaoma_folder}/{module}`
+3. **Reference Index**: Use `@{xiaoma_folder}/index` for all available agents
+
+### Examples
+
+```
+@{xiaoma_folder}/core/agents/dev - Activate dev agent
+@{xiaoma_folder}/xmc/agents/architect - Activate architect agent
+@{xiaoma_folder}/core - Include all core agents/tasks
+```
+
+### Notes
+
+- Rules are Manual type - only loaded when explicitly referenced
+- No automatic context pollution
+- Can combine multiple agents: `@{xiaoma_folder}/core/agents/dev @{xiaoma_folder}/core/agents/test`

package/docs/ide-info/gemini.md

@@ -0,0 +1,25 @@
+# XIAOMA Method - Gemini CLI Instructions
+
+## Activating Agents
+
+XIAOMA agents are concatenated in `.gemini/xiaoma-cli/GEMINI.md`.
+
+### How to Use
+
+1. **Type Trigger**: Use `*{agent-name}` in your prompt
+2. **Activate**: Agent persona activates from the concatenated file
+3. **Continue**: Agent remains active for conversation
+
+### Examples
+
+```
+*dev - Activate development agent
+*architect - Activate architect agent
+*test - Activate test agent
+```
+
+### Notes
+
+- All agents loaded from single GEMINI.md file
+- Triggers with asterisk: `*{agent-name}`
+- Context includes all agents (may be large)

package/docs/ide-info/github-copilot.md

@@ -0,0 +1,26 @@
+# XIAOMA Method - GitHub Copilot Instructions
+
+## Activating Agents
+
+XIAOMA agents are installed as chat modes in `.github/chatmodes/`.
+
+### How to Use
+
+1. **Open Chat View**: Click Copilot icon in VS Code sidebar
+2. **Select Mode**: Click mode selector (top of chat)
+3. **Choose Agent**: Select the XIAOMA agent from dropdown
+4. **Chat**: Agent is now active for this session
+
+### VS Code Settings
+
+Configured in `.vscode/settings.json`:
+
+- Max requests per session
+- Auto-fix enabled
+- MCP discovery enabled
+
+### Notes
+
+- Modes persist for the chat session
+- Switch modes anytime via dropdown
+- Multiple agents available in mode selector

package/docs/ide-info/iflow.md

@@ -0,0 +1,33 @@
+# XIAOMA Method - iFlow CLI Instructions
+
+## Activating Agents
+
+XIAOMA agents are installed as commands in `.iflow/commands/xiaoma/`.
+
+### How to Use
+
+1. **Access Commands**: Use iFlow command interface
+2. **Navigate**: Browse to `{xiaoma_folder}/agents/` or `{xiaoma_folder}/tasks/`
+3. **Select**: Choose the agent or task command
+4. **Execute**: Run to activate
+
+### Command Structure
+
+```
+.iflow/commands/xiaoma/
+├── agents/     # Agent commands
+└── tasks/      # Task commands
+```
+
+### Examples
+
+```
+/{xiaoma_folder}/agents/core-dev - Activate dev agent
+/{xiaoma_folder}/tasks/core-setup - Execute setup task
+```
+
+### Notes
+
+- Commands organized by type (agents/tasks)
+- Agent activates for session
+- Similar to Crush command structure

package/docs/ide-info/kilo.md

@@ -0,0 +1,24 @@
+# XIAOMA Method - KiloCode Instructions
+
+## Activating Agents
+
+XIAOMA agents are installed as custom modes in `.kilocodemodes`.
+
+### How to Use
+
+1. **Open Project**: Modes auto-load when project opens
+2. **Select Mode**: Use mode selector in KiloCode interface
+3. **Choose Agent**: Pick `xiaoma-{module}-{agent}` mode
+4. **Activate**: Mode is now active
+
+### Mode Format
+
+- Mode name: `xiaoma-{module}-{agent}`
+- Display: `{icon} {title}`
+- Example: `xiaoma-core-dev` shows as `🤖 Dev`
+
+### Notes
+
+- Modes persist until changed
+- Similar to Roo Code mode system
+- Icon shows in mode selector

package/docs/ide-info/opencode.md

@@ -0,0 +1,24 @@
+# XIAOMA Method - OpenCode Instructions
+
+## Activating Agents
+
+XIAOMA agents are installed as OpenCode agents in `.opencode/agent/XIAOMA/{module_name}` and workflow commands in `.opencode/command/XIAOMA/{module_name}`.
+
+### How to Use
+
+1. **Switch Agents**: Press **Tab** to cycle through primary agents or select using the `/agents`
+2. **Activate Agent**: Once the Agent is selected say `hello` or any prompt to activate that agent persona
+3. **Execute Commands**: Type `/xiaoma` to see and execute xiaoma workflow commands (commands allow for fuzzy matching)
+
+### Examples
+
+```
+/agents - to see a list of agents and switch between them
+/{xiaoma_folder}/xmc/workflows/workflow-init - Activate the workflow-init command
+```
+
+### Notes
+
+- Press **Tab** to switch between primary agents (Analyst, Architect, Dev, etc.)
+- Commands are autocompleted when you type `/` and allow for fuzzy matching
+- Workflow commands execute in current agent context, make sure you have the right agent activated before running a command

package/docs/ide-info/qwen.md

@@ -0,0 +1,25 @@
+# XIAOMA Method - Qwen Code Instructions
+
+## Activating Agents
+
+XIAOMA agents are concatenated in `.qwen/xiaoma-cli/QWEN.md`.
+
+### How to Use
+
+1. **Type Trigger**: Use `*{agent-name}` in your prompt
+2. **Activate**: Agent persona activates from the concatenated file
+3. **Continue**: Agent remains active for conversation
+
+### Examples
+
+```
+*dev - Activate development agent
+*architect - Activate architect agent
+*test - Activate test agent
+```
+
+### Notes
+
+- All agents loaded from single QWEN.md file
+- Triggers with asterisk: `*{agent-name}`
+- Similar to Gemini CLI setup

package/docs/ide-info/roo.md

@@ -0,0 +1,27 @@
+# XIAOMA Method - Roo Code Instructions
+
+## Activating Agents
+
+XIAOMA agents are installed as custom modes in `.roomodes`.
+
+### How to Use
+
+1. **Open Project**: Modes auto-load when project opens
+2. **Select Mode**: Use mode selector in Roo interface
+3. **Choose Agent**: Pick `xiaoma-{module}-{agent}` mode
+4. **Activate**: Mode is now active with configured permissions
+
+### Permission Levels
+
+Modes are configured with file edit permissions:
+
+- Development files only
+- Configuration files only
+- Documentation files only
+- All files (if configured)
+
+### Notes
+
+- Modes persist until changed
+- Each mode has specific file access rights
+- Icon shows in mode selector for easy identification

package/docs/ide-info/rovo-dev.md

@@ -0,0 +1,388 @@
+# Rovo Dev IDE Integration
+
+This document describes how XIAOMA-CLI integrates with [Atlassian Rovo Dev](https://www.atlassian.com/rovo-dev), an AI-powered software development assistant.
+
+## Overview
+
+Rovo Dev is designed to integrate deeply with developer workflows and organizational knowledge bases. When you install XIAOMA-CLI in a Rovo Dev project, it automatically installs XIAOMA agents, workflows, tasks, and tools just like it does for other IDEs (Cursor, VS Code, etc.).
+
+XIAOMA-CLI provides:
+
+- **Agents**: Specialized subagents for various development tasks
+- **Workflows**: Multi-step workflow guides and coordinators
+- **Tasks & Tools**: Reference documentation for XIAOMA tasks and tools
+
+### What are Rovo Dev Subagents?
+
+Subagents are specialized agents that Rovo Dev can delegate tasks to. They are defined as Markdown files with YAML frontmatter stored in the `.rovodev/subagents/` directory. Rovo Dev automatically discovers these files and makes them available through the `@subagent-name` syntax.
+
+## Installation and Setup
+
+### Automatic Installation
+
+When you run the XIAOMA-CLI installer and select Rovo Dev as your IDE:
+
+```bash
+xiaoma install
+```
+
+The installer will:
+
+1. Create a `.rovodev/subagents/` directory in your project (if it doesn't exist)
+2. Convert XIAOMA agents into Rovo Dev subagent format
+3. Write subagent files with the naming pattern: `xiaoma-<module>-<agent-name>.md`
+
+### File Structure
+
+After installation, your project will have:
+
+```
+project-root/
+├── .rovodev/
+│   ├── subagents/
+│   │   ├── xiaoma-core-code-reviewer.md
+│   │   ├── xiaoma-xmc-pm.md
+│   │   ├── xiaoma-xmc-dev.md
+│   │   └── ... (more agents from selected modules)
+│   ├── workflows/
+│   │   ├── xiaoma-brainstorming.md
+│   │   ├── xiaoma-prd-creation.md
+│   │   └── ... (workflow guides)
+│   ├── references/
+│   │   ├── xiaoma-task-core-code-review.md
+│   │   ├── xiaoma-tool-core-analysis.md
+│   │   └── ... (task/tool references)
+│   ├── config.yml          (Rovo Dev configuration)
+│   ├── prompts.yml         (Optional: reusable prompts)
+│   └── ...
+├── .xiaoma/                  (XIAOMA installation directory)
+└── ...
+```
+
+**Directory Structure Explanation:**
+
+- **subagents/**: Agents discovered and used by Rovo Dev with `@agent-name` syntax
+- **workflows/**: Multi-step workflow guides and instructions
+- **references/**: Documentation for available tasks and tools in XIAOMA
+
+## Subagent File Format
+
+XIAOMA agents are converted to Rovo Dev subagent format, which uses Markdown with YAML frontmatter:
+
+### Basic Structure
+
+```markdown
+---
+name: xiaoma-module-agent-name
+description: One sentence description of what this agent does
+tools:
+  - bash
+  - open_files
+  - grep
+  - expand_code_chunks
+model: anthropic.claude-3-5-sonnet-20241022-v2:0 # Optional
+load_memory: true # Optional
+---
+
+You are a specialized agent for [specific task].
+
+## Your Role
+
+Describe the agent's role and responsibilities...
+
+## Key Instructions
+
+1. First instruction
+2. Second instruction
+3. Third instruction
+
+## When to Use This Agent
+
+Explain when and how to use this agent...
+```
+
+### YAML Frontmatter Fields
+
+| Field         | Type    | Required | Description                                                                                                                           |
+| ------------- | ------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------- |
+| `name`        | string  | Yes      | Unique identifier for the subagent (kebab-case, no spaces)                                                                            |
+| `description` | string  | Yes      | One-line description of the subagent's purpose                                                                                        |
+| `tools`       | array   | No       | List of tools the subagent can use. If not specified, uses parent agent's tools                                                       |
+| `model`       | string  | No       | Specific LLM model for this subagent (e.g., `anthropic.claude-3-5-sonnet-20241022-v2:0`). If not specified, uses parent agent's model |
+| `load_memory` | boolean | No       | Whether to load default memory files (AGENTS.md, AGENTS.local.md). Defaults to `true`                                                 |
+
+### System Prompt
+
+The content after the closing `---` is the subagent's system prompt. This defines:
+
+- The agent's persona and role
+- Its capabilities and constraints
+- Step-by-step instructions for task execution
+- Examples of expected behavior
+
+## Using XIAOMA Components in Rovo Dev
+
+### Invoking a Subagent (Agent)
+
+In Rovo Dev, you can invoke a XIAOMA agent as a subagent using the `@` syntax:
+
+```
+@xiaoma-core-code-reviewer Please review this PR for potential issues
+@xiaoma-xmc-pm Help plan this feature release
+@xiaoma-xmc-dev Implement this feature
+```
+
+### Accessing Workflows
+
+Workflow guides are available in `.rovodev/workflows/` directory:
+
+```
+@xiaoma-core-code-reviewer Use the brainstorming workflow from .rovodev/workflows/xiaoma-brainstorming.md
+```
+
+Workflow files contain step-by-step instructions and can be referenced or copied into Rovo Dev for collaborative workflow execution.
+
+### Accessing Tasks and Tools
+
+Task and tool documentation is available in `.rovodev/references/` directory. These provide:
+
+- Task execution instructions
+- Tool capabilities and usage
+- Integration examples
+- Parameter documentation
+
+### Example Usage Scenarios
+
+#### Code Review
+
+```
+@xiaoma-core-code-reviewer Review the changes in src/components/Button.tsx
+for best practices, performance, and potential bugs
+```
+
+#### Documentation
+
+```
+@xiaoma-core-documentation-writer Generate API documentation for the new
+user authentication module
+```
+
+#### Feature Design
+
+```
+@xiaoma-module-feature-designer Design a solution for implementing
+dark mode support across the application
+```
+
+## Customizing XIAOMA Subagents
+
+You can customize XIAOMA subagents after installation by editing their files directly in `.rovodev/subagents/`.
+
+### Example: Adding Tool Restrictions
+
+By default, XIAOMA subagents inherit tools from the parent Rovo Dev agent. You can restrict which tools a specific subagent can use:
+
+```yaml
+---
+name: xiaoma-core-code-reviewer
+description: Reviews code and suggests improvements
+tools:
+  - open_files
+  - expand_code_chunks
+  - grep
+---
+```
+
+### Example: Using a Specific Model
+
+Some agents might benefit from using a different model. You can specify this:
+
+```yaml
+---
+name: xiaoma-core-documentation-writer
+description: Writes clear and comprehensive documentation
+model: anthropic.claude-3-5-sonnet-20241022-v2:0
+---
+```
+
+### Example: Enhancing the System Prompt
+
+You can add additional context to a subagent's system prompt:
+
+```markdown
+---
+name: xiaoma-core-code-reviewer
+description: Reviews code and suggests improvements
+---
+
+You are a specialized code review agent for our project.
+
+## Project Context
+
+Our codebase uses:
+
+- React 18 for frontend
+- Node.js 18+ for backend
+- TypeScript for type safety
+- Jest for testing
+
+## Review Checklist
+
+1. Type safety and TypeScript correctness
+2. React best practices and hooks usage
+3. Performance considerations
+4. Test coverage
+5. Documentation and comments
+
+...rest of original system prompt...
+```
+
+## Memory and Context
+
+By default, XIAOMA subagents have `load_memory: true`, which means they will load memory files from your project:
+
+- **Project-level**: `.rovodev/AGENTS.md` and `.rovodev/.agent.md`
+- **User-level**: `~/.rovodev/AGENTS.md` (global memory across all projects)
+
+These files can contain:
+
+- Project guidelines and conventions
+- Common patterns and best practices
+- Recent decisions and context
+- Custom instructions for all agents
+
+### Creating Project Memory
+
+Create `.rovodev/AGENTS.md` in your project:
+
+```markdown
+# Project Guidelines
+
+## Code Style
+
+- Use 2-space indentation
+- Use camelCase for variables
+- Use PascalCase for classes
+
+## Architecture
+
+- Follow modular component structure
+- Use dependency injection for services
+- Implement proper error handling
+
+## Testing Requirements
+
+- Minimum 80% code coverage
+- Write tests before implementation
+- Use descriptive test names
+```
+
+## Troubleshooting
+
+### Subagents Not Appearing in Rovo Dev
+
+1. **Verify files exist**: Check that `.rovodev/subagents/xiaoma-*.md` files are present
+2. **Check Rovo Dev is reloaded**: Rovo Dev may cache agent definitions. Restart Rovo Dev or reload the project
+3. **Verify file format**: Ensure files have proper YAML frontmatter (between `---` markers)
+4. **Check file permissions**: Ensure files are readable by Rovo Dev
+
+### Agent Name Conflicts
+
+If you have custom subagents with the same names as XIAOMA agents, Rovo Dev will load both but may show a warning. Use unique prefixes for custom subagents to avoid conflicts.
+
+### Tools Not Available
+
+If a subagent's tools aren't working:
+
+1. Verify the tool names match Rovo Dev's available tools
+2. Check that the parent Rovo Dev agent has access to those tools
+3. Ensure tool permissions are properly configured in `.rovodev/config.yml`
+
+## Advanced: Tool Configuration
+
+Rovo Dev agents have access to a set of tools for various tasks. Common tools available include:
+
+- `bash`: Execute shell commands
+- `open_files`: View file contents
+- `grep`: Search across files
+- `expand_code_chunks`: View specific code sections
+- `find_and_replace_code`: Modify files
+- `create_file`: Create new files
+- `delete_file`: Delete files
+- `move_file`: Rename or move files
+
+### MCP Servers
+
+Rovo Dev can also connect to Model Context Protocol (MCP) servers, which provide additional tools and data sources:
+
+- **Atlassian Integration**: Access to Jira, Confluence, and Bitbucket
+- **Code Analysis**: Custom code analysis and metrics
+- **External Services**: APIs and third-party integrations
+
+Configure MCP servers in `~/.rovodev/mcp.json` or `.rovodev/mcp.json`.
+
+## Integration with Other IDE Handlers
+
+XIAOMA-CLI supports multiple IDEs simultaneously. You can have both Rovo Dev and other IDE configurations (Cursor, VS Code, etc.) in the same project. Each IDE will have its own artifacts installed in separate directories.
+
+For example:
+
+- Rovo Dev agents: `.rovodev/subagents/xiaoma-*.md`
+- Cursor rules: `.cursor/rules/xiaoma/`
+- Claude Code: `.claude/rules/xiaoma/`
+
+## Performance Considerations
+
+- XIAOMA subagent files are typically small (1-5 KB each)
+- Rovo Dev lazy-loads subagents, so having many subagents doesn't impact startup time
+- System prompts are cached by Rovo Dev after first load
+
+## Best Practices
+
+1. **Keep System Prompts Concise**: Shorter, well-structured prompts are more effective
+2. **Use Project Memory**: Leverage `.rovodev/AGENTS.md` for shared context
+3. **Customize Tool Restrictions**: Give subagents only the tools they need
+4. **Test Subagent Invocations**: Verify each subagent works as expected for your project
+5. **Version Control**: Commit `.rovodev/subagents/` to version control for team consistency
+6. **Document Custom Subagents**: Add comments explaining the purpose of customized subagents
+
+## Related Documentation
+
+- [Rovo Dev Official Documentation](https://www.atlassian.com/rovo-dev)
+- [XIAOMA-CLI Installation Guide](./installation.md)
+- [IDE Handler Architecture](./ide-handlers.md)
+- [Rovo Dev Configuration Reference](https://www.atlassian.com/rovo-dev/configuration)
+
+## Examples
+
+### Example 1: Code Review Workflow
+
+```
+User: @xiaoma-core-code-reviewer Review src/auth/login.ts for security issues
+Rovo Dev → Subagent: Opens file, analyzes code, suggests improvements
+Subagent output: Security vulnerabilities found, recommendations provided
+```
+
+### Example 2: Documentation Generation
+
+```
+User: @xiaoma-core-documentation-writer Generate API docs for the new payment module
+Rovo Dev → Subagent: Analyzes code structure, generates documentation
+Subagent output: Markdown documentation with examples and API reference
+```
+
+### Example 3: Architecture Design
+
+```
+User: @xiaoma-module-feature-designer Design a caching strategy for the database layer
+Rovo Dev → Subagent: Reviews current architecture, proposes design
+Subagent output: Detailed architecture proposal with implementation plan
+```
+
+## Support
+
+For issues or questions about:
+
+- **Rovo Dev**: See [Atlassian Rovo Dev Documentation](https://www.atlassian.com/rovo-dev)
+- **XIAOMA-CLI**: See [XIAOMA-CLI README](../README.md)
+- **IDE Integration**: See [IDE Handler Guide](./ide-handlers.md)

package/docs/ide-info/trae.md

@@ -0,0 +1,25 @@
+# XIAOMA Method - Trae Instructions
+
+## Activating Agents
+
+XIAOMA agents are installed as rules in `.trae/rules/`.
+
+### How to Use
+
+1. **Type Trigger**: Use `@{agent-name}` in your prompt
+2. **Activate**: Agent persona activates automatically
+3. **Continue**: Agent remains active for conversation
+
+### Examples
+
+```
+@dev - Activate development agent
+@architect - Activate architect agent
+@task-setup - Execute setup task
+```
+
+### Notes
+
+- Rules auto-load from `.trae/rules/` directory
+- Multiple agents can be referenced: `@dev and @test`
+- Agent follows YAML configuration in rule file