OpenAI Codex CLI 安装配置完全指南

OpenAI Codex CLI 是 OpenAI 推出的开源编码代理工具，可在本地计算机上运行，帮助开发者通过自然语言指令完成代码编辑、生成补丁和执行命令等任务。本文将详细介绍 Codex CLI 的特性以及在不同操作系统上的安装配置方法。

效果演示

Codex CLI 提供了一个基于终端的交互式编码环境，开发者可以直接通过对话方式让 AI 协助完成编程任务。

特性

功能分类	特性
终端式编码助手	Codex CLI 是一个基于终端的交互式编码助理，用于在命令行中编辑代码、生成补丁并运行命令。
工具驱动架构	提供 `apply_patch`、`shell`、`update_plan`、`multi_tool_use` 等工具，用于对仓库文件和操作进行可控修改。
原子补丁编辑	使用专门的补丁格式通过 `apply_patch` 原子地添加/更新/删除文件，便于审计与回滚。
沙箱与审批	支持沙箱策略（如 `workspace-write`、`read-only`）和审批模式（`on-request`、`on-failure`、`never`），控制写入与网络访问权限。
计划追踪	`update_plan` 用于列出步骤并跟踪状态，要求始终只有一个 `in_progress` 步骤以保持明确进度。
交互规范	在重要操作前发送简短前导说明，保持语气友好、简洁并提供进度更新。
安全约束	遵循严格规则（不随意更改无关文件、不添加版权头、不执行破坏性命令），需要用户批准敏感操作。
测试与格式化	推荐在修改后运行相关测试与格式化工具，但不负责修复与当前任务无关的问题。
输出与风格	最终输出遵循 CLI 渲染规范（例如 `**` 标题、反引号表示路径/命令），保持可扫描的简洁结构。
并行执行	支持通过 `multi_tool_use.parallel` 并行运行多个工具以提升效率。

AI 模型配置方法

参数修改

Api Key：前往 ZetaTechs API 获取。

请求地址格式：

主站：https://api.zetatechs.com/v1
企业站：https://ent.zetatechs.com/v1

Windows 端图文指引

1. 打开终端（二选一）

使用 Windows PowerShell 或 CMD 打开终端。

2. 安装 WSL

为在 Windows 上获得最佳性能，请安装并使用 Windows Subsystem for Linux (WSL2)。

安装 WSL2，重启 Windows 计算机：

bash

wsl --install

安装完成后重启 Windows 计算机。

Windows 注意事项：

建议使用 PowerShell 而不是 CMD
如果遇到权限问题，尝试以管理员身份运行
某些杀毒软件可能会误报，需要添加白名单

下载 Node Version Manager (NVM)：

bash

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash

NVM 安装 Node.js 22：

标签栏新开一个 PowerShell 窗口，打开 WSL：

bash

wsl

安装 Node.js（版本号有时效性，请根据 OpenAI 官网要求安装对应版本）：

bash

nvm install 22

3. 安装 Codex CLI

bash

npm i -g @openai/codex

这个命令会从 npm 官方仓库下载并安装最新版本的 Codex CLI。

4. 修改配置文件

一键修改 Codex CLI 配置文件：

bash

curl -fsSL https://raw.githubusercontent.com/Zeta-Techs/coding-cli-setup/main/coding-cli-setup.sh | bash

5. 开始使用 Codex CLI

现在你可以开始使用 Codex CLI 了！

启动 WSL2：

bash

wsl

直接启动 Codex CLI：

bash

codex

在特定项目中使用：

bash

cd mnt/c/path/to/your/project
codex

Enter 启动 Codex CLI。

设置 Codex CLI 的权限：

允许 Codex 直接修改文件

Codex 修改文件需要手动授权

选择模型：

bash

/model

注意：修改接口地址后，使用所有模型（包括官方预设模型）均调用自定义接入点，而不使用官方账号额度。

MacOS 端图文指引

1. 安装 Homebrew (已安装请跳过)

Homebrew 是 macOS（或 Linux）缺失的软件包的管理器。

官网：https://brew.sh

安装 Homebrew：

bash

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

2. 安装 Node.js 环境

Node.js 环境安装步骤：

更新 Homebrew：

bash

brew update

安装 Node.js：

