@chenpu17/cc-gw 0.2.5 → 0.3.1

package/README.md

@@ -53,6 +53,7 @@ pnpm --filter @cc-gw/cli exec tsx index.ts start --daemon --port 4100
 - **请求日志**：多条件筛选（时间、Provider、模型、状态），查看压缩日志详情，支持分页导出与清理。
 - **模型管理**：维护 Provider 列表、预置模型、路由策略；一键测试连通性（发送诊断 PROMPT）。
 - **系统设置**：端口、日志保留策略、是否存储请求 payload、日志级别与访问日志开关、日志清理工具。
+- **使用指南**：提供图文步骤、常见问题与排查提示，帮助团队成员快速熟悉配置流程。
 
 UI 支持中英文、深色/浅色主题以及移动端响应式布局，提供键盘可达性（Skip Link、焦点管理）。
 
@@ -66,10 +67,24 @@ UI 支持中英文、深色/浅色主题以及移动端响应式布局，提供
 1. 启动 cc-gw 并确认配置中 `host` 为 `127.0.0.1`，`port` 与 CLI 启动一致。
 2. 在安装了 Claude Code 的终端设置环境变量：
    ```bash
-   export ANTHROPIC_BASE_URL=http://127.0.0.1:4100
+   export ANTHROPIC_BASE_URL=http://127.0.0.1:4100/anthropic
    claude "help me review this file"
    ```
-3. cc-gw 会根据 `modelRoutes`/默认策略将 Claude 请求路由到已配置的目标模型（如 Kimi、火山 DeepSeek、OpenAI 或自建模型）。
+3. 如果使用 VS Code 插件（Claude Code），在“自定义 API”中同样填写 `http://127.0.0.1:4100/anthropic`，插件会自动追加 `/v1/messages` 与 `?beta=true`，最后粘贴 cc-gw Web UI 或 CLI 创建的 API Key。
+4. cc-gw 会根据 `modelRoutes`/默认策略将 Claude 请求路由到已配置的目标模型（如 Kimi、火山 DeepSeek、OpenAI 或自建模型）。
+
+### 连接 Codex（原 Claude Code for Repo）
+1. 在 Web UI 的“模型管理 → 路由配置”中为 `/openai` 端点选择目标模型，默认会映射至配置中的 `defaults.completion`。
+2. 在 Codex 或其他需要 OpenAI 风格接口的客户端中，将 Base URL 设置为 `http://127.0.0.1:4100/openai/v1`；若需手动指定路径，请调用 `POST /openai/v1/responses`。
+3. 将 API Key 设置为 cc-gw 生成的密钥（支持 Bearer Header 或 `x-api-key` Header）。
+4. 触发一次 `hello` 或最小请求检查 Streaming 是否正常；若遇到 `Unsupported parameter: thinking` 等提示，说明 cc-gw 已自动剥离该字段并兼容上游。
+
+### 使用场景 / Usage Scenarios
+
+1. **双端点适配 / Dual Endpoint Support**：通过 `/anthropic` 与 `/openai` 端点，分别兼容 Claude Code 与 Codex 客户端。无需重启 cc-gw，即可在 Web UI 中为两个端点配置独立的默认模型与路由策略。
+2. **日志追踪 / Request Auditing**：在“请求日志”页按端点、Provider、API Key 等维度筛选记录，可直接查看和复制完整的请求/响应 payload，辅助排查联调问题。
+3. **模型切换 / Cross-Provider Routing**：利用“模型管理”页的路由映射，将 Claude Code 请求透明地转发到 GLM、Kimi K2、DeepSeek 等任意 OpenAI 兼容模型，实现一套 IDE 客户端、多家大模型的快速切换。
+4. **操作指引 / Built-in Guidance**：左侧“Help”导航提供分步配置、日常运维建议及 FAQ，可作为新人上手或问题排查的快速参考。
 
 ## 配置说明
 
@@ -114,7 +129,8 @@ UI 支持中英文、深色/浅色主题以及移动端响应式布局，提供
   "logRetentionDays": 30,
   "storePayloads": true,
   "logLevel": "info",
