API 文档

Codex 配置

什么是 Codex

OpenAI Codex 是 OpenAI 推出的 AI 编程命令行工具,可在终端中直接让 AI 读写代码、执行命令。

系统要求

  • Node.js 版本 ≥ 22.0
  • 操作系统:macOS、Linux、Windows (WSL)

Windows 用户请确保安装了 WSL,请勿使用 Windows 自带的 cmd。

快速开始

1. 安装 Codex

npm install -g @openai/codex

2. 获取配置信息

配置项说明获取方式
OPENAI_API_KEYAPI 认证密钥注册后在「令牌」页面创建(以 sk- 开头)
OPENAI_BASE_URLAPI 服务地址使用 https://laogouapi.com/v1

3. 配置并启动

# 设置环境变量
export OPENAI_API_KEY="sk-your-api-key"
export OPENAI_BASE_URL="https://laogouapi.com/v1"

# 进入项目目录并启动
cd your-project
codex

你也可以直接在命令后附带指令:

codex "创建一个 Python Flask Hello World 项目"

永久配置(推荐)

为避免每次手动设置环境变量,将配置写入 shell 配置文件:

# 写入配置
echo 'export OPENAI_API_KEY="sk-your-api-key"' >> ~/.zshrc
echo 'export OPENAI_BASE_URL="https://laogouapi.com/v1"' >> ~/.zshrc

# 使配置生效
source ~/.zshrc

如果使用 bash,将 ~/.zshrc 替换为 ~/.bashrc

指定模型

codex --model gpt-4o "重构这个函数"

可用模型通过 GET /v1/models 获取。

切换回 OpenAI 官方

取消环境变量即可恢复使用官方接口:

unset OPENAI_BASE_URL

常见问题

遇到 API Key 无效错误?

请检查:

  • 是否正确设置了 OPENAI_API_KEYOPENAI_BASE_URL
  • API Key 是否以 sk- 开头
  • 使用永久配置后是否重启了终端

请求超时或无响应?

可能是网络环境导致的问题,建议:

  1. 检查网络连接是否正常
  2. 尝试使用代理工具
  3. 如果问题持续,请稍后再试

支持哪些模型?

Codex 支持所有 OpenAI 格式的模型,推荐使用 gpt-4o。完整模型列表通过 GET /v1/models 接口获取。

Codex 使用 OpenAI Chat Completions 协议,完全兼容本平台。