# Codex CLI 核心速查

Source: https://codewiki.com/zh/cheatsheets/codex-cli/

## 安装与认证

- `npm install -g @openai/codex@0.153.0` — 安装本速查表采用的准确 CLI 版本
- `codex --version` — 输出已安装的 CLI 版本
- `codex login` — 通过默认浏览器流程认证
- `codex login --device-auth` — 使用设备代码认证，不打开浏览器
- `printenv OPENAI_API_KEY | codex login --with-api-key` — 从标准输入读取 API 密钥
- `codex login status` — 显示当前认证方式；未登录时返回非零状态
- `codex logout` — 删除已存储的 Codex 凭据

## 启动交互任务

- `codex` — 在当前目录打开终端界面
- `codex 'Explain the failing test'` — 打开终端界面并提供初始任务
- `codex -C repo 'Fix the failing test'` — 在任务开始前设置工作根目录
- `codex -i screenshot.png 'Fix this UI bug'` — 为初始任务附加图片
- `codex --search 'Verify the current dependency API'` — 为本次运行启用实时网页搜索
- `codex --no-alt-screen` — 在普通终端回滚区中显示界面

## 限定权限

- `codex -s read-only` — 允许模型生成的命令读取，但不允许写入
- `codex -s workspace-write -a on-request` — 允许写入工作区，并让 Codex 按需请求批准
- `codex -s workspace-write -a never` — 允许写入工作区，不显示交互式批准提示
- `codex --add-dir ../shared` — 在本次运行中授予另一目录写权限
- `codex --approve-for-me` — 在 workspace-write 模式下通过自动审查处理批准请求
- `codex --dangerously-bypass-approvals-and-sandbox` — 仅在外部已加固的沙箱中移除两层防护

## 控制终端界面

- `/init` — 为当前项目生成 AGENTS.md 框架
- `/status` — 显示当前会话配置与用量
- `/model` — 选择模型与推理强度
- `/permissions` — 在会话中更改批准与沙箱预设
- `/mention src/lib/api.ts` — 把指定工作区文件加入提示
- `/compact` — 用精简的上下文摘要替换早先轮次
- `/exit` — 关闭交互会话

## 非交互运行

- `codex exec 'Run tests and fix failures'` — 不打开终端界面，直接运行一个任务
- `printf '%s\n' 'Explain this diff' | codex exec -` — 从标准输入读取任务
- `codex exec --ephemeral 'Explain this repository'` — 运行任务，不在磁盘保存会话文件
- `codex exec --json 'Run the targeted tests'` — 以 JSONL 流式输出机器可读事件
- `codex exec -o final.txt 'Summarize the change'` — 把智能体最终消息写入文件
- `codex exec --output-schema schema.json 'Report findings'` — 用 JSON Schema 约束最终响应

## 继续或分支会话

- `codex resume` — 从当前目录的已保存交互会话中选择
- `codex resume --last` — 继续最近保存的交互会话
- `codex resume SESSION_ID` — 按标识符或名称继续指定会话
- `codex resume --all` — 显示不受当前目录筛选的会话
- `codex fork SESSION_ID` — 从先前会话开始新对话
- `codex fork --last` — 分支最近保存的交互会话
- `codex exec resume --last 'Run the remaining checks'` — 向最近的非交互会话发送新任务并继续运行

## 审查修改

- `/diff` — 显示已暂存、未暂存和未跟踪的工作区修改
- `/review` — 在当前会话中审查工作树
- `codex review --uncommitted` — 以非交互方式审查已暂存、未暂存和未跟踪的修改
- `codex review --base main` — 审查当前分支相对 main 的修改
- `codex review --commit COMMIT` — 审查一个提交引入的修改
- `printf '%s\n' 'Focus on correctness and missing tests' | codex review -` — 从标准输入读取自定义审查要求

## 覆盖配置

- `codex -m MODEL` — 在本次运行中覆盖已配置的模型
- `codex -p PROFILE` — 在基础配置上叠加具名配置档
- `codex -c key=value` — 在本次调用中覆盖一个配置值
- `codex --strict-config` — config.toml 含未知字段时失败
- `codex features list` — 显示已知功能标志、阶段与实际状态
- `codex features enable FEATURE` — 在 config.toml 中持久启用一项功能
- `codex features disable FEATURE` — 在 config.toml 中持久停用一项功能

## 管理 MCP 服务器

- `codex mcp list` — 列出已配置的 Model Context Protocol 服务器
- `codex mcp list --json` — 以 JSON 列出已配置的服务器
- `codex mcp get NAME --json` — 以 JSON 显示一个服务器配置
- `codex mcp add NAME -- COMMAND ARG` — 注册通过标准输入与输出启动的服务器
- `codex mcp add NAME --url URL` — 注册通过可流式 HTTP 访问的服务器
- `codex mcp login NAME` — 使用 OAuth 认证一个 HTTP 服务器
- `codex mcp remove NAME` — 删除一个服务器配置

## 诊断与集成

- `codex doctor` — 检查安装、配置、认证、运行时、Git 与终端状态
- `codex doctor --summary` — 只输出分组诊断检查与合计
- `codex doctor --json` — 输出已脱敏的机器可读诊断报告
- `codex completion bash` — 生成 Bash 命令补全脚本
- `codex sandbox -- COMMAND ARG` — 在 Codex 提供的沙箱中运行任意命令
- `codex update` — 检查并执行当前版本支持的 CLI 自更新