命令行选项 – Codex CLI

如何阅读本参考资料

本页列出了文档中介绍的所有 Codex CLI 命令和标志。您可以使用交互式表格按键名或说明搜索。每个部分都会显示选项的成熟度，并标出已弃用的选项和有风险的组合。

CLI 的大多数默认设置继承自 ~/.codex/config.toml。您在命令行中传入的任何 -c key=value 配置覆盖项都会在本次调用中优先生效。请参阅配置基础以了解更多信息。

全局标志

Key	Type / Values	Details
`--add-dir`	`path`	除主工作空间外，授予对其他目录的写入权限。如需指定多个路径，请重复使用此标志。
`--ask-for-approval, -a`	`untrusted \| on-request \| never`	控制 Codex 在运行命令前何时暂停以请求人工审批。
`--cd, -C`	`path`	在智能体开始处理您的请求前，为其设置工作目录。
`--config, -c`	`key=value`	覆盖配置值。值会尽可能解析为 TOML；否则使用原样字符串。
`--dangerously-bypass-approvals-and-sandbox, --yolo`	`boolean`	在不经过审批且不使用沙盒的情况下运行所有命令。仅可在经过外部加固的环境中使用。
`--dangerously-bypass-hook-trust`	`boolean`	在本次调用中运行已启用的钩子，无需预先保存的钩子信任记录。仅适用于已审查钩子来源的自动化流程。
`--disable`	`feature`	强制禁用某个功能标志（转换为 `-c features.<name>=false`）。可重复指定。
`--enable`	`feature`	强制启用某个功能标志（转换为 `-c features.<name>=true`）。可重复指定。
`--image, -i`	`path[,path...]`	将一个或多个图像文件附加到初始提示。多个路径可用逗号分隔，也可重复使用此标志。
`--local-provider`	`lmstudio \| ollama`	选择与 `--oss` 配合使用的本地提供商，并在本次运行中覆盖 `oss_provider`。
`--model, -m`	`string`	覆盖配置中设置的模型（例如 `gpt-5.6-terra`）。
`--no-alt-screen`	`boolean`	禁用 TUI 的备用屏幕模式（在本次运行中覆盖 `tui.alternate_screen`）。
`--oss`	`boolean`	使用本地开源模型提供商。Codex 会采用 `--local-provider` 指定的提供商或您配置的 `oss_provider`；若两者均未设置，则提示您在 LM Studio 和 Ollama 之间选择。
`--profile, -p`	`string`	将 `$CODEX_HOME/profile-name.config.toml` 叠加到基础用户配置之上。
`--remote`	`ws://host:port \| wss://host:port \| unix:// \| unix://PATH`	通过 WebSocket 或 Unix 套接字连接到远程 app-server 端点。支持用于 `codex`、`codex resume`、`codex fork`、`codex archive`、`codex delete` 和 `codex unarchive`；其他子命令会拒绝远程模式。
`--remote-auth-token-env`	`ENV_VAR`	从此环境变量读取 Bearer Token，并在使用 `--remote` 连接时发送。需要 `--remote`；Token 仅通过 `wss://` URL 或仅限本地的 `ws://` URL 发送。
`--sandbox, -s`	`read-only \| workspace-write \| danger-full-access`	为模型生成的 shell 命令选择沙盒策略。
`--search`	`boolean`	启用实时网页搜索（设置 `web_search = "live"`，替代默认值 `"cached"`）。
`--strict-config`	`boolean`	如果 `config.toml` 包含此 Codex 版本无法识别的字段，则报错。`codex`、`exec`、`review`、`resume`、`fork`、`app-server`、`mcp-server` 和 `exec-server` 等运行时命令支持此选项。
`PROMPT`	`string`	用于启动会话的可选文本指令。省略此项可启动不含预填消息的 TUI。

Key

--add-dir

Type / Values

path

Details

除主工作空间外，授予对其他目录的写入权限。如需指定多个路径，请重复使用此标志。

Key

--ask-for-approval, -a

Type / Values

untrusted | on-request | never

Details

控制 Codex 在运行命令前何时暂停以请求人工审批。

Key

--cd, -C

Type / Values

path

Details

在智能体开始处理您的请求前，为其设置工作目录。

Key

--config, -c

Type / Values

key=value

Details

覆盖配置值。值会尽可能解析为 TOML；否则使用原样字符串。

Key

--dangerously-bypass-approvals-and-sandbox, --yolo

Type / Values

boolean

Details

在不经过审批且不使用沙盒的情况下运行所有命令。仅可在经过外部加固的环境中使用。

Key

--dangerously-bypass-hook-trust

Type / Values

boolean

Details

在本次调用中运行已启用的钩子，无需预先保存的钩子信任记录。仅适用于已审查钩子来源的自动化流程。

Key

--disable

Type / Values

feature

Details

强制禁用某个功能标志（转换为 -c features.<name>=false）。可重复指定。

Key

--enable

Type / Values

feature

Details

强制启用某个功能标志（转换为 -c features.<name>=true）。可重复指定。

Key

--image, -i

Type / Values

path[,path...]

Details

将一个或多个图像文件附加到初始提示。多个路径可用逗号分隔，也可重复使用此标志。

Key

--local-provider

Type / Values

lmstudio | ollama

Details

选择与 --oss 配合使用的本地提供商，并在本次运行中覆盖 oss_provider。

Key

--model, -m

Type / Values

string

Details

覆盖配置中设置的模型（例如 gpt-5.6-terra）。

Key

--no-alt-screen

Type / Values

boolean

Details

禁用 TUI 的备用屏幕模式（在本次运行中覆盖 tui.alternate_screen）。

Key

--oss

Type / Values

boolean

Details

使用本地开源模型提供商。Codex 会采用 --local-provider 指定的提供商或您配置的 oss_provider；若两者均未设置，则提示您在 LM Studio 和 Ollama 之间选择。

Key

--profile, -p

Type / Values

string

Details

将 $CODEX_HOME/profile-name.config.toml 叠加到基础用户配置之上。

Key

--remote

Type / Values

ws://host:port | wss://host:port | unix:// | unix://PATH

Details

通过 WebSocket 或 Unix 套接字连接到远程 app-server 端点。支持用于 codex、codex resume、codex fork、codex archive、codex delete 和 codex unarchive；其他子命令会拒绝远程模式。

Key

--remote-auth-token-env

Type / Values

ENV_VAR

Details

从此环境变量读取 Bearer Token，并在使用 --remote 连接时发送。需要 --remote；Token 仅通过 wss:// URL 或仅限本地的 ws:// URL 发送。

Key

--sandbox, -s

Type / Values

read-only | workspace-write | danger-full-access

Details

为模型生成的 shell 命令选择沙盒策略。

Key

--search

Type / Values

boolean

Details

启用实时网页搜索（设置 web_search = "live"，替代默认值 "cached"）。

Key

--strict-config

Type / Values

boolean

Details

如果 config.toml 包含此 Codex 版本无法识别的字段，则报错。codex、exec、review、resume、fork、app-server、mcp-server 和 exec-server 等运行时命令支持此选项。

Key

PROMPT

Type / Values

string

Details

用于启动会话的可选文本指令。省略此项可启动不含预填消息的 TUI。

这些选项适用于基础 codex 命令。大多数选项会传递给子命令；例外情况请参阅上述说明或相应命令的帮助。对于传递给子命令的标志，请以相应命令的帮助为准。例如，codex exec --oss ... 会将 --oss 应用于 exec。

命令概览

“成熟度”列使用实验性、测试版、稳定和已弃用等功能成熟度标签。请参阅功能成熟度，了解这些标签的含义。

