跳转到内容

OpenAI Codex CLI 选项与命令

本文整理 Codex CLI 的命令、子命令与参数,内容对应官方 Developer commands、Slash commands、Non-interactive mode 与 CLI customization 等页面。CLI 版本更新很快,参数名、默认值与可用子命令请始终以本机 codex --help 和当前官方文档为准。


概述

codex 是 Codex 的命令行入口。它既可以在终端里进入交互式 TUI,也可以作为一次性命令嵌入脚本和 CI。

三种常见使用姿势:

模式 适合任务 典型命令
交互模式 学习仓库、逐步改代码、需要随时打断 codex
一次性任务 CI、脚本、批量分析、生成摘要 codex exec "任务说明"
恢复会话 延续之前上下文、继续未完成任务 codex resume

本文档约定:

  • 尖括号 <...> 表示必填占位符,方括号 [...] 表示可选。
  • | 表示“或”,例如 read-only | workspace-write。
  • 除特别说明外,参数同时适用于交互模式与子命令。

安装与更新

macOS / Linux(官方独立安装脚本)

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

更新(同一命令即可)

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

自更新(当安装版本支持时)

Terminal window
codex update

💡 Debug 构建会提示你改用正式发布版本。

安装完成后,进入项目目录运行 codex,首次运行选择 Sign in with ChatGPT 或其他登录方式即可。


命令总览

Maturity(成熟度)含义:Stable 稳定、Beta 测试、Experimental 实验性、Deprecated 已弃用。

命令 成熟度 说明
codex Stable 启动终端 UI(TUI),接受全局参数与可选提示词、图片附件。
codex app Stable 在 macOS / Windows 启动 ChatGPT 桌面 App。
codex app-server Experimental 启动 Codex app server,用于本地开发或调试(stdio / WebSocket / Unix socket)。
codex apply Stable 把 Codex 云端对话生成的最新 diff 应用到本地工作区。别名:codex a。
codex archive / codex unarchive Stable 按会话 ID 或名称归档 / 恢复交互会话。
codex cloud Experimental 在终端浏览或执行 Codex 云端对话。别名:codex cloud-tasks。
codex completion Stable 生成 Bash / Zsh / Fish / PowerShell 补全脚本。
codex debug app-server send-message-v2 Experimental 通过内置测试客户端发送一条 V2 消息,调试 app-server。
codex debug models Experimental 打印 Codex 看到的原始模型目录。
codex debug prompt-input Experimental 以 JSON 渲染模型可见的 prompt 输入列表。
codex delete Stable 永久删除保存的交互会话。
codex doctor Stable 生成安装、配置、鉴权、运行时、Git、终端、app-server 与线程的诊断报告。
codex exec Stable 非交互运行。别名:codex e。输出到 stdout 或 JSONL,可恢复历史会话。
codex execpolicy Experimental 评估 execpolicy 规则文件,查看命令会被允许、询问还是阻止。
codex features Stable 列出特性开关,并在 config.toml 中持久启用 / 禁用。
codex fork Stable 从历史会话 fork 出新对话,保留原记录。
codex login Stable 使用 ChatGPT OAuth、设备码、API Key 或 access token 登录。
codex logout Stable 移除已保存的鉴权凭据。
codex mcp Stable 管理 Model Context Protocol 服务器(列出、添加、删除、鉴权)。
codex plugin Stable 从已配置的插件市场安装、列出、移除插件。
codex plugin marketplace Stable 添加、列出、升级或移除插件市场(Git 或本地)。
codex remote-control Experimental 运行或管理本地 app-server 的远程控制,或生成一次性配对码。
codex resume Stable 按 ID 继续交互会话,或恢复最近一次对话。
codex review Stable 非交互式代码审查:未提交改动、分支 diff、某个 commit 或自定义指令。
codex sandbox Stable 在 Codex 提供的 macOS / Linux / Windows 沙箱中运行任意命令。
codex update Stable 检查并应用 Codex CLI 更新。

全局参数

以下参数适用于基础 codex 命令,大部分会传递给子命令(以各子命令帮助为准)。

