@chenpu17/cc-gw 0.3.6 → 0.3.8

package/README.md

@@ -53,6 +53,7 @@ pnpm --filter @cc-gw/cli exec tsx index.ts start --daemon --port 4100
 - **请求日志**：多条件筛选（时间、Provider、模型、状态），查看压缩日志详情，支持分页导出与清理。
 - **模型管理**：维护 Provider 列表、预置模型、路由策略；一键测试连通性（发送诊断 PROMPT），支持保存并应用 Anthropic 路由模板，实现不同 Provider 方案的“一键切换”。
 - **系统设置**：端口、日志保留策略、是否存储请求 payload、日志级别与访问日志开关、日志清理工具。
+- **安全控制**：在“系统设置 → 安全”中可启用 Web UI 登录校验，自定义用户名及密码并自动保护所有 `/api/*` 管理接口（模型请求端点仍保持开放）。
 - **使用指南**：提供图文步骤、常见问题与排查提示，帮助团队成员快速熟悉配置流程。
 
 UI 支持中英文、深色/浅色主题以及移动端响应式布局，提供键盘可达性（Skip Link、焦点管理）。
@@ -79,6 +80,36 @@ UI 支持中英文、深色/浅色主题以及移动端响应式布局，提供
 3. 将 API Key 设置为 cc-gw 生成的密钥（支持 Bearer Header 或 `x-api-key` Header）。
 4. 触发一次 `hello` 或最小请求检查 Streaming 是否正常；若遇到 `Unsupported parameter: thinking` 等提示，说明 cc-gw 已自动剥离该字段并兼容上游。
 
+### 环境变量与客户端配置示例
+
+绝大多数 Claude Code/Codex 客户端都支持通过环境变量快速切换到 cc-gw。建议在启动 IDE 或终端前写入：
+
+```bash
+export ANTHROPIC_BASE_URL=http://127.0.0.1:4100/anthropic
+export ANTHROPIC_API_KEY=sk-ant-xxxxxxxxxxxxxxxxxxxxxxxxxxxx
+
+# 如需走 OpenAI 兼容接口（Codex、Open Interpreter 等）
+export OPENAI_BASE_URL=http://127.0.0.1:4100/openai/v1
+export OPENAI_API_KEY=$ANTHROPIC_API_KEY
+```
+
+对于 Codex CLI，可在 `~/.codex/config.toml` 中直接声明 cc-gw，避免每次手动输入：
+
+```toml
+model = "gpt-5-codex"
+model_provider = "cc_gw"
+model_reasoning_effort = "high"
+disable_response_storage = true
+
+[model_providers.cc_gw]
+name = "cc_gw"
+base_url = "http://127.0.0.1:4100/openai/v1"
+wire_api = "responses"
+env_key = "cc_gw_key"
+```
+
+设置完成后，运行 `source ~/.bashrc`（或等效文件）即可让 IDE/CLI 读取新的网关地址与密钥，无需在界面里多次粘贴。
+
 ### 使用场景 / Usage Scenarios
 
 1. **双端点适配 / Dual Endpoint Support**：通过 `/anthropic` 与 `/openai` 端点，分别兼容 Claude Code 与 Codex 客户端。无需重启 cc-gw，即可在 Web UI 中为两个端点配置独立的默认模型与路由策略。
@@ -127,7 +158,8 @@ UI 支持中英文、深色/浅色主题以及移动端响应式布局，提供
     "claude-opus-4-1-20250805": "anthropic:claude-3-5-sonnet-latest"
   },
   "logRetentionDays": 30,
-  "storePayloads": true,
+  "storeRequestPayloads": true,
+  "storeResponsePayloads": true,
   "logLevel": "info",
   "requestLogging": true,
   "responseLogging": true
