什么是 Codex CLI?

Codex CLI 是 OpenAI 推出的一款轻量级编程智能体,运行在你的本地终端中。与传统的 AI 助手不同,它不是一个聊天窗口——它是一个真正的”智能体”,可以直接读取你的代码库、编辑文件、执行命令、提交 Git 操作,并在沙盒环境中运行代码。

Codex CLI 是 ChatGPT 中 Codex 功能的命令行版本,支持三种产品形态:

  • Codex CLI(终端):直接在命令行中与你对话、辅助编程
  • Codex App(桌面应用):独立的桌面应用体验,运行 codex app 启动
  • Codex IDE(编辑器集成):支持 VS Code、Cursor、Windsurf 等编辑器

Codex CLI 完全在本地运行,你的代码不会上传到云端,仅指令和必要的上下文会发送给 OpenAI 的模型进行处理。

安装指南

系统要求

要求 说明
操作系统 macOS 12+、Ubuntu 20.04+ / Debian 10+、Windows 11(需 WSL2)
Git(可选) 2.23+,用于内置 PR 辅助功能
内存 最低 4GB,推荐 8GB+
Rust 工具链 如果要从源码构建,需安装
flowchart LR
A[选择安装方式] --> B{你的操作系统?}
B -->|macOS| C1[curl 一键安装]
B -->|Linux| C2[curl 一键安装]
B -->|Windows| C3[PowerShell 安装<br>或 WSL2]
B -->|macOS| D1[Homebrew 安装]
B -->|任意平台| E[npm 全局安装]
B -->|任意平台| F[下载 GitHub Release]
B -->|任意平台| G[从源码编译]

方式一:一键安装脚本(推荐)

这是最简便的方式,适合大多数用户。

macOS / Linux:

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

Windows(PowerShell):

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

方式二:包管理器安装

通过 npm 安装(跨平台):

npm install -g @openai/codex

通过 Homebrew 安装(macOS):

brew install --cask codex

方式三:从 GitHub Release 下载

前往 GitHub Releases 页面 下载适合你平台的预编译二进制文件。

平台 架构 下载文件
macOS Apple Silicon (arm64) codex-aarch64-apple-darwin.tar.gz
macOS Intel (x86_64) 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 中:

# 以 Linux x86_64 为例
tar xzf codex-x86_64-unknown-linux-musl.tar.gz
mv codex-x86_64-unknown-linux-musl /usr/local/bin/codex
chmod +x /usr/local/bin/codex

方式四:从源码构建

如果你希望自行编译最新版本或参与开发:

# 克隆仓库
git clone https://github.com/openai/codex.git
cd codex/codex-rs

# 安装 Rust 工具链(如尚未安装)
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
source "$HOME/.cargo/env"
rustup component add rustfmt clippy

# 安装构建工具
cargo install --locked just
cargo install --locked cargo-nextest

# 构建 Codex
cargo build

# 运行 TUI 界面
cargo run --bin codex -- "介绍这个代码库"

首次使用与身份验证

安装完成后,在终端中运行:

codex

首次运行时,Codex CLI 会提示你登录。

验证方式一:ChatGPT 账号登录(推荐)

选择 “Sign in with ChatGPT”,使用你的 ChatGPT Plus、Pro、Business、Edu 或 Enterprise 订阅即可使用。不同订阅计划包含不同的 Codex 使用额度。

查看你的 ChatGPT 计划包含的 Codex 权益:OpenAI 帮助文档

验证方式二:API Key 登录

如果你有 OpenAI API 订阅,也可以通过 API Key 验证,但这需要进行额外配置

基本使用

启动交互模式

codex

这将启动 Codex CLI 的 TUI(文本用户界面),你可以在其中直接输入指令。Codex 会理解你的代码库上下文,并执行相应的操作:

  • 读取和分析文件
  • 创建和编辑代码
  • 运行终端命令
  • 执行 Git 操作
  • 在沙盒中运行代码并查看结果

非交互式执行(单次任务)

codex exec "给这个项目添加 README.md"

