Skip to content

Agentsflare Codex 配置方案

Codex 是 OpenAI 推出的官方 CLI 编码工具,支持自然语言指令完成代码编写、调试和重构。

安装 Codex

通过 npm 全局安装:

bash
npm install -g @openai/codex

或通过 npx 直接运行(无需安装):

bash
npx @openai/codex

验证安装:

bash
codex --version

使用 Agentsflare 配置 Codex

Codex 使用 TOML 配置文件,不是 YAML。可参考 OpenAI 官方的基础配置文档配置参考。要确保请求走 Agentsflare,而不是 Codex 内置的 OpenAI provider,必须显式声明自定义 provider,并将其设为默认 provider。

1. 创建用户级配置文件

创建或修改以下文件:

  • macOS / Linux~/.codex/config.toml
  • Windows%USERPROFILE%\\.codex\\config.toml

将以下内容写入 config.toml

toml
model = "gpt-5.3-codex"
model_provider = "agentsflare"

[model_providers.agentsflare]
name = "Agentsflare"
base_url = "https://api.agentsflare.com/v1"
env_key = "AGENTSFLARE_API_KEY"
requires_openai_auth = false
wire_api = "responses"

2. 提供 Agentsflare API Key

启动 Codex 前设置环境变量:

bash
export AGENTSFLARE_API_KEY="你的 Agentsflare API Key"
codex

Windows PowerShell:

powershell
$env:AGENTSFLARE_API_KEY = "你的 Agentsflare API Key"
codex

env_key 表示 API Key 从哪个环境变量读取。请将 Key 保存在环境变量中,不要写入 config.toml;也不要只设置 OPENAI_API_KEY,该变量对应 Codex 内置的 OpenAI provider,不能选择 Agentsflare provider。

Endpoint 配置规则

本配置使用 Responses API,这是 Codex 此 provider 应使用的协议:

项目
config.toml 中的 provider base URLhttps://api.agentsflare.com/v1
Codex 实际发送的请求POST https://api.agentsflare.com/v1/responses
必须设置的 wire_api"responses"

base_url 不要写成 /responses/chat/completions 结尾。Codex 会根据 wire_api 自动拼接请求路径,写完整 Endpoint 可能导致路径重复。此次集成不要将 wire_api 配置为 "chat"

之前的配置为什么仍会走 OpenAI 地址

之前的示例可能因以下原因没有生效:

  1. ~/.codex/config.yaml 不是 Codex 的用户配置文件,正确文件名是 ~/.codex/config.toml
  2. 顶层的 api_keybase_url 不会定义已选中的自定义 provider。必须在 [model_providers.<id>] 下声明 provider,并通过 model_provider 指向该 ID。
  3. OPENAI_BASE_URLOPENAI_API_KEY 配置的是内置 OpenAI 路径,不会替代上面的自定义 provider 选择。
  4. 项目目录下的 .codex/config.toml 不能覆盖机器级 provider 配置。model_provider[model_providers.agentsflare] 必须放在用户级 ~/.codex/config.toml 中。

验证当前实际路由

先运行诊断:

bash
codex doctor

报告中应看到:

  • ~/.codex/config.toml 加载配置;
  • 默认 model provider 为 agentsflare
  • 不要求 OpenAI authentication;
  • custom API base URL 为 https://api.agentsflare.com/v1
  • provider 路由可访问。

然后发送一次真实请求:

bash
codex exec --skip-git-repo-check "只回复:AGENTSFLARE_OK"

如果仍然访问 OpenAI 地址,请检查 model_provider = "agentsflare" 是否位于用户级配置的顶层、配置段名称是否严格为 [model_providers.agentsflare],以及启动时是否使用了 --ignore-user-config 或不同的 CODEX_HOME

常用命令

启动交互式会话:

bash
codex

直接执行单条指令:

bash
codex "把 utils.js 重构成 TypeScript"

指定模型启动:

bash
codex --model gpt-5.3-codex

查看帮助:

bash
codex --help

本文档遵循 CC BY-SA 4.0 协议。