参数 类型 / 取值 说明
--add-dir path 在主工作区之外,额外授予目录写权限;可重复。
--ask-for-approval, -a on-request | never 控制 Codex 何时在运行命令前暂停等待人工批准。
--cd, -C path 在开始处理请求前设置 agent 的工作目录。
--config, -c key=value 覆盖配置值,尽量按 TOML 解析,否则作为字符串。
--dangerously-bypass-approvals-and-sandbox, --yolo boolean 不使用审批与沙箱运行所有命令;仅限外部已加固环境。
--dangerously-bypass-hook-trust boolean 本次运行跳过 hook 信任要求;仅限已审核 hook 来源的自动化。
--disable feature 强制禁用某特性开关(等价 -c features.<name>=false);可重复。
--enable feature 强制启用某特性开关(等价 -c features.<name>=true);可重复。
--image, -i path[,path...] 给初始提示附加一个或多个图片;逗号分隔或重复该参数。
--local-provider lmstudio | ollama 选择配合 --oss 使用的本地提供方。
--model, -m string 覆盖配置中的模型(例如 gpt-6-sol)。
--no-alt-screen boolean 关闭 TUI 备用屏幕模式。
--oss boolean 使用本地开源模型提供方(配合 --local-provider 或配置项 oss_provider)。
--profile, -p string 在基础用户配置之上叠加 $CODEX_HOME/<profile>.config.toml。
--remote ws://host:port | wss://host:port | unix:// | unix://PATH 连接远端 app-server。仅 codex、resume、fork、archive、delete、unarchive 支持。
--remote-auth-token-env ENV_VAR 从环境变量读取 bearer token,需配合 --remote。
--sandbox, -s read-only | workspace-write | danger-full-access 选择模型生成 shell 命令的沙箱策略。
--search boolean 开启实时联网搜索(web_search = "live",默认为 "cached")。
--strict-config boolean 当 config.toml 含当前版本不识别的字段时报错。
PROMPT string 可选的首条指令;省略则直接进入空白 TUI。

命令详解

codex(交互模式)

无子命令时启动交互式终端 UI(TUI),接受上述全局参数及图片附件。

Terminal window
codex
  • 联网搜索默认为 cached 模式,使用 --search 切换实时浏览。
  • 低摩擦本地工作推荐:
Terminal window
codex --sandbox workspace-write --ask-for-approval on-request

连接远端 app-server:

Terminal window
# 先在另一处启动 server
codex app-server --listen ws://127.0.0.1:8080
# 客户端连接
codex --remote ws://127.0.0.1:8080
codex --remote unix:// # 默认 Unix socket
codex --remote unix:///tmp/codex.sock # 指定路径
codex --remote wss://host:port --remote-auth-token-env CODEX_TOKEN

codex exec(非交互模式)

用于脚本或 CI 的一次性运行:

Terminal window
codex exec "总结仓库结构,列出 5 个高风险区域"

运行时进度输出到 stderr,只有最终消息输出到 stdout,方便管道处理:

Terminal window
codex exec "为最近 10 个提交生成 release notes" | tee release-notes.md

当 stdin 有管道输入且同时提供了提示词时,提示词作为指令,管道内容作为附加上下文。

参数 类型 / 取值 说明
--cd, -C path 执行前设置工作区根目录。
--color always | never | auto 控制 stdout 的 ANSI 颜色。
--dangerously-bypass-approvals-and-sandbox, --yolo boolean 跳过审批与沙箱;危险,仅限隔离运行器。
--dangerously-bypass-hook-trust boolean 本次运行跳过 hook 信任要求。
--ephemeral boolean 不把会话 rollout 文件写入磁盘。
--full-auto boolean 已弃用兼容参数,推荐改用 --sandbox workspace-write。
--ignore-rules boolean 本次运行不加载用户或项目的 execpolicy .rules 文件。
--ignore-user-config boolean 不加载 $CODEX_HOME/config.toml,但鉴权仍用 CODEX_HOME。
--image, -i path[,path...] 给首条消息附加图片。
--json, --experimental-json boolean 输出换行分隔的 JSON 事件流。
--local-provider lmstudio | ollama 配合 --oss 选择本地提供方。
--model, -m string 本次运行的模型覆盖。
--oss boolean 使用本地开源提供方。
--output-last-message, -o path 把最终消息写入文件,便于下游脚本。
--output-schema path JSON Schema 文件,约束最终响应结构。
--profile, -p string 叠加 $CODEX_HOME/<profile>.config.toml。
--sandbox, -s read-only | workspace-write | danger-full-access 沙箱策略,默认读取配置。
--skip-git-repo-check boolean 允许在 Git 仓库之外运行。
-c, --config key=value 内联配置覆盖(可重复)。
PROMPT string | - 任务指令;- 表示从 stdin 读取。

