快速开始

Yuzu 兼容 OpenAI 与 Claude 官方接口。所有工具只需配置两项:

配置项值
Base URLhttps://api.yuzuapi.com(OpenAI 格式需加 /v1)
API Key在 控制台 → 密钥管理 创建,以 sk- 开头

一键安装

自动安装 Claude Code / Codex / Gemini CLI 并写入配置,原配置自动备份为 .bak。需先装好 Node.js。

irm https://yuzuapi.com/install.ps1 | iex
curl -fsSL https://yuzuapi.com/install.sh | bash

脚本源码:install.ps1 · install.sh。手动配置见下方各章节。

Node.js 配置

各 CLI 工具依赖 Node.js 18 及以上版本。

安装

从 nodejs.org 下载 LTS 安装包,或使用 winget:

winget install OpenJS.NodeJS.LTS

从 nodejs.org 下载 LTS 安装包,或使用 Homebrew:

brew install node

验证

node -v
npm -v

输出 v18 以上版本号即可。安装后需重新打开终端。

国内镜像(可选)

npm 下载慢时切换镜像:

npm config set registry https://registry.npmmirror.com

Claude 配置教程

以 Claude Code 为例,其他支持 Anthropic 接口的工具同理。

安装 Claude Code

npm install -g @anthropic-ai/claude-code

配置

编辑 ~/.claude/settings.json(Windows 为 %USERPROFILE%\.claude\settings.json),不存在则新建:

{
  "env": {
    "ANTHROPIC_BASE_URL": "https://api.yuzuapi.com",
    "ANTHROPIC_AUTH_TOKEN": "sk-你的Key"
  }
}

也可以只在当前终端临时生效:

$env:ANTHROPIC_BASE_URL = "https://api.yuzuapi.com"
$env:ANTHROPIC_AUTH_TOKEN = "sk-你的Key"
export ANTHROPIC_BASE_URL="https://api.yuzuapi.com"
export ANTHROPIC_AUTH_TOKEN="sk-你的Key"

启动

cd 你的项目目录
claude

在 Claude Code 中输入 /model 切换模型,/status 查看当前 Base URL 是否生效。

ChatGPT 配置教程

以 OpenAI 官方 Codex CLI 为例。

安装 Codex CLI

npm install -g @openai/codex

配置

编辑 ~/.codex/config.toml:

model_provider = "yuzu"
model = "gpt-5"

[model_providers.yuzu]
name = "Yuzu"
base_url = "https://api.yuzuapi.com/v1"
env_key = "YUZU_API_KEY"
wire_api = "responses"

设置 Key 环境变量(永久生效,设置后重开终端):

setx YUZU_API_KEY "sk-你的Key"
echo 'export YUZU_API_KEY="sk-你的Key"' >> ~/.zshrc

启动

codex

Gemini 配置教程

以 Google 官方 Gemini CLI 为例。

安装 Gemini CLI

npm install -g @google/gemini-cli

配置

setx GOOGLE_GEMINI_BASE_URL "https://api.yuzuapi.com"
setx GEMINI_API_KEY "sk-你的Key"
echo 'export GOOGLE_GEMINI_BASE_URL="https://api.yuzuapi.com"' >> ~/.zshrc
echo 'export GEMINI_API_KEY="sk-你的Key"' >> ~/.zshrc

启动

重开终端后运行,首次启动登录方式选择 Use Gemini API Key:

gemini

客户端配置

Cherry Studio、NextChat、LobeChat、Chatbox 等客户端,选择「OpenAI 兼容」类型并填写:

字段值
API 地址https://api.yuzuapi.com
API Keysk-你的Key
模型如 claude-sonnet-4-5、gpt-5、gemini-2.5-pro

部分客户端要求地址带 /v1,连接失败时尝试 https://api.yuzuapi.com/v1。

代码调用

使用 OpenAI SDK,修改 model 即可切换任意模型。

import OpenAI from "openai";

const client = new OpenAI({
  baseURL: "https://api.yuzuapi.com/v1",
  apiKey: process.env.YUZU_API_KEY,
});

const res = await client.chat.completions.create({
  model: "claude-sonnet-4-5",
  messages: [{ role: "user", content: "Hello" }],
});
console.log(res.choices[0].message.content);
import os
from openai import OpenAI

client = OpenAI(
    base_url="https://api.yuzuapi.com/v1",
    api_key=os.environ["YUZU_API_KEY"],
)

res = client.chat.completions.create(
    model="gpt-5",
    messages=[{"role": "user", "content": "Hello"}],
)
print(res.choices[0].message.content)
curl https://api.yuzuapi.com/v1/chat/completions \
  -H "Authorization: Bearer $YUZU_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"model": "gemini-2.5-pro", "messages": [{"role": "user", "content": "Hello"}]}'

常见问题

报错解决
command not found / 不是内部或外部命令重新打开终端;仍不行则重装对应工具
EACCESmacOS / Linux 在命令前加 sudo
禁止运行脚本Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
401 UnauthorizedKey 错误或已删除,检查是否多复制了空格
402 / 余额不足前往控制台充值
404 model not found模型名错误,对照价格查询

其他问题请 联系我们。