@@ -140,7 +172,8 @@ UI 支持中英文、深色/浅色主题以及移动端响应式布局，提供
 - 模型标识使用 `providerId:modelId` 形式供路由引用。
 - `modelRoutes`：将 Claude 发起的模型名映射到上游模型；未命中时使用 `defaults`。
 - `routingPresets`：可选字段，保存多个 `anthropic`（或其他端点）路由模板，供 Web UI “一键切换”；每个模板仅包含 `name` 与 `modelRoutes`。
-- `storePayloads`：是否在 SQLite 中压缩保存原始请求/响应（Brotli），关闭后仅保留元信息。
+- `storeRequestPayloads` / `storeResponsePayloads`：是否分别在 SQLite 中压缩保存请求原文与响应内容；关闭可减少敏感数据落盘。
+- `bodyLimit`：单次请求允许的最大请求体大小（字节），默认 10 MiB。`/compact` 等场景会发送较大上下文，如遇 413 可按需增大。
 - `logLevel`：控制 Fastify/Pino 控制台日志级别（`fatal`/`error`/`warn`/`info`/`debug`/`trace`）。
 - `providers[].authMode`：仅在 `type: "anthropic"` 时生效，可选 `apiKey`（默认，发送 `x-api-key`）或 `authToken`（发送 `Authorization: Bearer`）。配置 Claude Code 使用 `ANTHROPIC_AUTH_TOKEN` 时，请选择 `authToken` 并在 `apiKey` 输入框填入该值。
 - `requestLogging`：是否输出每个 HTTP 请求的进入日志。
@@ -172,6 +205,7 @@ pnpm --filter @cc-gw/cli exec tsx index.ts status
 
 - 守护模式下 PID/日志存放于 `~/.cc-gw/cc-gw.pid` 与 `~/.cc-gw/logs/cc-gw.log`。
 - `status` 会回显配置与日志路径，便于排查。
+- `cc-gw version`（或 `cc-gw --version`）可输出与 npm 包同步的版本号，便于核对升级情况。
 
 ## 数据与日志
 
@@ -199,7 +233,7 @@ cc-gw is a local gateway tailored for Claude Code and similar Anthropic-compatib
 | ------- | ------- |
 | Protocol adaptation | Converts Claude-style payloads into OpenAI-, Anthropic-, Kimi-, and DeepSeek-compatible requests while preserving tool calls and reasoning blocks. |
 | Model routing | Maps incoming model IDs to configured upstream providers with fallbacks for long-context/background tasks, plus Anthropic routing presets for one-click provider swaps. |
-| Observability | Persists request logs, token usage (including cache hits), TTFT, TPOT, and daily aggregates via better-sqlite3 with Brotli-compressed payloads. |
+| Observability | Persists request logs, token usage (including cache hits), TTFT, TPOT, and daily aggregates via better-sqlite3 with Brotli-compressed payloads; request/response bodies can be stored independently. |
 | Web console | React + Vite UI with dashboards, filters, provider CRUD, bilingual copy, and responsive layout. |
 | CLI daemon | `cc-gw` command wraps start/stop/restart/status, manages PID/log files, and scaffolds a default config on first launch. |
 
@@ -246,7 +280,8 @@ If the client expects a full path, call `POST /openai/v1/responses`. The gateway
 - Providers include `type`, `baseUrl`, `apiKey`, and `models` descriptions.
 - When `type` is `anthropic`, cc-gw forwards the original Claude payload and all headers to `<baseUrl>/v1/messages`, so tool calls/metadata remain intact.
 - Model routes use `providerId:modelId` syntax to remap Claude requests.
-- `storePayloads` toggles compressed body retention; disable to keep only metadata.
+- `storeRequestPayloads` / `storeResponsePayloads` control whether prompts and completions are persisted; disable either switch to avoid storing sensitive data.
+- `bodyLimit`: maximum request body size (in bytes). Defaults to 10 MiB—raise this if clients like Claude Code `/compact` hit HTTP 413.
 - `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.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@chenpu17/cc-gw",
-  "version": "0.3.6",
+  "version": "0.3.8",
   "private": false,
   "type": "module",
   "scripts": {

package/src/cli/dist/index.js

@@ -10,6 +10,7 @@ import path from "path";
 import process from "process";
 import { fileURLToPath } from "url";
 import { green, yellow } from "colorette";
+import { createRequire } from "module";
 var program = new Command();
 var DEFAULT_PORT = 4100;
 var HOME_DIR = path.join(os.homedir(), ".cc-gw");
@@ -17,6 +18,27 @@ var PID_FILE = path.join(HOME_DIR, "cc-gw.pid");
 var LOG_DIR = path.join(HOME_DIR, "logs");
 var LOG_FILE = path.join(LOG_DIR, "cc-gw.log");
 var CONFIG_FILE = path.join(HOME_DIR, "config.json");
+var require2 = createRequire(import.meta.url);
+function resolvePackageVersion() {
+  const __filename = fileURLToPath(import.meta.url);
+  const __dirname = path.dirname(__filename);
+  const candidates = [
+    path.resolve(__dirname, "../../package.json"),
+    path.resolve(__dirname, "../package.json"),
+    path.resolve(__dirname, "../../../package.json")
+  ];
+  for (const candidate of candidates) {
+    try {
+      const pkg = require2(candidate);
+      if (pkg && typeof pkg.version === "string") {
+        return pkg.version;
+      }
+    } catch {
+    }
+  }
+  return "0.0.0";
+}
+var CLI_VERSION = resolvePackageVersion();
 async function readConfiguredPort() {
   try {
     const raw = await fsp.readFile(CONFIG_FILE, "utf-8");
@@ -79,6 +101,8 @@ async function ensureConfigTemplate(port) {
       port: selectedPort,
       providers: [],
       defaults: { ...baseDefaults },
+      storeRequestPayloads: true,
+      storeResponsePayloads: true,
       endpointRouting: {
         anthropic: {
           defaults: { ...baseDefaults },
@@ -91,10 +115,16 @@ async function ensureConfigTemplate(port) {
       },
       logRetentionDays: 30,
       modelRoutes: {},
-      storePayloads: true,
       logLevel: "info",
       requestLogging: true,
-      responseLogging: true
+      responseLogging: true,
+      bodyLimit: 10 * 1024 * 1024,
+      webAuth: {
+        enabled: false,
+        username: "",
+        passwordHash: "",
+        passwordSalt: ""
+      }
     };
     await fsp.mkdir(path.dirname(CONFIG_FILE), { recursive: true });
     await fsp.writeFile(CONFIG_FILE, JSON.stringify(template, null, 2), "utf-8");
@@ -246,7 +276,10 @@ async function handleStatus() {
   console.log(`\u65E5\u5FD7\u76EE\u5F55: ${LOG_DIR}`);
   console.log(`\u914D\u7F6E\u6587\u4EF6: ${CONFIG_FILE}`);
 }
-program.name("cc-gw").description("Claude Code Gateway CLI").version("0.1.0");
+program.name("cc-gw").description("Claude Code Gateway CLI").version(CLI_VERSION);
+program.command("version").description("\u663E\u793A\u5F53\u524D cc-gw CLI \u7248\u672C").action(() => {
+  console.log(`cc-gw CLI \u7248\u672C: ${CLI_VERSION}`);
+});
 program.command("start").description("\u542F\u52A8 cc-gw \u670D\u52A1").option("--daemon", "\u4EE5\u5B88\u62A4\u8FDB\u7A0B\u65B9\u5F0F\u8FD0\u884C\uFF08\u9ED8\u8BA4\uFF09").option("--foreground", "\u4EE5\u524D\u53F0\u6A21\u5F0F\u8FD0\u884C\u5E76\u4FDD\u6301\u63A7\u5236\u53F0\u8F93\u51FA").option("--port <port>", "\u6307\u5B9A\u670D\u52A1\u76D1\u542C\u7AEF\u53E3").action(async (options) => {
   try {
     await handleStart(options);