恢复非交互会话:

Terminal window
codex exec "review the change for race conditions"
codex exec resume --last "fix the race conditions you found"
codex exec resume <SESSION_ID> "继续处理下一步"
codex exec resume 参数 类型 / 取值 说明
--all boolean 选择最近会话时,包含当前目录之外的会话。
--image, -i path[,path...] 给后续提示附加图片。
--last boolean 恢复当前目录的最近对话。
PROMPT string | - 恢复后立即发送的后续指令。
SESSION_ID uuid | session name 指定要恢复的会话。

机器可读输出(JSONL):

Terminal window
codex exec --json "总结仓库结构" | jq
{"type":"thread.started","thread_id":"0199a213-81c0-7800-8aa1-bbab2a035a53"}
{"type":"turn.started"}
{"type":"item.started","item":{"id":"item_1","type":"command_execution","command":"bash -lc ls","status":"in_progress"}}
{"type":"item.completed","item":{"id":"item_3","type":"agent_message","text":"Repo contains docs, sdk, and examples directories."}}
{"type":"turn.completed","usage":{"input_tokens":24763,"cached_input_tokens":24448,"output_tokens":122,"reasoning_output_tokens":0}}

结构化输出(配合 JSON Schema):

Terminal window
codex exec "Extract project metadata" \
--output-schema ./schema.json \
-o ./project-metadata.json

CI 中显式鉴权:

Terminal window
CODEX_API_KEY=<api-key> codex exec --json "triage open bug reports"

不要把 OPENAI_API_KEY / CODEX_API_KEY 设为 job 级别的环境变量;仅在需要的那次调用内联设置。


codex resume

按 ID 继续会话,或恢复最近一次对话。

参数 类型 / 取值 说明
--all boolean 选择最近会话时包含当前目录之外的会话。
--include-non-interactive boolean 在选择器和 --last 中包含非交互会话。
--last boolean 跳过选择器,恢复当前目录最近对话。
SESSION_ID uuid | session name 指定要恢复的会话。

接受与 codex 相同的全局参数(含模型、沙箱覆盖)。当当前目录与会话保存目录不同,Codex 会询问使用哪个目录;可用配置项 tui.resume_cwd("current" / "session")固定选择,显式 --cd/-C 优先级最高。


codex fork

从历史会话 fork 出新对话,保留原记录。

参数 类型 / 取值 说明
--all boolean 在选择器中显示当前目录之外的会话。
--last boolean 跳过选择器,直接 fork 最近对话。
SESSION_ID uuid 指定要 fork 的会话。

codex review

非交互式代码审查。目标四选一,或直接传入自定义审查指令。

参数 类型 / 取值 说明
--base branch 审查相对指定基线的改动。
--commit SHA 审查指定 commit 引入的改动。
--strict-config boolean config.toml 含未知字段时报错。
--title string 设置审查摘要中显示的 commit 标题;需配合 --commit。
--uncommitted boolean 审查已暂存、未暂存与未跟踪的改动。
PROMPT string | - 自定义审查指令;- 表示从 stdin 读取。

--uncommitted、--base、--commit 与自定义 PROMPT 互斥;--title 只能用于 --commit。


codex login / codex logout

参数 类型 / 取值 说明
--device-auth boolean 使用 OAuth 设备码流程,不打开浏览器。
--with-access-token boolean 从 stdin 读取 access token。
--with-api-key boolean 从 stdin 读取 API key。
status codex login status 打印当前鉴权模式,已登录时退出码为 0。
Terminal window
printenv OPENAI_API_KEY | codex login --with-api-key
printenv CODEX_ACCESS_TOKEN | codex login --with-access-token
codex login status

