Skip to content

安装

通过 Homebrew、安装脚本、Git 仓库中的 Cargo、预构建二进制文件或从源码安装 shunt。

Updated View as Markdown

Homebrew (macOS / Linux)

brew install pleaseai/tap/shunt

作为后台服务运行

brew services start shunt

日志会写入 $(brew --prefix)/var/log/shunt.log。brew services stop 会发送 SIGTERM, shunt 会先耗尽正在处理的请求再退出 —— 最多等待 [server] shutdown_timeout_seconds(默认 30 秒; 修改该值需要重启),超时后不再等待并退出。修改配置文件后不需要重启 —— shunt 会自动 热重载该文件。 更多细节(如配置查找路径)参见 Running as a service。

安装脚本 (macOS / Linux)

curl -fsSL https://shunt.sh/install.sh | sh

该脚本从 GitHub release 下载与你的操作系统和 CPU 匹配的预构建二进制文件,用该 release 的 SHA256SUMS 校验后安装为 ~/.local/bin/shunt。可通过两个环境变量调整:

  • SHUNT_VERSION —— 要安装的 release(例如 0.55.0)。默认是脚本发布时对应的 release,即最新版本。
  • SHUNT_INSTALL_DIR —— 安装目录(默认 ~/.local/bin)。如果它不在 PATH 中,脚本会打印需要添加的那一行。
curl -fsSL https://shunt.sh/install.sh | SHUNT_VERSION=0.55.0 sh

Cargo(Git 仓库)

直接从源码仓库安装。二进制文件名仍为 shunt:

cargo install --git https://github.com/pleaseai/shunt

新版本通过 Homebrew 和 GitHub release 二进制文件分发。crates.io 软件包将停留在最后发布的版本。

预构建二进制文件

每个 GitHub release 都附有面向 macOS(arm64/x64)和 Linux(arm64/x64)的独立二进制文件,以及一个 SHA256SUMS 文件:

# 为你的 OS/CPU 选择正确的资产 (darwin/linux × arm64/x64)
OS=$(uname -s | tr '[:upper:]' '[:lower:]')
ARCH=$(uname -m); case "$ARCH" in x86_64) ARCH=x64 ;; aarch64) ARCH=arm64 ;; esac
curl -fsSLO "https://github.com/pleaseai/shunt/releases/latest/download/shunt-${OS}-${ARCH}"
chmod +x "shunt-${OS}-${ARCH}" && mv "shunt-${OS}-${ARCH}" /usr/local/bin/shunt

从源码构建

需要带 cargo 的 stable Rust:

git clone https://github.com/pleaseai/shunt
cd shunt
cargo build --release   # -> target/release/shunt

你也可以用 cargo run -- <args> 直接从源码树运行。

默认构建不需要 Node 工具链,也不包含管理仪表盘的前端包。若要构建内嵌管理 SPA 的 二进制,请先构建前端包,再启用 ui 特性。构建前端包需要 Node.js 22.12 或更高 版本:

cd ui && npm ci && npm run build && cd ..
cargo build --release --features ui

上面提供的预构建发布二进制就是这样构建的,因此这一步只与从源码构建有关。该特性 新增了什么,参见端点。

连接 Claude Code 的前置条件

  • Claude Code —— 任何近期版本;仅当你想使用 模型发现 时才需要 v2.1.129+。
  • 你所映射的那个提供方的凭据:
    • openai 提供方所需的 OpenAI API 密钥,或
    • codex 提供方所需的、通过 Codex CLI(codex login)完成的 ChatGPT 登录。
  • 你正常的 Anthropic 凭据(claude.ai 登录或 API 密钥) —— 对于每个你未映射的模型,shunt 都会将其转发出去。

下一步:快速开始。

Navigation

Type to search…

↑↓ navigate↵ selectEsc close