CodeRoute
开始使用
接入文档

快速接入 CodeRoute

选择客户端查看对应配置教程，复制命令即可接入 CodeRoute。

Node.js 环境安装教程

在 Windows、macOS、Linux 安装 Node.js LTS，并验证 node/npm 命令可用。

Windows

前往 Node.js 官网下载 LTS 版本，双击安装包按提示安装即可。也可用包管理器：

powershell
choco install nodejs-lts
powershell
scoop install nodejs-lts

macOS

前往 Node.js 官网下载 macOS 安装包，或用 Homebrew：

bash
brew install node

Linux

bash
curl -fsSL https://deb.nodesource.com/setup_lts.x | sudo -E bash -
sudo apt-get install -y nodejs
bash
curl -fsSL https://rpm.nodesource.com/setup_lts.x | sudo bash -
sudo yum install -y nodejs

验证安装

安装完成后，在终端执行：

bash
node --version
npm --version

如果能输出版本号，说明 Node.js 与 npm 已可用。

下一步

环境就绪后，继续完成 Claude Code、Codex 或其他客户端配置教程即可接入 CodeRoute。

Claude Code 配置教程

用一键脚本安装并接入 CodeRoute。脚本会自动检测 Node.js 和 Claude Code，缺失时按提示安装并写入配置。复制命令不包含密钥。

按系统选择一键脚本

复制对应系统命令，运行后输入 API Key 即可。

powershell
irm https://coderoute.cc/install/claude-code.ps1 | iex
powershell
curl -fsSL https://coderoute.cc/install/claude-code.sh | bash
💡
配置写入后，已打开的 CLI 需要重启后才会读取新配置。Claude Code 终端同理。

备用方式：手动安装 Claude Code

⚠️
手动安装前请先完成 Node.js 环境安装教程。

第一步：安装 Claude Code

bash
sudo npm install -g @anthropic-ai/claude-code
bash
npm install -g @anthropic-ai/claude-code
bash
curl -fsSL https://claude.ai/install.sh | bash
bash
irm https://claude.ai/install.ps1 | iex

验证安装：

bash
claude --version

第二步：配置环境变量

把下面的值写入当前终端或系统环境变量。

临时设置（当前会话）

powershell
$env:ANTHROPIC_BASE_URL = "https://api.coderoute.cc"
$env:ANTHROPIC_AUTH_TOKEN = "your-key"
$env:CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC = "1"
cd your-project
claude
powershell
export ANTHROPIC_BASE_URL=https://api.coderoute.cc
export ANTHROPIC_AUTH_TOKEN=your-key
export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1
cd your-project
claude

永久设置