codex logout 无参数,会同时移除 API key 与 ChatGPT 凭据。


codex mcp

管理 ~/.codex/config.toml 中的 MCP 服务器条目。

子命令 参数 说明
add <name> -- <command...> 或 --url <value> 通过 stdio 启动命令或 streamable HTTP URL 注册服务器;stdio 支持 --env KEY=VALUE。
get <name> --json 显示指定服务器配置。
list --json 列出已配置的 MCP 服务器。
login <name> --scopes scope1,scope2 对支持 OAuth 的 streamable HTTP 服务器发起登录。
logout <name> — 移除该服务器的 OAuth 凭据。
remove <name> — 删除存储的 MCP 服务器定义。

codex mcp add 额外参数:

参数 类型 / 取值 说明
--bearer-token-env-var ENV_VAR 连接 streamable HTTP 服务器时作为 bearer token 发送的环境变量。
--env KEY=VALUE repeatable 启动 stdio 服务器时的环境变量赋值。
--oauth-client-id CLIENT_ID OAuth 客户端 ID;需 --url。
--oauth-resource RESOURCE 登录时的 OAuth resource 参数;需 --url。
--url https://… 注册 streamable HTTP 服务器(与 COMMAND... 互斥)。
COMMAND... stdio 传输 在 -- 后提供启动 MCP 服务器的可执行文件及参数。
Terminal window
# stdio
codex mcp add my-server --env API_KEY=xxx -- npx -y @some/mcp-server
# streamable HTTP
codex mcp add my-remote --url https://example.com/mcp

codex plugin 与 codex plugin marketplace

子命令 参数 说明
add <plugin[@marketplace]> [--marketplace, -m NAME] [--json] 从已配置市场安装插件。
list [--marketplace, -m NAME] [--available --json] [--json] 列出已安装插件;--available 需配合 --json。
remove <plugin[@marketplace]> [--marketplace, -m NAME] [--json] 从本地配置与缓存移除插件。
marketplace 见下表 管理插件市场来源。
marketplace 子命令 参数 说明
add <source> [--ref REF] [--sparse PATH] [--json] 从 GitHub 简写、Git URL、SSH URL 或本地目录安装市场;--sparse 可重复,仅 Git 来源。
list [--json] 显示当前纳入考虑的插件市场及根路径。
remove <marketplace-name> [--json] 移除已配置的插件市场。
upgrade [marketplace-name] [--json] 刷新一个或全部 Git 市场。
Terminal window
codex plugin marketplace add owner/repo
codex plugin add my-plugin@owner-repo

codex apply

把 Codex 云端对话的最新 diff 应用到本地。

参数 类型 说明
TASK_ID string 要应用 diff 的云端对话标识。

Codex 会打印被修改的文件;若 git apply 失败(如冲突),退出码非 0。


codex archive / codex unarchive / codex delete

参数 类型 / 取值 说明
SESSION session ID | session name 要归档 / 恢复 / 删除的会话;ID 优先于名称。
--remote 连接串 连接远端 app-server 后操作。
--remote-auth-token-env ENV_VAR 远端鉴权读取的 bearer token 环境变量。
--force boolean 仅 delete:不再提示;会话参数必须是 UUID,按名称仍会要求确认。
Terminal window
codex archive <SESSION>
codex unarchive <SESSION>
codex delete <SESSION_UUID> --force

codex cloud

在终端与 Codex 云端对话交互。

参数 类型 / 取值 说明
--attempts 1-4 云端运行的助手尝试次数(best-of-N)。
--env ENV_ID 目标云端环境标识(必填)。
QUERY string 任务提示词;省略则交互式询问。

codex cloud list:

参数 类型 / 取值 说明
--cursor string 上一次请求返回的分页游标。
--env ENV_ID 按环境标识过滤。
--json boolean 输出机器可读 JSON。
--limit 1-20 返回任务数量上限。

codex completion

生成 Shell 补全脚本,重定向到相应位置即可。

