Skip to content

Codex CLI 接入指南

本教程将指导你如何在本地使用 Codex CLI,并完成 API 接入与配置。


一、什么是 Codex CLI

Codex CLI 是一个运行在本地终端的 AI 编程助手,可以帮助你完成:

  • 代码生成
  • 代码修改
  • 自动执行命令
  • 项目分析

安装完成后,可直接在终端中使用。


二、环境准备

1. 安装 Node.js

建议版本:Node.js 20 及以上

下载地址:https://nodejs.org


2. 安装 Codex CLI

bash
npm install -g @openai/codex

验证安装:

bash
codex --version

三、配置 API

Codex 使用配置文件进行接口连接。

1. 配置文件位置

默认路径:

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

2. 基础配置示例

编辑 config.toml

toml
model = "gpt-4o"

[model_providers.default]
name = "default"
base_url = "https://你的API地址/v1"
env_key = "OPENAI_API_KEY"

说明:

  • model:使用的模型名称
  • base_url:API 地址(必须包含 /v1
  • env_key:环境变量名称

3. 设置 API Key

macOS / Linux

bash
export OPENAI_API_KEY="你的API_KEY"

Windows(PowerShell)

powershell
setx OPENAI_API_KEY "你的API_KEY"

四、启动 Codex

进入你的项目目录:

bash
cd your-project

启动:

bash
codex

五、基础使用

1. 交互模式

bash
codex

示例:

写一个 Python 爬虫

2. 单次执行

bash
codex "写一个登录接口"

3. 指定模型

bash
codex -m gpt-4o "优化这段代码"

4. 图片输入(多模态)

bash
codex --image "./demo.png"

支持对图片内容进行分析和处理。


六、常见问题

1. 401 / 403 错误

检查:

  • API Key 是否正确
  • 环境变量是否生效

2. 404 错误

检查:

  • API 地址是否正确
  • 是否包含 /v1 路径

3. 模型不可用

检查:

  • 模型名称是否正确
  • 当前账户是否已开通该模型

七、进阶配置

多模型配置

toml
model = "gpt-4o"

[model_providers.main]
base_url = "https://你的API地址/v1"
env_key = "OPENAI_API_KEY"

[models]
gpt-4o = { provider = "main" }
gpt-4.1 = { provider = "main" }

八、最佳实践

  • 使用环境变量管理 API Key(更安全)
  • 统一模型命名,方便切换
  • 为不同项目使用不同配置
  • 定期检查用量与日志

九、总结

完成以上配置后,你即可:

  • 在本地终端使用 AI 编程
  • 接入统一 API 服务
  • 灵活切换模型

YL AI