Enhance README with comprehensive command documentation

- Added complete command reference with syntax and descriptions for all CCW commands - Included detailed usage workflows for different complexity levels - Provided practical examples for complex feature development, bug fixes, and code analysis - Added complexity-based strategy guide (Simple/Medium/Complex) - Simplified installation section to focus on one-liner quick start - Updated both English and Chinese versions with gemini CLI analysis insights - Restructured documentation to prioritize command usage over installation details 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
2026-02-05 01:50:27 +08:00 · 2025-09-07 18:04:34 +08:00
parent 87c89a4de2
commit f277642784
2 changed files with 172 additions and 186 deletions
--- a/README.md
+++ b/README.md
@@ -56,129 +56,122 @@ CCW intelligently adapts its file structure and workflow processes based on task
 └── settings.local.json   # Local configuration
 ```

-## 🛠️ Installation
-
-### Quick Install (Recommended)
-
-**One-liner remote installation:**
+## 🚀 Quick Start

+**One-liner installation:**
 ```powershell
-# PowerShell (Windows/Linux/macOS)
 Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content
 ```

-**With parameters:**
-```powershell
-# Global installation
-Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content | ForEach-Object { iex "$_ -Global" }
-
-# Custom directory installation  
-Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content | ForEach-Object { iex "$_ -Directory 'C:\MyCustomPath'" }
-
-# Force installation (overwrites existing)
-Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content | ForEach-Object { iex "$_ -Force" }
-```
-
-### Manual Installation
-
-1. Clone this repository:
-```bash
-git clone https://github.com/catlog22/Claude-Code-Workflow.git
-cd Claude-Code-Workflow
-```
-
-2. Run the local installer:
-```powershell
-# Windows PowerShell
-.\Install-Claude.ps1
-
-# With parameters
-.\Install-Claude.ps1 -InstallMode Global -Force
-```
-
-3. Or manually set up the environment:
-```bash
-# Copy to your Claude Code configuration directory
-cp -r .claude ~/.claude/
-# Or on Windows
-xcopy .claude %USERPROFILE%\.claude /E /I
-```
-
-4. Verify installation:
+**Verify installation:**
 ```bash
 /workflow:session list
 ```

-### Installation Options
+## 📚 Complete Command Reference

-| Parameter | Description | Example |
-|-----------|-------------|---------|
-| `-Global` | Install system-wide | `-Global` |
-| `-Directory` | Custom installation path | `-Directory "C:\CCW"` |
-| `-Force` | Overwrite existing installation | `-Force` |
-| `-NoBackup` | Skip backup of existing files | `-NoBackup` |
-| `-NonInteractive` | Silent installation | `-NonInteractive` |
-| `-Branch` | Install from specific branch | `-Branch "develop"` |
+### Core Commands

-## 📖 Usage Guide
+| Command | Syntax | Description |
+|---------|--------|-------------|
+| `/enhance-prompt` | `/enhance-prompt <input>` | Enhance and structure user inputs with technical context |
+| `/gemini-chat` | `/gemini-chat <inquiry> [--all-files] [--compress]` | Interactive dialogue with Gemini CLI using smart templates |
+| `/gemini-execute` | `/gemini-execute <task-id\|description> [--yolo] [--debug]` | Intelligent executor with automatic file context inference |
+| `/gemini-mode` | `/gemini-mode <analysis-type> <target> [options]` | Template-driven codebase analysis (pattern, architecture, security) |
+| `/update_dms` | `/update_dms [full\|fast\|deep] [path]` | Distributed Memory System management with hierarchical CLAUDE.md |

-### Starting a Complex Workflow
+### Workflow Management

-1. **Initialize Session**:
+| Command | Syntax | Description |
+|---------|--------|-------------|
+| `/workflow:session` | `start\|pause\|resume\|list\|switch\|status [complexity] ["task"]` | Session lifecycle management with complexity adaptation |
+| `/workflow:brainstorm` | `/brainstorm <topic> [--perspectives=role1,role2]` | Multi-agent conceptual planning from different expert perspectives |
+| `/workflow:action-plan` | `[--from-brainstorming] [--skip-brainstorming] [--replan]` | Convert concepts to executable implementation plans |
+| `/workflow:implement` | `[--type=simple\|medium\|complex] [--auto-create-tasks]` | Enter implementation phase with complexity-based organization |
+| `/workflow:review` | `[--auto-fix]` | Final quality assurance with automated testing and validation |
+| `/workflow:issue` | `create\|list\|update\|integrate\|close [options]` | Dynamic issue and change request management |
+| `/workflow:context` | `[--detailed] [--health-check] [--export]` | Unified workflow state and progress overview |
+| `/workflow:sync` | `[--check] [--fix] [--force]` | Synchronize workflow state across all files |
+
+### Task Execution
+
+| Command | Syntax | Description |
+|---------|--------|-------------|
+| `/task:create` | `"<title>" [--type=type] [--priority=level]` | Create hierarchical implementation tasks with auto-generated IDs |
+| `/task:breakdown` | `<task-id> [--strategy=auto\|interactive] [--depth=1-3]` | Intelligent task decomposition into manageable sub-tasks |
+| `/task:execute` | `<task-id> [--mode=auto\|guided] [--agent=type]` | Execute tasks with automatic agent selection |
+| `/task:replan` | `[task-id\|--all] [--reason] [--strategy=adjust\|rebuild]` | Dynamic task re-planning for changing requirements |
+| `/task:context` | `[task-id\|--filter] [--analyze] [--update]` | Single-task context analysis and dependency tracking |
+| `/task:sync` | `[--force] [--dry-run]` | Maintain consistency between task files and tracking documents |
+
+## 🎯 Usage Workflows
+
+### Complex Feature Development
 ```bash
-/workflow:session start complex "Implement OAuth2 user authentication system"
-```
+# 1. Start sophisticated workflow with full documentation
+/workflow:session start complex "Implement OAuth2 authentication system"

-2. **Conceptual Planning** (Optional but recommended):
-```bash
-/brainstorm "Design OAuth2 authentication system architecture" --perspectives=system-architect,security-expert,data-architect
-```
+# 2. Multi-perspective brainstorming
+/brainstorm "OAuth2 architecture design" --perspectives=system-architect,security-expert,data-architect

-3. **Create Action Plan**:
-```bash
+# 3. Create detailed implementation plan
 /workflow:action-plan --from-brainstorming
-```

-4. **Task Creation & Breakdown**:
-```bash
+# 4. Break down into manageable tasks
 /task:create "Backend API development"
-/task:breakdown IMPL-1
-```
+/task:breakdown IMPL-1 --strategy=auto

-5. **Execute Tasks**:
-```bash
-/task:execute IMPL-1.1
-```
+# 5. Execute with intelligent automation
+/gemini-execute IMPL-1.1 --yolo
+/gemini-execute IMPL-1.2 --yolo

-6. **Handle Changes**:
-```bash
-/workflow:issue create --type=bug "JWT token refresh logic vulnerability"
-/workflow:issue integrate ISS-001 --position=immediate
-```
+# 6. Handle dynamic changes
+/workflow:issue create --type=enhancement "Add social login support"
+/workflow:issue integrate ISS-001 --position=next

-7. **Monitor Progress**:
-```bash
+# 7. Monitor and review
 /workflow:context --detailed
-/task:context IMPL-1.2
+/workflow:review --auto-fix
 ```

-8. **Review & Complete**:
+### Quick Bug Fix
 ```bash
+# 1. Lightweight session for simple tasks
+/workflow:session start simple "Fix login button alignment"
+
+# 2. Direct analysis and implementation
+/gemini-chat "Analyze login button CSS issues in @{src/components/Login.js}"
+
+# 3. Create and execute single task
+/task:create "Apply CSS fix to login button"
+/task:execute IMPL-1 --mode=auto
+
+# 4. Quick review
 /workflow:review
 ```

-## 🎯 Key Commands
+### Advanced Code Analysis
+```bash
+# 1. Security audit
+/gemini-mode security "Scan authentication modules for vulnerabilities"

-| Command | Purpose |
-|---------|---------|
-| `/workflow:session` | Manage workflow sessions |
-| `/brainstorm` | Multi-perspective conceptual planning |
-| `/workflow:action-plan` | Convert concepts to implementation plans |
-| `/task:breakdown` | Decompose tasks into executable units |
-| `/task:execute` | Execute specific tasks |
-| `/workflow:issue` | Manage issues and changes |
-| `/gemini-execute` | Enhanced Gemini CLI integration |
-| `/update_dms` | Maintain distributed memory system |
+# 2. Architecture analysis
+/gemini-mode architecture "Analyze component dependencies and data flow"
+
+# 3. Performance optimization
+/gemini-mode performance "Identify bottlenecks in React rendering"
+
+# 4. Pattern recognition
+/gemini-mode pattern "Extract reusable component patterns"
+```
+
+## 📊 Complexity-Based Strategies
+
+| Complexity | Use Cases | Command Strategy | Documentation Level |
+|------------|-----------|------------------|-------------------|
+| **Simple** | Bug fixes, text changes, single-file updates | Skip brainstorming → Direct implementation → Minimal tasks | Light (session + log) |
+| **Medium** | Multi-file features, refactoring, API changes | Optional brainstorming → Action plan → 2-level tasks → Progress tracking | Moderate (+ TODO_LIST.md) |
+| **Complex** | Architecture changes, security modules, system-wide updates | Required brainstorming → Detailed planning → 3-level tasks → Risk assessment | Complete (full document suite) |

 ## 🔧 Technical Highlights

--- a/README_CN.md
+++ b/README_CN.md
@@ -56,129 +56,122 @@ CCW 根据任务复杂度智能调整其文件结构和工作流程：
 └── settings.local.json   # 本地配置
 ```

