Codex CLI 使用教程

OpenAI 官方编码代理 · 本地终端交互式 AI 编程助手

← 返回首页
1

环境准备与安装

Linux
macOS
Windows
1

安装 Node.js 环境

Codex CLI 需要 Node.js 22 或更高版本:

curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash - sudo apt-get install -y nodejs

验证安装:

node --version npm --version
2

安装 Codex CLI

打开终端,运行以下命令:

npm install -g @openai/codex
如果遇到权限问题,可配置 npm 用户目录:
mkdir -p ~/.npm-global && npm config set prefix '~/.npm-global' && export PATH=~/.npm-global/bin:$PATH

验证安装:

codex --version
1

安装 Node.js 环境

使用 Homebrew 安装 Node.js 22:

brew install node@22

验证安装:

node --version npm --version
2

安装 Codex CLI

打开终端,运行以下命令:

npm install -g @openai/codex
如果提示权限不足,可在命令前加 sudo
1

安装 WSL2

Codex CLI 在 Windows 上需要通过 WSL2 运行。打开 PowerShell(管理员),执行:

wsl --install
安装完成后需要重启电脑,然后在 WSL 终端中继续后续步骤。
2

安装 Node.js 环境

在 WSL 终端中安装 Node.js 22:

curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash - sudo apt-get install -y nodejs

验证安装:

node --version npm --version
3

安装 Codex CLI

在 WSL 终端中运行:

npm install -g @openai/codex
Windows 用户的环境变量设置可在 PowerShell 中进行(见下方一键脚本)
2

设置环境变量

重要提示:
1. 请先在 cc.midlight.top/console/token 创建您的 API Key
2. Codex CLI 使用 OpenAI 兼容接口,需设置 OPENAI_BASE_URL 和 OPENAI_API_KEY
3. 设置环境变量后,所有模型均通过自定义接口调用

一键设置环境变量

Windows (PowerShell)
macOS / Linux

在终端中执行以下命令:

curl -fsSL https://cc-help.midlight.top/codex-cli-setup.sh | bash
脚本会自动设置 OPENAI_BASE_URL 和 OPENAI_API_KEY 环境变量。

在 PowerShell 中执行以下命令:

irm https://cc-help.midlight.top/codex-cli-setup.ps1 | iex
脚本会自动设置 OPENAI_BASE_URL 和 OPENAI_API_KEY 环境变量。
手动配置方式(可选)

macOS / Linux(写入 ~/.bashrc 或 ~/.zshrc):

# 你的 API Key(在平台令牌管理中生成) export OPENAI_API_KEY="sk-xxx你的密钥xxx" # 指向 iCode 中转地址 export OPENAI_BASE_URL="https://cc.midlight.top" # 使配置生效 source ~/.bashrc

Windows (PowerShell)

# 永久写入用户环境变量 [System.Environment]::SetEnvironmentVariable("OPENAI_API_KEY", "sk-xxx你的密钥xxx", "User") [System.Environment]::SetEnvironmentVariable("OPENAI_BASE_URL", "https://cc.midlight.top", "User") # 设置后重启终端使变量生效
3

启动与使用

启动 Codex CLI

在项目目录下输入命令启动:

codex

常用操作

/model — 切换使用的模型(如 gpt-4o、o3-mini 等)。
直接输入 — 描述你想要完成的编码任务,Codex 会自动执行。
沙箱模式 — Codex 默认在沙箱中运行命令,保护你的系统安全。
审批机制 — 对文件修改和命令执行会请求你的确认。
user@dev:~/project $ codex OpenAI Codex CLI ? What would you like to do? > Help me refactor the authentication module Fix the failing unit tests Add input validation to the API endpoints

快速执行模式

也可以直接在命令行传入任务描述:

codex "fix the type error in src/utils.ts"