diff --git a/README.md b/README.md index 1ceebf82..ebe3ce8d 100644 --- a/README.md +++ b/README.md @@ -144,17 +144,43 @@ After installation, run the following command to ensure CCW is working: ## ⚙️ Configuration -### **Prerequisites: Required Tools** +### **Tool Control System** -Before using CCW, install the following command-line tools: +CCW uses a **configuration-based tool control system** that makes external CLI tools **optional** rather than required. This allows you to: -#### **Core CLI Tools** +- ✅ **Start with Claude-only mode** - Work immediately without installing additional tools +- ✅ **Progressive enhancement** - Add external tools selectively as needed +- ✅ **Graceful degradation** - Automatic fallback when tools are unavailable +- ✅ **Flexible configuration** - Control tool availability per project -| Tool | Purpose | Installation | -|------|---------|--------------| -| **Gemini CLI** | AI analysis & documentation | `npm install -g @google/gemini-cli` ([GitHub](https://github.com/google-gemini/gemini-cli)) | -| **Codex CLI** | AI development & implementation | `npm install -g @openai/codex` ([GitHub](https://github.com/openai/codex)) | -| **Qwen Code** | AI architecture & code generation | `npm install -g @qwen-code/qwen-code` ([Docs](https://github.com/QwenLM/qwen-code)) | +**Configuration File**: `~/.claude/workflows/tool-control.yaml` + +```yaml +tools: + gemini: + enabled: false # Optional: AI analysis & documentation + qwen: + enabled: true # Optional: AI architecture & code generation + codex: + enabled: true # Optional: AI development & implementation +``` + +**Behavior**: +- **When disabled**: CCW automatically falls back to other enabled tools or Claude's native capabilities +- **When enabled**: Uses specialized tools for their specific strengths +- **Default**: All tools disabled - Claude-only mode works out of the box + +### **Optional CLI Tools** *(Enhanced Capabilities)* + +While CCW works with Claude alone, installing these tools provides enhanced analysis and extended context: + +#### **External CLI Tools** + +| Tool | Purpose | Installation | Benefits | +|------|---------|--------------|----------| +| **Gemini CLI** | AI analysis & documentation | `npm install -g @google/gemini-cli` ([GitHub](https://github.com/google-gemini/gemini-cli)) | Free quota, extended context for complex projects | +| **Codex CLI** | AI development & implementation | `npm install -g @openai/codex` ([GitHub](https://github.com/openai/codex)) | Autonomous development, mathematical reasoning | +| **Qwen Code** | AI architecture & code generation | `npm install -g @qwen-code/qwen-code` ([Docs](https://github.com/QwenLM/qwen-code)) | Large context window, architecture analysis | #### **System Utilities** diff --git a/README_CN.md b/README_CN.md index f16b6e16..61cb8862 100644 --- a/README_CN.md +++ b/README_CN.md @@ -144,17 +144,43 @@ bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflo ## ⚙️ 配置 -### **前置要求:必需工具** +### **工具控制系统** -在使用 CCW 之前,请安装以下命令行工具: +CCW 使用**基于配置的工具控制系统**,使外部 CLI 工具成为**可选项**而非必需项。这允许您: -#### **核心 CLI 工具** +- ✅ **从纯 Claude 模式开始** - 无需安装额外工具即可立即开始工作 +- ✅ **渐进式增强** - 根据需要选择性地添加外部工具 +- ✅ **优雅降级** - 工具不可用时自动回退 +- ✅ **灵活配置** - 按项目控制工具可用性 -| 工具 | 用途 | 安装方式 | -|------|------|----------| -| **Gemini CLI** | AI 分析与文档生成 | `npm install -g @google/gemini-cli` ([GitHub](https://github.com/google-gemini/gemini-cli)) | -| **Codex CLI** | AI 开发与实现 | `npm install -g @openai/codex` ([GitHub](https://github.com/openai/codex)) | -| **Qwen Code** | AI 架构与代码生成 | `npm install -g @qwen-code/qwen-code` ([文档](https://github.com/QwenLM/qwen-code)) | +**配置文件**: `~/.claude/workflows/tool-control.yaml` + +```yaml +tools: + gemini: + enabled: false # 可选:AI 分析与文档生成 + qwen: + enabled: true # 可选:AI 架构与代码生成 + codex: + enabled: true # 可选:AI 开发与实现 +``` + +**行为**: +- **禁用时**: CCW 自动回退到其他已启用工具或 Claude 的原生能力 +- **启用时**: 使用专用工具发挥各自优势 +- **默认**: 所有工具禁用 - 纯 Claude 模式开箱即用 + +### **可选 CLI 工具** *(增强功能)* + +虽然 CCW 仅使用 Claude 即可工作,但安装这些工具可提供增强的分析和扩展上下文: + +#### **外部 CLI 工具** + +| 工具 | 用途 | 安装方式 | 优势 | +|------|------|----------|------| +| **Gemini CLI** | AI 分析与文档生成 | `npm install -g @google/gemini-cli` ([GitHub](https://github.com/google-gemini/gemini-cli)) | 免费配额,复杂项目的扩展上下文 | +| **Codex CLI** | AI 开发与实现 | `npm install -g @openai/codex` ([GitHub](https://github.com/openai/codex)) | 自主开发,数学推理 | +| **Qwen Code** | AI 架构与代码生成 | `npm install -g @qwen-code/qwen-code` ([文档](https://github.com/QwenLM/qwen-code)) | 大上下文窗口,架构分析 | #### **系统实用工具**