参数 类型 / 取值 说明
SHELL bash | zsh | fish | power-shell | elvish 生成补全的 Shell,输出到 stdout。
Terminal window
# Zsh
eval "$(codex completion zsh)"
# 若提示 command not found: compdef
autoload -Uz compinit && compinit
eval "$(codex completion zsh)"

codex doctor

生成诊断报告,用于反馈问题或排查异常安装。

参数 类型 说明
--all boolean 展开详细报告中的长列表。
--ascii boolean 使用 ASCII 状态标签与分隔符。
--json boolean 输出已脱敏的机器可读报告。
--no-color boolean 关闭 ANSI 颜色。
--summary boolean 仅显示分组的检查行与最终计数。

codex features

子命令 说明
codex features list 显示已知特性开关、成熟阶段与当前生效状态。
codex features enable <feature> 在 $CODEX_HOME/config.toml 中持久启用。
codex features disable <feature> 持久禁用。

features 子命令不接受 --profile。


codex execpolicy

在保存前检查 execpolicy 规则文件。

参数 类型 / 取值 说明
--pretty boolean 美化 JSON 输出。
--rules, -r path(可重复) 要评估的 execpolicy 规则文件。
COMMAND... var-args 要按指定策略检查的命令。

codex app-server

供本地开发 / 调试使用的 Codex app server。

参数 类型 / 取值 说明
--analytics-default-enabled boolean 对第一方客户端默认开启分析,除非用户选择关闭。
--code-mode-host ws://HOST/PATH | wss://HOST/PATH 连接远端 Code Mode host,而非启动本地 host。
--listen stdio:// | ws://IP:PORT | unix:// | unix://PATH | off 传输监听 URL。
--stdio boolean 使用 stdio 传输,等价 --listen stdio://,与 --listen 互斥。
--ws-auth capability-token | signed-bearer-token WebSocket 客户端鉴权模式。
--ws-token-file absolute path 共享 capability token 文件。
--ws-token-sha256 hex SHA-256 capability-token 鉴权期望的 SHA-256 摘要。
--ws-shared-secret-file absolute path 验证签名 JWT 的 HMAC 共享密钥文件。
--ws-issuer string 签名 bearer token 期望的 iss。
--ws-audience string 签名 bearer token 期望的 aud。
--ws-max-clock-skew-seconds number 校验 exp / nbf 时允许的时钟偏移。
Terminal window
codex app-server --listen stdio://
codex app-server --listen ws://127.0.0.1:8080
codex app-server --listen unix:///tmp/codex.sock

生成客户端绑定 schema 时追加 --experimental 以包含受控字段与方法。


codex remote-control

Terminal window
codex remote-control # 前台启动远程控制
codex remote-control start # 启动本地 app-server 守护进程并启用远程控制
codex remote-control stop # 停止
codex remote-control pair # 生成并打印短期手动配对码
codex remote-control pair --json

任意 remote-control 命令都可加 --json 输出机器可读结果;pair 的 JSON 含 pairingCode、manualPairingCode、environmentId、expiresAt。


codex sandbox

在同一套沙箱策略下运行任意命令。

macOS(Seatbelt)

参数 类型 / 取值 说明
--allow-unix-socket path 允许命令绑定 / 连接该路径下的 Unix socket;可重复。
--cd, -C DIR 指定工作目录;需 --permission-profile。
--config, -c key=value 传入配置覆盖;可重复。
--include-managed-config boolean 解析权限 profile 时纳入托管要求。
--log-denials boolean 用 log stream 捕获沙箱拒绝并在退出后打印。
--permission-profile, -P NAME 应用配置栈中的具名权限 profile。
--profile, -p NAME 叠加 $CODEX_HOME/NAME.config.toml。
COMMAND... var-args -- 后为要在 Seatbelt 中执行的命令。

Linux(Landlock)与 Windows 参数类似:--cd/-C、--config/-c、--include-managed-config、--permission-profile/-P、--profile/-p、COMMAND...;Windows 在原生沙箱中执行。


codex app

