Skip to content

Codex CLI ​

应用介绍 ​

Codex CLI 是运行在终端中的编程智能体,可以理解代码库、修改文件、执行命令并协助完成测试、重构和故障排查等开发任务。它适合习惯命令行工作流、希望在本地仓库中直接使用 AI 的开发者。Codex CLI 可以通过自定义模型提供方接入 OpenAI Responses API 兼容服务。

准备信息 ​

text
OpenAI Base URL:https://ai.example.edu.cn/v1
API Key:你的 API Key
模型名称:以模型聚合服务平台“模型广场”中显示的模型标识为准

接口兼容性

当前 Codex 自定义提供方使用 Responses API,请确认平台和所选模型支持 POST /v1/responses。仅支持 /v1/chat/completions 的模型不能直接用于当前 Codex CLI。

1. 安装 Codex CLI ​

macOS 或 Linux 可以使用官方安装脚本:

bash
curl -fsSL https://chatgpt.com/codex/install.sh | sh

安装后检查版本:

bash
codex --version

如果已经安装,可以再次运行安装脚本更新到最新版本。

2. 设置 API Key ​

macOS 或 Linux 当前终端可以执行:

bash
export CAMPUS_AI_API_KEY="你的 API Key"

这里只对当前终端会话生效。关闭终端后需要重新设置。需要长期使用时,可以用文本编辑器打开个人 Shell 配置:

bash
# Bash
${EDITOR:-nano} ~/.bashrc
source ~/.bashrc

# Zsh
${EDITOR:-nano} ~/.zshrc
source ~/.zshrc

在对应文件中添加 export CAMPUS_AI_API_KEY="你的 API Key"。使用编辑器可以避免真实密钥直接出现在命令历史中。

Windows PowerShell 可以执行:

powershell
$env:CAMPUS_AI_API_KEY = "你的 API Key"

不要把 Key 写进仓库

不要把真实 API Key 写进项目的 .env、脚本、config.toml 或其他可能提交到 Git 的文件。为 Codex 创建独立 Key,并设置合适的模型权限和额度。

3. 编辑 config.toml ​

Codex 的用户级配置文件位置如下:

操作系统配置文件
macOS / Linux~/.codex/config.toml
Windows%USERPROFILE%\.codex\config.toml

macOS 或 Linux 可以执行:

bash
mkdir -p ~/.codex
${EDITOR:-nano} ~/.codex/config.toml

写入以下配置,并将模型名称替换为模型广场中支持 Responses API 的模型标识:

toml
model_provider = "campus-ai"
model = "gpt-5.6-luna"
model_reasoning_effort = "medium"

[model_providers.campus-ai]
name = "校园 AI"
base_url = "https://ai.example.edu.cn/v1"
env_key = "CAMPUS_AI_API_KEY"
wire_api = "responses"
requires_openai_auth = false

各字段作用如下:

字段作用
model_provider选择下面定义的 campus-ai 提供方
model实际发送给平台的模型标识
model_reasoning_effort推理强度;模型不支持时可删除这一行
base_urlOpenAI 兼容接口地址,末尾包含 /v1
env_key告诉 Codex 从哪个环境变量读取 API Key
wire_api使用 Responses API 协议
requires_openai_auth不使用 OpenAI 官方账号登录,改用自定义提供方密钥

已有 Codex 配置

如果 config.toml 已经存在,请合并配置,不要创建第二个同名 [model_providers.campus-ai]。原有的 MCP、权限或界面设置可以保留。

4. 启动并验证 ​

确认 API Key 环境变量存在,但不要打印完整密钥:

bash
test -n "$CAMPUS_AI_API_KEY" && echo "API Key 已设置" || echo "API Key 未设置"

然后进入一个可信项目并启动 Codex:

bash
cd /path/to/your/project
codex

启动后:

  1. 执行 /status,确认模型提供方为 campus-ai,Base URL 指向模型聚合服务平台。
  2. 执行 /model,检查当前模型是否为配置的模型标识。
  3. 先发送只读测试任务,例如“请概括这个项目的目录结构,不要修改文件”。
  4. 确认响应正常后,再尝试需要编辑文件的任务。

可选:仅本次启动覆盖模型 ​

不修改配置文件时,可以在启动命令中临时指定模型:

bash
codex --model gpt-5.6-luna

模型名称仍需替换为当前 API Key 有权限使用的实际模型标识。

安全建议 ​

  • 只在可信仓库中启动 Codex。
  • 首次使用时选择保守的权限配置,执行命令和写文件前检查目标范围。
  • 使用 Git 保存任务前后的检查点,并认真审阅 git diff。
  • 在 .gitignore 中排除 .env、证书、密钥和本地数据。
  • 不要让 Codex 读取未经授权的业务数据、个人隐私或生产环境凭据。

配置字段以 OpenAI Codex 配置参考 为准;安装和基本使用方式见 Codex CLI 官方文档。

配置过程中遇到账号、API Key、接口地址、模型权限、额度、限流或通用错误时,请查看常见问题(FAQ)。