跳转至

Codex 接入 JarlessAPI 指南

本文档介绍如何安装 OpenAI Codex 并将其配置为通过 JarlessAPI 提供服务。

本页覆盖 Codex CLI（终端版）。第一次使用终端的用户，可以先完成 准备工作，再回来安装。桌面应用和网页产品的接入方式不在本页范围内。

前置条件

  • 已安装 Node.js 18 或更高版本（可执行 node --version 确认）
  • 已在 JarlessAPI 控制台创建 API Key，并确认该分组支持的模型 ID（参见 获取 API Key）

第一步：安装 Codex

在终端中执行以下命令，全局安装 Codex：

npm install -g @openai/codex

sudo npm install -g @openai/codex

npm install -g @openai/codex --registry=https://registry.npmmirror.com

安装完成后，执行以下命令验证安装是否成功：

codex --version

若终端输出版本号，则安装成功。

Node.js 版本要求

Codex 需要 Node.js 18 或更高版本。若 codex --version 执行报错，请先通过 node --version 确认 Node.js 版本是否满足要求。

第二步：创建配置文件

Codex 的配置存放于 ~/.codex/ 目录下（Windows 对应路径为 %USERPROFILE%\.codex\）。需要手动创建两个文件：config.toml 和 auth.json。

如何打开配置目录

按 Win + R，输入以下路径后回车，即可在文件资源管理器中打开配置目录：

%USERPROFILE%\.codex

若目录不存在，请手动创建该文件夹，再在其中新建对应文件。可使用记事本、VS Code 等文本编辑器进行编辑。

打开 Finder，按 Command + Shift + G，输入 ~/.codex 后回车。若目录不存在，请先在终端中执行 mkdir -p ~/.codex 创建该目录。可使用 TextEdit 或 VS Code 等编辑器打开文件。

在终端中执行以下命令创建目录（如已存在则跳过）：

mkdir -p ~/.codex

随后使用任意文本编辑器打开对应文件，例如 nano ~/.codex/config.toml。

写入 config.toml

在 ~/.codex/config.toml（Windows：%USERPROFILE%\.codex\config.toml）中写入以下内容：

示例使用 gpt-6-astra。如果所选分组支持其他模型，把 model 改为该分组支持的完整模型 ID。API Key 只需填写在下方的 auth.json 中。

approval_policy = "never"
sandbox_mode = "danger-full-access"
model_provider = "jarlessapi"
model = "gpt-6-astra"
model_reasoning_effort = "xhigh"
plan_mode_reasoning_effort = "xhigh"
model_reasoning_summary = "detailed"
model_verbosity = "high"
service_tier = "default"

[model_providers.jarlessapi]
name = "jarlessapi"
base_url = "https://jarlessapi.com/v1"
wire_api = "responses"
requires_openai_auth = true

写入 auth.json

在 ~/.codex/auth.json（Windows：%USERPROFILE%\.codex\auth.json）中写入以下内容：

{
  "auth_mode": "apikey",
  "OPENAI_API_KEY": "你所选分组的 API Key"
}

Codex 可以使用其他分组的 API Key。切换分组后，确保当前模型在新分组的支持列表中；日常切换模型可在对话中使用 /model。

已有旧配置时

若你已有旧的 Codex 配置文件，请确认 model_provider 字段未被其他 provider 配置覆盖。

第三步：启动 Codex

配置完成后，在终端中执行以下命令启动 Codex：

codex

Codex 将自动读取 ~/.codex/config.toml 和 ~/.codex/auth.json，连接至 JarlessAPI 服务。

需要换模型时，在 Codex 对话中输入 /model 并回车，选择当前分组支持的模型即可。如果列表中没有目标模型，再修改 config.toml 中的 model。参见 Codex 官方指令说明。

验证配置是否生效

若启动后遇到连接或鉴权错误，请检查以下内容：

  • config.toml 中的 base_url 是否为 https://jarlessapi.com/v1
  • auth.json 中的 OPENAI_API_KEY 是否为你当前所选分组的有效密钥
  • config.toml 中的 model 是否在该密钥所属分组的支持列表中
  • 修改配置文件后，是否已重启 Codex

更多排错方法，参见 常见错误排查。

接通以后，做第一个任务

在 练习文件夹 中启动 Codex，先让它列出当前目录，确认位置正确。然后进入 个人作品集网站、资料转汇报 PPT 或 文章转知识图卡，跟着完成第一份作品。

查看所有实战 →