参数 类型 说明
--download-url url 覆盖安装时使用的桌面 App 安装包地址。
PATH path 工作区路径;macOS 会打开该路径,Windows 会打印路径。

调试类命令

命令 参数 说明
codex debug models --bundled 打印模型目录;--bundled 只显示内置目录。
codex debug prompt-input --image, -i、PROMPT 以 JSON 渲染模型可见的 prompt 输入列表。
codex debug app-server send-message-v2 USER_MESSAGE 发送一条 V2 消息,观察 app-server 协议行为。

codex mcp-server 命令与独立二进制 codex-mcp-server 已移除,请改用 Codex app server。


Slash Commands(交互会话内)

在 TUI 的输入框输入 / 打开命令弹窗,继续输入可过滤。会话正在运行时,输入斜杠命令后按 Tab 可排队到下一轮执行。

命令 用途 何时使用
/permissions 设置 Codex 无需询问即可执行的范围。 会话中放宽或收紧审批,例如在 Auto 与 Read Only 间切换。
/ide 引入打开的文件、当前选区等 IDE 上下文。 把编辑器上下文拉进下一条提示。
/keymap 重映射 TUI 快捷键。 查看并持久化自定义快捷键到 config.toml。
/vim 切换 composer 的 Vim 模式。 在 Vim 普通 / 插入模式与默认编辑方式间切换。
/setup-default-sandbox 配置提权 Windows 沙箱(仅 Windows)。 在 Codex 提示后替换降级沙箱。
/sandbox-add-read-dir 给沙箱额外目录读权限(仅 Windows)。 解除命令读取当前可读根之外绝对路径的阻塞。
/agent、/subagents 切换当前 agent 线程。 查看或继续子 agent 线程。
/apps 浏览应用(连接器)并插入提示。 以 $app-slug 附加应用后让 Codex 使用。
/plugins 浏览已安装与可发现的插件。 查看插件工具、安装推荐插件或管理可用性。
/hooks 查看与管理生命周期 hook。 查看已配置 hook、信任新 hook 或禁用非托管 hook。
/clear 清屏并开启新对话。 想同时重置可视界面与对话上下文时。
/rename 重命名当前对话。 给已保存会话一个易辨识的名字。
/archive 归档当前会话并退出。 从活跃列表移除会话但不删除记录。
/delete 永久删除当前会话并退出。 归档不够、需要移除记录时。
/compact 摘要化当前对话以释放 token。 长任务后保留要点又不撑爆上下文。
/copy 复制最近一次完成的输出。 抓取最新响应或计划文本;也可按 Ctrl+O。
/diff 显示 Git diff(含未跟踪文件)。 提交或跑测试前复查 Codex 的改动。
/exit 退出 CLI(等同 /quit)。 另一种退出拼写。
/experimental 切换实验特性。 启用如 Network proxy、Prevent sleep 等选项。
/approve 批准一次自动审查拒绝的重试。 重试被自动审查拒绝的命令或操作。
/memories 配置记忆的使用与生成。 开关记忆注入或生成。
/skills 浏览并使用 skills。 选择相关本地 skill 改进任务表现。
/import 导入 Claude Code 或 Cursor 的配置、项目与对话。 迁移外部 agent 产物到 Codex。
/feedback 发送日志给维护者。 反馈问题或提供诊断。
/init 在当前目录生成 AGENTS.md 脚手架。 为仓库或子目录固化指令。
/logout 退出登录。 在共享机器上清理本地凭据。
/mcp 列出已配置的 MCP 工具。 查看当前会话可调用的外部工具;/mcp verbose 看详情。
/mention 给对话附加文件。 让 Codex 检视指定文件或目录。
/model 选择当前模型(及推理强度)。 在 gpt-6-luna、gpt-6-sol 等之间切换。
/fast 开启 / 关闭 Fast 服务层级。 切换并持久化 Fast 层级。
/plan 切换到计划模式,可附带提示。 让 Codex 先给出执行计划。
/goal 设置、编辑、暂停、恢复、查看或清除任务目标。 给长任务一个持久目标。
/personality 选择沟通风格。 让回复更简洁、更解释或更协作。
/ps 查看后台终端及其最近输出。 不离开主记录查看长时命令。
/stop 停止所有后台终端。 取消当前会话启动的后台任务。
/fork 将当前对话 fork 为新对话。 分支探索新方案而不丢原记录。
/app 在 ChatGPT 桌面 App 中继续当前会话。 从 TUI 转到桌面 App。
/side、/btw 开启临时侧边对话。 提一个聚焦追问而不打断主对话。
/raw 切换原始滚动模式。 让终端选取与复制更直接。
/resume 从会话列表恢复已保存对话。 继续之前的 CLI 会话。
/new 在同一 CLI 会话内开始新对话。 不离开终端重置上下文。
/quit 退出 CLI。 立即离开会话。
/review 让 Codex 审查工作区。 完成后或需要第二双眼睛时。
/status 显示会话配置与 token 用量。 确认模型、审批策略、可写根与剩余上下文。
/usage 查看账户 token 用量或重置额度。 查看每日 / 每周 / 累计用量。
/debug-config 打印配置层级与要求诊断。 排查优先级与策略来源。
/statusline 交互配置 TUI 状态栏字段。 选择并排序页脚项(模型 / 上下文 / 限额 / git / token / 会话)。
/title 交互配置终端标题字段。 选择并排序标题项。
/theme 选择语法高亮主题。 预览并持久化主题。
/pets、/pet 选择或隐藏终端宠物。 用内置或自定义宠物个性化 TUI。

