快速开始

每个 ChatGPT 计划都包含 Codex。

你也可以使用 OpenAI API key 登录，通过 API 额度使用 Codex。

安装

Codex 桌面应用支持 macOS 和 Windows。

大多数 Codex 桌面应用功能在两个平台上均可使用。平台特定的例外情况会在相关文档中注明。

下载并安装 Codex 应用 下载 Codex 桌面应用（macOS 或 Windows）。如果你使用的是 Intel 芯片的 Mac，请选择 Intel 版本。获取 Linux 版本通知
打开 Codex 并登录 下载安装完成后，打开 Codex 并使用 ChatGPT 账户或 OpenAI API key 登录。如果使用 OpenAI API key 登录，部分功能可能不可用。
选择一个项目 选择你希望 Codex 工作的项目文件夹。如果你之前使用过 Codex 桌面应用、CLI 或 IDE 扩展，你将看到之前处理过的项目。
发送你的第一条消息 选择项目后，确保选择了**本地（Local）**模式，让 Codex 在你的机器上工作，然后发送第一条消息。你可以向 Codex 询问关于项目或计算机的任何问题。以下是一些示例：
- 解释这个项目是做什么的
- 帮我修复这个错误
- 为这个函数编写测试
- 重构这段代码
如果需要更多灵感，请浏览 Codex 使用场景。如果你是 Codex 新手，请阅读最佳实践指南。

为你的 IDE 安装 Codex 扩展。

安装 Codex 扩展 为你的编辑器下载：
打开 Codex 面板 安装完成后，Codex 扩展会出现在侧边栏中，与其他扩展一起。它可能位于折叠区域中。你可以根据需要将 Codex 面板移到编辑器右侧。
登录并开始你的第一个任务 使用 ChatGPT 账户或 API key 登录即可开始使用。 Codex 默认以 Agent 模式启动，可以读取文件、运行命令并在项目目录中写入更改。
使用 Git 检查点 Codex 可以修改你的代码库，因此建议在每个任务前后创建 Git 检查点，以便在需要时轻松还原更改。
如果你是 Codex 新手，请阅读最佳实践指南。

Codex CLI 支持 macOS、Windows 和 Linux。

安装 Codex CLI 在 macOS 或 Linux 上，使用独立安装器：

bash

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

在 Windows 上运行：

powershell

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

对于无人值守安装，在运行安装器的 shell 中设置 CODEX_NON_INTERACTIVE=1。详见环境变量。

bash

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

powershell

$env:CODEX_NON_INTERACTIVE=1; irm https://chatgpt.com/codex/install.ps1 | iex

你也可以通过 npm 或 Homebrew 安装 Codex CLI：

bash

npm install -g @openai/codex

bash

brew install --cask codex

运行 codex 并登录 在终端中运行 codex 即可开始。系统会提示你使用 ChatGPT 账户或 API key 登录。
让 Codex 在当前目录中工作 认证完成后，你可以让 Codex 在当前目录中执行任务。
使用 Git 检查点 Codex 可以修改你的代码库，因此建议在每个任务前后创建 Git 检查点，以便在需要时轻松还原更改。
如果你是 Codex 新手，请阅读最佳实践指南。

在浏览器中使用 Codex，访问 chatgpt.com/codex。

在浏览器中打开 Codex 访问 chatgpt.com/codex。你也可以在 GitHub Pull Request 评论中通过 @codex 标签将任务委托给 Codex（需要登录 ChatGPT）。
设置环境 在开始第一个任务之前，为 Codex 配置一个环境。打开环境设置，按照步骤连接一个 GitHub 仓库。
启动任务并监控进度 环境准备就绪后，从 Codex 界面启动编码任务。你可以通过查看日志实时监控进度，也可以让任务在后台运行。
审查更改并创建 Pull Request 任务完成后，在 diff 视图中审查建议的更改。你可以对结果进行迭代，或直接在 GitHub 仓库中创建 Pull Request。 Codex 还提供更改预览。你可以直接接受 PR，或检出分支在本地测试更改：
bash
```
git fetch
git checkout <branch-name>
```