Skip to content

coderplan-ai/codex-relay

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 

Repository files navigation

OpenAI Codex CLI 配置教程_Codex API 国内使用方法_Codex 中转 API 推荐

国内使用 Codex CLI 的难题

OpenAI Codex CLI 是 OpenAI 推出的命令行 AI 编程工具,支持代码生成、编辑和自动化操作,是继 Claude Code 之后又一个强大的 AI 编程助手。

国内开发者在使用 Codex CLI 时面临:

1. 网络限制:OpenAI API 在国内无法直连,需要稳定的代理或中转方案。

2. API Key 获取困难:需要海外手机号注册 OpenAI 账号,海外信用卡充值。

3. 配置不直观:Codex CLI 的 OpenAI Compatible 模式需要正确设置 Base URL 和 API Key。

解决方案:通过 OpenAI 兼容 API 接入

Codex CLI 支持 OpenAI API 协议,可以通过任何提供 OpenAI Compatible 接口的中转服务接入。只需要设置正确的 OPENAI_BASE_URLOPENAI_API_KEY,就能在国内稳定使用。

Codex CLI 配置教程

方法一:使用一键配置脚本

# 克隆仓库
git clone https://github.com/coderplan-ai/codex-relay.git
cd codex-relay

# Mac / Linux
chmod +x examples/env-setup.sh
./examples/env-setup.sh

# Windows PowerShell
# .\examples\env-setup.ps1

方法二:手动配置

Mac / Linux(Zsh)

echo 'export OPENAI_BASE_URL="https://api.coderplan.ai/v1"' >> ~/.zshrc
echo 'export OPENAI_API_KEY="sk-你的密钥"' >> ~/.zshrc
source ~/.zshrc

Windows(PowerShell)

$env:OPENAI_BASE_URL = "https://api.coderplan.ai/v1"
$env:OPENAI_API_KEY = "sk-你的密钥"

# 永久设置
[Environment]::SetEnvironmentVariable("OPENAI_BASE_URL", "https://api.coderplan.ai/v1", "User")
[Environment]::SetEnvironmentVariable("OPENAI_API_KEY", "sk-你的密钥", "User")

安装和启动 Codex CLI

# 确保 Node.js 18+ 已安装
npm install -g @openai/codex

# 进入项目目录
cd your-project-folder

# 启动 Codex CLI
codex

验证配置

使用仓库中的测试脚本验证 API 是否连通:

# 替换为你的实际 API Key
export OPENAI_API_KEY="sk-你的密钥"
node examples/test-api.mjs

如果配置正确,你会看到模型返回的响应。

模型选择建议

场景 推荐模型 说明
日常编程 gpt-5.4 速度快,编程能力强
复杂任务 gpt-5.5 最新旗舰模型,推理能力最强
推理优化 o3 专门优化推理能力
高性价比 gpt-5.4-mini 速度快成本低,简单任务首选

常见问题

Q: Codex CLI 启动后报 401 错误? A: 检查 OPENAI_API_KEY 是否正确,确认 Key 以 sk- 开头。注意 OPENAI_BASE_URL 末尾需要加 /v1

Q: 配置后连接超时? A: 确认环境变量已生效:echo $OPENAI_BASE_URL,应输出 https://api.coderplan.ai/v1。重启终端后再试。

Q: 响应中中文乱码? A: 确保终端编码设置为 UTF-8。Mac/Linux 默认支持,Windows 可在 PowerShell 中执行 [Console]::OutputEncoding = [System.Text.Encoding]::UTF8

更新日志

  • 2026-05-27:初始版本,支持 Codex CLI 环境变量配置、API 连通性测试

如果这个教程对你有帮助,欢迎 Star 本仓库。

获取 API Key:coderplan.ai

About

OpenAI Codex CLI配置教程_Codex API国内使用_Codex中转API推荐_CoderPlan

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors