文档

快速开始与逐工具配置

安装二进制、启动本地网关,再把受支持的工具指向环回地址。本页只保留可直接复制的路径;完整配置参考留在公开核心仓库中。

快速开始

安装二进制、启动网关,再把一个工具指向环回地址。三步复制运行,即可完成第一次脱敏请求。

  1. 安装二进制

    适配 macOS、Linux 与 Windows 的单一 CGO-free 二进制,覆盖 amd64 与 arm64。

    macOS

    brew install --cask fregie/tap/tokenhush

    Linux

    curl -fsSL https://raw.githubusercontent.com/fregie/tokenhush/main/install.sh | bash

    Windows

    scoop bucket add fregie https://github.com/fregie/scoop-bucket && scoop install tokenhush
  2. 启动网关

    网关在前台运行,默认监听 127.0.0.1:8787,按 Ctrl-C 退出。V1 不内置服务命令;自启动请使用操作系统自带的包装方式(launchd、systemd 用户单元或任务计划程序)。

    tokenhush run
  3. 把工具指向网关

    tokenhush env 会为指定的工具打印片段。五个目标是 claudecodexaiderclineroo

    tokenhush env claude

    在启动工具的同一个 shell 会话里使用打印出的片段。下方逐工具卡片会说明细节,包括片段该放在哪里。

逐工具配置

每个受支持工具的最短路径。平台方言、鉴权说明与完整的 tokenhush.yaml 参考都在公开配置指南中,每张卡片都有链接。

Claude Code CLI

将 ANTHROPIC_BASE_URL 指向网关。API-key 模式已支持;订阅(OAuth)登录路径仍待人工验证。

eval "$(tokenhush env claude)"

订阅路径待验证。 推理请求会遵循 ANTHROPIC_BASE_URL;订阅(OAuth)登录路径仍待人工验证。授权与令牌刷新不会经过网关。

Codex CLI

通过 config.toml 以 API-key 模式接入。ChatGPT 订阅登录目前不支持经网关使用,请改用 API 密钥。

tokenhush env codex

手动配置(~/.codex/config.toml

model_providers.tokenhush = { name = "Tokenhush", base_url = "http://127.0.0.1:8787/v1" }

Codex 默认使用 Responses API;网关支持该协议,包括增量式 SSE 回填。请使用 API 密钥,不要用 ChatGPT 订阅登录。

Aider

把 OPENAI_API_BASE 或 ANTHROPIC_API_BASE 指向网关,或用 --openai-api-base 在命令行直接传入 base URL。

eval "$(tokenhush env aider)"

片段会为当前 shell 设置 OpenAI 与 Anthropic 的 base 变量;--openai-api-base 标志对单个进程等效。

Cline

在 VS Code 扩展设置中选择 OpenAI 兼容提供方,并把它的 base URL 指向本地网关。

tokenhush env cline

在扩展设置中

Base URL: http://127.0.0.1:8787/v1

Roo Code

Roo Code 的接入方式与 Cline 相同:在扩展里选择 OpenAI 兼容提供方并设置 base URL。

tokenhush env roo

在扩展设置中

Base URL: http://127.0.0.1:8787/v1

未覆盖:Cursor 代理流量、ChatGPT 与 Claude 桌面应用,以及浏览器 Web UI。这些需要系统级拦截,公开核心并未实现。

Continue 与 Open WebUI

手动 base-URL 配置:两者都通过 OpenAI 兼容端点接入,都不是 tokenhush env 的目标工具。

Continue

编辑 ~/.continue/config.json,在 models 中设置apiBase

{
  "models": [
    {
      "apiBase": "http://127.0.0.1:8787/v1"
    }
  ]
}

Open WebUI

在 Connections 中添加一个 OpenAI 兼容端点。

Base URL: http://127.0.0.1:8787/v1

验证与诊断

用 tokenhush status 确认网关是否运行,用 tokenhush doctor 诊断配置问题,并读取仅含元数据的审计时间线。

tokenhush status
tokenhush doctor
tokenhush audit

doctor 在全部检查通过时退出码为 0,有检查失败为1,用法错误为 2audit读取本地时间线,默认只存元数据。

完整文档

公开核心仓库提供权威且持续更新的参考。