-  "requestLogging": true
+  "requestLogging": true,
+  "responseLogging": true
 }
 ```
 
@@ -125,7 +141,9 @@ UI 支持中英文、深色/浅色主题以及移动端响应式布局，提供
 - `modelRoutes`：将 Claude 发起的模型名映射到上游模型；未命中时使用 `defaults`。
 - `storePayloads`：是否在 SQLite 中压缩保存原始请求/响应（Brotli），关闭后仅保留元信息。
 - `logLevel`：控制 Fastify/Pino 控制台日志级别（`fatal`/`error`/`warn`/`info`/`debug`/`trace`）。
-- `requestLogging`：是否输出每个 HTTP 请求的访问日志，关闭后终端更加安静。
+- `providers[].authMode`：仅在 `type: "anthropic"` 时生效，可选 `apiKey`（默认，发送 `x-api-key`）或 `authToken`（发送 `Authorization: Bearer`）。配置 Claude Code 使用 `ANTHROPIC_AUTH_TOKEN` 时，请选择 `authToken` 并在 `apiKey` 输入框填入该值。
+- `requestLogging`：是否输出每个 HTTP 请求的进入日志。
+- `responseLogging`：是否输出每个 HTTP 请求完成的日志，可独立于 `requestLogging` 控制。
 - 推荐通过 Web UI 的“模型管理 / 系统设置”在线编辑并热加载，无需手工修改文件。
 
 #### Anthropic Provider 额外说明
@@ -204,13 +222,24 @@ pnpm --filter @cc-gw/web build
 pnpm --filter @cc-gw/cli exec tsx index.ts start --daemon --port 4100
 ```
 
-Connect Claude Code by pointing `ANTHROPIC_BASE_URL` to your local gateway:
+Connect Claude Code by pointing `ANTHROPIC_BASE_URL` to the Anthropic namespace on cc-gw. Both the CLI and editor clients append `/v1/messages` automatically:
 
 ```bash
-export ANTHROPIC_BASE_URL=http://127.0.0.1:4100
+export ANTHROPIC_BASE_URL=http://127.0.0.1:4100/anthropic
 claude "help me review this file"
 ```
 
+Using the Claude Code VS Code extension? Open the extension settings, enable the custom API mode, set the Base URL to the same `http://127.0.0.1:4100/anthropic`, and paste an API key generated from the cc-gw Web UI or CLI—the extension appends `/v1/messages?beta=true` automatically and cc-gw now forwards the query string upstream.
+
+Connect Codex (or any OpenAI-compatible IDE integration) by targeting the OpenAI endpoint exposed by cc-gw:
+
+```bash
+export OPENAI_BASE_URL=http://127.0.0.1:4100/openai/v1
+export OPENAI_API_KEY="<your cc-gw api key>"
+```
+
+If the client expects a full path, call `POST /openai/v1/responses`. The gateway strips unsupported fields (such as `thinking`) before forwarding to the upstream provider, so health checks like `hello` should stream back correctly.
+
 ### Configuration Snapshot
 
 - Providers include `type`, `baseUrl`, `apiKey`, and `models` descriptions.
@@ -219,6 +248,7 @@ claude "help me review this file"
 - `storePayloads` toggles compressed body retention; disable to keep only metadata.
 - `logLevel` adjusts Fastify/Pino verbosity (`fatal` → `trace`).
 - `requestLogging` controls whether per-request access logs are emitted to the console.
+- `responseLogging` toggles completion logs separately so you can keep the console quieter while preserving metrics.
 - Web UI allows editing without restarting; CLI restart will pick up bundle changes after rebuilds.
 
 ### Observability & Storage
@@ -249,6 +279,7 @@ claude "help me review this file"
 - Always rebuild `@cc-gw/server` and `@cc-gw/web` before restarts to ensure the daemon picks up new code.
 - If cache statistics remain zero, verify whether the upstream provider exposes `cached_tokens` or equivalent details.
 - Back up `~/.cc-gw/` (config, logs, SQLite DB) for migrations or disaster recovery.
+- Use the **Help** page in the Web UI to review setup steps, troubleshooting tips, and FAQs whenever a teammate needs a refresher.
 
 ---
 

package/package.json

