本文为非官方中文翻译,内容以 OpenAI 官方英文文档为准。
官方来源:https://developers.openai.com/codex/quickstart
快速开始
开始在你的 IDE、CLI 或云端使用 Codex
每个 ChatGPT 套餐都包含 Codex。
你也可以通过使用 OpenAI API key 登录并消耗 API credits 来使用 Codex。
设置
App
Codex app 可在 macOS 和 Windows 上使用。
Codex app 的大多数功能在两个平台上都可用。特定平台的例外情况会在相关文档中说明。
-
下载并安装 Codex app
下载适用于 macOS 或 Windows 的 Codex app。如果你使用的是基于 Intel 的 Mac,请选择 Intel 构建版本。
-
打开 Codex 并登录
下载并安装 Codex app 后,打开它并使用你的 ChatGPT 账户或 OpenAI API key 登录。
如果你使用 OpenAI API key 登录,某些功能(例如 cloud threads)可能不可用。
-
选择一个项目
选择一个你希望 Codex 在其中工作的项目文件夹。
如果你之前使用过 Codex app、CLI 或 IDE Extension,你将看到你曾处理过的项目。
-
发送你的第一条消息
选择项目后,确保已选择 Local,以便让 Codex 在你的机器上工作,然后向 Codex 发送你的第一条消息。
你可以向 Codex 询问有关该项目的任何问题,或更广泛地询问与你的计算机相关的问题。以下是一些示例:
如果你需要更多灵感,请查看 Codex 使用场景。 如果你刚开始使用 Codex,请阅读最佳实践指南。
IDE extension
为你的 IDE 安装 Codex extension。
-
安装 Codex extension
为你的编辑器下载:
-
打开 Codex 面板
安装后,Codex extension 会出现在侧边栏中,与其他扩展并列。它可能隐藏在折叠区域中。如果你愿意,也可以将 Codex 面板移动到编辑器右侧。
-
登录并开始你的第一个任务
使用你的 ChatGPT 账户或 API key 登录即可开始。
Codex 默认以 Agent mode 启动,这使它能够读取文件、运行命令并在你的项目目录中写入更改。
-
使用 Git checkpoints
Codex 可能会修改你的代码库,因此建议在每个任务前后创建 Git checkpoints,以便在需要时轻松回退更改。 如果你刚开始使用 Codex,请阅读最佳实践指南。
CLI
Codex CLI 支持 macOS、Windows 和 Linux。
-
安装 Codex CLI
使用 npm 安装:
npm install -g @openai/codex使用 Homebrew 安装:
brew install codex -
运行
codex并登录在终端中运行
codex即可开始。系统会提示你使用 ChatGPT 账户或 API key 登录。 -
让 Codex 在当前目录中工作
完成身份验证后,你可以让 Codex 在当前目录中执行任务。
-
使用 Git checkpoints
Codex 可能会修改你的代码库,因此建议在每个任务前后创建 Git checkpoints,以便在需要时轻松回退更改。 如果你刚开始使用 Codex,请阅读最佳实践指南。
Cloud
在云端通过 chatgpt.com/codex 使用 Codex。
-
在浏览器中打开 Codex
前往 chatgpt.com/codex。你也可以通过在 GitHub pull request 评论中标记
@codex来将任务委派给 Codex(需要登录 ChatGPT)。 -
设置环境
在开始你的第一个任务之前,为 Codex 设置一个环境。在 chatgpt.com/codex 打开环境设置,并按照步骤连接 GitHub 仓库。
-
启动任务并监控进度
当环境准备就绪后,可从 Codex 界面 启动编码任务。你可以通过查看日志实时监控进度,或让任务在后台运行。
-
审查更改并创建 pull request
任务完成后,在 diff 视图中审查建议的更改。你可以基于结果继续迭代,或直接在你的 GitHub 仓库中创建 pull request。
Codex 还会提供更改预览。你可以直接接受该 PR,或在本地检出该分支来测试更改:
git fetchgit checkout <branch-name>