Key	成熟度	Details
`codex`	Stable	启动终端 UI。接受上述全局标志，以及可选提示或图像附件。
`codex app`	Stable	在 macOS 或 Windows 上启动 ChatGPT 桌面应用。在 macOS 上，Codex 可以打开工作空间路径；在 Windows 上，Codex 会输出要打开的路径。
`codex app-server`	Experimental	启动 Codex App Server，用于通过 stdio、WebSocket 或 Unix 套接字进行本地开发或调试。
`codex apply`	Stable	将 Codex 云端聊天生成的最新差异应用到您的本地工作树。别名：`codex a`。
`codex archive`	Stable	按会话 ID 或会话名称归档已保存的交互式会话。
`codex cloud`	Experimental	无需打开 TUI，即可从终端浏览或执行 Codex 云端聊天。别名：`codex cloud-tasks`。
`codex completion`	Stable	为 Bash、Zsh、Fish 或 PowerShell 生成 shell 补全脚本。
`codex debug app-server send-message-v2`	Experimental	通过内置测试客户端发送单条 V2 消息，以调试 app-server。
`codex debug models`	Experimental	输出 Codex 可见的原始模型目录，并提供仅检查内置目录的选项。
`codex debug prompt-input`	Experimental	将模型可见的提示输入列表呈现为 JSON，并可选择包含提示和图像。
`codex delete`	Stable	按会话 ID 或会话名称永久删除已保存的交互式会话。
`codex doctor`	Stable	针对本地安装、配置、身份验证、运行时、Git、终端、app-server 和线程清单方面的问题生成诊断报告。
`codex exec`	Stable	以非交互方式运行 Codex。别名：`codex e`。将结果流式输出到 stdout 或 JSONL，并可选择恢复之前的会话。
`codex execpolicy`	Experimental	评估 execpolicy 规则文件，查看命令会被允许执行、要求确认还是被阻止。
`codex features`	Stable	列出功能标志，并在 `config.toml` 中保存其启用或禁用状态。
`codex fork`	Stable	从之前的交互式会话派生出新聊天，并保留原始对话记录。
`codex login`	Stable	使用 ChatGPT OAuth、设备身份验证、API 密钥，或通过 stdin 管道传入的访问 Token 对 Codex 进行身份验证。
`codex logout`	Stable	移除已存储的身份验证凭据。
`codex mcp`	Stable	管理 Model Context Protocol 服务器（列出、添加、移除、身份验证）。
`codex mcp-server`	Deprecated	用于通过 stdio 将 Codex 作为 MCP 服务器运行的接口，现已弃用。请改用 Codex App Server。如需从 Claude Code 调用 Codex，请使用适用于 Claude Code 的 Codex 插件。
`codex plugin`	Stable	安装、列出和移除来自已配置市场来源的插件。
`codex plugin marketplace`	Stable	添加、列出、升级或移除来自 Git 或本地来源的插件市场。
`codex remote-control`	Experimental	运行或管理本地 app-server 的远程控制，或创建一个短期有效的配对码。
`codex resume`	Stable	按 ID 继续之前的交互式会话，或恢复最近一次聊天。
`codex review`	Stable	对未提交的更改、相对于基础分支的差异或某个提交执行非交互式审查，也可使用自定义审查指令。
`codex sandbox`	Stable	在 Codex 提供的 macOS、Linux 或 Windows 沙盒中运行任意命令。
`codex unarchive`	Stable	按会话 ID 或会话名称恢复已归档的交互式会话。
`codex update`	Stable	当已安装版本支持自更新时，检查并应用 Codex CLI 更新。

Key

codex

成熟度

Stable

Details

启动终端 UI。接受上述全局标志，以及可选提示或图像附件。

Key

codex app

成熟度

Stable

Details

在 macOS 或 Windows 上启动 ChatGPT 桌面应用。在 macOS 上，Codex 可以打开工作空间路径；在 Windows 上，Codex 会输出要打开的路径。

Key

codex app-server

成熟度

Experimental

Details

启动 Codex App Server，用于通过 stdio、WebSocket 或 Unix 套接字进行本地开发或调试。

Key

codex apply

成熟度

Stable

Details

将 Codex 云端聊天生成的最新差异应用到您的本地工作树。别名：codex a。

Key

codex archive

成熟度

Stable

Details

按会话 ID 或会话名称归档已保存的交互式会话。

Key

codex cloud

成熟度

Experimental

Details

无需打开 TUI，即可从终端浏览或执行 Codex 云端聊天。别名：codex cloud-tasks。

Key

codex completion

成熟度

Stable

Details

为 Bash、Zsh、Fish 或 PowerShell 生成 shell 补全脚本。

Key

codex debug app-server send-message-v2

成熟度

Experimental

Details

通过内置测试客户端发送单条 V2 消息，以调试 app-server。

Key

codex debug models

成熟度

Experimental

Details

输出 Codex 可见的原始模型目录，并提供仅检查内置目录的选项。

Key

codex debug prompt-input

成熟度

Experimental

Details

将模型可见的提示输入列表呈现为 JSON，并可选择包含提示和图像。

Key

codex delete

成熟度

Stable

Details

按会话 ID 或会话名称永久删除已保存的交互式会话。

Key

codex doctor

成熟度

Stable

Details

针对本地安装、配置、身份验证、运行时、Git、终端、app-server 和线程清单方面的问题生成诊断报告。

Key

codex exec

成熟度

Stable

Details

以非交互方式运行 Codex。别名：codex e。将结果流式输出到 stdout 或 JSONL，并可选择恢复之前的会话。

Key

codex execpolicy

成熟度

Experimental

Details

评估 execpolicy 规则文件，查看命令会被允许执行、要求确认还是被阻止。

Key

codex features

成熟度

Stable

Details

列出功能标志，并在 config.toml 中保存其启用或禁用状态。

Key

codex fork

成熟度

Stable

Details

从之前的交互式会话派生出新聊天，并保留原始对话记录。

Key

codex login

成熟度

Stable

Details

使用 ChatGPT OAuth、设备身份验证、API 密钥，或通过 stdin 管道传入的访问 Token 对 Codex 进行身份验证。

Key

codex logout

成熟度

Stable

Details

移除已存储的身份验证凭据。

Key

codex mcp

成熟度

Stable

Details

管理 Model Context Protocol 服务器（列出、添加、移除、身份验证）。

Key

codex mcp-server

成熟度

Deprecated

Details

用于通过 stdio 将 Codex 作为 MCP 服务器运行的接口，现已弃用。请改用 Codex App Server。如需从 Claude Code 调用 Codex，请使用适用于 Claude Code 的 Codex 插件。

Key

codex plugin

成熟度

Stable

Details

安装、列出和移除来自已配置市场来源的插件。

Key

codex plugin marketplace

成熟度

Stable

Details

添加、列出、升级或移除来自 Git 或本地来源的插件市场。

Key

codex remote-control

成熟度

Experimental

Details

运行或管理本地 app-server 的远程控制，或创建一个短期有效的配对码。

Key

codex resume

成熟度

Stable

Details

按 ID 继续之前的交互式会话，或恢复最近一次聊天。

Key

codex review

成熟度

Stable

Details

对未提交的更改、相对于基础分支的差异或某个提交执行非交互式审查，也可使用自定义审查指令。

Key

codex sandbox

成熟度

Stable

Details

在 Codex 提供的 macOS、Linux 或 Windows 沙盒中运行任意命令。

Key

codex unarchive

成熟度

Stable

Details

按会话 ID 或会话名称恢复已归档的交互式会话。

Key

codex update

成熟度

Stable

Details

当已安装版本支持自更新时，检查并应用 Codex CLI 更新。

命令详情

`codex`（交互式）

运行 codex 而不指定子命令，会启动交互式终端 UI（TUI）。智能体接受上述全局标志和图像附件。网页搜索默认使用缓存模式；使用 --search 可切换为实时浏览。若要更顺畅地在本地工作，请使用 --sandbox workspace-write --ask-for-approval on-request。

使用 --remote ws://host:port 或 --remote wss://host:port，将 TUI 连接到通过 codex app-server --listen ws://IP:PORT 启动的 App Server。对于本地 Unix 套接字，使用 --remote unix:// 可连接默认套接字，使用 --remote unix://PATH 可明确指定路径。当服务器要求使用不记名 Token 进行 WebSocket 身份验证时，请添加 --remote-auth-token-env <ENV_VAR>。

`codex app-server`

在本地启动 Codex App Server。它主要用于开发和调试，可能会在不另行通知的情况下发生变化。

Key	Type / Values	Details
`--analytics-default-enabled`	`boolean`	默认对第一方 app-server 客户端启用分析功能，除非用户在配置中选择停用。
`--code-mode-host`	`ws://HOST/PATH \| wss://HOST/PATH`	连接到远程 Code Mode 主机，而不是启动本地主机。此出站连接在线程间共享，且独立于 `--listen`；连接远程主机时请使用 `wss://`。
`--listen`	`stdio:// \| ws://IP:PORT \| unix:// \| unix://PATH \| off`	传输监听器 URL。使用 `stdio://` 传输 JSONL，使用 `ws://IP:PORT` 指定 TCP WebSocket 端点，使用 `unix://` 指定默认 Unix 套接字，使用 `unix://PATH` 指定自定义 Unix 套接字，或使用 `off` 禁用本地传输。
`--stdio`	`boolean`	使用 stdio 传输。等同于 `--listen stdio://`，且与 `--listen` 互斥。
`--ws-audience`	`string`	已签名持有者 Token 的预期 `aud` 声明。需要 `--ws-auth signed-bearer-token`。
`--ws-auth`	`capability-token \| signed-bearer-token`	app-server WebSocket 客户端的身份验证模式。若省略，则禁用 WebSocket 身份验证；非本地监听器会在启动时发出警告。
`--ws-issuer`	`string`	已签名持有者 Token 的预期 `iss` 声明。需要 `--ws-auth signed-bearer-token`。
`--ws-max-clock-skew-seconds`	`number`	验证已签名持有者 Token 的 `exp` 和 `nbf` 声明时允许的时钟偏差。需要 `--ws-auth signed-bearer-token`。
`--ws-shared-secret-file`	`absolute path`	包含 HMAC 共享密钥的文件，该密钥用于验证已签名的 JWT 持有者 Token。使用 `--ws-auth signed-bearer-token` 时必须提供。
`--ws-token-file`	`absolute path`	包含共享能力 Token 的文件。除非您改为提供 `--ws-token-sha256`，否则应与 `--ws-auth capability-token` 配合使用。
`--ws-token-sha256`	`hexadecimal SHA-256 digest`	用于 capability-token 身份验证的预期 SHA-256 摘要。当客户端 Token 来自其他来源时，使用此项代替 `--ws-token-file`。

Key

--analytics-default-enabled

Type / Values

boolean

Details

默认对第一方 app-server 客户端启用分析功能，除非用户在配置中选择停用。

Key

--code-mode-host

Type / Values

ws://HOST/PATH | wss://HOST/PATH

Details

连接到远程 Code Mode 主机，而不是启动本地主机。此出站连接在线程间共享，且独立于 --listen；连接远程主机时请使用 wss://。

Key

--listen

Type / Values

stdio:// | ws://IP:PORT | unix:// | unix://PATH | off

Details

传输监听器 URL。使用 stdio:// 传输 JSONL，使用 ws://IP:PORT 指定 TCP WebSocket 端点，使用 unix:// 指定默认 Unix 套接字，使用 unix://PATH 指定自定义 Unix 套接字，或使用 off 禁用本地传输。

Key

--stdio

Type / Values

boolean

Details

使用 stdio 传输。等同于 --listen stdio://，且与 --listen 互斥。

Key

--ws-audience

Type / Values

string

Details

已签名持有者 Token 的预期 aud 声明。需要 --ws-auth signed-bearer-token。

Key

--ws-auth

Type / Values

capability-token | signed-bearer-token

Details

app-server WebSocket 客户端的身份验证模式。若省略，则禁用 WebSocket 身份验证；非本地监听器会在启动时发出警告。

Key

--ws-issuer

Type / Values

string

Details

已签名持有者 Token 的预期 iss 声明。需要 --ws-auth signed-bearer-token。

Key

--ws-max-clock-skew-seconds

Type / Values

number

Details

验证已签名持有者 Token 的 exp 和 nbf 声明时允许的时钟偏差。需要 --ws-auth signed-bearer-token。

Key

--ws-shared-secret-file

Type / Values

absolute path

Details

包含 HMAC 共享密钥的文件，该密钥用于验证已签名的 JWT 持有者 Token。使用 --ws-auth signed-bearer-token 时必须提供。

Key

--ws-token-file

Type / Values

absolute path

Details

包含共享能力 Token 的文件。除非您改为提供 --ws-token-sha256，否则应与 --ws-auth capability-token 配合使用。

Key

--ws-token-sha256

Type / Values

hexadecimal SHA-256 digest

Details

用于 capability-token 身份验证的预期 SHA-256 摘要。当客户端 Token 来自其他来源时，使用此项代替 --ws-token-file。

codex app-server --listen stdio:// 保留默认通过 stdio 传输 JSONL 的行为，codex app-server --stdio 是该传输方式的别名。--listen ws://IP:PORT 为 App Server 客户端启用 WebSocket 传输。服务器接受 ws:// 格式的监听 URL；当客户端使用 wss:// 连接时，请使用 TLS 终止或安全代理。使用 --listen unix:// 可在 Codex 的默认 Unix 套接字上接受 WebSocket 握手，使用 --listen unix:///absolute/path.sock 则可选择套接字路径。如果您要为客户端绑定生成模式，请添加 --experimental 以包含受功能开关控制的字段和方法。

添加 --code-mode-host wss://code-mode.example.com/host，将 App Server 连接到远程 Code Mode 主机，而不是启动本地主机。此出站连接独立于 --listen，由 App Server 进程中的所有线程共享。仅对 localhost 或通过 SSH 转发的主机使用 ws://。

`codex remote-control`

运行 codex remote-control，在前台启动远程控制。使用 codex remote-control start 启动本地 app-server 守护进程并启用远程控制，使用 codex remote-control stop 停止该进程。托管远程控制客户端和 SSH 远程工作流会使用这些命令；构建本地协议客户端时，这些命令不能替代 codex app-server --listen。

守护进程运行后，使用 codex remote-control pair 创建并打印短期有效的手动配对码。为任意远程控制命令添加 --json，即可获得机器可读的输出。对于 pair，JSON 响应包含 pairingCode、manualPairingCode、environmentId 和 expiresAt。

`codex app`

在 macOS 或 Windows 上从终端启动 ChatGPT 桌面应用。在 macOS 上，Codex 可以打开指定的工作空间路径；在 Windows 上，Codex 会打印要打开的路径。

Key	Type / Values	Details
`--download-url`	`url`	用于覆盖安装时所用的 ChatGPT 桌面应用安装程序 URL 的高级选项。
`PATH`	`path`	ChatGPT 桌面应用的工作空间路径。在 macOS 上，Codex 会打开此路径；在 Windows 上，Codex 会输出该路径。

Key

--download-url

Type / Values

url

Details

用于覆盖安装时所用的 ChatGPT 桌面应用安装程序 URL 的高级选项。

Key

PATH

Type / Values

path

Details

ChatGPT 桌面应用的工作空间路径。在 macOS 上，Codex 会打开此路径；在 Windows 上，Codex 会输出该路径。

codex app 会打开已安装的 ChatGPT 桌面应用；如果尚未安装，则会启动安装程序。在 macOS 上，Codex 会打开指定的工作空间路径；在 Windows 上，Codex 会打印安装后要打开的路径。

`codex debug app-server send-message-v2`

使用内置的 app-server 测试客户端，通过 app-server 的 V2 线程/轮次流程发送一条消息。

Key	Type / Values	Details
`USER_MESSAGE`	`string`	通过内置 V2 测试客户端流程发送到 app-server 的消息文本。

Key

USER_MESSAGE

Type / Values

string

Details

通过内置 V2 测试客户端流程发送到 app-server 的消息文本。

此调试流程以 experimentalApi: true 初始化，启动一个线程、发起一个轮次，并以流式方式传输服务器通知。使用此流程可在本地重现并检查 app-server 协议的行为。

