跳到主要内容

Codex CLI

Codex CLI 是 OpenAI 推出的运行在终端的 AI 编程智能体,能够读取本地代码库,通过自然语言交互完成代码编写、文件操作和命令执行等开发任务。

准备工作

codebuddy

配置步骤

Codex CLI 支持通过 config.toml 配置文件接入自定义模型。

配置字段对照表

字段解释
model大模型 ID,在 AI 控制台 模型列表复制已启用的大模型标识填入
model_provider提供商 ID,指向自定义的 [model_providers] 配置
base_url大模型 Base URL,在 AI 控制台中获取
env_keyAPI Key 对应的环境变量名

方式一:配置文件,永久生效

  1. 打开或创建 Codex CLI 配置文件
备注

如果通过您文件浏览器找到文件,文件浏览器默认会隐藏掉以"."开头的文件名的文件,您可能需要打开文件浏览器的隐藏文件选项才能看到。

Mac 通过访达快捷键 Command + Shift + . 打开,Windows 可以通过勾选 "文件资源管理器 - 查看 - 显示 - 隐藏项目" 打开。

  • Mac/Linux 配置路径
~/.codex/config.toml
  • Windows 配置路径
C:\Users\<你的用户名>\.codex\config.toml
  1. 填入以下配置
model = "hy3-preview"
model_provider = "cloudbase"

[model_providers.cloudbase]
name = "CloudBase"
base_url = "https://{{cloudBase环境ID}}.api.tcloudbasegateway.com/v1/ai/cloudbase"
env_key = "CLOUDBASE_API_KEY"
  1. 设置 API Key 环境变量

Mac/Linux(当前终端窗口有效)

export CLOUDBASE_API_KEY="eyJhbGciOiJSUzI1N..."

Windows CMD(当前终端窗口有效)

set CLOUDBASE_API_KEY=eyJhbGciOiJSUzI1N...

Windows PowerShell(当前终端窗口有效)

$env:CLOUDBASE_API_KEY = "eyJhbGciOiJSUzI1N..."
备注

以上环境变量为临时生效,关闭终端后失效。如需永久生效,可将环境变量写入 Shell 配置文件(如 ~/.zshrc~/.bashrc)中。

  1. 启动 Codex CLI
codex

方式二:命令行参数,临时生效

无需修改配置文件,通过命令行直接覆盖:

export CLOUDBASE_API_KEY="eyJhbGciOiJSUzI1N..."

codex --config model='"hy3-preview"' \
--config model_provider='"cloudbase"' \
--config 'model_providers.cloudbase.base_url="https://{{cloudBase环境ID}}.api.tcloudbasegateway.com/v1/ai/cloudbase"' \
--config 'model_providers.cloudbase.env_key="CLOUDBASE_API_KEY"'

常见错误排查

报错信息解决方法
404 模型未找到Base URL 填写不正确,请前往 AI 控制台中复制正确的 Base URL
401 Credentials are invalidAPI Key 填写错误,或者可能被删除
429 Token usage exceeded quota limit配置了错误的大模型名称,或者大模型未在 AI 控制台 中启用