/quit 与 /exit 都会退出;退出前请先保存或提交重要工作。


交互快捷键

快捷键 作用
输入 @ 在工作区搜索文件并加进提示。
Up / Down 恢复草稿历史。
Ctrl+R 搜索提示历史(Enter 选用,Esc 取消)。
Ctrl+O 复制最近一次完成的输出(等同 /copy)。
行首 ! 在当前审批与沙箱设置下运行本地 shell 命令。
Tab Codex 工作时,把后续提示 / 斜杠命令 / shell 命令排队到下一轮。
Enter Codex 工作时,向当前轮注入新指令。
Esc ×2 输入框为空时,编辑上一条用户消息并从该点 fork。
Ctrl+C 或 /exit 关闭会话。
Ctrl+G 用 VISUAL / EDITOR 打开编辑器撰写长提示。

配置与自定义

  • CLI 默认从 ~/.codex/config.toml 继承配置;命令行 -c key=value 的覆盖优先级更高。
  • 主题:/theme 预览并保存到 tui.theme。自定义主题放到 $CODEX_HOME/themes 下的 .tmTheme 文件。
  • 补全:codex completion zsh(或 bash / fish / power-shell / elvish),在 Shell 配置中加载。
  • 提示编辑器:按 Ctrl+G,优先使用 VISUAL,否则 EDITOR。

安全建议

以下组合会影响机器安全,务必谨慎。

  • 无人值守的本地工作推荐 --sandbox workspace-write,尽量待在 workspace 内。
  • 除非身处专用沙箱 VM,否则不要使用 --dangerously-bypass-approvals-and-sandbox / --yolo。
  • 需要给 Codex 更多目录写权限时,优先用 --add-dir,而不是强开 --sandbox danger-full-access。
  • CI 里可把 --json 与 --output-last-message 搭配,既拿到机器可读进度,又得到最终总结。
  • 配置了 required = true 的 MCP 服务器却初始化失败时,codex exec 会直接报错退出,而非跳过。

快速示例

Terminal window
# 只读分析仓库
codex exec "只读分析当前仓库,不要修改文件:1. 项目用途 2. 入口文件 3. 安装/构建/测试命令"
# 分析测试失败日志
npm test 2>&1 | codex exec "总结失败测试并给出最小修复建议" | tee test-summary.md
# 生成结构化数据
codex exec "Extract project metadata" --output-schema ./schema.json -o ./meta.json
# 恢复上一轮
codex exec resume --last "根据刚才发现,修复竞态条件"
# 一轮代码审查
codex review --uncommitted
codex review --base main

参考来源

再次提醒:CLI 更新频繁,以上命令与参数请以本机 codex --help、codex <子命令> --help 与官方最新文档为准。