Getting Started

快速开始

官方 Quickstart 覆盖 App、IDE Extension、CLI 和 Cloud 四种入口的首轮上手。

每个 ChatGPT 方案都包含 Codex。

你也可以通过使用 OpenAI API key 登录,使用 API credits 来使用 Codex。

设置

App

ChatGPT desktop app

适合在 macOS 或 Windows 上直接处理本地项目。

ChatGPT desktop app 可在 macOS 和 Windows 上使用,并包含 Codex 的本地项目能力。

大多数 ChatGPT desktop app 中的 Codex 功能在两个平台上都可用。特定平台的例外会在相关文档中注明。

打开 ChatGPT desktop app 并登录

下载并安装 ChatGPT desktop app 后,打开它并使用你的 ChatGPT account 或 OpenAI API key 登录。

如果使用 OpenAI API key 登录,某些功能可能不可用。

选择项目

选择一个你希望 Codex 在其中工作的项目文件夹。

如果你以前使用过 ChatGPT desktop app、Codex CLI 或 IDE Extension,会看到过去处理过的项目。

发送第一条消息

选择项目后,确认已选择 Local,让 Codex 在你的机器上工作,然后向 Codex 发送第一条消息。

你可以向 Codex 询问关于项目或你的电脑的一般问题。这里有一些示例:

了解这个项目
在这个仓库里构建一个经典贪吃蛇游戏。
用最小且高置信度的改动查找并修复代码库中的 bug。

如果需要更多灵感,可以探索 Codex use cases 。如果你刚开始使用 Codex,请阅读 best practices guide

IDE extension

IDE 扩展

适合在编辑器侧边栏里让 Codex 读取、运行并修改当前项目。

为你的 IDE 安装 Codex extension。

安装 Codex extension

为你的编辑器下载:

下载 Visual Studio Code 版本

下载 Cursor 版本

下载 Windsurf 版本

下载 Visual Studio Code Insiders 版本

打开 Codex panel

安装后,Codex extension 会和其他扩展一起显示在侧边栏中。它可能隐藏在折叠区域里。如果你愿意,也可以把 Codex panel 移到编辑器右侧。

登录并开始你的第一个任务

使用你的 ChatGPT account 或 API key 登录即可开始。

Codex 默认以 Agent mode 启动,这让它可以读取文件、运行命令,并在你的项目目录中写入更改。

使用 Git checkpoints

Codex 可以修改你的代码库,因此可以考虑在每个任务前后创建 Git checkpoints,以便在需要时轻松回退更改。如果你刚开始使用 Codex,请阅读 best practices guide。

CLI

命令行

适合在终端中安装 Codex CLI,并让它在当前目录执行任务。

Codex CLI 支持 macOS、Windows 和 Linux。

安装 Codex CLI

在 macOS 或 Linux 上,使用 standalone installer:

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

在 Windows 上,运行:

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

如需 unattended installs,请在运行下载 installer 的 shell 中设置 CODEX_NON_INTERACTIVE=1。详情见 Environment variables。

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

你也可以使用 npm 或 Homebrew 安装 Codex CLI:

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

运行 codex 并登录

在终端中运行 codex 即可开始。系统会提示你使用 ChatGPT account 或 API key 登录。

让 Codex 在当前目录中工作

完成身份验证后,你可以让 Codex 在当前目录中执行任务。

使用 Git checkpoints

Codex 可以修改你的代码库,因此可以考虑在每个任务前后创建 Git checkpoints,以便在需要时轻松回退更改。如果你刚开始使用 Codex,请阅读 best practices guide。

Cloud

云端 Codex

适合在浏览器和 GitHub 工作流中启动任务、审查 diff 并创建 PR。

在 chatgpt.com/codex 上的云端使用 Codex。

在浏览器中打开 Codex

前往 chatgpt.com/codex。你也可以通过在 GitHub pull request 评论中标记 @codex,把任务委托给 Codex(需要登录 ChatGPT)。

设置环境

在开始第一个任务之前,为 Codex 设置环境。在 chatgpt.com/codex 打开 environment settings,并按照步骤连接 GitHub repository。

启动任务并监控进度

环境准备好后,从 Codex interface 启动编码任务。你可以通过查看日志实时监控进度,或者让任务在后台运行。

审查更改并创建 pull request

任务完成后,在 diff view 中审查提出的更改。你可以继续迭代结果,或直接在 GitHub repository 中创建 pull request。

Codex 还会提供更改预览。你可以直接接受 PR,也可以在本地 checkout 分支来测试更改:

git fetch git checkout <branch-name>

后续步骤

站内延伸阅读