Codex CLI 安装与配置指南

完整的 Codex CLI 安装和配置指南,集成 AI Code Editor 服务

10 分钟阅读

什么是 Codex CLI?

Codex CLI 是 OpenAI 官方的命令行界面,用于 AI 驱动的代码生成和辅助开发。 它让开发者能够在终端中直接使用强大的 AI 功能,实现更快的开发工作流程和智能代码补全。

通过 AI Code Editor 集成,您可以使用我们优化的 API 端点来运行 Codex CLI, 享受稳定的服务和有竞争力的价格。

前置要求

系统要求

  • Node.js 版本 18.0.0 或更高
  • npm 或 pnpm 包管理器
  • macOS、Linux 或 Windows 操作系统
  • 支持 UTF-8 的终端

AI Code Editor 账户

您需要一个带有有效 API 密钥的 AI Code Editor 账户。如果还没有账户:

  1. 访问 aicodeditor.com/dashboard
  2. 注册或登录您的账户
  3. 导航至 API 密钥部分
  4. 生成新的 API 密钥(格式:cr_xxxxxxxxxx)

安装

步骤 1:安装 Codex CLI

使用 npm 全局安装 Codex CLI:

npm install -g @openai/codex@latest

或使用 pnpm:

pnpm add -g @openai/codex@latest

步骤 2:验证安装

验证 Codex CLI 是否已成功安装:

codex --version

如果安装成功,您应该看到 Codex CLI 的版本号。

配置

步骤 1:配置 Codex 设置

创建或编辑配置文件 ~/.codex/config.toml

model_provider = "aicodeditor"
model = "gpt-5-codex"
model_reasoning_effort = "high"
disable_response_storage = true
preferred_auth_method = "apikey"

[model_providers.aicodeditor]
name = "aicodeditor"
base_url = "https://codex.aicodeditor.com/v1"
wire_api = "responses"

配置说明:

  • model_provider:设置为 "aicodeditor" 以使用 AI Code Editor 的 API
  • model:指定要使用的 AI 模型
  • model_reasoning_effort:设置为 "high" 以获得最佳效果
  • disable_response_storage:通过不存储响应来确保隐私
  • preferred_auth_method:使用 API 密钥认证
  • base_url:AI Code Editor 的 Codex API 端点

步骤 2:配置 API 认证

创建或编辑认证文件 ~/.codex/auth.json

{
    "OPENAI_API_KEY": "cr_xxxxxxxxxx"
}

重要提示:cr_xxxxxxxxxx 替换为您从 AI Code Editor 获得的实际 API 密钥。 这应该与您用于 Claude Code 的 API 密钥相同。

步骤 3:设置文件权限(Unix/Linux/macOS)

确保您的认证文件具有适当的权限:

chmod 600 ~/.codex/auth.json

基础用法

启动 Codex CLI

在您的项目目录中启动 Codex CLI:

cd /path/to/your/project codex

常用命令

命令描述
codex以交互模式启动 Codex CLI
codex --help显示帮助信息
codex --version显示版本信息
codex --config打开配置编辑器

使用示例

这里是使用 Codex CLI 生成代码的简单示例:

# 启动 Codex CLI
$ codex
# 要求 Codex 生成一个函数
> 创建一个 Python 函数来计算斐波那契数
# Codex 将为您生成代码

故障排除

常见问题及解决方案

1. 认证失败

错误:"认证失败" 或 "无效的 API 密钥"

解决方案:

  • 验证 ~/.codex/auth.json 中的 API 密钥是否正确
  • 确保 API 密钥以 cr_ 开头
  • 检查您的 API 密钥在 AI Code Editor 控制面板中是否处于活动状态

2. 找不到配置文件

错误:"找不到配置文件"

解决方案:

  • 如果 ~/.codex 目录不存在,请创建它
  • 确保 config.toml auth.json 文件都存在
  • 检查文件权限是否正确

3. 连接超时

错误:"请求超时" 或 "连接失败"

解决方案:

  • 检查您的互联网连接
  • 验证 config.toml 中的 base_url 是否正确
  • 如果在代理后面,请配置代理设置

获取帮助

如果遇到这里未涵盖的问题:

开始使用 Codex CLI 和 AI Code Editor

通过 Codex CLI 和我们优化的 API 服务体验 AI 辅助编码的强大功能