powershell
[System.Environment]::SetEnvironmentVariable("ANTHROPIC_BASE_URL", "https://api.coderoute.cc", [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable("ANTHROPIC_AUTH_TOKEN", "your-key", [System.EnvironmentVariableTarget]::User)
[System.Environment]::SetEnvironmentVariable("CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC", "1", [System.EnvironmentVariableTarget]::User)
powershell
echo 'export ANTHROPIC_BASE_URL=https://api.coderoute.cc' >> ~/.zshrc
echo 'export ANTHROPIC_AUTH_TOKEN=your-key' >> ~/.zshrc
echo 'export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1' >> ~/.zshrc
source ~/.zshrc
powershell
echo 'export ANTHROPIC_BASE_URL=https://api.coderoute.cc' >> ~/.bashrc
echo 'export ANTHROPIC_AUTH_TOKEN=your-key' >> ~/.bashrc
echo 'export CLAUDE_CODE_DISABLE_NONESSENTIAL_TRAFFIC=1' >> ~/.bashrc
source ~/.bashrc

第三步：开始使用

进入项目目录后运行：

bash
claude

启动后，Claude Code 会分析当前目录的代码，并提供智能编程辅助。

更多使用说明请参考 Anthropic 官方文档。

Codex (OpenAI) 配置教程

安装并配置 Codex，通过 ~/.codex 连接 CodeRoute 平台。

按系统选择一键脚本

脚本会自动检测 Node.js 和 Codex CLI，缺失时引导安装；随后提示输入 API Key，并写入 ~/.codex 配置。复制命令不包含密钥。

powershell
irm https://coderoute.cc/install/codex.ps1 | iex
powershell
curl -fsSL https://coderoute.cc/install/codex.sh | bash
💡
配置写入 ~/.codex 后，Codex CLI 和 Codex App 客户端会同时生效；已打开的 CLI 需要重启后才会读取新配置。

备用方式：手动安装 Codex

⚠️
手动安装前请先完成 Node.js 环境安装教程。

第一步：安装 Codex

bash
sudo npm install -g @openai/codex@latest
bash
npm install -g @openai/codex@latest

以上命令会从 npm 官方仓库下载并安装最新版本的 Codex 工具。

bash
codex --version

如果显示版本号，恭喜你！Codex 已经成功安装了。

第二步：创建配置文件

Codex 使用配置文件进行连接设置，需要创建 config.toml 和 auth.json 两个文件。

bash
# 创建配置目录（已有配置会被下面两条命令覆盖，建议先自行备份）
mkdir -p ~/.codex

# 创建 config.toml
cat > ~/.codex/config.toml << 'EOF'
model_provider = "codex"
model = "gpt-5.6-sol"
review_model = "gpt-5.6-sol"
model_reasoning_effort = "high"
disable_response_storage = true
network_access = "enabled"
windows_wsl_setup_acknowledged = true
model_context_window = 272000
model_auto_compact_token_limit = 272000
effective_context_window_percent = 95

[model_providers.codex]
name = "codex"
base_url = "https://api.coderoute.cc/v1"
wire_api = "responses"
requires_openai_auth = true
supports_websockets = false
http_headers = { "x-openai-actor-authorization" = "coderoute" }
EOF

# 创建 auth.json
cat > ~/.codex/auth.json << 'EOF'
{
  "OPENAI_API_KEY": "YOUR_API_KEY"
}
EOF
bash
# 创建配置目录（已有配置会被下面的命令覆盖，建议先自行备份）
New-Item -ItemType Directory -Force -Path "$env:USERPROFILE\.codex" | Out-Null
$utf8NoBom = New-Object System.Text.UTF8Encoding($false)

# 创建 config.toml
$config = @'
model_provider = "codex"
model = "gpt-5.6-sol"
review_model = "gpt-5.6-sol"
model_reasoning_effort = "high"
disable_response_storage = true
network_access = "enabled"
windows_wsl_setup_acknowledged = true
model_context_window = 272000
model_auto_compact_token_limit = 272000
effective_context_window_percent = 95

[model_providers.codex]
name = "codex"
base_url = "https://api.coderoute.cc/v1"
wire_api = "responses"
requires_openai_auth = true
supports_websockets = false
http_headers = { "x-openai-actor-authorization" = "coderoute" }
'@
[System.IO.File]::WriteAllText("$env:USERPROFILE\.codex\config.toml", $config, $utf8NoBom)

# 创建 auth.json
$auth = @'
{
  "OPENAI_API_KEY": "YOUR_API_KEY"
}
'@
[System.IO.File]::WriteAllText("$env:USERPROFILE\.codex\auth.json", $auth, $utf8NoBom)

第三步：开始使用

进入项目目录后运行：

bash
codex

更多使用说明请参考 OpenAI 官方文档。

TRAE SOLO 配置教程

在 TRAE SOLO 中添加自定义模型，分别接入 Codex 和 Claude 通道。

第一步：进入自定义模型配置

  1. 打开设置
  2. 添加模型
  3. 自定义配置

第二步：按模型类型填写配置

Codex 模型配置

OpenAI / Codex 地址使用 https://api.coderoute.cc/v1。

Claude 模型配置

Claude / Anthropic 地址使用 https://api.coderoute.cc。

OpenClaw 配置教程

通过 CodeRoute 接入 OpenClaw。推荐使用一键脚本，按提示选择 Anthropic（Claude）或 OpenAI（Codex）通道。

推荐方式：交互式一键脚本

运行后选择通道并输入 API Key，脚本会写入 OpenClaw 配置。

bash
curl -fsSL https://coderoute.cc/install/openclaw.sh | bash
bash
irm https://coderoute.cc/install/openclaw.ps1 | iex

备用方式：手动安装 OpenClaw

通过 npm 全局安装：

bash
npm install -g @openclaw/cli

Anthropic（Claude）

Claude / Anthropic 接口不要带 /v1，示例模型：claude-opus-4-6。

bash
export ANTHROPIC_API_KEY="YOUR_API_KEY"
openclaw onboard --auth-choice custom-api-key \
  --custom-base-url https://api.coderoute.cc \
  --custom-api-key-env ANTHROPIC_API_KEY \
  --custom-compatibility anthropic \
  --custom-model claude-opus-4-6

OpenAI（Codex）

OpenAI / Codex 接口必须带 /v1，示例模型：gpt-5.6-sol。

第三步：开始使用

bash
openclaw

Hermes 配置教程

通过 CodeRoute 接入 Hermes。推荐使用一键脚本选择通道并写入配置。

推荐方式：交互式一键脚本

运行后选择通道并输入 API Key，脚本会写入 ~/.hermes/config.yaml。

bash
curl -fsSL https://coderoute.cc/install/hermes.sh | bash
bash
irm https://coderoute.cc/install/hermes.ps1 | iex

备用方式：手动安装 Hermes

通过 pipx 安装：

bash
pipx install hermes-agent

手动写入配置文件：

yaml
mkdir -p ~/.hermes
cat > ~/.hermes/config.yaml << 'EOF'
model:
  default: claude-opus-4-7
  provider: coderoute-claude
providers:
  coderoute-claude:
    api_mode: anthropic_messages
    base_url: https://api.coderoute.cc
    api_key: YOUR_API_KEY
    default_model: claude-opus-4-7
    models:
      - claude-opus-4-7
EOF

第三步：开始使用

bash
hermes

API脚本 接入教程

下面示例覆盖文本、视觉、图片和视频接口。复制后把 YOUR_API_KEY 替换为你的密钥即可运行。

OpenAI Responses 文本+视觉

新一代 OpenAI 接口，适合文本对话、图片理解和流式输出。

bash
curl https://api.coderoute.cc/v1/responses \
  -H "Authorization: Bearer $CODEROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-5.6-sol",
    "input": "用 Python 写一个快速排序",
    "stream": false
  }'

OpenAI Chat Completions 文本+视觉

兼容传统 OpenAI Chat 格式，适合已有客户端平滑迁移。

bash
curl https://api.coderoute.cc/v1/chat/completions \
  -H "Authorization: Bearer $CODEROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "kimi-k2.7-code",
    "messages": [
      {"role": "user", "content": "用 Python 写一个快速排序"}
    ]
  }'

