本页内容

Codex CLI

本地运行 GPT-5 CLI 工具

OpenAI 出品的软件工程代理,能够理解整个代码库、生成新功能、修复 Bug、运行测试并自动起草拉取请求(PR)。

系统要求

软件依赖

Node.js 18 或更高版本(建议 LTS)、npm 或兼容包管理器

终端

PowerShell / Terminal / bash / zsh

快速开始:安装与配置

请选择你的操作系统,仅显示相关步骤。确保已安装 Node.js 18+。

步骤 1:安装 Codex 最新版

在 CMD / PowerShell 中执行:

npm install -g @openai/codex

步骤 2:放置配置文件

下载 config.toml 模板,保存到 C:\Users\你的用户名\.codex\config.toml。

首次启动 codex 会自动创建 .codex 目录。

步骤 3:永久配置环境变量

「系统属性」→「环境变量」→ 在「系统变量」中新建:

OPENAI_API_KEY = <你的 API Key>

设置完成后需要重启终端(CMD / PowerShell)才能生效。

步骤 4:启动 Codex

codex

步骤 1:安装 Codex 最新版

在终端中执行:

npm install -g @openai/codex

步骤 2:放置配置文件

下载 config.toml 模板,保存到 ~/.codex/config.toml。

首次启动 codex 会自动创建 .codex 目录。

步骤 3:永久配置环境变量

在 ~/.zshrc 或 ~/.bashrc 末尾追加:

export OPENAI_API_KEY="<你的 API Key>"

保存后执行 source ~/.zshrc(按实际文件替换)使其立即生效。

步骤 4:启动 Codex

codex

步骤 1:安装 Codex 最新版

在终端中执行:

npm install -g @openai/codex

步骤 2:放置配置文件

下载 config.toml 模板,保存到 ~/.codex/config.toml。

首次启动 codex 会自动创建 .codex 目录。

步骤 3:永久配置环境变量

在 ~/.bashrc 末尾追加:

export OPENAI_API_KEY="<你的 API Key>"

保存后执行 source ~/.bashrc 使其立即生效。

步骤 4:启动 Codex

codex

配置文件模板中的 base_url 已固定指向中转地址 https://ai.kedang.net,无需再单独设置 OPENAI_BASE_URL。

故障排除

!

提示找不到 codex 命令

确认 npm 全局 bin 目录已加入 PATH,可运行 npm config get prefix 查看安装路径。

!

Windows 环境变量不生效

新建系统变量后必须完全重启终端窗口(而非仅新开标签页)才能读取到最新值。

官方地址