OpenAI Codex 快速上手教程（GitHub README 中文整理）

是什么

Codex CLI 是 OpenAI 推出的开源编程智能体，直接运行在你自己的电脑上，无需把代码上传到云端。它把 ChatGPT 的代码能力带到了终端里，让你在命令行中就能完成写代码、改 Bug、跑测试等一系列开发任务。

除了命令行工具，OpenAI 还提供了多种使用形态：如果你习惯在编辑器里工作，可以安装 VS Code、Cursor、Windsurf 等 IDE 的插件；如果你想要桌面应用体验，运行 codex app 或访问 Codex App 页面即可；如果你更倾向于云端智能体，可以使用 Codex Web（chatgpt.com/codex）。

能干什么

• 本地运行：代码和上下文都在本地处理，隐私性更好
• 多平台支持：macOS、Linux、Windows 都能用
• 多种安装方式：支持脚本安装、npm、Homebrew 等
• ChatGPT 账号集成：Plus、Pro、Business、Edu、Enterprise 用户可直接使用
• 开源可扩展：Apache-2.0 协议，可以自由修改和贡献代码

怎么装

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 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 即可使用。

提示：安装脚本默认从 OpenAI 官方源下载，国内访问受限时推荐使用国产替代方案或等待网络恢复。

怎么用第一个例子

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

codex

首次启动时，选择 Sign in with ChatGPT 登录你的 ChatGPT 账号。如果你有 Plus、Pro、Business、Edu 或 Enterprise 套餐，可以直接在套餐内使用 Codex，无需额外付费。

登录成功后，你就可以在终端里用自然语言向 Codex 描述需求了。比如：

codex "帮我写一个 Python 脚本，读取当前目录下所有 CSV 文件并合并成一个"

Codex 会在本地执行任务，生成代码、运行命令、检查结果，然后给你反馈。你也可以把它当成一个随时待命的编程搭档，用来写测试、重构代码、排查 Bug 等。

如果你更想用 API Key 方式接入，需要额外配置，具体参考 OpenAI 官方文档。

社区资源

• 官方文档：https://developers.openai.com/codex
• 贡献指南：仓库内 docs/contributing.md
• 安装与构建：仓库内 docs/install.md
• 开源基金：仓库内 docs/open-source-fund.md
• GitHub 仓库：https://github.com/openai/codex

项目采用 Apache-2.0 开源协议，欢迎社区贡献代码和反馈问题。

翻译整理自 GitHub README，原文：https://github.com/openai/codex