Codex CLI
Codex CLI 是 OpenAI 官方推出的终端智能编程助手(CLI Agent)。它能够在本地计算机上自主分析代码仓库、执行终端命令、通过原子补丁(apply_patch)安全编辑文件,为开发者提供高效的命令行自主编程工作流。
✨ AI 一键配置
复制下方提示词发送给您的 AI 助手,即可自动完成环境探测与安装配置:
AI 配置提示词 (Prompt)
点击卡片任意位置复制
请参考 OpenRely 官方文档(https://openrely.ai/zh/docs/apps/codex-cli)帮我配置当前机器的 Codex CLI:
1. 获取密钥:若我尚未提供 API 密钥,请先提醒我前往 OpenRely 控制台(https://api.openrely.ai/keys)创建并输入
2. 安装环境:检查本机是否已安装 Codex CLI,若未安装则执行 npm install -g @openai/codex
3. 配置文件:创建 ~/.codex 目录,写入配置文件 ~/.codex/config.toml:
model_provider = "custom"
disable_response_storage = true
[model_providers.custom]
name = "custom"
base_url = "https://api.openrely.ai/v1"
wire_api = "responses"
在 ~/.codex/auth.json 中写入 {"OPENAI_API_KEY": "<我的_API_KEY>"}(文件权限设置为 600)。
关于模型选择:无需硬编码特定模型版本,Codex 会话内可直接输入 /model 动态选取最新模型(支持的模型列表可参考 OpenRely 模型广场 https://api.openrely.ai/pricing)
4. 验证就绪:执行 codex --version 检查安装状态,并提示我直接输入 codex 开启编程会话
🔑 准备
1登录控制台
api.openrely.ai/sign-in前往 ↗
2获取 API Key
api.openrely.ai/keys
sk-...3填写服务地址点击复制
https://api.openrely.ai/v1
🚀 步骤
全局安装 CLI
Codex CLI 是 OpenAI 推出的终端编程助手。通过 npm 全局安装官方 CLI 包,安装后即可在终端直接调用 codex 命令:
npm install -g @openai/codex配置端点与密钥
Codex CLI 使用用户主目录下的 ~/.codex/config.toml 与 ~/.codex/auth.json 存储服务端点与鉴权凭据:
在终端中执行以下命令,一键写入配置目录与凭据文件:
# 1. 创建配置目录
mkdir -p ~/.codex
# 2. 写入自定义服务接入点(指向 OpenRely)
cat > ~/.codex/config.toml <<EOF
model_provider = "custom"
disable_response_storage = true
[model_providers.custom]
name = "custom"
base_url = "https://api.openrely.ai/v1"
wire_api = "responses"
EOF
# 3. 写入您的 OpenRely API Key
cat > ~/.codex/auth.json <<EOF
{
"OPENAI_API_KEY": "sk-your-openrely-api-key"
}
EOF
chmod 600 ~/.codex/config.toml ~/.codex/auth.json在 PowerShell 窗口中运行以下命令完成配置写入:
# 1. 创建配置目录
New-Item -ItemType Directory -Force -Path "$HOME\.codex"
# 2. 写入自定义服务接入点(指向 OpenRely)
@"
model_provider = "custom"
disable_response_storage = true
[model_providers.custom]
name = "custom"
base_url = "https://api.openrely.ai/v1"
wire_api = "responses"
"@ | Out-File -Encoding utf8 "$HOME\.codex\config.toml"
# 3. 写入您的 OpenRely API Key
@"
{
"OPENAI_API_KEY": "sk-your-openrely-api-key"
}
"@ | Out-File -Encoding utf8 "$HOME\.codex\auth.json"启动与验证
进入您的代码项目根目录,运行 codex 启动交互式会话:
codex首次进入交互界面后,您可以:
- 输入
/model挑选或核对当前使用的模型; - 发送一条测试指令验证 API 连通性:
> 解释当前项目的整体架构设计若能正常流式返回回复,即表示已成功接入 OpenRely。
💡 常用
在 Codex CLI 交互会话中,常用的内置快捷指令:
| 指令 | 说明 |
|---|---|
/model | 交互式查看与实时切换模型(随时选用最新模型) |
/help | 查看所有内置命令与配置选项 |
/clear | 清空当前对话上下文,开启全新任务 |
/exit | 退出 Codex CLI 会话 |
❓ 常见问题
遇到其他调用报错或计费疑问?请查阅完整的 常见问题与排障指南。
这篇文档对您有帮助吗?