-## 🛠️ 安装
-
-### 快速安装（推荐）
-
-**一键远程安装：**
+## 🚀 快速开始

+**一键安装：**
 ```powershell
-# PowerShell (Windows/Linux/macOS)
 Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content
 ```

-**带参数安装：**
-```powershell
-# 全局安装
-Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content | ForEach-Object { iex "$_ -Global" }
-
-# 自定义目录安装
-Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content | ForEach-Object { iex "$_ -Directory 'C:\MyCustomPath'" }
-
-# 强制安装（覆盖现有文件）
-Invoke-Expression (Invoke-WebRequest -Uri "https://raw.githubusercontent.com/catlog22/Claude-Code-Workflow/main/install-remote.ps1" -UseBasicParsing).Content | ForEach-Object { iex "$_ -Force" }
-```
-
-### 手动安装
-
-1. 克隆此仓库：
-```bash
-git clone https://github.com/catlog22/Claude-Code-Workflow.git
-cd Claude-Code-Workflow
-```
-
-2. 运行本地安装脚本：
-```powershell
-# Windows PowerShell
-.\Install-Claude.ps1
-
-# 带参数
-.\Install-Claude.ps1 -InstallMode Global -Force
-```
-
-3. 或手动设置环境：
-```bash
-# 复制到您的 Claude Code 配置目录
-cp -r .claude ~/.claude/
-# 或在 Windows 上
-xcopy .claude %USERPROFILE%\.claude /E /I
-```
-
-4. 验证安装：
+**验证安装：**
 ```bash
 /workflow:session list
 ```

-### 安装选项
+## 📚 完整命令参考

-| 参数 | 说明 | 示例 |
-|-----------|-------------|---------|
-| `-Global` | 系统级安装 | `-Global` |
-| `-Directory` | 自定义安装路径 | `-Directory "C:\CCW"` |
-| `-Force` | 覆盖现有安装 | `-Force` |
-| `-NoBackup` | 跳过现有文件备份 | `-NoBackup` |
-| `-NonInteractive` | 静默安装 | `-NonInteractive` |
-| `-Branch` | 从特定分支安装 | `-Branch "develop"` |
+### 核心命令

-## 📖 使用指南
+| 命令 | 语法 | 描述 |
+|---------|--------|-------------|
+| `/enhance-prompt` | `/enhance-prompt <输入>` | 增强和构造用户输入，添加技术上下文 |
+| `/gemini-chat` | `/gemini-chat <查询> [--all-files] [--compress]` | 使用智能模板与 Gemini CLI 进行交互对话 |
+| `/gemini-execute` | `/gemini-execute <任务ID\|描述> [--yolo] [--debug]` | 智能执行器，自动推断文件上下文 |
+| `/gemini-mode` | `/gemini-mode <分析类型> <目标> [选项]` | 模板驱动的代码库分析（模式、架构、安全） |
+| `/update_dms` | `/update_dms [full\|fast\|deep] [路径]` | 分布式记忆系统管理，维护层级化 CLAUDE.md |

-### 启动复杂工作流
+### 工作流管理

-1. **初始化会话**：
+| 命令 | 语法 | 描述 |
+|---------|--------|-------------|
+| `/workflow:session` | `start\|pause\|resume\|list\|switch\|status [复杂度] ["任务"]` | 会话生命周期管理，支持复杂度自适应 |
+| `/workflow:brainstorm` | `/brainstorm <主题> [--perspectives=角色1,角色2]` | 多智能体概念规划，提供不同专家视角 |
+| `/workflow:action-plan` | `[--from-brainstorming] [--skip-brainstorming] [--replan]` | 将概念转化为可执行的实施计划 |
+| `/workflow:implement` | `[--type=simple\|medium\|complex] [--auto-create-tasks]` | 进入实施阶段，基于复杂度组织流程 |
+| `/workflow:review` | `[--auto-fix]` | 最终质量保证，自动化测试和验证 |
+| `/workflow:issue` | `create\|list\|update\|integrate\|close [选项]` | 动态问题和变更请求管理 |
+| `/workflow:context` | `[--detailed] [--health-check] [--export]` | 统一的工作流状态和进度概览 |
+| `/workflow:sync` | `[--check] [--fix] [--force]` | 在所有文件间同步工作流状态 |
+
+### 任务执行
+
+| 命令 | 语法 | 描述 |
+|---------|--------|-------------|
+| `/task:create` | `"<标题>" [--type=类型] [--priority=级别]` | 创建层级化实施任务，自动生成 ID |
+| `/task:breakdown` | `<任务ID> [--strategy=auto\|interactive] [--depth=1-3]` | 智能任务分解为可管理的子任务 |
+| `/task:execute` | `<任务ID> [--mode=auto\|guided] [--agent=类型]` | 执行任务，自动选择智能体 |
+| `/task:replan` | `[任务ID\|--all] [--reason] [--strategy=adjust\|rebuild]` | 动态任务重新规划，适应需求变更 |
+| `/task:context` | `[任务ID\|--filter] [--analyze] [--update]` | 单任务上下文分析和依赖跟踪 |
+| `/task:sync` | `[--force] [--dry-run]` | 保持任务文件和跟踪文档的一致性 |
+
+## 🎯 使用工作流
+
+### 复杂功能开发
 ```bash
-/workflow:session start complex "实现 OAuth2 用户认证系统"
-```
+# 1. 启动完整文档的复杂工作流
+/workflow:session start complex "实现 OAuth2 认证系统"

