优云API 优云API 文档

yycode × Codex 快速开始指南

前置条件:安装 Node.js 环境

Codex 依赖 Node.js 运行环境,请先参考 Node.js 环境安装指南 完成安装并验证。

更省事的方式:自动配置

如果你不想手动安装和逐项写配置,推荐直接使用 自动配置工具


1. 安装 Codex

# Windows
npm install -g @openai/codex@latest

# macOS / Linux
sudo npm install -g @openai/codex@latest

验证安装:

codex --version

输出版本号即表示安装成功。


2. 创建 API Key

登录 yycode 控制台,进入 令牌管理 页面,点击 添加令牌


填写密钥名称,选择Codex分组(模型和倍率),按需配置 IP 限制、额度限制、模型限制和有效期。新手建议直接使用默认配置。

安全提示:API Key 等同于账号凭证,请妥善保管,切勿提交到代码仓库或公开分享。


3. 导入密钥到 Codex

创建配置目录

# Windows (PowerShell)
if (Test-Path "$env:USERPROFILE\.codex") { Remove-Item -Recurse -Force "$env:USERPROFILE\.codex" }
mkdir "$env:USERPROFILE\.codex"
# macOS / Linux
rm -rf ~/.codex && mkdir -p ~/.codex

创建 config.toml

~/.codex/(Windows 为 %USERPROFILE%\.codex\)目录下创建 config.toml

model = "gpt-5.5"
model_provider = "yycode"

[model_providers.yycode]
name = "yycode New API"
base_url = "https://yycode.net/v1"
wire_api = "responses"
requires_openai_auth = true

创建 auth.json

点击密钥旁的 复制 按钮获取 API Key:

在同一目录下创建 auth.json,将 YOUR_API_KEY 替换为你在控制台创建的密钥:

{
  "auth_mode": "apikey",
  "OPENAI_API_KEY": "这里填你在平台创建的 API Key"
}

4. 开始使用

进入任意项目目录,运行:

codex

Codex 会自动分析当前目录的代码并提供智能编程辅助。更多用法请参考 OpenAI 官方文档


常见问题(FAQ)

Q:运行 npm install -g 提示权限不足?
A:macOS / Linux 在命令前加 sudo;Windows 使用管理员权限运行 PowerShell。

Q:codex --version 提示命令不存在?
A:确认 npm 全局目录已加入系统 PATH,可运行 npm bin -g 查看路径并手动添加。

Q:连接失败或返回 401 错误?
A:检查 config.tomlbase_url 是否为 https://yycode.net,以及 auth.json 中的 API Key 是否正确且未过期。

Q:如何切换不同模型或倍率?
A:在 yycode 控制台 创建不同分组的密钥,更新 auth.json 中的 Key,或通过 CC Switch 在多个配置间快速切换。

整篇文档已复制