
Codex 是 OpenAI 的编码代理,可以读取、修改和运行代码。它可以帮助您更快地构建代码、修复错误并理解不熟悉的代码。
它可以满足您的任何需求:在您的终端中、在您的 IDE 中,或者您也可以在云端、在 Codex 界面或在 GitHub 中运行任务。
设置
您需要 ChatGPT Plus、Pro、Team、Edu 或 Enterprise 套餐才能在所有平台上使用 Codex。您也可以使用 OpenAI API 密钥在本地使用 Codex,但这需要额外的设置——您可以在我们的定价页面了解更多信息。
设置完成后,您可以使用 ChatGPT 帐户登录并以不同方式使用 Codex:
- 云代理:您可以导航至chatgpt.com/codex或
@codex
在 GitHub PR 中标记以在云中使用 Codex - IDE 扩展:您可以为您的 IDE 安装 Codex 扩展并在编辑器中使用它
- CLI:您可以安装 Codex CLI 并在终端中使用它
您还可以从 IDE 扩展将任务委托给云代理。
云代理
要在云中使用 Codex,您应该首先为 Codex 配置一个新的工作环境。您可以导航到chatgpt.com/codex上的环境设置页面,然后按照那里的步骤连接 GitHub 存储库。
您可以在专用页面中了解有关如何配置环境的更多信息。
环境设置完成后,您可以从界面启动编码任务,并跟踪进度。您可以实时检查日志,跟踪 Codex 的运行情况,也可以让它在后台运行。
当任务完成后,您将能够以差异的形式查看界面中提出的更改,根据需要进行迭代,并在 GitHub 存储库中创建 PR。
Codex 将向您显示更改的预览,欢迎您按原样接受 PR,或者您可以在本地检查分支并测试更改。
您可以通过运行以下命令来执行此操作(假设您已经克隆了您的存储库):
git fetch
git checkout branch-name
要了解有关如何在云端将任务委托给 Codex 的更多信息,请参阅我们的专用指南。
IDE 扩展
您可以为您的 IDE 安装 Codex 扩展并在编辑器中使用它:
安装完成后,您会在侧边栏的其他扩展程序旁边找到该扩展程序——它可能隐藏在折叠部分中。大多数人喜欢将“Codex”拖到编辑器的右侧。
系统将提示您使用 ChatGPT 帐户登录以开始使用(您也可以使用 API 密钥,但这需要额外的设置 – 您可以在我们的定价页面了解更多信息)。
登录后,您将能够在编辑器中使用 Codex。默认情况下,它将以“代理”模式运行,这意味着它可以在当前目录中读取文件、进行编辑和运行命令。
您可以从编辑器撤消编辑,但我们建议在每个任务之前和之后创建 git 检查点,以便在需要时恢复到以前的状态。
您可以在我们的专用指南中了解有关如何使用 IDE 扩展的更多信息。
命令行界面
Codex CLI 是一个编码代理,您可以从终端本地运行它,并且可以在您的机器上读取、修改和运行代码。
Codex CLI 正式支持 macOS 和 Linux。Windows 支持仍处于实验阶段,我们建议在 WSL 中运行。
安装
使用您喜欢的包管理器安装 Codex CLI:
使用 npm 安装
npm install -g @openai/codex
使用 Homebrew 安装
brew install codex
用法
在终端中运行codex
以开始:
codex
这将使用默认设置运行 Codex CLI,并提示您进行身份验证。我们建议您使用 ChatGPT 帐户登录,因为您已包含使用积分。
然后您将能够要求 Codex 在当前目录中执行任务。
由于 Codex 可以编辑您的代码库,我们建议在每个任务之前和之后创建 git 检查点,以便在需要时能够恢复到以前的状态。
您可以直接从 CLI 配置要使用的模型、批准模式、提示或其他参数。
有关更多详细信息,请参阅我们的Codex CLI 概述页面。
与 Codex 合作
您现在可以开始在您喜欢的环境中使用 Codex。
典型的工作流程如下:
- 从 Codex CLI 开始为新项目生成代码
- 打开您喜欢的 IDE 进行编辑,借助 Codex IDE 扩展
- 如果您想构建与当前代码库完全独立的新功能,您可以将其委托给 Codex 云代理(例如添加身份验证、连接数据库、添加新页面等)
- 审查 Codex 界面的变更并在 GitHub 上创建 PR
- 在本地检查 PR 并测试更改
- 如果需要更改,您可以通过
@codex
在评论中标记来迭代 GitHub 上的 PR - 在此过程中,您可以继续在 IDE 中执行其他任务
- 一旦您对更改感到满意,就可以合并 PR
- 对其他任务重复此过程