mirror of
https://github.com/catlog22/Claude-Code-Workflow.git
synced 2026-02-05 01:50:27 +08:00
docs: fix command name inconsistencies across documentation
Fix multiple command naming and parameter inconsistencies:
1. Command Name Fixes:
- Change /cli:mode:bug-index to /cli:mode:bug-diagnosis
- Affected files: COMMAND_REFERENCE.md, COMMAND_SPEC.md,
EXAMPLES.md, GETTING_STARTED.md, GETTING_STARTED_CN.md,
PROJECT_INTRODUCTION.md
2. Parameter Fixes:
- Remove invalid --tool parameter from /workflow:lite-plan
- The lite-plan command does not support --tool flag
- Affected files: README.md, README_CN.md, COMMAND_SPEC.md
3. Invalid Command Fixes in PROJECT_INTRODUCTION.md:
- Change /gemini:analyze to /cli:analyze --tool gemini
- Change /qwen:mode:plan to /cli:mode:plan --tool qwen
- Change /codex:mode:auto to /cli:execute --tool codex
- Change /workflow:plan-deep to /workflow:plan
- These legacy command formats are no longer valid
Impact:
- All documentation now matches actual command implementations
- Users will not encounter "command not found" errors
- Examples are now executable and correct
- Consistent command syntax across all docs
Files modified: 8
- COMMAND_REFERENCE.md
- COMMAND_SPEC.md
- EXAMPLES.md
- GETTING_STARTED.md
- GETTING_STARTED_CN.md
- PROJECT_INTRODUCTION.md
- README.md
- README_CN.md
This commit is contained in:
@@ -16,7 +16,7 @@ These commands provide direct access to AI tools for quick analysis and interact
|
||||
| `/cli:codex-execute` | Automated task decomposition and execution with Codex using resume mechanism. |
|
||||
| `/cli:discuss-plan` | Orchestrates an iterative, multi-model discussion for planning and analysis without implementation. |
|
||||
| `/cli:execute` | Auto-execution of implementation tasks with YOLO permissions and intelligent context inference. |
|
||||
| `/cli:mode:bug-index` | Bug analysis and fix suggestions using CLI tools. |
|
||||
| `/cli:mode:bug-diagnosis` | Bug analysis and fix suggestions using CLI tools. |
|
||||
| `/cli:mode:code-analysis` | Deep code analysis and debugging using CLI tools with specialized template. |
|
||||
| `/cli:mode:plan` | Project planning and architecture analysis using CLI tools. |
|
||||
|
||||
|
||||
@@ -79,8 +79,8 @@ High-level orchestrators for complex, multi-phase development processes.
|
||||
# Force code exploration
|
||||
/workflow:lite-plan -e "Refactor logging module for better performance"
|
||||
|
||||
# Preset CLI tool
|
||||
/workflow:lite-plan --tool codex "Add unit tests for auth service"
|
||||
# Basic usage
|
||||
/workflow:lite-plan "Add unit tests for auth service"
|
||||
```
|
||||
|
||||
### **/workflow:execute**
|
||||
@@ -247,13 +247,13 @@ Direct access to AI tools for analysis and code interaction without a full workf
|
||||
/cli:execute "implement JWT authentication with middleware"
|
||||
```
|
||||
|
||||
### **/cli:mode:bug-index**
|
||||
- **Syntax**: `/cli:mode:bug-index [--agent] [--tool ...] [--enhance] [--cd path] <bug description>`
|
||||
### **/cli:mode:bug-diagnosis**
|
||||
- **Syntax**: `/cli:mode:bug-diagnosis [--tool ...] [--enhance] [--cd path] <bug description>`
|
||||
- **Responsibilities**: Performs systematic bug analysis using the `bug-fix.md` template. Read-only.
|
||||
- **Agent Calls**: `@cli-execution-agent` (if `--agent` is used).
|
||||
- **Agent Calls**: `@cli-execution-agent` (default).
|
||||
- **Example**:
|
||||
```bash
|
||||
/cli:mode:bug-index "null pointer error in login flow"
|
||||
/cli:mode:bug-diagnosis "null pointer error in login flow"
|
||||
```
|
||||
|
||||
### **/cli:mode:code-analysis**
|
||||
|
||||
@@ -505,7 +505,7 @@ design-system/
|
||||
|
||||
```bash
|
||||
# Analyze bug
|
||||
/cli:mode:bug-index "Login button click event not firing on mobile Safari"
|
||||
/cli:mode:bug-diagnosis "Login button click event not firing on mobile Safari"
|
||||
|
||||
# Claude analyzes and implements fix
|
||||
```
|
||||
@@ -533,8 +533,8 @@ button.addEventListener('touchend', (e) => {
|
||||
# Start session for thorough investigation
|
||||
/workflow:session:start "Memory Leak Investigation"
|
||||
|
||||
# Deep code analysis
|
||||
/cli:mode:code-analysis --tool gemini "Analyze React component lifecycle and event listener management for potential memory leaks"
|
||||
# Deep bug analysis
|
||||
/cli:mode:bug-diagnosis --tool gemini "Memory leak in React components - event listeners not cleaned up"
|
||||
|
||||
# Create fix plan
|
||||
/workflow:plan "Fix memory leaks in React components: cleanup event listeners and cancel subscriptions"
|
||||
|
||||
@@ -182,7 +182,7 @@ Quick bug analysis and fix workflow:
|
||||
|
||||
```bash
|
||||
# Analyze the bug
|
||||
/cli:mode:bug-index "Incorrect success message with wrong password"
|
||||
/cli:mode:bug-diagnosis "Incorrect success message with wrong password"
|
||||
|
||||
# Claude will analyze and then directly implement the fix based on the analysis
|
||||
```
|
||||
|
||||
@@ -182,7 +182,7 @@
|
||||
|
||||
```bash
|
||||
# 分析 Bug
|
||||
/cli:mode:bug-index "密码错误时仍显示成功消息"
|
||||
/cli:mode:bug-diagnosis "密码错误时仍显示成功消息"
|
||||
|
||||
# Claude 会分析后直接根据分析结果实现修复
|
||||
```
|
||||
@@ -233,7 +233,7 @@ CCW 支持通过统一的 CLI 接口直接调用外部 AI 工具(Gemini、Qwen
|
||||
/cli:mode:code-analysis --tool qwen "分析 src/utils/ 目录下的工具函数"
|
||||
|
||||
# Bug 分析模式
|
||||
/cli:mode:bug-index --tool gemini "分析内存泄漏问题的可能原因"
|
||||
/cli:mode:bug-diagnosis --tool gemini "分析内存泄漏问题的可能原因"
|
||||
```
|
||||
|
||||
### 工具语义调用
|
||||
|
||||
@@ -200,13 +200,13 @@ CCW 基于任务类型自动选择最适合的工具:
|
||||
|
||||
```bash
|
||||
# 探索和理解阶段
|
||||
/gemini:analyze "认证系统架构模式"
|
||||
/cli:analyze --tool gemini "认证系统架构模式"
|
||||
|
||||
# 设计和规划阶段
|
||||
/qwen:mode:plan "微服务认证架构设计"
|
||||
/cli:mode:plan --tool qwen "微服务认证架构设计"
|
||||
|
||||
# 实现和开发阶段
|
||||
/codex:mode:auto "实现 JWT 认证系统"
|
||||
/cli:execute --tool codex "实现 JWT 认证系统"
|
||||
```
|
||||
|
||||
### 🔄 完整开发生命周期
|
||||
@@ -304,8 +304,8 @@ CCW 基于任务类型自动选择最适合的工具:
|
||||
```bash
|
||||
# 快速错误解决工作流
|
||||
/workflow:session:start "支付验证修复"
|
||||
/gemini:mode:bug-index "并发请求时支付验证失败"
|
||||
/codex:mode:bug-index "修复支付验证竞态条件"
|
||||
/cli:mode:bug-diagnosis --tool gemini "并发请求时支付验证失败"
|
||||
/cli:execute --tool codex "修复支付验证竞态条件"
|
||||
/workflow:review
|
||||
```
|
||||
|
||||
@@ -313,9 +313,9 @@ CCW 基于任务类型自动选择最适合的工具:
|
||||
```bash
|
||||
# 深度架构分析和重构
|
||||
/workflow:session:start "微服务重构"
|
||||
/gemini:analyze "当前单体架构的技术债务"
|
||||
/workflow:plan-deep "单体到微服务的迁移策略"
|
||||
/qwen:mode:auto "重构用户服务为微服务架构"
|
||||
/cli:analyze --tool gemini "当前单体架构的技术债务"
|
||||
/workflow:plan "单体到微服务的迁移策略"
|
||||
/workflow:execute
|
||||
/workflow:test-gen WFS-microservice-refactoring
|
||||
```
|
||||
|
||||
|
||||
@@ -126,8 +126,8 @@ Lightweight interactive workflow with in-memory planning and immediate execution
|
||||
# Force code exploration
|
||||
/workflow:lite-plan -e "Refactor logging module for better performance"
|
||||
|
||||
# Preset CLI tool
|
||||
/workflow:lite-plan --tool codex "Add unit tests for auth service"
|
||||
# Basic usage
|
||||
/workflow:lite-plan "Add unit tests for auth service"
|
||||
```
|
||||
|
||||
**Interactive Flow**:
|
||||
|
||||
@@ -126,8 +126,8 @@ CCW 包含内置的**命令指南技能**,帮助您有效地发现和使用命
|
||||
# 强制代码探索
|
||||
/workflow:lite-plan -e "重构日志模块以提高性能"
|
||||
|
||||
# 预设 CLI 工具
|
||||
/workflow:lite-plan --tool codex "为认证服务添加单元测试"
|
||||
# 基本用法
|
||||
/workflow:lite-plan "为认证服务添加单元测试"
|
||||
```
|
||||
|
||||
**交互流程**:
|
||||
|
||||
Reference in New Issue
Block a user