跳转到内容

Codex 安装与配置

Codex 是 OpenAI 提供的本地运行 AI 编程助手,可以在您的本地环境中提供智能代码补全、代码解释、错误修复等功能。作为 OpenAI 生态系统的本地 AI 编程工具,Codex 支持 ChatGPT 账号和 API Key 两种认证方式。

  • 需要 OpenAI 生态集成:如果您已经在使用 ChatGPT 或其他 OpenAI 服务,Codex 可以无缝衔接
  • 偏好简单认证:支持使用 ChatGPT 账号直接登录,无需单独配置 API Key
  • 海外网络环境:在能够直接访问 OpenAI 服务的网络环境下体验最佳
  • Hagicode 多模型支持:作为 Hagicode 的 executor 选项之一,支持多模型切换

通过 NPM 可以非常方便地安装 Codex。请确保您已经安装了 Node.js 环境。

Terminal window
npm install -g @openai/codex

安装完毕之后,可以通过以下命令验证安装是否成功:

Terminal window
codex --version

Codex 支持两种认证方式:使用 ChatGPT 账号登录(推荐)或使用 API Key。

这是最简单的方式,无需单独配置 API Key。

Terminal window
codex login

运行此命令后,Codex 会打开浏览器引导您完成 ChatGPT 账号登录流程。

如果您希望使用 API Key 进行认证,可以按照以下步骤操作。

  1. 访问 OpenAI API Keys 页面
  2. 创建新的 API Key
  3. 设置环境变量:
Terminal window
export OPENAI_API_KEY="your-api-key-here"

或者将以下配置添加到您的 Shell 配置文件中(如 ~/.bashrc~/.zshrc):

Terminal window
echo 'export OPENAI_API_KEY="your-api-key-here"' >> ~/.bashrc
source ~/.bashrc

完成安装和认证配置后,您可以启动 Codex 开始使用:

Terminal window
codex

首次运行时,Codex 会引导您完成初始化配置,包括:

  • 选择默认模型
  • 配置代理设置(如需要)
  • 设置偏好选项

以下是 Codex 的常用命令:

Terminal window
# 启动 Codex 交互式模式
codex
# 查看 Codex 版本信息
codex --version
# 查看帮助信息
codex --help
# 登录 ChatGPT 账号
codex login
# 退出登录
codex logout
# 查看当前配置
codex config
# 运行单次查询
codex ask "如何实现一个快速排序算法?"

Codex 需要访问 OpenAI 的服务,因此对网络环境有一定要求:

  • 海外网络:直接使用,无需额外配置
  • 国内网络:需要配置代理或使用网络优化服务

如果您在国内网络环境下使用,建议:

  1. 配置系统级代理
  2. 设置 HTTP/HTTPS 代理环境变量:
Terminal window
export HTTP_PROXY="http://proxy.example.com:8080"
export HTTPS_PROXY="http://proxy.example.com:8080"
  1. 或在 Codex 配置文件中设置代理

Codex 使用 OpenAI 的 API 服务,按照以下方式计费:

  • ChatGPT Plus 订阅:如果您拥有 ChatGPT Plus 订阅,可以使用 Codex 而无需额外付费
  • API 按量计费:使用 API Key 时,按照实际使用量计费,具体费率请参考 OpenAI 定价页面

💡 提示:如需了解更多详细信息,请访问 Codex 官方文档