@zeyue0329/xiaoma-cli 1.6.4 → 1.7.0

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

@@ -1,388 +0,0 @@
-# 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

@@ -1,25 +0,0 @@
-# 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

package/docs/ide-info/windsurf.md

@@ -1,22 +0,0 @@
-# XIAOMA Method - Windsurf Instructions
-
-## Activating Agents
-
-XIAOMA agents are installed as workflows in `.windsurf/workflows/`.
-
-### How to Use
-
-1. **Open Workflows**: Access via Windsurf menu or command palette
-2. **Select Workflow**: Choose the agent/task workflow
-3. **Execute**: Run to activate that agent persona
-
-### Workflow Types
-
-- **Agent workflows**: `{module}-{agent}.md` (auto_execution_mode: 3)
-- **Task workflows**: `task-{module}-{task}.md` (auto_execution_mode: 2)
-
-### Notes
-
-- Agents run with higher autonomy (mode 3)
-- Tasks run with guided execution (mode 2)
-- Workflows persist for the session

package/docs/index.md

@@ -1,60 +0,0 @@
----
-title: Welcome to the XiaoMa Method
-description: AI-driven development framework with specialized agents, guided workflows, and intelligent planning
----
-
-The XiaoMa Method (**B**uild **M**ore **A**rchitect **D**reams) is an AI-driven development framework module within the XiaoMa Method Ecosystem that helps you build software through the whole process from ideation and planning all the way through agentic implementation. It provides specialized AI agents, guided workflows, and intelligent planning that adapts to your project's complexity, whether you're fixing a bug or building an enterprise platform.
-
-If you're comfortable working with AI coding assistants like Claude, Cursor, or GitHub Copilot, you're ready to get started.
-
-:::note[🚀 V6 is Here and We're Just Getting Started!]
-Skills Architecture, XiaoMa Builder v1, Dev Loop Automation, and so much more in the works. **[Check out the Roadmap →](/roadmap/)**
-:::
-
-## New Here? Start with a Tutorial
-
-The fastest way to understand XiaoMa is to try it.
-
-- **[Get Started with XiaoMa](./tutorials/getting-started.md)** — Install and understand how XiaoMa works
-- **[Workflow Map](./reference/workflow-map.md)** — Visual overview of BMM phases, workflows, and context management
-
-:::tip[Just Want to Dive In?]
-Install XiaoMa and use the `xiaoma-help` skill — it will guide you through everything based on your project and installed modules.
-:::
-
-## How to Use These Docs
-
-These docs are organized into four sections based on what you're trying to do:
-
-| Section           | Purpose                                                                                                    |
-| ----------------- | ---------------------------------------------------------------------------------------------------------- |
-| **Tutorials**     | Learning-oriented. Step-by-step guides that walk you through building something. Start here if you're new. |
-| **How-To Guides** | Task-oriented. Practical guides for solving specific problems. "How do I customize an agent?" lives here.  |
-| **Explanation**   | Understanding-oriented. Deep dives into concepts and architecture. Read when you want to know *why*.       |
-| **Reference**     | Information-oriented. Technical specifications for agents, workflows, and configuration.                   |
-
-## Extend and Customize
-
-Want to expand XiaoMa with your own agents, workflows, or modules? The **[XiaoMa Builder](https://xiaoma-builder-docs.xiaoma-cli.org/)** provides the framework and tools for creating custom extensions, whether you're adding new capabilities to XiaoMa or building entirely new modules from scratch.
-
-## What You'll Need
-
-XiaoMa works with any AI coding assistant that supports custom system prompts or project context. Popular options include:
-
-- **[Claude Code](https://code.claude.com)** — Anthropic's CLI tool (recommended)
-- **[Cursor](https://cursor.sh)** — AI-first code editor
-- **[Codex CLI](https://github.com/openai/codex)** — OpenAI's terminal coding agent
-
-You should be comfortable with basic software development concepts like version control, project structure, and agile workflows. No prior experience with XiaoMa-style agent systems is required—that's what these docs are for.
-
-## Join the Community
-
-Get help, share what you're building, or contribute to XiaoMa:
-
-- **[Discord](https://discord.gg/gk8jAdXWmj)** — Chat with other XiaoMa users, ask questions, share ideas
-- **[GitHub](https://github.com/xiaoma-code-org/XiaoMa-Cli)** — Source code, issues, and contributions
-- **[YouTube](https://www.youtube.com/@XiaoMaCode)** — Video tutorials and walkthroughs
-
-## Next Step
-
-Ready to dive in? **[Get Started with XiaoMa](./tutorials/getting-started.md)** and build your first project.

package/docs/installers-bundlers/ide-injections.md

@@ -1,186 +0,0 @@
-# IDE Content Injection Standard
-
-## Overview
-
-This document defines the standard for IDE-specific content injection in XIAOMA modules. Each IDE can inject its own specific content into XIAOMA templates during installation without polluting the source files with IDE-specific code. The installation process is interactive, allowing users to choose what IDE-specific features they want to install.
-
-## Architecture
-
-### 1. Injection Points
-
-Files that support IDE-specific content define injection points using HTML comments:
-
-```xml
-<!-- IDE-INJECT-POINT: unique-point-name -->
-```
-
-### 2. Module Structure
-
-Each module that needs IDE-specific content creates a sub-module folder:
-
-```
-src/modules/{module-name}/sub-modules/{ide-name}/
-  ├── injections.yaml    # Injection configuration
-  ├── sub-agents/        # IDE-specific subagents (if applicable)
-  └── config.yaml        # Other IDE-specific config
-```
-
-### 3. Injection Configuration Format
-
-The `injections.yaml` file defines what content to inject where:
-
-```yaml
-# injections.yaml structure
-injections:
-  - file: 'relative/path/to/file.md' # Path relative to installation root
-    point: 'injection-point-name' # Must match IDE-INJECT-POINT name
-    requires: 'subagent-name' # Which subagent must be selected (or "any")
-    content: | # Content to inject (preserves formatting)
-      <llm>
-        <i>Instructions specific to this IDE</i>
-      </llm>
-
-# Subagents available for installation
-subagents:
-  source: 'sub-agents' # Source folder relative to this config
-  target: '.claude/agents' # Claude's expected location (don't change)
-  files:
-    - 'agent1.md'
-    - 'agent2.md'
-```
-
-### 4. Interactive Installation Process
-
-For Claude Code specifically, the installer will:
-
-1. **Detect available subagents** from the module's `injections.yaml`
-2. **Ask the user** about subagent installation:
-   - Install all subagents (default)
-   - Select specific subagents
-   - Skip subagent installation
-3. **Ask installation location** (if subagents selected):
-   - Project level: `.claude/agents/`
-   - User level: `~/.claude/agents/`
-4. **Copy selected subagents** to the chosen location
-5. **Inject only relevant content** based on selected subagents
-
-Other IDEs can implement their own installation logic appropriate to their architecture.
-
-## Implementation
-
-### IDE Installer Responsibilities
-
-Each IDE installer (e.g., `claude-code.js`) must:
-
-1. **Check for sub-modules**: Look for `sub-modules/{ide-name}/` in each installed module
-2. **Load injection config**: Parse `injections.yaml` if present
-3. **Process injections**: Replace injection points with configured content
-4. **Copy additional files**: Handle subagents or other IDE-specific files
-
-### Example Implementation (Claude Code)
-
-```javascript
-async processModuleInjections(projectDir, xiaomaDir, options) {
-  for (const moduleName of options.selectedModules) {
-    const configPath = path.join(
-      xiaomaDir, 'src/modules', moduleName,
-      'sub-modules/claude-code/injections.yaml'
-    );
-
-    if (exists(configPath)) {
-      const config = yaml.load(configPath);
-
-      // Interactive: Ask user about subagent installation
-      const choices = await this.promptSubagentInstallation(config.subagents);
-
-      if (choices.install !== 'none') {
-        // Ask where to install
-        const location = await this.promptInstallLocation();
-
-        // Process injections based on selections
-        for (const injection of config.injections) {
-          if (this.shouldInject(injection, choices)) {
-            await this.injectContent(projectDir, injection, choices);
-          }
-        }
-
-        // Copy selected subagents
-        await this.copySelectedSubagents(projectDir, config.subagents, choices, location);
-      }
-    }
-  }
-}
-```
-
-## Benefits
-
-1. **Clean Source Files**: No IDE-specific conditionals in source
-2. **Modular**: Each IDE manages its own injections
-3. **Scalable**: Easy to add support for new IDEs
-4. **Maintainable**: IDE-specific content lives with IDE config
-5. **Flexible**: Different modules can inject different content
-
-## Adding Support for a New IDE
-
-1. Create sub-module folder: `src/modules/{module}/sub-modules/{new-ide}/`
-2. Add `injections.yaml` with IDE-specific content
-3. Update IDE installer to process injections using this standard
-4. Test installation with and without the IDE selected
-
-## Example: XMC Module with Claude Code
-
-### File Structure
-
-```
-src/modules/xmc/
-├── agents/pm.md                         # Has injection point
-├── templates/prd.md                     # Has multiple injection points
-└── sub-modules/
-    └── claude-code/
-        ├── injections.yaml              # Defines what to inject
-        └── sub-agents/                  # Claude Code specific subagents
-            ├── market-researcher.md
-            ├── requirements-analyst.md
-            └── ...
-```
-
-### Injection Point in pm.md
-
-```xml
-<agent>
-  <persona>...</persona>
-  <!-- IDE-INJECT-POINT: pm-agent-instructions -->
-  <cmds>...</cmds>
-</agent>
-```
-
-### Injection Configuration
-
-```yaml
-injections:
-  - file: '{xiaoma_folder}/xmc/agents/pm.md'
-    point: 'pm-agent-instructions'
-    requires: 'any' # Injected if ANY subagent is selected
-    content: |
-      <llm critical="true">
-        <i>Use 'market-researcher' subagent for analysis</i>
-      </llm>
-
-  - file: '{xiaoma_folder}/xmc/templates/prd.md'
-    point: 'prd-goals-context-delegation'
-    requires: 'market-researcher' # Only if this specific subagent selected
-    content: |
-      <i>DELEGATE: Use 'market-researcher' subagent...</i>
-```
-
-### Result After Installation
-
-```xml
-<agent>
-  <persona>...</persona>
-  <llm critical="true">
-    <i>Use 'market-researcher' subagent for analysis</i>
-  </llm>
-  <cmds>...</cmds>
-</agent>
-```