From fd145c34cdc6a4e97e343c4954197cc5c3b0c325 Mon Sep 17 00:00:00 2001 From: catlog22 Date: Sat, 17 Jan 2026 11:05:30 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E4=BC=98=E5=8C=96=E8=87=AA=E5=AE=9A?= =?UTF-8?q?=E4=B9=89=20CLI=20=E6=B3=A8=E5=86=8C=E8=AF=B4=E6=98=8E?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - 明确通过 Dashboard 界面注册 - 简化配置说明为表格形式 - 强调注册一次永久语义调用 --- README.md | 26 +++++++++++--------------- README_CN.md | 26 +++++++++++--------------- 2 files changed, 22 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index f1c3db42..38d185c9 100644 --- a/README.md +++ b/README.md @@ -185,23 +185,19 @@ User: "Use Gemini to plan the refactoring, then Codex to implement it" ### Custom CLI Registration -Register **any API as a custom CLI** via Dashboard API Settings: +Register **any API as a custom CLI** via Dashboard interface: -```json -// Example: Register "deepseek" as custom CLI -{ - "tools": { - "deepseek": { - "enabled": true, - "type": "api-endpoint", - "endpoint": "https://api.deepseek.com/v1/chat", - "apiKey": "your-api-key" - } - } -} +```bash +ccw view # Open Dashboard → Status → API Settings → Add Custom CLI ``` -After registration, use it semantically: +| Field | Example | +|-------|---------| +| **Name** | `deepseek` | +| **Endpoint** | `https://api.deepseek.com/v1/chat` | +| **API Key** | `your-api-key` | + +After registration, use it semantically like built-in CLIs: ```text User: "Use DeepSeek to analyze this algorithm complexity" @@ -211,7 +207,7 @@ User: "Let DeepSeek and Gemini compare their analysis results" → System auto-calls: deepseek + gemini in parallel ``` -> ⚙️ **Dashboard**: `ccw view` → Status → API Settings to manage custom CLIs. +> ⚙️ Register once, invoke semantically forever - no code changes needed. --- diff --git a/README_CN.md b/README_CN.md index 18e82fc1..8b1f7a1a 100644 --- a/README_CN.md +++ b/README_CN.md @@ -185,23 +185,19 @@ qwen --version ### 自定义 CLI 注册 -通过 Dashboard API Settings **注册任意 API 为自定义 CLI**: +通过 Dashboard 界面 **注册任意 API 为自定义 CLI**: -```json -// 示例:注册 "deepseek" 为自定义 CLI -{ - "tools": { - "deepseek": { - "enabled": true, - "type": "api-endpoint", - "endpoint": "https://api.deepseek.com/v1/chat", - "apiKey": "your-api-key" - } - } -} +```bash +ccw view # 打开 Dashboard → Status → API Settings → 添加自定义 CLI ``` -注册后即可语义调用: +| 字段 | 示例 | +|------|------| +| **名称** | `deepseek` | +| **端点** | `https://api.deepseek.com/v1/chat` | +| **API Key** | `your-api-key` | + +注册后即可像内置 CLI 一样语义调用: ```text 用户: "使用 DeepSeek 分析这个算法复杂度" @@ -211,7 +207,7 @@ qwen --version → 系统自动调用: deepseek + gemini 并行执行 ``` -> ⚙️ **Dashboard 配置**: `ccw view` → Status → API Settings 管理自定义 CLI。 +> ⚙️ 注册一次,永久语义调用 - 无需修改代码。 ---