-2. **概念规划**（可选但推荐）：
-```bash
-/brainstorm "设计 OAuth2 认证系统架构" --perspectives=system-architect,security-expert,data-architect
-```
+# 2. 多视角头脑风暴
+/brainstorm "OAuth2 架构设计" --perspectives=system-architect,security-expert,data-architect

-3. **创建行动计划**：
-```bash
+# 3. 创建详细实施计划
 /workflow:action-plan --from-brainstorming
-```

-4. **任务创建与分解**：
-```bash
+# 4. 分解为可管理的任务
 /task:create "后端 API 开发"
-/task:breakdown IMPL-1
-```
+/task:breakdown IMPL-1 --strategy=auto

-5. **执行任务**：
-```bash
-/task:execute IMPL-1.1
-```
+# 5. 智能自动化执行
+/gemini-execute IMPL-1.1 --yolo
+/gemini-execute IMPL-1.2 --yolo

-6. **处理变更**：
-```bash
-/workflow:issue create --type=bug "JWT 令牌刷新逻辑漏洞"
-/workflow:issue integrate ISS-001 --position=immediate
-```
+# 6. 处理动态变更
+/workflow:issue create --type=enhancement "添加社交登录支持"
+/workflow:issue integrate ISS-001 --position=next

-7. **监控进度**：
-```bash
+# 7. 监控和审查
 /workflow:context --detailed
-/task:context IMPL-1.2
+/workflow:review --auto-fix
 ```

-8. **审查与完成**：
+### 快速Bug修复
 ```bash
+# 1. 简单任务的轻量级会话
+/workflow:session start simple "修复登录按钮对齐问题"
+
+# 2. 直接分析和实施
+/gemini-chat "分析 @{src/components/Login.js} 中登录按钮的 CSS 问题"
+
+# 3. 创建并执行单一任务
+/task:create "应用登录按钮的 CSS 修复"
+/task:execute IMPL-1 --mode=auto
+
+# 4. 快速审查
 /workflow:review
 ```

-## 🎯 关键命令
+### 高级代码分析
+```bash
+# 1. 安全审计
+/gemini-mode security "扫描认证模块的安全漏洞"

-| 命令 | 用途 |
-|---------|---------|
-| `/workflow:session` | 管理工作流会话 |
-| `/brainstorm` | 多视角概念规划 |
-| `/workflow:action-plan` | 将概念转化为实施计划 |
-| `/task:breakdown` | 将任务分解为可执行单元 |
-| `/task:execute` | 执行特定任务 |
-| `/workflow:issue` | 管理问题和变更 |
-| `/gemini-execute` | 增强的 Gemini CLI 集成 |
-| `/update_dms` | 维护分布式记忆系统 |
+# 2. 架构分析
+/gemini-mode architecture "分析组件依赖和数据流"
+
+# 3. 性能优化
+/gemini-mode performance "识别 React 渲染的瓶颈"
+
+# 4. 模式识别
+/gemini-mode pattern "提取可重用的组件模式"
+```
+
+## 📊 基于复杂度的策略
+
+| 复杂度 | 使用场景 | 命令策略 | 文档级别 |
+|------------|-----------|------------------|-------------------|
+| **简单** | Bug修复、文本更改、单文件更新 | 跳过头脑风暴 → 直接实施 → 最小任务 | 轻量（会话+日志） |
+| **中等** | 多文件功能、重构、API更改 | 可选头脑风暴 → 行动计划 → 2级任务 → 进度跟踪 | 中等（+ TODO_LIST.md） |
+| **复杂** | 架构更改、安全模块、系统级更新 | 必需头脑风暴 → 详细规划 → 3级任务 → 风险评估 | 完整（全套文档） |

 ## 🔧 技术亮点