Codex CLI 快速入门

Codex 是 OpenAI 的编程代理，可以读取、修改和运行代码。它帮助你更快地构建功能、修复 bug，并理解不熟悉的代码。

你可以在多种环境中使用 Codex：终端、IDE，或者在云端的 Codex 界面和 GitHub 中运行任务。

Codex 包含在 ChatGPT Plus、Pro、Business、Edu 和 Enterprise 计划中，也可以通过 OpenAI API 平台的 API 积分使用。

认证方式

你需要 ChatGPT Plus、Pro、Business、Edu 或 Enterprise 计划才能在所有平台上使用 Codex。这是推荐的认证方式，因为它包含最新的模型和功能。

如果你更喜欢使用 OpenAI API 密钥在本地使用 Codex，可以参考下方的 使用 API 密钥 部分。

设置完成后，你可以使用 ChatGPT 账号登录，并以不同方式使用 Codex。

在云端使用

要在云端使用 Codex，首先需要配置一个新的环境供 Codex 工作。

你可以访问 chatgpt.com/codex 的环境设置页面，按照步骤连接 GitHub 仓库。

环境设置完成后，你可以从界面启动编程任务，并实时跟踪进度。你可以查看实时日志来跟踪 Codex 的工作，或者让它在后台运行。

任务完成后，你可以在界面中以 diff 形式查看建议的更改，根据需要迭代，并在 GitHub 仓库中创建 PR。Codex 会显示更改预览，你可以直接接受 PR，或者在本地检出分支测试更改：

git fetch
git checkout branch-name

在 IDE 中使用

你可以为 IDE 安装 Codex 扩展：

• VS Code 扩展
• Cursor 扩展
• Windsurf 扩展

安装后，你会在侧边栏中找到扩展（可能在折叠区域中）。大多数人喜欢将 "Codex" 拖到编辑器右侧。

系统会提示你使用 ChatGPT 账号登录（也可以使用 API 密钥）。

登录后，你可以在编辑器中使用 Codex。默认情况下，它以 "Agent" 模式运行，可以读取文件、进行编辑，并在当前目录中运行命令。

你可以从编辑器撤销编辑，但我们建议在每个任务前后创建 git 检查点，以便在需要时恢复到之前的状态。

在终端中使用（CLI）

Codex CLI 是一个编程代理，你可以在终端本地运行，它可以在你的机器上读取、修改和运行代码。

安装

使用你喜欢的包管理器安装 Codex CLI：

npm 安装

npm install -g @openai/codex

Homebrew 安装

brew install codex

使用

在终端运行 codex 开始使用：

codex

这将使用默认设置运行 Codex CLI，并提示你进行认证。

我们建议使用 ChatGPT 账号登录，因为你已包含使用额度。

然后你可以让 Codex 在当前目录中执行任务。

由于 Codex 可以修改你的代码库，我们建议在每个任务前后创建 git 检查点，以便在需要时恢复到之前的状态。

你可以直接从 CLI 配置使用的模型、审批模式、提示词或其他参数。

典型工作流程

设置完成后，典型的工作流程如下：

1. 使用 Codex CLI 为新项目生成代码
2. 打开你喜欢的 IDE，在 Codex IDE 扩展的辅助下进行编辑
3. 如果你想构建与当前代码库相对独立的新功能，可以将其委托给 Codex 云端代理（例如添加认证、连接数据库、添加新页面等）
4. 在 Codex 界面中查看更改并在 GitHub 上创建 PR
5. 在本地检出 PR 并测试更改
6. 如果需要更改，可以在 GitHub 上通过在评论中 @codex 来迭代 PR
7. 在此期间，你可以继续在 IDE 中处理其他任务
8. 满意后合并 PR
9. 重复以上流程处理其他任务

使用 API 密钥

使用 ChatGPT 登录是推荐的方式，因为它包含最新的模型和所有 Codex 功能。对于无头自动化、脚本编写，或者如果你更喜欢使用 OpenAI API 平台的 API 积分，可以改用 API 密钥认证。

设置 API 密钥访问：

1. 确保你的 OpenAI 平台账户有可用的 API 积分
2. 在 API 密钥仪表板 生成密钥，并在 shell 配置文件中导出为 OPENAI_API_KEY
3. 在 CLI 中，在 ~/.codex/config.toml 中设置 preferred_auth_method = "apikey"，或运行 codex --config preferred_auth_method="apikey" 进行单次会话
4. 在 IDE 扩展中，在提示时选择 "Use API key"，并确保环境变量已设置

你可以随时通过运行 codex --config preferred_auth_method="chatgpt" 或在 IDE 提示中选择 ChatGPT 选项切换回 ChatGPT 登录（默认方式）。

下一步

• 功能特性 - 了解 Codex CLI 的所有功能
• 命令行参考 - 查看完整的命令行选项
• 配置参考 - 自定义 Codex 行为
• 云端功能 - 了解云端任务委托