OpenAI Codex CLI 速查表

Codex CLI(npm: @openai/codex) 最后更新:2026 年 3 月 27 日
⌨️ TUI 与输入
提交与导航
Enter 提交消息(斜杠弹窗打开时可能为执行命令)
Tab Steer 模式:任务运行中可排队;以 ! 开头的 shell 行不提交
历史:跨会话仅文本;本会话可恢复附件与占位符
编辑与剪贴
CtrlC 清空输入框并将完整草稿存入本地历史;连按约 1s 内第二次可退出
CtrlK / CtrlY Kill 行到缓冲区 / Yank 回输入区
CtrlL 仅清屏,保留当前对话(与 /clear 不同)
前缀与弹窗
/ 斜杠命令弹窗;命令名后空格可将 token 提升为原子元素
! 行首:直接执行 shell(不走对话提交路径)
$ 插入 ChatGPT 连接器(Apps),弹窗中选应用后写入 $app-slug
? 快捷键浮层(粘贴爆发检测中不会误触)
远程图片行
于行首 选中 [Image #N] 行; 在行间移动
Del / 删除当前选中的远程图片行
🔌 MCP
配置位置
~/.codex/config.toml [mcp_servers.<name>]
传输方式
stdio command + args + env
HTTP urlbearer_token_env_var、可选 headers
常用键
enabled / required 关闭或启动失败即报错(required=true 时)
enabled_tools 工具白名单;disabled_tools 黑名单
mcp_servers.*.tools.* 按工具设置 approval_mode(auto / prompt / approve)
交互
/mcp 列出当前会话可用 MCP 工具
codex mcp CLI:添加、列出、鉴权等(实验性)
codex mcp-server 将 Codex 作为 MCP server(stdio)
⚡ 斜杠命令
会话与界面
/clear 清屏并新开对话(进行中任务时不可用)
/new 新对话,不清屏
/resume 从保存列表恢复会话
/fork 分叉当前线程;保存会话分叉用 codex fork
/compact 压缩可见 transcript 释放上下文
/copy 复制最近一轮已完成助手输出
/diff 查看 Git diff(含未跟踪文件)
/quit / /exit 退出 CLI
模型与风格
/model 切换模型与推理力度(若模型支持)
/fast on | off | status;可持久化到配置
/personality friendly | pragmatic | none
/plan 进入规划模式;可跟内联提示
权限与状态
/permissions 审批预设(如 Auto、Read Only);/approvals 为别名
/status 模型、审批策略、可写根、Token 用量
/debug-config 配置分层、策略来源诊断
/statusline 页脚字段交互配置 → tui.status_line
工具与审查
/init 生成 AGENTS.md 脚手架
/mention 附加文件或目录路径
/review 工作区代码审查(可用 review_model
/mcp 列出 MCP 工具
/apps 浏览连接器并插入 $app-slug
/agent 切换子代理线程
/ps 实验性后台终端与最近输出
/sandbox-add-read-dir Windows 原生:授予沙箱额外读目录
其他
/experimental 开关实验特性(如 Apps、Smart Approvals)
/feedback 提交诊断与反馈
/logout 清除本地凭据
📁 AGENTS.md 与历史
项目说明文件
AGENTS.md 仓库级持久说明;可用 /init 生成模板
model_instructions_file 用单文件替代内置 AGENTS 说明(config.toml)
project_doc_fallback_filenames 无 AGENTS.md 时尝试的其它文件名
project_doc_max_bytes 读取项目说明的上限字节
历史持久化
~/.codex/history.jsonl 跨会话文本历史(不含附件路径持久化)
history.persistence save-all | none
项目配置(需信任)
.codex/config.toml 项目内覆盖;不信任的项目会跳过
projects.*.trust_level trusted / untrusted
🧠 工作流
规划与审批
/plan 先出计划再实现;运行中任务时暂时不可用
/permissions 切换 Auto、Read Only 等预设
子代理与并行
features.multi_agent 多代理协作工具(默认开)
agents.max_threads 并发线程上限(默认 6)
agents.max_depth 嵌套深度(默认 1)
/agent 在子代理线程间切换
非交互与 CI
codex exec 脚本/流水线;默认只读沙箱
--full-auto workspace-write + on-request 审批
--json JSONL 事件流
--output-schema 结构化最终回复(JSON Schema)
CODEX_API_KEY codex exec 管道场景常用
联网搜索
web_search disabled | cached | live(索引 vs 实时)
codex --search 等价将 web_search 设为 live
Codex Cloud
codex cloud 在终端浏览/执行云端任务(实验性)
codex apply 将最近云端 diff 应用到本地(别名 codex a
⚙️ 配置与环境
配置文件
~/.codex/config.toml 用户主配置
.codex/config.toml 项目层(需信任项目)
requirements.toml 企业/管理员强制约束
#:schema 引用官方 JSON Schema 获编辑器补全
安全相关键(节选)
approval_policy untrusted | on-request | never | granular 表
sandbox_mode read-only | workspace-write | danger-full-access
web_search 见工作流节;可与 tools.web_search 细调
常用环境变量
CODEX_HOME 数据与状态根目录
CODEX_SQLITE_HOME SQLite 状态库目录(或 sqlite_home
CODEX_CA_CERTIFICATE 自定义根证书 PEM(优先于 SSL_CERT_FILE)
OPENAI_API_KEY 部分安装方式与兼容提供方
🔧 技能与特性开关
Skills
skills.config 按路径启用/禁用技能目录(含 SKILL.md
skill_mcp_dependency_install 特性:技能缺 MCP 依赖时可提示安装
特性标志(节选)
unified_exec 统一 PTY exec(默认开,Windows 除外)
multi_agent 多代理工具集
fast_mode Fast 模式与 service_tier = fast
smart_approvals 实验:守护子代理审批准入
codex features list 查看全部特性与生效状态
TUI
tui.alternate_screen auto | always | never
tui.theme 语法高亮主题(kebab-case)
file_opener vscode | cursor | windsurf | …
🖥️ CLI 与子命令
交互
codex 启动 TUI;可跟初始提示或 -i 图片
codex resume --last / --all / 会话 ID
codex fork 分叉已保存会话为新线程
codex login ChatGPT OAuth / 设备码 / API key stdin
codex logout 删除本地凭据
常用全局参数
-m / --model 覆盖模型
-s / --sandbox read-only | workspace-write | danger-full-access
-a / --ask-for-approval untrusted | on-request | never
--full-auto 本地高效预设
--yolo 绕过审批与沙箱(极度危险)
-C / --cd 工作目录
-p / --profile 配置 profile
--search 启用 live 联网搜索
--add-dir 额外可写目录(可重复)
-c / --config key=value 覆盖(可重复)
--enable / --disable 临时开关特性标志
exec 摘录
codex exec 别名 codex e- 从 stdin 读提示
--ephemeral 不落盘 rollout
--skip-git-repo-check 非 Git 目录运行
codex exec resume 续跑非交互会话
其它
codex app 桌面应用(macOS)
codex completion 生成 shell 补全脚本
codex execpolicy 实验:策略规则试跑