`codex debug models`

以 JSON 格式打印 Codex 可见的原始模型目录。

Key	Type / Values	Details
`--bundled`	`boolean`	跳过刷新，仅输出当前 Codex 二进制文件附带的模型目录。

Key

--bundled

Type / Values

boolean

Details

跳过刷新，仅输出当前 Codex 二进制文件附带的模型目录。

如果您只想查看当前二进制文件内置的目录，而不从远程模型端点刷新，请使用 --bundled。

`codex debug prompt-input`

以 JSON 格式准确呈现模型实际可见的提示输入列表。调试指令发现、会话上下文或提示构建时，可使用此命令。

Key	Type / Values	Details
`--image, -i`	`path[,path...]`	为用户提示附加一张或多张图像。多个路径用逗号分隔，也可重复使用此标志。
`PROMPT`	`string`	追加到会话上下文之后的可选用户提示。

Key

--image, -i

Type / Values

path[,path...]

Details

为用户提示附加一张或多张图像。多个路径用逗号分隔，也可重复使用此标志。

Key

PROMPT

Type / Values

string

Details

追加到会话上下文之后的可选用户提示。

`codex apply`

将 Codex 云端聊天中的最新差异应用到本地代码仓库。您必须完成身份验证并拥有该聊天的访问权限。

Key	Type / Values	Details
`TASK_ID`	`string`	待应用差异所对应的 Codex 云端聊天标识符。

Key

TASK_ID

Type / Values

string

Details

待应用差异所对应的 Codex 云端聊天标识符。

Codex 会打印已应用补丁的文件；如果 git apply 失败（例如因冲突），则会以非零退出码退出。

`codex review`

以非交互方式运行代码审查。请仅选择一个审查目标，或将自定义审查指令作为提示传入。

Key	Type / Values	Details
`--base`	`branch`	审查与指定基础分支相比的更改。
`--commit`	`SHA`	审查指定提交引入的更改。
`--strict-config`	`boolean`	如果 `config.toml` 包含此 Codex 版本无法识别的字段，则报错。
`--title`	`string`	设置审查摘要中显示的提交标题。需要 `--commit`。
`--uncommitted`	`boolean`	审查已暂存、未暂存和未跟踪的更改。
`PROMPT`	`string \| - (read stdin)`	自定义审查指令。使用 `-` 从 stdin 读取指令。

Key

--base

Type / Values

branch

Details

审查与指定基础分支相比的更改。

Key

--commit

Type / Values

SHA

Details

审查指定提交引入的更改。

Key

--strict-config

Type / Values

boolean

Details

如果 config.toml 包含此 Codex 版本无法识别的字段，则报错。

Key

--title

Type / Values

string

Details

设置审查摘要中显示的提交标题。需要 --commit。

Key

--uncommitted

Type / Values

boolean

Details

审查已暂存、未暂存和未跟踪的更改。

Key

PROMPT

Type / Values

string | - (read stdin)

Details

自定义审查指令。使用 - 从 stdin 读取指令。

--uncommitted、--base、--commit 和自定义 PROMPT 互斥。 --title 只能与 --commit 一起使用。

`codex archive` 和 `codex unarchive`

按会话 ID 或会话名称归档或恢复已保存的交互式会话。如果您想清理会话选择器而不删除对话记录，请使用这些命令。会话 ID 优先于会话名称。

codex archive <SESSION>
codex unarchive <SESSION>

Key	Type / Values	Details
`--remote`	`ws://host:port \| wss://host:port \| unix:// \| unix://PATH`	更改归档状态前，先连接到远程 App Server 端点。
`--remote-auth-token-env`	`ENV_VAR`	当 `--remote` 要求身份验证时，从此环境变量中读取不记名 Token。
`SESSION`	`session ID \| session name`	要归档或恢复的已保存会话。会话 ID 优先于会话名称。

Key

--remote

Type / Values

ws://host:port | wss://host:port | unix:// | unix://PATH

Details

更改归档状态前，先连接到远程 App Server 端点。

Key

--remote-auth-token-env

Type / Values

ENV_VAR

Details

当 --remote 要求身份验证时，从此环境变量中读取不记名 Token。

Key

SESSION

Type / Values

session ID | session name

Details

要归档或恢复的已保存会话。会话 ID 优先于会话名称。

`codex delete`

按会话 ID 或会话名称永久删除已保存的交互式会话。仅当您想删除对话记录，而不是将其从活跃会话列表中隐藏时，才使用此命令。

codex delete <SESSION>
codex delete <SESSION_UUID> --force

Key	Type / Values	Details
`--force`	`boolean`	不提示确认，直接删除。会话参数必须为 UUID；若使用名称，仍需交互式确认。
`--remote`	`ws://host:port \| wss://host:port \| unix:// \| unix://PATH`	删除会话前，先连接到远程 App Server 端点。
`--remote-auth-token-env`	`ENV_VAR`	当 `--remote` 要求身份验证时，从此环境变量中读取不记名 Token。
`SESSION`	`session ID \| session name`	要删除的已保存会话。会话 ID 优先于会话名称。

Key

--force

Type / Values

boolean

Details

不提示确认，直接删除。会话参数必须为 UUID；若使用名称，仍需交互式确认。

Key

--remote

Type / Values

ws://host:port | wss://host:port | unix:// | unix://PATH

Details

删除会话前，先连接到远程 App Server 端点。

Key

--remote-auth-token-env

Type / Values

ENV_VAR

Details

当 --remote 要求身份验证时，从此环境变量中读取不记名 Token。

Key

SESSION

Type / Values

session ID | session name

Details

要删除的已保存会话。会话 ID 优先于会话名称。

--force 只能与会话 UUID 一起使用。通过名称指定会话时，仍需确认，以免 Codex 在未提示的情况下删除重名或名称有歧义的会话。

`codex cloud`

在终端中与 Codex 云端聊天交互。默认命令会打开交互式选择器；codex cloud exec 会直接提交任务，codex cloud list 则返回最近的聊天，供脚本处理或快速查看。

Key	Type / Values	Details
`--attempts`	`1-4`	Codex 云端应运行的助手尝试次数（best-of-N）。
`--env`	`ENV_ID`	目标 Codex 云端环境标识符（必填）。使用 `codex cloud` 列出可选项。
`QUERY`	`string`	任务提示。如果省略，Codex 会以交互方式提示您提供详细信息。

Key

--attempts

Type / Values

1-4

Details

Codex 云端应运行的助手尝试次数（best-of-N）。

Key

--env

Type / Values

ENV_ID

Details

目标 Codex 云端环境标识符（必填）。使用 codex cloud 列出可选项。

Key

QUERY

Type / Values

string

Details

任务提示。如果省略，Codex 会以交互方式提示您提供详细信息。

身份验证使用与主 CLI 相同的凭据。如果任务提交失败，Codex 会以非零退出码退出。

`codex cloud list`

列出最近的云端聊天，并可按需进行筛选和分页。

Key	Type / Values	Details
`--cursor`	`string`	上一个请求返回的分页游标。
`--env`	`ENV_ID`	按环境标识符筛选任务。
`--json`	`boolean`	输出机器可读的 JSON，而非纯文本。
`--limit`	`1-20`	要返回的最大任务数。

Key

--cursor

Type / Values

string

Details

上一个请求返回的分页游标。

Key

--env

Type / Values

ENV_ID

Details

按环境标识符筛选任务。

Key

--json

Type / Values

boolean

Details

输出机器可读的 JSON，而非纯文本。

Key

--limit

Type / Values

1-20

Details

要返回的最大任务数。

纯文本输出先打印任务 URL，随后打印状态详情。自动化场景请使用 --json。JSON 负载包含一个 tasks 数组和一个可选的 cursor 值。每个任务都包含 id、url、title、status、updated_at、environment_id、environment_label、summary、is_review 和 attempt_total。

`codex completion`

生成 Shell 补全脚本并将输出重定向到适当位置，例如 codex completion zsh > "${fpath[1]}/_codex"。

Key	Type / Values	Details
`SHELL`	`bash \| zsh \| fish \| power-shell \| elvish`	要为其生成补全脚本的 Shell。输出将打印到 stdout。

Key

SHELL

Type / Values

bash | zsh | fish | power-shell | elvish

Details

要为其生成补全脚本的 Shell。输出将打印到 stdout。

`codex doctor`

在提交支持请求前，或排查 Codex 安装故障时，生成本地诊断报告。报告会检查安装、配置、身份验证、运行时、 Git、终端、app-server 和线程清单是否正常。

Key	Type / Values	Details
`--all`	`boolean`	展开人类可读的详细报告中的长列表。
`--ascii`	`boolean`	在人类可读的输出中使用 ASCII 状态标签和分隔符。
`--json`	`boolean`	输出经过脱敏的机器可读支持报告。
`--no-color`	`boolean`	在人类可读的输出中禁用 ANSI 颜色。
`--summary`	`boolean`	仅显示按组排列的检查项行和最终计数汇总。

Key

--all

Type / Values

boolean

Details

展开人类可读的详细报告中的长列表。

Key

--ascii

Type / Values

boolean

Details

在人类可读的输出中使用 ASCII 状态标签和分隔符。

Key

--json

Type / Values

boolean

Details

输出经过脱敏的机器可读支持报告。

Key

--no-color

Type / Values

boolean

Details

在人类可读的输出中禁用 ANSI 颜色。

Key

--summary

Type / Values

boolean

Details

仅显示按组排列的检查项行和最终计数汇总。

`codex features`

管理存储在 $CODEX_HOME/config.toml 中的功能标志。enable 和 disable 命令会持久保存更改，使其应用于后续会话。 features 子命令不接受 --profile。

Key	Type / Values	Details
`Disable subcommand`	`codex features disable <feature>`	在 `$CODEX_HOME/config.toml` 中保存禁用某个功能标志的设置。
`Enable subcommand`	`codex features enable <feature>`	在 `$CODEX_HOME/config.toml` 中保存启用某个功能标志的设置。
`List subcommand`	`codex features list`	显示已知的功能标志、各自的成熟度阶段及其实际生效状态。

Key

Disable subcommand

Type / Values

codex features disable <feature>

Details

在 $CODEX_HOME/config.toml 中保存禁用某个功能标志的设置。

Key

Enable subcommand

Type / Values

codex features enable <feature>

Details

在 $CODEX_HOME/config.toml 中保存启用某个功能标志的设置。

Key

List subcommand

Type / Values

codex features list

Details

显示已知的功能标志、各自的成熟度阶段及其实际生效状态。

`codex exec`

对于应无需人工交互即可完成的脚本或 CI 运行，请使用 codex exec（或简写形式 codex e）。

Key	Type / Values	Details
`--cd, -C`	`path`	执行任务前设置工作空间根目录。
`--color`	`always \| never \| auto`	控制 stdout 中 ANSI 颜色的使用。
`--dangerously-bypass-approvals-and-sandbox, --yolo`	`boolean`	绕过审批提示和沙盒限制。此操作有危险，仅可在隔离的运行器中使用。
`--dangerously-bypass-hook-trust`	`boolean`	本次调用运行已启用的钩子时，不要求存在持久保存的钩子信任记录。仅供已审查钩子来源的自动化使用。
`--ephemeral`	`boolean`	运行时不将会话运行记录文件持久保存到磁盘。
`--full-auto`	`boolean`	已弃用的兼容性标志。建议使用 `--sandbox workspace-write`；使用此标志时，Codex 会输出警告。
`--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` 配合使用的本地提供商，并在本次运行中覆盖 `oss_provider`。
`--model, -m`	`string`	在本次运行中覆盖已配置的模型。
`--oss`	`boolean`	使用本地开源提供商。Codex 会采用 `--local-provider` 指定的提供商或您配置的 `oss_provider`；如果两者均未设置，则报错退出。
`--output-last-message, -o`	`path`	将助手的最终消息写入文件，便于下游脚本处理。
`--output-schema`	`path`	描述预期最终响应结构的 JSON Schema 文件。Codex 会根据该文件验证工具输出。
`--profile, -p`	`string`	将 `$CODEX_HOME/profile-name.config.toml` 叠加到基础用户配置之上。
`--sandbox, -s`	`read-only \| workspace-write \| danger-full-access`	用于模型生成命令的沙盒策略。默认采用配置值。
`--skip-git-repo-check`	`boolean`	允许在 Git 代码仓库之外运行（适用于临时使用的目录）。
`-c, --config`	`key=value`	为非交互式运行提供内联配置覆盖（可重复指定）。
`PROMPT`	`string \| - (read stdin)`	任务的初始指令。使用 `-` 通过 stdin 管道传入提示。
`Resume subcommand`	`codex exec resume [SESSION_ID]`	按 ID 恢复 exec 会话，或添加 `--last` 以继续当前工作目录下最近的会话。添加 `--all` 可将任意目录中的会话纳入选择范围。可提供一个可选的后续提示。

Key

--cd, -C

Type / Values

path

Details

执行任务前设置工作空间根目录。

Key

--color

Type / Values

always | never | auto

Details

控制 stdout 中 ANSI 颜色的使用。

Key

--dangerously-bypass-approvals-and-sandbox, --yolo

Type / Values

boolean

Details

绕过审批提示和沙盒限制。此操作有危险，仅可在隔离的运行器中使用。

Key

--dangerously-bypass-hook-trust

Type / Values

boolean

Details

本次调用运行已启用的钩子时，不要求存在持久保存的钩子信任记录。仅供已审查钩子来源的自动化使用。

Key

--ephemeral

Type / Values

boolean

Details

运行时不将会话运行记录文件持久保存到磁盘。

Key

--full-auto

Type / Values

boolean

Details

已弃用的兼容性标志。建议使用 --sandbox workspace-write；使用此标志时，Codex 会输出警告。

Key

--ignore-rules

Type / Values

boolean

Details

本次运行不加载用户或项目的 execpolicy .rules 文件。

Key

--ignore-user-config

Type / Values

boolean

Details

不加载 $CODEX_HOME/config.toml。身份验证仍使用 CODEX_HOME。

Key

--image, -i

Type / Values

path[,path...]

Details

将图像附加到第一条消息。可重复使用；支持以逗号分隔的列表。

Key

--json, --experimental-json

Type / Values

boolean

Details

输出以换行符分隔的 JSON 事件，而非格式化文本。

Key

--local-provider

Type / Values

lmstudio | ollama

Details

选择与 --oss 配合使用的本地提供商，并在本次运行中覆盖 oss_provider。

Key

--model, -m

Type / Values

string

Details

在本次运行中覆盖已配置的模型。

Key

--oss

Type / Values

boolean

Details

使用本地开源提供商。Codex 会采用 --local-provider 指定的提供商或您配置的 oss_provider；如果两者均未设置，则报错退出。

Key

--output-last-message, -o

Type / Values

path

Details

将助手的最终消息写入文件，便于下游脚本处理。

Key

--output-schema

Type / Values

path

Details

描述预期最终响应结构的 JSON Schema 文件。Codex 会根据该文件验证工具输出。

Key

--profile, -p

Type / Values

string

Details

将 $CODEX_HOME/profile-name.config.toml 叠加到基础用户配置之上。

Key

--sandbox, -s

Type / Values

read-only | workspace-write | danger-full-access

Details

用于模型生成命令的沙盒策略。默认采用配置值。

Key

--skip-git-repo-check

Type / Values

boolean

Details

允许在 Git 代码仓库之外运行（适用于临时使用的目录）。

Key

-c, --config

Type / Values

key=value

Details

为非交互式运行提供内联配置覆盖（可重复指定）。

Key

PROMPT

Type / Values

string | - (read stdin)

Details

任务的初始指令。使用 - 通过 stdin 管道传入提示。

Key

Resume subcommand

Type / Values

codex exec resume [SESSION_ID]

Details

按 ID 恢复 exec 会话，或添加 --last 以继续当前工作目录下最近的会话。添加 --all 可将任意目录中的会话纳入选择范围。可提供一个可选的后续提示。

Codex 默认输出经过格式化的内容。添加 --json 可接收以换行符分隔的 JSON 事件（每次状态变化对应一个事件）。可选的 resume 子命令可让您继续执行非交互式任务。使用 --last 选择当前工作目录下最近的会话，或添加 --all 以搜索所有会话：

Key	Type / Values	Details
`--all`	`boolean`	选择最近的会话时，将当前工作目录之外的会话也纳入选择范围。
`--image, -i`	`path[,path...]`	为后续提示附加一张或多张图像。多个路径用逗号分隔，也可重复使用此标志。
`--last`	`boolean`	恢复当前工作目录下最近的聊天。
`PROMPT`	`string \| - (read stdin)`	恢复会话后立即发送的可选后续指令。
`SESSION_ID`	`uuid \| session name`	恢复指定会话。省略此项并使用 `--last` 可继续最近的会话。

Key

--all

Type / Values

boolean

Details

选择最近的会话时，将当前工作目录之外的会话也纳入选择范围。

Key

--image, -i

Type / Values

path[,path...]

Details

为后续提示附加一张或多张图像。多个路径用逗号分隔，也可重复使用此标志。

Key

--last

Type / Values

boolean

Details

恢复当前工作目录下最近的聊天。

Key

PROMPT

Type / Values

string | - (read stdin)

Details

恢复会话后立即发送的可选后续指令。

Key

SESSION_ID

Type / Values

uuid | session name

Details

恢复指定会话。省略此项并使用 --last 可继续最近的会话。

`codex execpolicy`

保存 execpolicy 规则文件前，请先检查这些文件。codex execpolicy check 接受一个或多个 --rules 标志（例如，可指定 ~/.codex/rules 下的文件），并输出 JSON，显示最严格的判定结果以及所有匹配规则。添加 --pretty 可格式化输出。execpolicy 命令目前处于预览阶段。

Key	Type / Values	Details
`--pretty`	`boolean`	以易读格式输出 JSON 结果。
`--rules, -r`	`path (repeatable)`	要评估的 execpolicy 规则文件的路径。可多次指定此标志，以合并多个文件中的规则。
`COMMAND...`	`var-args`	要根据指定策略进行检查的命令。

Key

--pretty

Type / Values

boolean

Details

以易读格式输出 JSON 结果。

Key

--rules, -r

Type / Values

path (repeatable)

Details

要评估的 execpolicy 规则文件的路径。可多次指定此标志，以合并多个文件中的规则。

Key

COMMAND...

Type / Values

var-args

Details

要根据指定策略进行检查的命令。

使用 ChatGPT 账户、API 密钥或访问令牌对 CLI 进行身份验证。不指定任何标志时，Codex 会打开浏览器以启动 ChatGPT OAuth 流程。

Key	Type / Values	Details
`--device-auth`	`boolean`	使用 OAuth 设备代码流程，而不是打开浏览器窗口。
`--with-access-token`	`boolean`	从 stdin 读取访问 Token（例如 `printenv CODEX_ACCESS_TOKEN \| codex login --with-access-token`）。
`--with-api-key`	`boolean`	从 stdin 读取 API 密钥（例如 `printenv OPENAI_API_KEY \| codex login --with-api-key`）。
`status subcommand`	`codex login status`	输出当前生效的身份验证模式；如果已登录，则以退出码 0 退出。

Key

--device-auth

Type / Values

boolean

Details

使用 OAuth 设备代码流程，而不是打开浏览器窗口。

Key

--with-access-token

Type / Values

boolean

Details

从 stdin 读取访问 Token（例如 printenv CODEX_ACCESS_TOKEN | codex login --with-access-token）。

Key

--with-api-key

Type / Values

boolean

Details

从 stdin 读取 API 密钥（例如 printenv OPENAI_API_KEY | codex login --with-api-key）。

Key

status subcommand

Type / Values

codex login status

Details

输出当前生效的身份验证模式；如果已登录，则以退出码 0 退出。

如果存在凭据，codex login status 会以退出码 0 退出，这对自动化脚本很有用。

`codex logout`

移除已保存的 API 密钥凭据和 ChatGPT 身份验证凭据。此命令没有标志。

`codex mcp`

管理存储在 ~/.codex/config.toml 中的模型上下文协议服务器条目。

Key	Type / Values	Details
`add <name>`	`-- <command...> \| --url <value>`	使用 stdio 启动命令或可流式 HTTP URL 注册服务器。stdio 传输支持 `--env KEY=VALUE`。
`get <name>`	`--json`	显示指定服务器的配置。`--json` 会打印原始配置条目。
`list`	`--json`	列出已配置的 MCP 服务器。添加 `--json` 可获得机器可读的输出。
`login <name>`	`--scopes scope1,scope2`	为可流式 HTTP 服务器启动 OAuth 登录流程（仅限支持 OAuth 的服务器）。
`logout <name>`		移除为可流式 HTTP 服务器保存的 OAuth 凭据。
`remove <name>`		删除已保存的 MCP 服务器定义。

Key

add <name>

Type / Values

-- <command...> | --url <value>

Details

使用 stdio 启动命令或可流式 HTTP URL 注册服务器。stdio 传输支持 --env KEY=VALUE。

Key

get <name>

Type / Values

--json

Details

显示指定服务器的配置。--json 会打印原始配置条目。

Key

list

Type / Values

--json

Details

列出已配置的 MCP 服务器。添加 --json 可获得机器可读的输出。

Key

login <name>

Type / Values

--scopes scope1,scope2

Details

为可流式 HTTP 服务器启动 OAuth 登录流程（仅限支持 OAuth 的服务器）。

Key

logout <name>

Details

移除为可流式 HTTP 服务器保存的 OAuth 凭据。

Key

remove <name>

Details

删除已保存的 MCP 服务器定义。

add 子命令同时支持 stdio 和可流式 HTTP 两种传输方式：

Key	Type / Values	Details
`--bearer-token-env-var`	`ENV_VAR`	连接到可流式 HTTP 服务器时，其值会作为不记名 Token 发送的环境变量。
`--env KEY=VALUE`	`repeatable`	启动 stdio 服务器时应用的环境变量赋值。
`--oauth-client-id`	`CLIENT_ID`	可流式 HTTP MCP 服务器的 OAuth 客户端标识符。需要 `--url`。
`--oauth-resource`	`RESOURCE`	登录可流式 HTTP MCP 服务器时要包含的 OAuth 资源参数。需要 `--url`。
`--url`	`https://…`	注册可流式 HTTP 服务器，而非 stdio 服务器。与 `COMMAND...` 互斥。
`COMMAND...`	`stdio transport`	用于启动 MCP 服务器的可执行文件及参数。请在 `--` 后提供。

Key

--bearer-token-env-var

Type / Values

ENV_VAR

Details

连接到可流式 HTTP 服务器时，其值会作为不记名 Token 发送的环境变量。

Key

--env KEY=VALUE

Type / Values

repeatable

Details

启动 stdio 服务器时应用的环境变量赋值。

Key

--oauth-client-id

Type / Values

CLIENT_ID

Details

可流式 HTTP MCP 服务器的 OAuth 客户端标识符。需要 --url。

Key

--oauth-resource

Type / Values

RESOURCE

Details

登录可流式 HTTP MCP 服务器时要包含的 OAuth 资源参数。需要 --url。

Key

--url

Type / Values

https://…

Details

注册可流式 HTTP 服务器，而非 stdio 服务器。与 COMMAND... 互斥。

Key

COMMAND...

Type / Values

stdio transport

Details

用于启动 MCP 服务器的可执行文件及参数。请在 -- 后提供。

OAuth 操作（login、logout）仅适用于可流式 HTTP 服务器，且服务器必须支持 OAuth。

`codex plugin`

安装、列出和移除来自已配置市场的插件。