bash

brew install node

macOS 注意事项：

如果遇到权限问题，可能需要使用 sudo
首次运行可能需要在系统偏好设置中允许
建议使用 Terminal 或 iTerm2

验证安装是否成功：

bash

node --version
npm --version

如果显示版本号，说明安装成功。

3. 安装 Codex CLI

打开终端，运行以下命令：

bash

# 全局安装 Codex CLI
npm install -g @openai/codex

如果遇到权限问题，可以使用 sudo：

bash

sudo npm install -g @openai/codex

验证 Codex CLI 安装：

bash

codex --version

如果显示版本号，恭喜你！Codex CLI 已经成功安装了。

4. 修改配置文件

一键修改 Codex CLI 配置文件：

bash

curl -fsSL https://raw.githubusercontent.com/Zeta-Techs/coding-cli-setup/main/coding-cli-setup.sh | bash

5. 开始使用 Codex CLI

现在你可以开始使用 Codex CLI 了！

直接启动 Codex CLI：

bash

codex

在特定项目中使用：

bash

cd /path/to/your/project
codex

Enter 启动 Codex CLI。

6. macOS 常见问题解决

问题 1：安装后找不到 codex 命令

解决方法：重新加载 shell 配置

bash

source ~/.zshrc

或

bash

source ~/.bash_profile

问题 2：权限被拒绝

解决方法：使用 sudo 安装

bash

sudo npm install -g @openai/codex

问题 3：Node.js 版本不兼容

解决方法：使用 nvm 安装正确版本的 Node.js

bash

nvm install 22
nvm use 22

Linux 端图文指引

1. 安装 Node.js 环境

Node.js 环境安装步骤：

下载 NVM：

bash

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash

加载 NVM：

bash

export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh"

安装 Node.js 22：

bash

nvm install 22

验证安装：

bash

node --version
npm --version

2. 安装 Codex CLI

全局安装 Codex CLI：

bash

npm install -g @openai/codex

如果遇到权限问题，可以使用 sudo：

bash

sudo npm install -g @openai/codex

3. 修改配置文件

一键修改 Codex CLI 配置文件：

bash

curl -fsSL https://raw.githubusercontent.com/Zeta-Techs/coding-cli-setup/main/coding-cli-setup.sh | bash

4. 开始使用 Codex CLI

现在你可以开始使用 Codex CLI 了！

直接启动 Codex CLI：

bash

codex

在特定项目中使用：

bash

cd /path/to/your/project
codex

Enter 启动 Codex CLI。

5. Linux 常见问题解决

问题 1：npm 命令找不到

解决方法：确保 Node.js 正确安装

bash

which node
which npm

如果没有输出，重新安装 Node.js。

问题 2：权限被拒绝

解决方法：更改 npm 全局目录权限或使用 sudo

bash

sudo chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share}

问题 3：WSL 相关问题

解决方法：确保 WSL2 已正确安装

bash

wsl --version

使用技巧

常用命令

命令	说明
`codex`	启动 Codex CLI
`/model`	选择模型
`/help`	显示帮助信息
`/exit`	退出 Codex CLI

最佳实践

明确描述需求：向 Codex 描述任务时尽量清晰具体
分步骤执行：复杂任务可以分多个步骤完成
审查修改：始终审查 Codex 生成的代码修改
使用版本控制：在使用 Codex 前确保代码已提交到版本控制
设置适当的权限：根据任务需要选择合适的沙箱策略

字节笔记本

OpenAI Codex CLI 安装配置完全指南

效果演示

特性

AI 模型配置方法

参数修改

Windows 端图文指引

1. 打开终端（二选一）

2. 安装 WSL

3. 安装 Codex CLI

4. 修改配置文件

5. 开始使用 Codex CLI

MacOS 端图文指引

1. 安装 Homebrew (已安装请跳过)

2. 安装 Node.js 环境

3. 安装 Codex CLI

4. 修改配置文件

5. 开始使用 Codex CLI

6. macOS 常见问题解决

Linux 端图文指引

1. 安装 Node.js 环境

2. 安装 Codex CLI

3. 修改配置文件

4. 开始使用 Codex CLI

5. Linux 常见问题解决

使用技巧

常用命令

最佳实践

相关链接