Anthropic Messages 文本+视觉

Claude / Anthropic Messages 格式；图片模式会先转 base64 再提交。

bash
curl https://api.coderoute.cc/v1/messages \
  -H "x-api-key: $CODEROUTE_API_KEY" \
  -H "anthropic-version: 2023-06-01" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "claude-opus-4-6",
    "max_tokens": 1024,
    "messages": [
      {"role": "user", "content": "用 Python 写一个快速排序"}
    ]
  }'

gpt-image-2 图片生成

文生图走 /v1/images/generations；带参考图的图生图走 /v1/images/edits。

bash
curl https://api.coderoute.cc/v1/images/generations \
  -H "Authorization: Bearer $CODEROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-image-2",
    "prompt": "一只戴眼镜的橘猫，像素艺术风格",
    "size": "1024x1024"
  }'

gpt-image-2 图片编辑

上传图片并按提示修改，通过流式事件保存编辑结果。

bash
curl https://api.coderoute.cc/v1/images/edits \
  -H "Authorization: Bearer $CODEROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "gpt-image-2",
    "image": {"url": "https://example.com/a.png"},
    "prompt": "把背景换成赛博朋克城市"
  }'
⚠️
常见报错：若返回 “expected struct ImageUrl”，说明 image 字段被直接写成了字符串。正确写法：{"image": {"url": "..."}}；传本地图片时把 url 换成 data URL，例如 data:image/png;base64,<BASE64>。

grok-imagine-video 视频生成

异步视频生成：提交任务拿到 request_id，轮询状态直到完成，再下载视频文件。

bash
# 提交生成任务
curl https://api.coderoute.cc/v1/videos/generations \
  -H "Authorization: Bearer $CODEROUTE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "grok-imagine-video",
    "prompt": "城市夜景延时摄影，4K",
    "resolution": "720p",
    "duration": 8
  }'

# 轮询任务状态
# GET /v1/videos/{request_id}  →  返回 status 与 video.url
# 完成后用 GET /v1/videos/{request_id}/content 下载视频字节流

resolution 支持 480p / 720p，duration 默认 8 秒、可选 1–15 秒，按秒计费。video.url 为临时签名直链，请及时下载保存。

关于支持的客户端

CodeRoute 提供 OpenAI 与 Anthropic 双兼容协议，覆盖 GLM、DeepSeek、Kimi、Qwen 等编码模型，因此任何走 OpenAI 或 Anthropic 兼容协议的客户端均可接入（Claude Code、Codex、Cursor、OpenAI SDK、OpenClaw、Hermes、Continue、Cline 等）。

各客户端配置项随版本可能调整，具体以对应客户端官方文档为准；如遇接入问题可扫码联系团队协助。