@zeyue0329/xiaoma-cli 1.6.4 → 1.7.0

package/docs/how-to/quick-fixes.md

@@ -1,123 +0,0 @@
----
-title: "Quick Fixes"
-description: How to make quick fixes and ad-hoc changes
-sidebar:
-  order: 5
----
-
-Use the **DEV agent** directly for bug fixes, refactorings, or small targeted changes that don't require the full XiaoMa Method or Quick Flow.
-
-## When to Use This
-
-- Bug fixes with a clear, known cause
-- Small refactorings (rename, extract, restructure) contained within a few files
-- Minor feature tweaks or configuration changes
-- Exploratory work to understand an unfamiliar codebase
-
-:::note[Prerequisites]
-- XiaoMa Method installed (`npx xiaoma-cli install`)
-- An AI-powered IDE (Claude Code, Cursor, or similar)
-:::
-
-## Choose Your Approach
-
-| Situation | Agent | Why |
-| --- | --- | --- |
-| Fix a specific bug or make a small, scoped change | **DEV agent** | Jumps straight into implementation without planning overhead |
-| Change touches several files or you want a written plan first | **Quick Flow Solo Dev** | Creates a quick-spec before implementation so the agent stays aligned to your standards |
-
-If you are unsure, start with the DEV agent. You can always escalate to Quick Flow if the change grows.
-
-## Steps
-
-### 1. Invoke the DEV Agent
-
-Start a **fresh chat** in your AI IDE and invoke the DEV agent skill:
-
-```text
-xiaoma-dev
-```
-
-This loads the agent's persona and capabilities into the session. If you decide you need Quick Flow instead, invoke the **Quick Flow Solo Dev** agent skill in a fresh chat:
-
-```text
-xiaoma-quick-flow-solo-dev
-```
-
-Once the Solo Dev agent is loaded, describe your change and ask it to create a **quick-spec**. The agent drafts a lightweight spec capturing what you want to change and how. After you approve the quick-spec, tell the agent to start the **Quick Flow dev cycle** -- it will implement the change, run tests, and perform a self-review, all guided by the spec you just approved.
-
-:::tip[Fresh Chats]
-Always start a new chat session when loading an agent. Reusing a session from a previous workflow can cause context conflicts.
-:::
-
-### 2. Describe the Change
-
-Tell the agent what you need in plain language. Be specific about the problem and, if you know it, where the relevant code lives.
-
-:::note[Example Prompts]
-**Bug fix** -- "Fix the login validation bug that allows empty passwords. The validation logic is in `src/auth/validate.ts`."
-
-**Refactoring** -- "Refactor the UserService to use async/await instead of callbacks."
-
-**Configuration change** -- "Update the CI pipeline to cache node_modules between runs."
-
-**Dependency update** -- "Upgrade the express dependency to the latest v5 release and fix any breaking changes."
-:::
-
-You don't need to provide every detail. The agent will read the relevant source files and ask clarifying questions when needed.
-
-### 3. Let the Agent Work
-
-The agent will:
-
-- Read and analyze the relevant source files
-- Propose a solution and explain its reasoning
-- Implement the change across the affected files
-- Run your project's test suite if one exists
-
-If your project has tests, the agent runs them automatically after making changes and iterates until tests pass. For projects without a test suite, verify the change manually (run the app, hit the endpoint, check the output).
-
-### 4. Review and Verify
-
-Before committing, review what changed:
-
-- Read through the diff to confirm the change matches your intent
-- Run the application or tests yourself to double-check
-- If something looks wrong, tell the agent what to fix -- it can iterate in the same session
-
-Once satisfied, commit the changes with a clear message describing the fix.
-
-:::caution[If Something Breaks]
-If a committed change causes unexpected issues, use `git revert HEAD` to undo the last commit cleanly. Then start a fresh chat with the DEV agent to try a different approach.
-:::
-
-## Learning Your Codebase
-
-The DEV agent is also useful for exploring unfamiliar code. Load it in a fresh chat and ask questions:
-
-:::note[Example Prompts]
-"Explain how the authentication system works in this codebase."
-
-"Show me where error handling happens in the API layer."
-
-"What does the `ProcessOrder` function do and what calls it?"
-:::
-
-Use the agent to learn about your project, understand how components connect, and explore unfamiliar areas before making changes.
-
-## What You Get
-
-- Modified source files with the fix or refactoring applied
-- Passing tests (if your project has a test suite)
-- A clean commit describing the change
-
-No planning artifacts are produced -- that's the point of this approach.
-
-## When to Upgrade to Formal Planning
-
-Consider using [Quick Flow](../explanation/quick-flow.md) or the full XiaoMa Method when:
-
-- The change affects multiple systems or requires coordinated updates across many files
-- You are unsure about the scope and need a spec to think it through
-- The fix keeps growing in complexity as you work on it
-- You need documentation or architectural decisions recorded for the team

package/docs/how-to/shard-large-documents.md

@@ -1,78 +0,0 @@
----
-title: "Document Sharding Guide"
-description: Split large markdown files into smaller organized files for better context management
-sidebar:
-  order: 8
----
-
-Use the `xiaoma-shard-doc` tool if you need to split large markdown files into smaller, organized files for better context management.
-
-:::caution[Deprecated]
-This is no longer recommended, and soon with updated workflows and most major LLMs and tools supporting subprocesses this will be unnecessary.
-:::
-
-## When to Use This
-
-Only use this if you notice your chosen tool / model combination is failing to load and read all the documents as input when needed.
-
-## What is Document Sharding?
-
-Document sharding splits large markdown files into smaller, organized files based on level 2 headings (`## Heading`).
-
-### Architecture
-
-```text
-Before Sharding:
-_xiaoma-output/planning-artifacts/
-└── PRD.md (large 50k token file)
-
-After Sharding:
-_xiaoma-output/planning-artifacts/
-└── prd/
-    ├── index.md                    # Table of contents with descriptions
-    ├── overview.md                 # Section 1
-    ├── user-requirements.md        # Section 2
-    ├── technical-requirements.md   # Section 3
-    └── ...                         # Additional sections
-```
-
-## Steps
-
-### 1. Run the Shard-Doc Tool
-
-```bash
-/xiaoma-shard-doc
-```
-
-### 2. Follow the Interactive Process
-
-```text
-Agent: Which document would you like to shard?
-User: docs/PRD.md
-
-Agent: Default destination: docs/prd/
-       Accept default? [y/n]
-User: y
-
-Agent: Sharding PRD.md...
-       ✓ Created 12 section files
-       ✓ Generated index.md
-       ✓ Complete!
-```
-
-## How Workflow Discovery Works
-
-XiaoMa workflows use a **dual discovery system**:
-
-1. **Try whole document first** - Look for `document-name.md`
-2. **Check for sharded version** - Look for `document-name/index.md`
-3. **Priority rule** - Whole document takes precedence if both exist - remove the whole document if you want the sharded to be used instead
-
-## Workflow Support
-
-All BMM workflows support both formats:
-
-- Whole documents
-- Sharded documents
-- Automatic detection
-- Transparent to user

package/docs/how-to/upgrade-to-v6.md

@@ -1,100 +0,0 @@
----
-title: "How to Upgrade to v6"
-description: Migrate from XiaoMa v4 to v6
-sidebar:
-  order: 3
----
-
-Use the XiaoMa installer to upgrade from v4 to v6, which includes automatic detection of legacy installations and migration assistance.
-
-## When to Use This
-
-- You have XiaoMa v4 installed (`.xiaoma-cli` folder)
-- You want to migrate to the new v6 architecture
-- You have existing planning artifacts to preserve
-
-:::note[Prerequisites]
-- Node.js 20+
-- Existing XiaoMa v4 installation
-:::
-
-## Steps
-
-### 1. Run the Installer
-
-Follow the [Installer Instructions](./install-xiaoma.md).
-
-### 2. Handle Legacy Installation
-
-When v4 is detected, you can:
-
-- Allow the installer to back up and remove `.xiaoma-cli`
-- Exit and handle cleanup manually
-
-If you named your xiaoma method folder something else - you will need to manually remove the folder yourself.
-
-### 3. Clean Up IDE Skills
-
-Manually remove legacy v4 IDE commands/skills - for example if you have Claude Code, look for any nested folders that start with xiaoma and remove them:
-
-- `.claude/commands/`
-
-The new v6 skills are installed to:
-
-- `.claude/skills/`
-
-### 4. Migrate Planning Artifacts
-
-**If you have planning documents (Brief/PRD/UX/Architecture):**
-
-Move them to `_xiaoma-output/planning-artifacts/` with descriptive names:
-
-- Include `PRD` in filename for PRD documents
-- Include `brief`, `architecture`, or `ux-design` accordingly
-- Sharded documents can be in named subfolders
-
-**If you're mid-planning:** Consider restarting with v6 workflows. Use your existing documents as inputs—the new progressive discovery workflows with web search and IDE plan mode produce better results.
-
-### 5. Migrate In-Progress Development
-
-If you have stories created or implemented:
-
-1. Complete the v6 installation
-2. Place `epics.md` or `epics/epic*.md` in `_xiaoma-output/planning-artifacts/`
-3. Run the Scrum Master's `xiaoma-sprint-planning` workflow
-4. Tell the SM which epics/stories are already complete
-
-## What You Get
-
-**v6 unified structure:**
-
-```text
-your-project/
-├── _xiaoma/               # Single installation folder
-│   ├── _config/         # Your customizations
-│   │   └── agents/      # Agent customization files
-│   ├── core/            # Universal core framework
-│   ├── xmc/             # XiaoMa Method module
-│   ├── bmb/             # XiaoMa Builder
-│   └── cis/             # Creative Intelligence Suite
-└── _xiaoma-output/        # Output folder (was doc folder in v4)
-```
-
-## Module Migration
-
-| v4 Module                     | v6 Status                                 |
-| ----------------------------- | ----------------------------------------- |
-| `.xiaoma-2d-phaser-game-dev`    | Integrated into BMGD Module               |
-| `.xiaoma-2d-unity-game-dev`     | Integrated into BMGD Module               |
-| `.xiaoma-godot-game-dev`        | Integrated into BMGD Module               |
-| `.xiaoma-infrastructure-devops` | Deprecated — new DevOps agent coming soon |
-| `.xiaoma-creative-writing`      | Not adapted — new v6 module coming soon   |
-
-## Key Changes
-
-| Concept       | v4                                    | v6                                   |
-| ------------- | ------------------------------------- | ------------------------------------ |
-| **Core**      | `_xiaoma-core` was actually XiaoMa Method | `_xiaoma/core/` is universal framework |
-| **Method**    | `_xiaoma-cli`                        | `_xiaoma/xmc/`                         |
-| **Config**    | Modified files directly               | `config.yaml` per module             |
-| **Documents** | Sharded or unsharded required setup   | Fully flexible, auto-scanned         |

