Skip to content

Codex 接入指南

Codex 是 OpenAI 推出的终端 AI 编程助手,可以在终端中通过自然语言命令交互,帮助开发者快速完成代码生成、调试、重构等任务。

1. 获取 API Key

2. 安装 Codex

前置条件:Node.js 18.0 或更高版本

1: 安装 Codex

注意:必须安装指定版本 0.80.0

bash
npm install -g @openai/codex@0.80.0

2: 验证安装

bash
codex --version

安装

3. 配置接入凭证

配置文件路径取决于操作系统,请确保路径正确,否则配置不会生效。

1: 创建配置文件

  • macOS / Linux:~/.codex/config.toml
  • Windows:C:\Users\你的用户名\.codex\config.toml

复制如下内容到配置文件,将 <OPENAI_API_MODEL> 替换为您开通的模型名称:

注意:env_key 不需要修改

toml
model_provider = "EazyDevelop"
model = "<OPENAI_API_MODEL>"
[model_providers.EazyDevelop]
name = "EazyDevelop"
base_url = "https://api-maas.eazytec-cloud.com/v1"
env_key = "EAZYDEVELOP_API_KEY"
wire_api = "chat"

2: 配置环境变量

<OPENAI_API_KEY> 替换为 EazyDevelop 开通的 API 密钥。

macOS / Linux:

  1. 在终端中执行以下命令,查看默认 Shell 类型:

    bash
    echo $SHELL
  2. 根据 Shell 类型设置环境变量:

    Shell 类型命令
    Zshecho 'export EAZYDEVELOP_API_KEY="<OPENAI_API_KEY>"' >> ~/.zshrc
    Bashecho 'export EAZYDEVELOP_API_KEY="<OPENAI_API_KEY>"' >> ~/.bashrc
  3. 执行以下命令使环境变量生效:

    Shell 类型命令
    Zshsource ~/.zshrc
    Bashsource ~/.bashrc

Windows:

打开 CMD 命令行,执行如下命令:

<OPENAI_API_KEY> 替换为您开通的 API 密钥

cmd
setx EAZYDEVELOP_API_KEY "<OPENAI_API_KEY>"

验证环境变量是否生效:

cmd
echo %EAZYDEVELOP_API_KEY%

配置

4. 开始使用

配置完成后,新建终端窗口,执行以下命令启动 Codex 即可开始对话:

bash
codex

请无视红色警告

对话

注意事项

  • 必须安装指定版本 0.80.0,其他版本可能无法正常工作
  • 配置文件路径不要写错,可以通过 echo $HOME(macOS/Linux)查看主目录路径
  • Windows 设置环境变量后需要重新打开终端窗口才能生效
  • config.toml 中的 env_key 不需要修改,保持 EAZYDEVELOP_API_KEY 即可

相关链接