@@ -1,8 +1,24 @@
 {
   "name": "@chenpu17/cc-gw",
-  "version": "0.2.5",
+  "version": "0.3.1",
   "private": false,
   "type": "module",
+  "scripts": {
+    "dev": "pnpm --filter server dev",
+    "build": "pnpm run build:server && pnpm run build:web",
+    "build:server": "pnpm --filter @cc-gw/server build",
+    "build:cli": "pnpm --filter @cc-gw/cli build",
+    "build:web": "pnpm --filter @cc-gw/web build",
+    "build:all": "pnpm run build:server && pnpm run build:cli && pnpm run build:web",
+    "release:bundle": "pnpm run build:all && node scripts/build-release.mjs",
+    "prepack": "pnpm run build:all",
+    "lint": "pnpm exec eslint .",
+    "format": "pnpm exec prettier --check .",
+    "format:write": "pnpm exec prettier --write .",
+    "typecheck": "pnpm -r exec tsc --noEmit",
+    "test": "pnpm exec vitest run",
+    "test:playwright": "playwright test"
+  },
   "bin": {
     "cc-gw": "src/cli/dist/index.js"
   },
@@ -13,6 +29,15 @@
     "README.md",
     "LICENSE"
   ],
+  "pnpm": {
+    "peerDependencyRules": {
+      "ignoreMissing": [
+        "react",
+        "react-dom"
+      ]
+    }
+  },
+  "packageManager": "pnpm@9.0.0",
   "engines": {
     "node": ">=18.18.0"
   },
@@ -26,42 +51,29 @@
   ],
   "repository": {
     "type": "git",
-    "url": "https://github.com/chenpu17/cc-gw.git"
+    "url": "git+https://github.com/chenpu17/cc-gw.git"
   },
   "dependencies": {
     "@fastify/cors": "^9.0.1",
     "@fastify/static": "^7.0.4",
-    "sqlite3": "^5.1.7",
-    "commander": "^12.0.0",
     "colorette": "^2.0.20",
+    "commander": "^12.0.0",
     "fastify": "^4.26.2",
     "open": "^10.1.0",
+    "sqlite3": "^5.1.7",
     "tiktoken": "^1.0.21",
     "undici": "^6.11.1"
   },
   "devDependencies": {
     "@eslint/js": "^9.5.0",
+    "@playwright/test": "^1.55.1",
     "@types/node": "^20.12.7",
+    "@types/sqlite3": "^3.1.11",
     "eslint": "^8.57.0",
     "globals": "^15.0.0",
     "prettier": "^3.2.5",
     "typescript": "^5.4.3",
     "typescript-eslint": "^7.5.0",
-    "vitest": "^1.6.0",
-    "@types/sqlite3": "^3.1.11"
-  },
-  "scripts": {
-    "dev": "pnpm --filter server dev",
-    "build": "pnpm run build:server && pnpm run build:web",
-    "build:server": "pnpm --filter @cc-gw/server build",
-    "build:cli": "pnpm --filter @cc-gw/cli build",
-    "build:web": "pnpm --filter @cc-gw/web build",
-    "build:all": "pnpm run build:server && pnpm run build:cli && pnpm run build:web",
-    "release:bundle": "pnpm run build:all && node scripts/build-release.mjs",
-    "lint": "pnpm exec eslint .",
-    "format": "pnpm exec prettier --check .",
-    "format:write": "pnpm exec prettier --write .",
-    "typecheck": "pnpm -r exec tsc --noEmit",
-    "test": "pnpm exec vitest run"
+    "vitest": "^1.6.0"
   }
-}
+}

package/src/cli/dist/index.js

@@ -57,21 +57,33 @@ async function ensureConfigTemplate(port) {
     return false;
   } catch {
     const selectedPort = port ? Number.parseInt(port, 10) || DEFAULT_PORT : DEFAULT_PORT;
+    const baseDefaults = {
+      completion: null,
+      reasoning: null,
+      background: null,
+      longContextThreshold: 6e4
+    };
     const template = {
       host: "127.0.0.1",
       port: selectedPort,
       providers: [],
-      defaults: {
-        completion: null,
-        reasoning: null,
-        background: null,
-        longContextThreshold: 6e4
+      defaults: { ...baseDefaults },
+      endpointRouting: {
+        anthropic: {
+          defaults: { ...baseDefaults },
+          modelRoutes: {}
+        },
+        openai: {
+          defaults: { ...baseDefaults },
+          modelRoutes: {}
+        }
       },
       logRetentionDays: 30,
       modelRoutes: {},
       storePayloads: true,
       logLevel: "info",
-      requestLogging: true
+      requestLogging: true,
+      responseLogging: true
     };
     await fsp.mkdir(path.dirname(CONFIG_FILE), { recursive: true });
     await fsp.writeFile(CONFIG_FILE, JSON.stringify(template, null, 2), "utf-8");