Key	Type / Values	Details
`add <plugin[@marketplace]>`	`[--marketplace, -m NAME] [--json]`	从已配置的市场安装插件。如果插件参数省略了 `@marketplace`，请使用 `--marketplace` 或 `-m`。
`list`	`[--marketplace, -m NAME] [--available --json] [--json]`	列出已安装的插件。使用 `--json` 时，输出包含 `installed` 和 `available` 数组；`--available` 会包含市场中尚未安装的插件，并且需要 `--json`。
`marketplace`		管理已配置的市场源。请参阅下方的 `codex plugin marketplace`。
`remove <plugin[@marketplace]>`	`[--marketplace, -m NAME] [--json]`	从本地配置和缓存中移除已安装的插件。使用 `--json` 可获得便于自动化处理的输出。

Key

add <plugin[@marketplace]>

Type / Values

[--marketplace, -m NAME] [--json]

Details

从已配置的市场安装插件。如果插件参数省略了 @marketplace，请使用 --marketplace 或 -m。

Key

list

Type / Values

[--marketplace, -m NAME] [--available --json] [--json]

Details

列出已安装的插件。使用 --json 时，输出包含 installed 和 available 数组；--available 会包含市场中尚未安装的插件，并且需要 --json。

Key

marketplace

Details

管理已配置的市场源。请参阅下方的 codex plugin marketplace。

Key

remove <plugin[@marketplace]>

Type / Values

[--marketplace, -m NAME] [--json]

Details

从本地配置和缓存中移除已安装的插件。使用 --json 可获得便于自动化处理的输出。

codex plugin add --json 会打印 pluginId、name、marketplaceName、 version、installedPath 和 authPolicy。codex plugin list --json 会打印 installed 和 available 两个数组。条目包含 pluginId、name、 marketplaceName、version、installed、enabled、source、installPolicy、 authPolicy；如果可用，还包含 marketplaceSource，其中记录已配置的市场源类型和值。codex plugin remove --json 会打印 pluginId、name 和 marketplaceName。

`codex plugin marketplace`

管理 Codex 可浏览并可从中安装插件的市场源。

Key	Type / Values	Details
`add <source>`	`[--ref REF] [--sparse PATH] [--json]`	通过 GitHub 简写、Git URL、SSH URL 或本地市场根目录安装插件市场。`--sparse` 仅支持 Git 源，可重复指定。
`list`	`[--json]`	显示 Codex 当前考虑使用的插件市场及各市场的根路径。
`remove <marketplace-name>`	`[--json]`	移除已配置的插件市场。
`upgrade [marketplace-name]`	`[--json]`	刷新一个已配置的 Git 市场；若未提供名称，则刷新所有已配置的 Git 市场。

Key

add <source>

Type / Values

[--ref REF] [--sparse PATH] [--json]

Details

通过 GitHub 简写、Git URL、SSH URL 或本地市场根目录安装插件市场。--sparse 仅支持 Git 源，可重复指定。

Key

list

Type / Values

[--json]

Details

显示 Codex 当前考虑使用的插件市场及各市场的根路径。

Key

remove <marketplace-name>

Type / Values

[--json]

Details

移除已配置的插件市场。

Key

upgrade [marketplace-name]

Type / Values

[--json]

Details

刷新一个已配置的 Git 市场；若未提供名称，则刷新所有已配置的 Git 市场。

codex plugin marketplace add 接受 GitHub 简写形式，例如 owner/repo 或 owner/repo@ref，也接受 HTTP 或 HTTPS Git URL、SSH Git URL 和本地市场根目录。使用 --ref 固定 Git 引用，并重复指定 --sparse PATH，对基于 Git 的市场代码仓库进行稀疏检出。

codex plugin marketplace list 会打印当前范围内的市场名称和根目录，包括隐式发现的默认市场以及已配置的市场快照。

在市场的 add、list、upgrade 或 remove 命令中添加 --json，即可获得便于自动化处理的输出。市场 add 命令的 JSON 包含 marketplaceName、 installedRoot 和 alreadyAdded；list 命令的 JSON 包含一个 marketplaces 数组，其条目包含 name、root 和可选的 marketplaceSource；upgrade 命令的 JSON 包含 selectedMarketplaces、upgradedRoots 和 errors；remove 命令的 JSON 包含 marketplaceName 和 installedRoot。

`codex mcp-server`

codex mcp-server 已弃用。请改用 Codex App Server。要在 Claude Code 中调用 Codex，请使用适用于 Claude Code 的 Codex 插件，该插件使用 App Server。

对于现有集成，此命令会通过 stdio 将 Codex 作为 MCP 服务器运行，以供其他工具连接。它会继承全局配置覆盖项，并在下游客户端关闭连接时退出。

`codex resume`

按 ID 继续交互式会话，或恢复最近的聊天。除非您传入 --all，否则 codex resume 会将 --last 的范围限定为当前工作目录。它接受与 codex 相同的全局标志，包括模型和沙盒覆盖项。

如果当前工作目录与会话保存的目录不同， Codex 会询问要使用哪个目录。将 tui.resume_cwd 设置为 "current" 或 "session"，即可沿用相应选择而不再提示。显式指定的 --cd（-C）覆盖项优先于 tui.resume_cwd。

Key	Type / Values	Details
`--all`	`boolean`	选择最近的会话时，将当前工作目录之外的会话也纳入选择范围。
`--include-non-interactive`	`boolean`	将非交互式会话纳入选择器和 `--last` 的选择范围。
`--last`	`boolean`	跳过选择器，恢复当前工作目录下最近的聊天。
`SESSION_ID`	`uuid \| session name`	恢复指定会话。省略此项并使用 `--last` 可继续最近的会话。

Key

--all

Type / Values

boolean

Details

选择最近的会话时，将当前工作目录之外的会话也纳入选择范围。

Key

--include-non-interactive

Type / Values

boolean

Details

将非交互式会话纳入选择器和 --last 的选择范围。

Key

--last

Type / Values

boolean

Details

跳过选择器，恢复当前工作目录下最近的聊天。

Key

SESSION_ID

Type / Values

uuid | session name

Details

恢复指定会话。省略此项并使用 --last 可继续最近的会话。

`codex fork`

从之前的交互式会话派生一个新聊天。默认情况下，codex fork 会打开会话选择器；添加 --last 则改为从您最近的会话派生。

当前工作目录与会话保存的目录不同时，codex fork 使用的工作目录选择提示和 tui.resume_cwd 设置与 codex resume 相同。

Key	Type / Values	Details
`--all`	`boolean`	在选择器中显示当前工作目录之外的会话。
`--last`	`boolean`	跳过选择器，自动从最近的聊天派生新聊天。
`SESSION_ID`	`uuid`	从指定会话派生新会话。省略此项并使用 `--last`，可从最近的会话派生新会话。

Key

--all

Type / Values

boolean

Details

在选择器中显示当前工作目录之外的会话。

Key

--last

Type / Values

boolean

Details

跳过选择器，自动从最近的聊天派生新聊天。

Key

SESSION_ID

Type / Values

uuid

Details

从指定会话派生新会话。省略此项并使用 --last，可从最近的会话派生新会话。

`codex sandbox`

使用沙盒辅助工具，按 Codex 内部采用的同一套策略运行命令。

macOS seatbelt

Key	Type / Values	Details
`--allow-unix-socket`	`path`	允许沙盒中的命令绑定或连接以此路径为根的 Unix 套接字。可重复指定以允许多个路径。
`--cd, -C`	`DIR`	用于解析配置方案和执行命令的工作目录。需要 `--permission-profile`。
`--config, -c`	`key=value`	向沙盒中的运行传入配置覆盖项（可重复指定）。
`--include-managed-config`	`boolean`	解析显式指定的权限配置方案时，纳入受管要求。需要 `--permission-profile`。
`--log-denials`	`boolean`	命令运行时，使用 `log stream` 捕获 macOS 沙盒拒绝事件，并在命令退出后输出这些事件。
`--permission-profile, -P`	`NAME`	应用当前生效的配置栈中按名称指定的权限配置方案。
`--profile, -p`	`NAME`	将 `$CODEX_HOME/NAME.config.toml` 叠加到基础用户配置之上。
`COMMAND...`	`var-args`	要在 macOS Seatbelt 下执行的 Shell 命令。`--` 后的所有内容都会被转发。

