Codex CLI
如需完整文档索引,请参阅 llms.txt。文档页面的 Markdown 版本可通过在页面后追加
.md来获取 URL。
在终端中检查、编辑并运行代码
Section titled “在终端中检查、编辑并运行代码”无需离开终端,即可检查代码、进行更改、运行命令并自动执行可重复的工作。
为什么使用 Codex CLI
Section titled “为什么使用 Codex CLI”- 面向你的本地仓库工作: 让 Codex 检查文件、进行编辑,并运行你机器上已安装的工具。
- 保持掌控: 选择适合任务的模型、推理强度、权限和命令。
- 结合脚本和 CI: 使用 Codex 以交互方式使用,或调用 codex exec from repeatable workflows and pipelines.
开始使用 Codex CLI。
安装 Codex、登录,并在项目目录中运行你的第一个任务。
1. 安装 Codex
Section titled “1. 安装 Codex”选择以下一种安装方法:
macOS/Linux
Section titled “macOS/Linux”安装 Codex CLI ,使用适用于 macOS 和 Linux 的独立安装程序。
安装:
curl -fsSL https://chatgpt.com/codex/install.sh | sh更新:
curl -fsSL https://chatgpt.com/codex/install.sh | shWindows
Section titled “Windows”安装 Codex CLI ,使用适用于 Windows 的独立安装程序。
安装:
powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"更新:
powershell -ExecutionPolicy ByPass -c "irm https://chatgpt.com/codex/install.ps1 | iex"你也可以安装 Codex CLI ,使用 npm。
安装:
npm install -g @openai/codex更新:
npm install -g @openai/codexHomebrew
Section titled “Homebrew”你也可以安装 Codex CLI ,使用 Homebrew。
安装:
brew install --cask codex更新:
brew upgrade --cask codex2. 运行 Codex 并登录
Section titled “2. 运行 Codex 并登录”打开一个项目目录并运行 codex。首次运行 Codex时,选择 使用 ChatGPT 登录,或使用其他可用的登录方式。
3. 开始你的第一个任务
Section titled “3. 开始你的第一个任务”描述你想完成的事情。例如,让 Codex 解释项目、进行一次聚焦的修改,或帮助调试问题。
Tell me about this project在任务前后创建 Git 检查点,以便你可以还原更改。参见 最佳实践。
查看 Codex CLI 的功能
Section titled “查看 Codex CLI 的功能”使用一个专注的终端循环来完成交互式工作、自动化、代码审查和委派。
- 将编码循环保留在终端中:在仓库中启动 Codex 以探索不熟悉的代码、规划更改、编辑文件,并运行你的本地开发工具。引导当前回合,检查出现的命令和差异,并在同一会话中继续后续工作。
- 使用技能和插件:将可重复的说明打包为技能,然后添加插件来连接 Codex 到你团队的工具和数据,而无需离开 CLI。
- 在发布前审查更改:针对未提交的更改、某个提交或基准分支运行专门审查。 Codex 会报告按优先级排序的问题,而不会修改你的工作树,因此你可以在提交或打开拉取请求前处理风险。
围绕 Codex 构建终端工作流
Section titled “围绕 Codex 构建终端工作流”了解 CLI 可用于恢复会话、添加视觉和网页上下文、拆分复杂工作,以及将 Codex 连接到你的开发工具的功能。
- 返回已保存的聊天 —
codex resume:从当前仓库重新打开最近的聊天,或在需要返回较早工作时搜索本地聊天。 - 将视觉上下文带入提示词 —
codex --image:在第一个提示词中传入错误截图、架构图或设计参考,或将图片粘贴到交互式编写器中。 - 拆分较大的调查 —
subagents:要求 Codex 将聚焦工作委派给专门的 Agent,然后把它们的发现带回主终端会话。 - 搜索当前上下文 —
codex --search:当任务依赖当前发布版本、文档或外部行为时,将一次运行切换到实时网页搜索。搜索活动会保留在转录记录中可见。 - 将工作移至 Codex cloud —
codex cloud:浏览进行中和已完成的聊天,将工作提交到已配置的环境,并从终端将结果应用到你的本地仓库。 - 使用 MCP —
codex mcp连接外部工具:添加本地或远程 MCP 服务器,在需要时进行身份验证,并在 Codex 使用它们之前检查当前会话可用的工具。 - 为每次运行设定边界 —
/permissions:选择 Codex 何时可以无需询问就编辑文件或运行命令,并在继续前检查活动沙箱和可写根目录。 - 让 Codex 适配你的终端 —
codex completion:为你的 shell 生成补全,选择语法主题,并在由 VISUAL 或 EDITOR配置的编辑器中打开较长提示词。
在以下情况下使用 Codex CLI……
Section titled “在以下情况下使用 Codex CLI……”- 你在终端中工作:在一个聚焦循环中探索、编辑并运行仓库。
- 你需要脚本编写或 CI:在可重复的工作流中运行非交互式命令。
- 你想进行本地代码审查:在提交或打开拉取请求之前检查更改。
- 你想把工作交给云端:启动云端聊天,稍后再返回终端。