Cheat Sheet速查表
跳转到主要内容

OpenAI Codex CLI 常用命令与配置速查表

OpenAI Codex CLI 是 OpenAI 推出的终端原生智能体编程助手(Coding Agent),支持在本地命令行中读取代码库、编辑文件、执行测试、衔接 Codex Cloud 远程任务及接入 MCP 工具生态。

本速查表按日常高频检索路径梳理 CLI 子命令与启动参数、沙箱与审批策略、TUI 交互斜杠命令、终端快捷键及 config.toml / AGENTS.md 配置规范。

🔗 相关矩阵速查:三大终端 AI 编程 CLI 横向对比速查表 · Claude Code 常用命令与 CLI 全景速查表 · Antigravity CLI (agy) 常用命令与配置速查表 · AI Agent Harness 工程架构与核心机制速查表


1. 安装、认证与核心 CLI 命令

1.1 安装与登录

操作命令说明
npm 全局安装npm install -g @openai/codex跨平台标准安装方式
官方脚本安装curl -fsSL https://chatgpt.com/codex/install.sh | shmacOS / Linux 一键安装
账号认证codex login通过浏览器登录 ChatGPT(Plus / Pro / Team 等)账号
API Key 认证export OPENAI_API_KEY="sk-..."适用于无浏览器环境或自动化流水线

1.2 CLI 子命令与全局启动参数

命令 / 参数功能简述典型使用示例
codex启动当前目录的交互式 TUI 会话codex
codex "prompt"携带初始指令启动交互会话codex "排查登录接口 500 超时报错"
codex exec / codex e非交互(Headless)执行,适合脚本与 CI/CDcodex exec "运行全部单测并修复失败用例"
codex exec --json以结构化 JSON 流输出思考过程与文件变更codex exec --json "重构 utils" > run.jsonl
codex review非交互式代码审查(自动扫描当前 Git 变更差异)codex review
codex resume打开历史会话选择器(记录保存在 ~/.codex/sessions/)codex resume / codex resume --last / codex resume <id>
codex apply / codex a将 Codex Cloud 远程任务生成的 Diff 应用到本地工作区codex apply <task_id>
codex cloud查看或管理 Codex Cloud 云端任务codex cloud
codex mcp管理外部 Model Context Protocol (MCP) 服务codex mcp list / codex mcp add <name> ...
-m, --model <name>指定本次会话或任务使用的底层模型codex -m gpt-6.1-sol
--strict-config严格校验 config.toml 语法与配置项是否合法codex --strict-config

2. 沙箱权限与审批策略矩阵(Security & Approval)

Codex CLI 的权限体系分为两层:“底层能访问什么(--sandbox)” 与 “何时弹窗询问人(--ask-for-approval)”。

参数维度可选值行为说明与适用场景
--sandbox <mode>
(简写 -s)
read-only只读模式:仅分析与检索代码,禁止修改文件与执行写入操作
workspace-write工作区写入(推荐默认):仅允许修改当前工作目录内的文件
danger-full-access完全访问:不限制目录与系统写入(仅限受控容器/隔离环境)
--ask-for-approval <policy>on-request推荐默认策略:由模型按任务风险动态请求确认,权限升降可控
on-failure仅在命令失败或异常时升级确认(涉及沙箱外提权时建议仍用 on-request)
never全静默不弹窗:配合非交互脚本或 CI 流水线使用

⚠️ 废弃参数迁移提醒:

  • --full-auto 自 v0.128.0 起已废弃(Deprecated),推荐显式组合沙箱与审批策略: codex --sandbox workspace-write --ask-for-approval on-request "修复测试"
  • 审批策略 untrusted 自 v0.149.0 起已正式移除(Retired),请迁移至 on-request。

3. 交互式内置斜杠命令速查 (Slash Commands)

在 codex TUI 输入框中输入 / 可调用会话控制、流程编排与外观定制命令:

3.1 项目上下文、模型与权限

斜杠命令核心功能使用场景与说明
/init在当前仓库自动生成 AGENTS.md 规范模板新项目接入时一键建立项目记忆与规则
/status查看当前会话模型、权限模式与 Token 占用状态实时监控上下文消耗与运行参数
/model交互式切换底层模型与推理深度(Reasoning Effort)简单重构切轻量档,复杂排障提高推理力度
/permissions实时调整沙箱级别与审批策略会话中按需收紧或放开文件/Shell 执行权限
/mcp查看并管理已连接的 MCP 服务器状态排查外部数据库或 API 工具连接是否就绪

3.2 研发工作流与会话控制

斜杠命令核心功能使用场景与说明
/plan先制定实现方案并等待确认,再动手改代码重大架构调整或跨模块重构前的安全对齐
/review针对当前工作区变更进行多角度代码审查聚焦 Bug、边界条件、安全漏洞与性能隐患
/diff可视化浏览当前尚未提交的文件改动差异快速核对修改行,决定是否继续或回退
/fork从当前上下文分叉出独立的新会话分支并行尝试不同实现方案,避免污染原对话
/compact压缩摘要历史对话上下文,释放可用窗口长会话防上下文溢出与注意力漂移
/copy复制最近一次完整输出到系统剪贴板快捷提取生成的代码片段或排查报告
/title为当前会话线程设置自定义标题方便后续通过 codex resume 快速定位
/statusline / /theme自定义底部状态栏字段 / 切换 TUI 配色主题个人终端界面偏好定制
/prompts:<name>调用自定义 Markdown 提示词模板复用 ~/.codex/prompts/<name>.md 中的团队指令

4. 终端快捷键与输入语法速查

快捷键 / 语法对应操作适用场景与效果
@<path>文件模糊搜索与引用如 @src/auth.ts,快速将目标文件注入上下文
!<command>内联执行本地 Shell如 !npm test,在当前沙箱/审批策略下直接跑命令
Tab预排队下一条指令Codex 正在思考/执行时提前输入下一轮 Prompt 或 ! 命令
Enter运行中实时插话向正在生成回复的 Agent 追加纠偏或补充指示
Ctrl + G唤起外部编辑器在 $VISUAL / $EDITOR(Vim、VS Code 等)中撰写长 Prompt
Ctrl + R检索历史输入反向搜索并复用先前执行过的提示词
Ctrl + L清屏重绘清空终端屏幕显示,保留当前会话与历史上下文
Ctrl + O复制最近输出与 /copy 等效,一键复制最新回答
Ctrl + X打开快捷键菜单调出键盘预设与快捷功能面板
Ctrl + C中断操作 / 退出取消当前运行中的任务或退出 Codex 会话

5. 配置文件与记忆体系 (config.toml & AGENTS.md)

Codex CLI 采用**“项目级覆盖全局级”**的分层配置架构:

配置类型全局路径(所有项目生效)项目级路径(当前仓库生效)核心用途
核心配置~/.codex/config.toml.codex/config.toml默认模型、沙箱级别、网络开关、MCP 配置
项目规范记忆~/.codex/AGENTS.md./AGENTS.md(仓库根目录)构建/测试命令、代码风格、架构约定与禁忌边界
自定义命令~/.codex/prompts/*.md—以 /prompts:<文件名> 形式触发的标准化模板
会话记录~/.codex/sessions/—供 codex resume 恢复的历史会话归档

最小推荐 ~/.codex/config.toml 示例

# 默认使用模型与推理深度
model = "gpt-6.1-sol"

# 默认沙箱与审批策略
sandbox_mode = "workspace-write"
approval_policy = "on-request"

# 默认关闭沙箱内网络访问,按需开启
network_access = false