codex exec 模式适合集成到脚本或 CI/CD 流水线中。

配置文件

Codex CLI 支持通过多种方式配置:

# 指定配置目录
codex -c log_dir=./.codex-log

查看日志:

tail -F ./.codex-log/codex-tui.log

基础交互流程

sequenceDiagram
participant 你 as 开发者
participant Codex as Codex CLI
participant LLM as OpenAI 模型
participant Env as 本地环境

你->>Codex: 输入指令(如"添加用户登录功能")
Codex->>LLM: 发送指令+代码上下文
LLM->>Codex: 返回执行计划
Codex->>你: 展示计划并请求确认
你->>Codex: 确认执行
Codex->>Env: 读取/编辑文件、运行命令
Env-->>Codex: 执行结果
Codex->>LLM: 发送执行结果
LLM->>Codex: 分析结果并决定下一步
Codex-->>你: 展示完成情况

核心特性

1. 真正的自主编程

Codex CLI 不仅仅是一个代码补全工具。它能理解复杂的编程任务,自主规划执行步骤,并在需要时向你请求确认。从项目初始化到功能开发、测试编写、重构,它都能胜任。

2. 本地代码库理解

Codex CLI 运行在本地,能直接访问你的完整代码库。它不需要将代码上传到任何服务器——仅指令和必要的上下文会发送到 OpenAI 的模型。

3. 安全的沙盒执行

当 Codex 需要运行代码时,它会在本地的沙盒环境中执行,确保不会意外影响你的系统。

4. MCP(Model Context Protocol)支持

Codex CLI 支持通过 MCP 协议集成外部工具,包括:

  • 连接数据库
  • 调用外部 API
  • 集成自定义工具链
  • 读取远程服务数据

5. 回顾与搜索

Codex CLI 支持搜索本地对话历史,包括大小写不敏感的内容匹配和结果预览,方便你回顾之前的编程会话。

6. 多配置文件管理

支持通过 --profile 参数选择不同的配置文件,适合在不同的工作场景(工作项目、个人项目、不同代码库)之间切换。

使用场景

快速原型开发

codex "创建一个 FastAPI 项目,包含用户认证和 CRUD API"

Codex 会自动创建项目结构、安装依赖、编写代码,让你在几分钟内获得可运行的原型。

代码重构与优化

codex "将这个模块中的回调函数全部改为 async/await 模式"

调试与修复

codex "运行测试,分析失败原因并修复"

代码审查

codex "审查这个目录下最近修改的代码,找出潜在问题"

文档生成

codex "为这个 API 模块生成详细的文档注释"

常见问题

Q: Codex CLI 与 GitHub Copilot 有什么区别?

Codex CLI 是自主编程智能体,可以独立完成整个编程任务;而 GitHub Copilot 主要是代码补全工具,在你编写代码时提供建议。两者互补使用效果更好。

Q: 我的代码会上传到 OpenAI 吗?

Codex CLI 本身运行在本地,只有你向 Codex 发出的指令和必要的代码上下文会被发送到 OpenAI 进行处理。如果你对隐私敏感,可以在使用前查阅 OpenAI 的数据处理政策。

Q: Windows 是否原生支持?

Codex CLI 在 Windows 上需要 WSL2 环境。如果你没有 WSL2,可以通过 npm 安装,但某些功能可能受限。

Q: 如何卸载?

# npm 安装
npm uninstall -g @openai/codex

# Homebrew 安装
brew uninstall --cask codex

# 一键脚本安装
rm $(which codex)
rm -rf ~/.codex

总结

Codex CLI 是 OpenAI 推出的新一代编程智能体,它将强大的 AI 能力直接带入终端。与传统的 AI 编程助手相比,Codex CLI 更像一个真正的协作者——它能理解项目全局、自主执行任务、并持续迭代改进。

对于习惯命令行的开发者来说,Codex CLI 提供了一种高效、专注的编程方式,尤其适合快速原型开发、代码重构和自动化任务。结合其 MCP 扩展能力和沙盒执行环境,它正在重新定义终端编程的可能性。


相关资源: