For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
主导航

Codex CLI

在终端中检查、编辑并运行代码

无需离开终端,即可检查代码、进行更改、运行命令,并将重复性工作自动化。

$ codex
╭──────────────────────────────────────────────────╮
│ >_ OpenAI Codex                                  │
│                                                  │
│ model:     gpt-5.6-sol medium/model to change │
│ directory: ~/code                                │
╰──────────────────────────────────────────────────╯

  To get started, describe a task or try one of these commands:

  /init - create an AGENTS.md file with instructions for Codex
  /status - show current session configuration
  /permissions - choose what Codex is allowed to do
  /model - choose what model and reasoning effort to use
  /review - review any changes and find issues
      

 Refactor the Dashboard component to React Hooks
      
  100% context left · ? for shortcuts
      
01

在本地代码仓库中工作

让 Codex 检查文件、进行编辑,并运行您计算机上已安装的工具。

02

保持掌控

选择适合任务的模型、推理强度、权限和命令。

03

将 Codex 与脚本和 CI 结合使用

以交互方式使用 Codex,或在可重复执行的工作流和流水线中调用 codex exec。

快速入门

开始使用 Codex CLI

安装 Codex、登录,然后从项目目录运行您的第一个任务。

  1. 安装 Codex

    使用适用于 macOS 和 Linux 的独立安装程序安装 Codex CLI。

    安装 Codex

    curl -fsSL https://chatgpt.com/codex/install.sh | sh

    更新 Codex

    curl -fsSL https://chatgpt.com/codex/install.sh | sh
  2. 运行 Codex 并登录

    打开项目目录并运行 codex。首次运行 Codex 时,请选择 使用 ChatGPT 登录 或使用其他可用的登录方式。

    查看身份验证选项
  3. 开始您的第一个任务

    说明您想要完成的任务。例如,让 Codex 解释项目、进行有针对性的更改,或协助调试问题。

    介绍一下这个项目

    在任务前后创建 Git 检查点,以便您还原更改。请参阅 最佳实践.

了解 Codex CLI 能做什么

在一个终端工作循环中集中完成交互式工作、自动化、审查和委派。

01

在终端中完成整个编码循环

在代码仓库中启动 Codex,探索不熟悉的代码、规划更改、编辑文件并运行本地开发工具。引导当前轮次,随时检查显示的命令和差异,并在同一会话中继续后续工作。

了解更多
02

使用技能和插件

将可复用的指令封装为技能,再添加插件,将 Codex 连接到您团队的工具和数据,全程无需离开 CLI。

了解更多
03

在发布前审查更改

针对未提交的更改、某次提交或基准分支运行专项审查。Codex 会按优先级报告发现的问题,但不会修改您的工作树,因此您可以在提交或发起 Pull Request 前处理风险。

了解更多

了解这些 CLI 功能:恢复会话、添加视觉和网页上下文、拆分复杂工作,以及将 Codex 连接到您的开发工具。

Use Codex CLI when…

您在终端中工作

在一个专注的工作循环中探索代码仓库、编辑代码并运行项目。

您需要使用脚本或 CI

在可重复执行的工作流中运行非交互式命令。

您想进行本地代码审查

在提交或发起 Pull Request 前检查更改。

您想将工作交给云端处理

启动云端聊天,之后再返回终端。