package/docs/ide-info/auggie.md

@@ -1,31 +0,0 @@
-# XIAOMA Method - Auggie CLI Instructions
-
-## Activating Agents
-
-XIAOMA agents can be installed in multiple locations based on your setup.
-
-### Common Locations
-
-- User Home: `~/.augment/commands/`
-- Project: `.augment/commands/`
-- Custom paths you selected
-
-### How to Use
-
-1. **Type Trigger**: Use `@{agent-name}` in your prompt
-2. **Activate**: Agent persona activates
-3. **Tasks**: Use `@task-{task-name}` for tasks
-
-### Examples
-
-```
-@dev - Activate development agent
-@architect - Activate architect agent
-@task-setup - Execute setup task
-```
-
-### Notes
-
-- Agents can be in multiple locations
-- Check your installation paths
-- Activation syntax same across all locations

package/docs/ide-info/claude-code.md

@@ -1,25 +0,0 @@
-# XIAOMA Method - Claude Code Instructions
-
-## Activating Agents
-
-XIAOMA agents are installed as slash commands in `.claude/commands/xiaoma/`.
-
-### How to Use
-
-1. **Type Slash Command**: Start with `/` to see available commands
-2. **Select Agent**: Type `/xiaoma-{agent-name}` (e.g., `/xiaoma-dev`)
-3. **Execute**: Press Enter to activate that agent persona
-
-### 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
-
-- Commands are autocompleted when you type `/`
-- Agent remains active for the conversation
-- Start a new conversation to switch agents

package/docs/ide-info/cline.md

@@ -1,31 +0,0 @@
-# XIAOMA Method - Cline Instructions
-
-## Activating Agents
-
-XIAOMA agents are installed as **toggleable rules** in `.clinerules/` directory.
-
-### Important: Rules are OFF by default
-
-- Rules are NOT automatically loaded to avoid context pollution
-- You must manually enable the agent you want to use
-
-### How to Use
-
-1. **Open Rules Panel**: Click the rules icon below the chat input
-2. **Enable an Agent**: Toggle ON the specific agent rule you need (e.g., `01-core-dev`)
-3. **Activate in Chat**: Type `@{agent-name}` to activate that persona
-4. **Disable When Done**: Toggle OFF to free up context
-
-### Best Practices
-
-- Only enable 1-2 agents at a time to preserve context
-- Disable agents when switching tasks
-- Rules are numbered (01-, 02-) for organization, not priority
-
-### Example
-
-```
-Toggle ON: 01-core-dev.md
-In chat: "@dev help me refactor this code"
-When done: Toggle OFF the rule
-```

package/docs/ide-info/codex.md

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

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

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

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

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

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

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

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

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

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