Codex

Codex CLI 是 OpenAI 官方的终端编程代理。TokenByte 的 OpenAI 兼容端点可直接替代官方地址，推荐通过 ~/.codex/config.toml + auth.json 的方式持久化配置。

前置条件

Node.js 20 及以上（下载）
Windows 建议同时安装 Git；macOS / Linux 可免装
已在 TokenByte 控制台创建 API Key

配置

安装 Codex CLI

sudo npm install -g @openai/codex

在 CMD 或 PowerShell 中运行：

npm install -g @openai/codex

验证安装

codex --version

输出形如 codex-cli 0.41.0 即安装成功。

配置 TokenByte 接入

在用户主目录下的 .codex 文件夹中创建 config.toml：

model = "<从模型页复制的模型名称>"

model_provider = "custom"

model_reasoning_effort = "high"

disable_response_storage = true

[model_providers.custom]

name = "custom"

base_url = "https://api.tokenbyte.ai/v1"

wire_api = "responses"

其中 model 必须填写模型广场或控制台 · 模型市场中模型卡片标题显示的完整名称。

然后在 .codex 目录下创建 auth.json，写入 API Key：

{
  "OPENAI_API_KEY": "<API密钥创建的密钥>"
}

将 <API密钥创建的密钥> 替换为在控制台 · API 密钥中创建的完整 Key（形如 sk-tb-...）。

Windows 用户目录下若无 .codex 文件夹，需手动创建。资源管理器默认隐藏以 . 开头的目录，可在 查看 → 显示 → 隐藏的项目 中打开显示，或直接用 mkdir .codex 新建。

启动并测试

在任意项目目录下运行：

codex

出现欢迎界面后，输入一句话即可验证：

你好，帮我看看这段代码

若能返回模型回复，说明已接入 TokenByte。

VS Code 插件（可选）

终端侧验证无误后，再连接 VS Code 插件，可减少排错范围。

在扩展市场搜索 Codex，只安装带有 OpenAI 官方认证标识的那一款，避免同名第三方扩展。
插件会自动读取 ~/.codex/config.toml 与 auth.json，无需在 VS Code 中重复填写。

如果终端里 codex 还没跑通，直接装插件通常会因为环境变量或配置路径问题报错，优先回到终端定位。

遇到问题？参考常见问题。