From ae77e698db631981b49115e9d53962ee7b8d3818 Mon Sep 17 00:00:00 2001 From: catlog22 Date: Fri, 3 Oct 2025 09:36:47 +0800 Subject: [PATCH] docs: Add prerequisites section with required tools installation guide MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Added comprehensive prerequisites section to both English and Chinese README files: - Core CLI tools: Gemini CLI, Codex CLI, Qwen Code with GitHub links - System utilities: ripgrep, jq with download links - Platform-specific quick install commands (macOS, Ubuntu/Debian, Windows) 🤖 Generated with [Claude Code](https://claude.com/claude-code) Co-Authored-By: Claude --- README.md | 35 +++++++++++++++++++++++++++++++++++ README_CN.md | 35 +++++++++++++++++++++++++++++++++++ 2 files changed, 70 insertions(+) diff --git a/README.md b/README.md index e987f010..689df3fb 100644 --- a/README.md +++ b/README.md @@ -233,6 +233,41 @@ After installation, run the following command to ensure CCW is working: ## ⚙️ Configuration +### **Prerequisites: Required Tools** + +Before using CCW, install the following command-line tools: + +#### **Core CLI Tools** + +| 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)) | + +#### **System Utilities** + +| Tool | Purpose | Installation | +|------|---------|--------------| +| **ripgrep (rg)** | Fast code search | [Download](https://github.com/BurntSushi/ripgrep/releases) or `brew install ripgrep` (macOS), `apt install ripgrep` (Ubuntu) | +| **jq** | JSON processing | [Download](https://jqlang.github.io/jq/download/) or `brew install jq` (macOS), `apt install jq` (Ubuntu) | + +**Quick Install (All Tools):** + +```bash +# macOS +brew install ripgrep jq +npm install -g @google/gemini-cli @openai/codex @qwen-code/qwen-code + +# Ubuntu/Debian +sudo apt install ripgrep jq +npm install -g @google/gemini-cli @openai/codex @qwen-code/qwen-code + +# Windows (Chocolatey) +choco install ripgrep jq +npm install -g @google/gemini-cli @openai/codex @qwen-code/qwen-code +``` + ### **Essential: Gemini CLI Setup** Configure Gemini CLI for optimal integration: diff --git a/README_CN.md b/README_CN.md index 06c82cc7..9d17d70a 100644 --- a/README_CN.md +++ b/README_CN.md @@ -236,6 +236,41 @@ bash <(curl -fsSL https://raw.githubusercontent.com/catlog22/Claude-Code-Workflo ## ⚙️ 配置 +### **前置要求:必需工具** + +在使用 CCW 之前,请安装以下命令行工具: + +#### **核心 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)) | + +#### **系统实用工具** + +| 工具 | 用途 | 安装方式 | +|------|------|----------| +| **ripgrep (rg)** | 快速代码搜索 | [下载](https://github.com/BurntSushi/ripgrep/releases) 或 `brew install ripgrep` (macOS), `apt install ripgrep` (Ubuntu) | +| **jq** | JSON 处理 | [下载](https://jqlang.github.io/jq/download/) 或 `brew install jq` (macOS), `apt install jq` (Ubuntu) | + +**快速安装(所有工具):** + +```bash +# macOS +brew install ripgrep jq +npm install -g @google/gemini-cli @openai/codex @qwen-code/qwen-code + +# Ubuntu/Debian +sudo apt install ripgrep jq +npm install -g @google/gemini-cli @openai/codex @qwen-code/qwen-code + +# Windows (Chocolatey) +choco install ripgrep jq +npm install -g @google/gemini-cli @openai/codex @qwen-code/qwen-code +``` + ### **必需: Gemini CLI 设置** 配置 Gemini CLI 以实现最佳集成: