快速开始
在 IDE、CLI 或云端开始使用 Codex
每个 ChatGPT 套餐都包含 Codex。
你也可以使用 OpenAI API key 登录,并通过 API credits 使用 Codex。
设置
Codex App 支持 macOS 和 Windows。大多数 Codex App 功能都可在两个平台上使用;平台特有的例外会在相关文档中说明。
- 1
下载并安装 Codex App
下载 macOS 或 Windows 版本。如果你使用的是 Intel 芯片的 Mac,请选择 Intel 构建版本。
- 2
打开 Codex 并登录
下载安装完成后,打开 Codex,并使用你的 ChatGPT 账号或 OpenAI API key 登录。
如果你使用 OpenAI API key 登录,某些功能可能不可用,例如云端线程。
- 3
选择项目
选择一个你希望 Codex 参与工作的项目文件夹。
如果你以前用过 Codex App、CLI 或 IDE 扩展,这里还会显示你之前处理过的项目。
- 4
为你的 IDE 安装 Codex 扩展。
- 1
- 2
打开 Codex 面板
安装完成后,Codex 扩展会出现在侧边栏,与其他扩展一起显示。
它可能被折叠在隐藏区域里;如果你愿意,也可以把 Codex 面板移动到编辑器右侧。
- 3
登录并开始你的第一个任务
使用 ChatGPT 账号或 API key 登录即可开始。
Codex 默认以 Agent mode(智能体模式)启动,这样它就可以读取文件、运行命令,并在你的项目目录中写入改动。
告诉我这个项目是做什么的
在这个仓库里实现一个经典 Snake 游戏
以最小且高置信度的改动修复我代码库里的 bug
- 4
使用 Git 检查点
Codex 可能会修改你的代码库,因此建议你在每个任务前后都创建 Git 检查点,以便在需要时轻松回滚。
如果你刚开始使用 Codex,建议先读最佳实践指南。
进一步了解 Codex IDE 扩展 →
Codex CLI 支持 macOS、Windows 和 Linux。
- 1
安装 Codex CLI
你可以使用 npm 或 Homebrew 安装:
npmnpm install -g @openai/codexHomebrewbrew install codex - 2
运行 codex 并登录
在终端中运行 codex 即可开始。
系统会提示你使用 ChatGPT 账号或 API key 登录。
- 3
让 Codex 在当前目录工作
完成认证后,你就可以让 Codex 在当前目录中执行任务。
下面这些示例可以作为第一批任务的起点:
告诉我这个项目是做什么的
在这个仓库里实现一个经典 Snake 游戏
以最小且高置信度的改动修复我代码库里的 bug
- 4
使用 Git 检查点
Codex 可能会修改你的代码库,因此建议你在每个任务前后都创建 Git 检查点,以便在需要时轻松回滚。
如果你刚开始使用 Codex,建议先读最佳实践指南。
进一步了解 Codex CLI →
在 chatgpt.com/codex 的云端使用 Codex。
- 1
在浏览器中打开 Codex
你也可以在 GitHub pull request 评论中
@codex,把任务委派给 Codex。 - 2
- 3
启动任务并监控进度
环境准备好后,你可以从 Codex 界面 发起编码任务。
你可以通过查看日志实时监控进度,也可以让任务在后台运行。
告诉我这个项目是做什么的
解释我这个应用架构中最主要的失败模式
以最小且高置信度的改动修复我代码库里的 bug
- 4
审查改动并创建 pull request
任务完成后,在 diff 视图中审查建议的改动。你可以继续迭代结果,也可以直接在 GitHub 仓库中创建 pull request。
如果你想先在本地验证改动,也可以先把对应分支检出下来进行测试:
进一步了解 Codex 云端 →在本地检出分支git fetch git checkout <branch-name>