Key

--allow-unix-socket

Type / Values

path

Details

允许沙盒中的命令绑定或连接以此路径为根的 Unix 套接字。可重复指定以允许多个路径。

Key

--cd, -C

Type / Values

DIR

Details

用于解析配置方案和执行命令的工作目录。需要 --permission-profile。

Key

--config, -c

Type / Values

key=value

Details

向沙盒中的运行传入配置覆盖项（可重复指定）。

Key

--include-managed-config

Type / Values

boolean

Details

解析显式指定的权限配置方案时，纳入受管要求。需要 --permission-profile。

Key

--log-denials

Type / Values

boolean

Details

命令运行时，使用 log stream 捕获 macOS 沙盒拒绝事件，并在命令退出后输出这些事件。

Key

--permission-profile, -P

Type / Values

NAME

Details

应用当前生效的配置栈中按名称指定的权限配置方案。

Key

--profile, -p

Type / Values

NAME

Details

将 $CODEX_HOME/NAME.config.toml 叠加到基础用户配置之上。

Key

COMMAND...

Type / Values

var-args

Details

要在 macOS Seatbelt 下执行的 Shell 命令。-- 后的所有内容都会被转发。

Linux Landlock

Key	Type / Values	Details
`--cd, -C`	`DIR`	用于解析配置方案和执行命令的工作目录。需要 `--permission-profile`。
`--config, -c`	`key=value`	启动沙盒前应用的配置覆盖项（可重复指定）。
`--include-managed-config`	`boolean`	解析显式指定的权限配置方案时，将受管要求一并纳入。需要 `--permission-profile`。
`--permission-profile, -P`	`NAME`	应用当前生效的配置栈中指定名称的权限配置方案。
`--profile, -p`	`NAME`	将 `$CODEX_HOME/NAME.config.toml` 叠加到基础用户配置之上。
`COMMAND...`	`var-args`	要在 Landlock + seccomp 下执行的命令。请在 `--` 后提供可执行文件。

Key

--cd, -C

Type / Values

DIR

Details

用于解析配置方案和执行命令的工作目录。需要 --permission-profile。

Key

--config, -c

Type / Values

key=value

Details

启动沙盒前应用的配置覆盖项（可重复指定）。

Key

--include-managed-config

Type / Values

boolean

Details

解析显式指定的权限配置方案时，将受管要求一并纳入。需要 --permission-profile。

Key

--permission-profile, -P

Type / Values

NAME

Details

应用当前生效的配置栈中指定名称的权限配置方案。

Key

--profile, -p

Type / Values

NAME

Details

将 $CODEX_HOME/NAME.config.toml 叠加到基础用户配置之上。

Key

COMMAND...

Type / Values

var-args

Details

要在 Landlock + seccomp 下执行的命令。请在 -- 后提供可执行文件。

Windows

Key	Type / Values	Details
`--cd, -C`	`DIR`	用于解析配置方案和执行命令的工作目录。需要 `--permission-profile`。
`--config, -c`	`key=value`	启动沙盒前应用的配置覆盖项（可重复指定）。
`--include-managed-config`	`boolean`	解析显式指定的权限配置方案时，将受管要求一并纳入。需要 `--permission-profile`。
`--permission-profile, -P`	`NAME`	应用当前生效的配置栈中指定名称的权限配置方案。
`--profile, -p`	`NAME`	将 `$CODEX_HOME/NAME.config.toml` 叠加到基础用户配置之上。
`COMMAND...`	`var-args`	要在 Windows 原生沙盒中执行的命令。请在 `--` 后提供可执行文件。

Key

--cd, -C

Type / Values

DIR

Details

用于解析配置方案和执行命令的工作目录。需要 --permission-profile。

Key

--config, -c

Type / Values

key=value

Details

启动沙盒前应用的配置覆盖项（可重复指定）。

Key

--include-managed-config

Type / Values

boolean

Details

解析显式指定的权限配置方案时，将受管要求一并纳入。需要 --permission-profile。

Key

--permission-profile, -P

Type / Values

NAME

Details

应用当前生效的配置栈中指定名称的权限配置方案。

Key

--profile, -p

Type / Values

NAME

Details

将 $CODEX_HOME/NAME.config.toml 叠加到基础用户配置之上。

Key

COMMAND...

Type / Values

var-args

Details

要在 Windows 原生沙盒中执行的命令。请在 -- 后提供可执行文件。

`codex update`

当已安装的版本支持自更新时，检查并应用 Codex CLI 更新。调试构建会打印一条消息，提示您改为安装发布版构建。

标志组合和安全提示

对于可完全在工作空间内执行的无人值守本地任务，请使用 --sandbox workspace-write；除非您在专用沙盒虚拟机中运行，否则请避免使用 --dangerously-bypass-approvals-and-sandbox。
需要授予 Codex 更多目录的写入权限时，请优先使用 --add-dir，而不要强制使用 --sandbox danger-full-access。
在 CI 中搭配使用 --json 和 --output-last-message，以捕获机器可读的进度信息和最终的自然语言摘要。

交互式快捷操作

输入 @ 可在工作空间中搜索文件，并将其路径添加到提示中。
按 Up 或 Down 可恢复历史草稿。
按 Ctrl+R 搜索提示历史记录，然后按 Enter 使用匹配项，或按 Esc 取消。
按 Ctrl+O 或运行 /copy，可复制 Codex 最近完成的输出。
在行首添加 !，即可按当前审批和沙盒设置运行本地 Shell 命令。
Codex 工作期间，按 Tab 可将后续提示、斜杠命令或 Shell 命令排入队列，供下一轮处理。
Codex 工作期间，按 Enter 可向当前轮次添加新指令。
编辑器为空时，按两次 Esc 可编辑上一条用户消息，并从该处派生聊天。
按 Ctrl+C 或运行 /exit 可关闭会话。

Codex CLI 概览：安装、升级和小技巧。
基础配置：持久保存模型、提供商等默认设置。
高级配置：配置方案、提供商、沙盒调优和集成。
AGENTS.md：从概念层面介绍 Codex 智能体的能力和最佳实践。

建议

开始使用

Core concepts

SDKs and CLI

资源

Legacy APIs

Choose a model

Text and code

提示词

Reasoning

Images and video

Realtime and audio

Specialized models

Agents SDK

ChatKit

Search and retrieval

Connect tools and data

Build tool workflows

Computer and code

Media

开始使用

Audio

Connection methods

Sessions and operations

Go live

Performance and quality

Cost and throughput

Safety and governance

Infrastructure and access

运营

Core concepts

Plan

Build

Test and publish

Conversion specs

指南

资源

开始使用

指南

File Upload

API

Measurement

Advertiser API

API 参考

开始使用

基础

探索

可用平台

发布

工作流

能力

参考资料

自定义

配置文件

智能体配置

扩展 ChatGPT 和 Codex 的功能

Linux

Windows

开发工作流

扩展并实现自动化

环境

使用 Codex 构建

第三方集成

参考资料

权限

Codex Security

网络安全

入门

ChatGPT Work

身份与身份验证

工作空间访问权限、策略和模型

插件和连接器控制

使用情况、治理与合规

部署和模型提供商

社区

博客

社区

博客

最近搜索

Topics

`codex`（交互式）

`codex app-server`

`codex remote-control`

`codex app`

`codex debug app-server send-message-v2`

`codex debug models`

`codex debug prompt-input`

`codex apply`

`codex review`

`codex archive` 和 `codex unarchive`

`codex delete`

`codex cloud`

`codex cloud list`

`codex completion`

`codex doctor`

`codex features`

`codex exec`

`codex execpolicy`

`codex login`

`codex logout`

`codex mcp`

`codex plugin`

`codex plugin marketplace`

`codex mcp-server`

`codex resume`

`codex fork`

`codex sandbox`

`codex update`