npm i -g @openai/codex
或 brew install --cask codex

Codex CLI 是 OpenAI 推出的一款可在您本地计算机上运行的编码助手。

如果您希望在代码编辑器中使用 Codex（如 VS Code、Cursor、Windsurf），请在您的 IDE 中安装。
如果您想要桌面应用的体验，可以运行 codex app，或者访问Codex 应用页面。
如果您正在寻找 OpenAI 提供的云端助手——Codex Web,请前往chatgpt.com/codex。

---

快速入门

安装并运行 Codex CLI

使用您偏好的包管理工具全局安装：

# 使用 npm 安装
npm install -g @openai/codex

# 使用 Homebrew 安装
brew install --cask codex

然后只需运行 codex 即可开始使用。

您也可以前往 最新的 GitHub 发布页面,下载适用于您操作系统的相应二进制文件。

每个 GitHub 发布版本都包含多个可执行文件，但实际使用时，您可能需要以下其中之一：

• macOS
  • Apple Silicon/arm64：codex-aarch64-apple-darwin.tar.gz
  • x86_64（较旧的 Mac 硬件）：codex-x86_64-apple-darwin.tar.gz
• Linux
  • x86_64：codex-x86_64-unknown-linux-musl.tar.gz
  • arm64：codex-aarch64-unknown-linux-musl.tar.gz

每个压缩包内只有一个文件，文件名中已标明适用平台（例如 codex-x86_64-unknown-linux-musl）。解压后，建议将其重命名为 codex。

将 Codex 与您的 ChatGPT 方案结合使用

运行 codex，然后选择“使用 ChatGPT 登录”。我们建议您登录自己的 ChatGPT 账户，以便将 Codex 作为 Plus、Pro、Business、Edu 或 Enterprise 方案的一部分来使用。了解您的 ChatGPT 方案包含哪些内容。

您也可以使用 API 密钥来使用 Codex，但这需要进行额外的设置。

文档

• Codex 文档
• 贡献指南
• 安装与构建
• 开源基金

本仓库采用 Apache-2.0 许可证授权。

Codex CLI 快速上手指南

Codex CLI 是 OpenAI 推出的本地运行编程代理工具，可直接在终端中辅助代码编写、调试与重构。

环境准备

• 操作系统：macOS（Intel 或 Apple Silicon）、Linux（x86_64 或 arm64）
• 前置依赖：
  • 方式一（推荐）：已安装 Node.js（用于通过 npm 安装）
  • 方式二：macOS 用户已安装 Homebrew
  • 或直接从 GitHub Release 下载对应平台的二进制文件
• 账号要求：需拥有 ChatGPT 账号（Plus/Pro/Business/Edu/Enterprise 计划）或使用 OpenAI API Key

💡 国内用户若访问 npm 或 GitHub 较慢，可配置国内镜像源：

• npm 镜像：npm config set registry https://registry.npmmirror.com
• GitHub 加速：可使用 https://ghproxy.com 等代理下载 Release 文件

安装步骤

方式一：通过 npm 安装（跨平台推荐）

npm install -g @openai/codex

方式二：通过 Homebrew 安装（仅限 macOS）

brew install --cask codex

方式三：手动下载二进制文件

访问 GitHub Releases，根据系统选择对应压缩包：

• macOS Apple Silicon：codex-aarch64-apple-darwin.tar.gz
• macOS Intel：codex-x86_64-apple-darwin.tar.gz
• Linux x86_64：codex-x86_64-unknown-linux-musl.tar.gz
• Linux arm64：codex-aarch64-unknown-linux-musl.tar.gz

解压后重命名为 codex 并加入系统 PATH：

tar -xzf codex-*.tar.gz
mv codex-* codex
chmod +x codex
sudo mv codex /usr/local/bin/

基本使用

安装完成后，在终端直接运行：

codex

首次启动时选择 Sign in with ChatGPT，按提示登录你的 ChatGPT 账号即可开始使用。

如需使用 API Key 模式，请参考官方认证文档进行额外配置。

📌 提示：若希望在 VS Code、Cursor 等编辑器中使用，请前往 IDE 集成页面 安装插件；若偏好图形界面，可运行 codex app 启动桌面应用。