mcpField
O
OpenAI Codex CLI

OpenAI Codex CLI

官方Agent-ready
developers.openai.comAI 与 Agent131.4kcodex今天更新
代码仓库访问官网

关于 OpenAI Codex CLI

OpenAI 官方的编码 Agent 工具，支持读取、修改和执行本地代码。在隔离的沙箱环境中运行命令，与本地仓库工作流集成。

主要功能

  1. 01理解和修改本地代码库
  2. 02在沙箱中执行代码和命令
  3. 03处理自然语言指令进行代码更改
  4. 04支持本地仓库工作流和文件操作

适用场景

  1. 01接收自然语言指令自动进行代码修改
  2. 02在隔离环境中测试和调试代码
  3. 03自动化开发任务，如修复测试或重构代码

安装

选择你的系统或包管理器，复制命令到终端运行。

$
npm install -g @openai/codex

安装完成后运行codex --version确认安装成功。

命令示例

常用命令按使用顺序排列。

01
codex
02
codex exec "fix the failing tests"
03
codex --help

详细介绍

Codex CLI 是 OpenAI 推出的编码 Agent，可在您的计算机本地运行。

Codex CLI 启动画面


如果您希望在代码编辑器（VS Code、Cursor、Windsurf）中使用 Codex，请在 IDE 中安装。
如果您想使用桌面应用体验，请运行 codex app，或访问Codex App 页面。
如果您想使用 OpenAI 的云端 Agent Codex Web，请访问 chatgpt.com/codex。

快速开始

安装并运行 Codex CLI

在 Mac 或 Linux 上运行以下命令安装 Codex CLI：

curl -fsSL https://chatgpt.com/codex/install.sh | sh

在 Windows 上运行以下命令安装 Codex CLI：

powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"

独立安装程序默认从 https://releases.openai.com/codex 下载，若元数据或资源文件无法下载，则回退到 GitHub Releases。如需强制使用 GitHub Releases，请将 CODEX_INSTALLER_USE_RELEASES_OPENAI_COM 设置为 false（0 和 no 也可）：

curl -fsSL https://chatgpt.com/codex/install.sh | CODEX_INSTALLER_USE_RELEASES_OPENAI_COM=false sh

$env:CODEX_INSTALLER_USE_RELEASES_OPENAI_COM='false'; irm https://chatgpt.com/codex/install.ps1 | iex

也可以通过以下包管理器安装 Codex CLI：

# Install using npm
npm install -g @openai/codex

# Install using Homebrew
brew install --cask codex

然后直接运行 codex 即可开始使用。

您也可以前往最新的 GitHub Release，下载适用于您平台的二进制文件。

每个 GitHub Release 包含多个可执行文件，但实际上您很可能只需要以下其中一个：

  • 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。

使用 ChatGPT 套餐中的 Codex

运行 codex 并选择 Sign in with ChatGPT。我们建议您登录 ChatGPT 账户，以将 Codex 作为 Plus、Pro、Business、Edu 或 Enterprise 套餐的一部分使用。了解 ChatGPT 套餐包含的内容。

您也可以使用 API 密钥使用 Codex，但这需要额外配置。

文档

本仓库基于 Apache-2.0 License 授权。

评论

支持 Markdown