如何阅读本参考
本页面汇总了所有已记录的 Codex CLI 命令和标志。使用交互式表格按键名或描述进行搜索。每个部分都标明了该选项是稳定版还是实验性功能,并指出了有风险的组合。
CLI 继承了大多数默认配置,来源于 ~/.codex/config.toml。任何
-c key=value 在命令行中传入的覆盖项在该次调用中具有更高优先级。请参见 配置基础 for more information.
全局标志
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--add-dir | path | 授予主工作区之外的额外目录写入权限。可重复指定以添加多个路径。 |
--ask-for-approval, -a | untrusted | on-request | never | 控制 Codex 在运行命令之前何时暂停以等待人工批准。 on-failure 已弃用;建议使用 on-request for interactive runs or never for non-interactive runs. |
--cd, -C | path | 在代理开始处理您的请求之前,为其设置工作目录。 |
--config, -c | key=value | 覆盖配置值。如果可能,值将被解析为 JSON;否则将使用原始字符串。 |
--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...] | 将一个或多个图像文件附加到初始提示词中。多个路径请使用逗号分隔,或重复使用该标志。 |
--model, -m | string | 覆盖配置中设置的模型(例如 gpt-5.4). |
--no-alt-screen | boolean | 禁用 TUI 的备用屏幕模式(覆盖 tui.alternate_screen for this run). |
--oss | boolean | 使用本地开源模型提供者(等同于 -c model_provider="oss")。将验证 Ollama 是否正在运行。 |
--profile, -p | string | 将 $CODEX_HOME/profile-name.config.toml 层叠在基础用户配置之上。 |
--remote | ws://host:port | wss://host:port | 将交互式 TUI 连接到远程 app-server WebSocket 端点。支持 codex, codex resume,且 codex fork;其他子命令会拒绝远程模式。 |
--remote-auth-token-env | ENV_VAR | 从该环境变量读取 bearer token,并在连接 --remote。需要 --remote;令牌仅通过 wss:// URL 或主机为 ws:// 的 URL 时发送该 token。 localhost, 127.0.0.1, or ::1. |
--sandbox, -s | read-only | workspace-write | danger-full-access | 选择用于模型生成 shell 命令的沙盒策略。 |
--search | boolean | 启用实时网络搜索(将设置为 web_search = "live" 而不是默认的 "cached"). |
PROMPT | string | 启动会话的可选文本指令。省略此项将以无预填充消息的方式启动 TUI。 |
--add-dirpath--ask-for-approval, -auntrusted | on-request | neveron-failure 已弃用;建议使用 on-request for interactive runs or never for non-interactive runs.--cd, -Cpath--config, -ckey=value--dangerously-bypass-approvals-and-sandbox, --yoloboolean--dangerously-bypass-hook-trustboolean--disablefeature-c features.<name>=false)。可重复使用。--enablefeature-c features.<name>=true)。可重复使用。--image, -ipath[,path...]--model, -mstringgpt-5.4).--no-alt-screenbooleantui.alternate_screen for this run).--ossboolean-c model_provider="oss")。将验证 Ollama 是否正在运行。--profile, -pstring$CODEX_HOME/profile-name.config.toml 层叠在基础用户配置之上。--remotews://host:port | wss://host:portcodex, codex resume,且 codex fork;其他子命令会拒绝远程模式。--remote-auth-token-envENV_VAR--remote。需要 --remote;令牌仅通过 wss:// URL 或主机为 ws:// 的 URL 时发送该 token。 localhost, 127.0.0.1, or ::1.--sandbox, -sread-only | workspace-write | danger-full-access--searchbooleanweb_search = "live" 而不是默认的 "cached").PROMPTstring这些选项适用于基础 codex 命令,并会向下传递至每个子命令,除非下文某个小节另有说明。运行子命令时,请将全局标志放在其后(例如, codex exec --oss ...),以便 Codex 按预期应用它们。
命令概览
成熟度列使用了诸如 Experimental、Beta 和 Stable 等功能成熟度标签。请参阅 功能成熟度 了解如何解读这些标签。
| 键 | 成熟度 | 详情 |
|---|---|---|
codex | 稳定版 | 启动终端 UI。接受上述全局标志以及可选的提示词或图片附件。 |
codex app | 稳定版 | 在 macOS 或 Windows 上启动 Codex 桌面应用。在 macOS 上,Codex 可以打开一个工作区路径;在 Windows 上,Codex 会打印要打开的路径。 |
codex app-server | 实验性 | 启动 Codex 应用服务器,用于通过 stdio、WebSocket 或 Unix socket 进行本地开发或调试。 |
codex apply | 稳定版 | 将 Codex Cloud 任务生成的最新差异应用到本地工作区。别名: codex a. |
codex cloud | 实验性 | 在终端中浏览或执行 Codex Cloud 任务,而无需打开 TUI。别名: codex cloud-tasks. |
codex completion | 稳定版 | 为 Bash、Zsh、Fish 或 PowerShell 生成 Shell 补全脚本。 |
codex debug app-server send-message-v2 | 实验性 | 通过内置测试客户端发送单条 V2 消息来调试应用服务器。 |
codex debug models | 实验性 | 打印 Codex 读取的原始模型目录,包含用于仅检查内置目录的选项。 |
codex exec | 稳定版 | 以非交互方式运行 Codex。别名: codex e. 将结果流式输出到 stdout 或 JSONL,并可选择恢复之前的会话。 |
codex execpolicy | 实验性 | 评估 execpolicy 规则文件,查看某个命令是被允许、提示还是阻止。 |
codex features | 稳定版 | 列出功能标志,并在 中持久启用或禁用它们 config.toml. |
codex fork | 稳定版 | 将先前的交互式会话派生为一个新线程,同时保留原始记录。 |
codex login | 稳定版 | 使用 ChatGPT OAuth、设备授权、API 密钥或通过 stdin 管道传入的访问令牌对 Codex 进行身份验证。 |
codex logout | 稳定版 | 移除已存储的身份验证凭据。 |
codex mcp | 实验性 | 管理 Model Context Protocol 服务器(列出、添加、移除、身份验证)。 |
codex mcp-server | 实验性 | 将 Codex 自身作为 MCP 服务器通过 stdio 运行。当由其他智能体调用 Codex 时非常有用。 |
codex plugin marketplace | 实验性 | 从 Git 或本地源添加、列出、升级或移除插件市场。 |
codex remote-control | 实验性 | 确保本地 app-server 守护进程正在运行,且已启用远程控制支持。 |
codex resume | 稳定版 | 通过 ID 继续之前的交互式会话,或恢复最近一次对话。 |
codex sandbox | 实验性 | 在 Codex 提供的 macOS、Linux 或 Windows 沙箱内运行任意命令。 |
codex update | 稳定版 | 当已安装的版本支持自我更新时,检查并应用 Codex CLI 更新。 |
命令详情
codex (交互式)
运行 codex 不带子命令时将启动交互式终端 UI (TUI)。Agent 接受上述全局标志以及图像附件。Web 搜索默认使用缓存模式;使用 --search 切换到实时浏览。为了实现低阻力本地工作,使用 --sandbox workspace-write --ask-for-approval on-request.
使用 --remote ws://host:port or --remote wss://host:port 将 TUI 连接到通过以下命令启动的 app server: codex app-server --listen ws://IP:PORT. 添加 --remote-auth-token-env <ENV_VAR> 当服务器要求提供 bearer token 以进行 WebSocket 身份验证时。
codex app-server
在本地启动 Codex app server。这主要用于开发和调试,可能会随时更改,恕不另行通知。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--analytics-default-enabled | boolean | 除非用户在配置中选择退出,否则默认为第一方 app-server 客户端启用分析功能。 |
--listen | stdio:// | ws://IP:PORT | unix:// | unix://PATH | off | 传输层监听器 URL。使用 stdio:// for JSONL, ws://IP:PORT 指定 TCP WebSocket 端点, unix:// 使用默认的 Unix 套接字, unix://PATH 使用自定义 Unix 套接字,或 off 禁用本地传输。 |
--ws-audience | string | 预期的 aud 已签名 bearer token 的声明。需要 --ws-auth signed-bearer-token. |
--ws-auth | capability-token | signed-bearer-token | app-server WebSocket 客户端的身份验证模式。如果省略,则 WebSocket 身份验证将被禁用;非本地监听器会在启动期间发出警告。 |
--ws-issuer | string | 预期的 iss 已签名 bearer token 的声明。需要 --ws-auth signed-bearer-token. |
--ws-max-clock-skew-seconds | number | 验证已签名 bearer token exp and nbf 声明时允许的时钟偏差。需要 --ws-auth signed-bearer-token. |
--ws-shared-secret-file | absolute path | 包含用于验证已签名 JWT bearer token 的 HMAC 共享密钥的文件。需配合 --ws-auth signed-bearer-token. |
--ws-token-file | absolute path | 包含共享能力 token 的文件。需配合 --ws-auth capability-token. |
--analytics-default-enabledboolean--listenstdio:// | ws://IP:PORT | unix:// | unix://PATH | offstdio:// for JSONL, ws://IP:PORT 指定 TCP WebSocket 端点, unix:// 使用默认的 Unix 套接字, unix://PATH 使用自定义 Unix 套接字,或 off 禁用本地传输。--ws-audiencestringaud 已签名 bearer token 的声明。需要 --ws-auth signed-bearer-token.--ws-authcapability-token | signed-bearer-token--ws-issuerstringiss 已签名 bearer token 的声明。需要 --ws-auth signed-bearer-token.--ws-max-clock-skew-secondsnumberexp and nbf 声明时允许的时钟偏差。需要 --ws-auth signed-bearer-token.--ws-shared-secret-fileabsolute path--ws-auth signed-bearer-token.--ws-token-fileabsolute path--ws-auth capability-token.codex app-server --listen stdio:// 保持默认的 JSONL-over-stdio 行为。 --listen ws://IP:PORT 为 app-server 客户端启用 WebSocket 传输。服务器接受 ws:// 监听 URL;当客户端使用 wss://值。使用 --listen unix:// 连接时,请使用 TLS 终止或安全代理;以在 Codex 的默认 Unix 套接字上接受 WebSocket 握手,或 --listen unix:///absolute/path.sock 以选择套接字路径。如果为客户端绑定生成 schema,请添加 --experimental 以包含受控字段和方法。
codex remote-control
确保 app-server 守护程序在启用远程控制支持的情况下运行。托管的远程控制客户端和 SSH 远程工作流使用此命令;它并不能替代 codex app-server --listen 当您构建本地协议客户端时。
codex app
在 macOS 或 Windows 上从终端启动 Codex Desktop。在 macOS 上,Codex 可以打开特定的工作区路径;在 Windows 上,Codex 会打印要打开的路径。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--download-url | url | 用于安装期间 Codex desktop 安装程序 URL 的高级覆盖。 |
PATH | path | Codex Desktop 的工作区路径。在 macOS 上,Codex 会打开此路径;在 Windows 上,Codex 会打印该路径。 |
--download-urlurlPATHpathcodex app 打开已安装的 Codex Desktop 应用,或在应用缺失时启动安装程序。在 macOS 上,Codex 会打开提供的工作区路径;在 Windows 上,它会在安装后打印要打开的路径。
codex debug app-server send-message-v2
使用内置的 app-server 测试客户端,通过 app-server 的 V2 线程/轮次流发送一条消息。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
USER_MESSAGE | string | 通过内置的 V2 测试客户端流发送到 app-server 的消息文本。 |
USER_MESSAGEstring此调试流初始化于 experimentalApi: true, 启动一个线程,发送一个轮次,并流式传输服务器通知。可使用它在本地复现和检查应用与服务器之间的协议行为。
codex debug models
以 JSON 格式打印 Codex 看到的原始模型目录。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--bundled | boolean | 跳过刷新,仅打印当前 Codex 二进制文件捆绑的模型目录。 |
--bundledboolean使用 --bundled 当您只想检查当前二进制文件捆绑的目录,而不想从远程模型端点刷新时。
codex apply
将 Codex 云任务的最新差异应用到本地仓库。您必须经过身份验证并拥有该任务的访问权限。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
TASK_ID | string | 应应用其差异的 Codex Cloud 任务的标识符。 |
TASK_IDstringCodex 会打印已打补丁的文件,如果 git apply 失败(例如,由于冲突),则以非零状态退出。
codex cloud
从终端与 Codex 云任务进行交互。默认命令会打开一个交互式选择器; codex cloud exec 直接提交任务,而 codex cloud list 返回最近的任务,用于脚本编写或快速检查。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--attempts | 1-4 | Codex Cloud 应运行的助手尝试次数 (best-of-N)。 |
--env | ENV_ID | 目标 Codex Cloud 环境标识符(必需)。使用 codex cloud to list options. |
QUERY | string | 任务提示。如果省略,Codex 将以交互方式提示输入详细信息。 |
--attempts1-4--envENV_IDcodex cloud to list options.QUERYstring身份验证遵循与主 CLI 相同的凭据。如果任务提交失败,Codex 将以非零状态退出。
codex cloud list
列出最近的云任务,支持可选的过滤和分页。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--cursor | string | 由上次请求返回的分页游标。 |
--env | ENV_ID | 按环境标识符过滤任务。 |
--json | boolean | 输出机器可读的 JSON 而非纯文本。 |
--limit | 1-20 | 要返回的最大任务数。 |
--cursorstring--envENV_ID--jsonboolean--limit1-20纯文本输出会打印任务 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".
| 键 | 类型 / 值 | 详情 |
|---|---|---|
SHELL | bash | zsh | fish | power-shell | elvish | 要为其生成补全的 Shell。输出打印到 stdout。 |
SHELLbash | zsh | fish | power-shell | elvishcodex features
管理存储在 ~/.codex/config.toml 或所选配置文件中的特性标志。 enable and disable 命令会持久化更改,使其在未来的会话中生效。当你使用 --profile profile-name, Codex writes to $CODEX_HOME/profile-name.config.toml 而不是基础用户配置来启动时。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
Disable subcommand | codex features disable <feature> | 在活动配置文件中持久化禁用某个特性标志。使用 --profile profile-name, writes to $CODEX_HOME/profile-name.config.toml. |
Enable subcommand | codex features enable <feature> | 在活动配置文件中持久化启用某个特性标志。使用 --profile profile-name, writes to $CODEX_HOME/profile-name.config.toml. |
List subcommand | codex features list | 显示已知的特性标志、其成熟度阶段及其有效状态。 |
Disable subcommandcodex features disable <feature>--profile profile-name, writes to $CODEX_HOME/profile-name.config.toml.Enable subcommandcodex features enable <feature>--profile profile-name, writes to $CODEX_HOME/profile-name.config.toml.List subcommandcodex features listcodex exec
使用 codex exec (或简写形式 codex e)用于应在无需人工交互的情况下完成的脚本化或 CI 样式运行。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--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 事件,而不是格式化文本。 |
--model, -m | string | 覆盖此次运行的已配置模型。 |
--oss | boolean | 使用本地开源提供商(需要运行中的 Ollama 实例)。 |
--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 恢复执行会话,或添加 --last 从当前工作目录继续最近的会话。添加 --all 以考虑来自任何目录的会话。接受可选的后续提示。 |
--cd, -Cpath--coloralways | never | auto--dangerously-bypass-approvals-and-sandbox, --yoloboolean--dangerously-bypass-hook-trustboolean--ephemeralboolean--full-autoboolean--sandbox workspace-write;当使用此标志时,Codex 会打印一条警告。--ignore-rulesboolean.rules 文件。--ignore-user-configboolean$CODEX_HOME/config.toml。身份验证仍然使用 CODEX_HOME.--image, -ipath[,path...]--json, --experimental-jsonboolean--model, -mstring--ossboolean--output-last-message, -opath--output-schemapath--profile, -pstring$CODEX_HOME/profile-name.config.toml 层叠在基础用户配置之上。--sandbox, -sread-only | workspace-write | danger-full-access--skip-git-repo-checkboolean-c, --configkey=valuePROMPTstring | - (read stdin)- 从 stdin 管道传入提示。Resume subcommandcodex exec resume [SESSION_ID]--last 从当前工作目录继续最近的会话。添加 --all 以考虑来自任何目录的会话。接受可选的后续提示。Codex 默认输出格式化文本。添加 --json 以接收换行符分隔的 JSON 事件(每次状态更改一个)。可选的 resume 子命令允许你继续非交互式任务。使用 --last 从当前工作目录中选择最近的会话,或添加 --all 以搜索所有会话:
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--all | boolean | 在选择最近的会话时,包含当前工作目录之外的会话。 |
--image, -i | path[,path...] | 将一个或多个图像附加到后续提示中。使用逗号分隔多个路径,或重复使用该标志。 |
--last | boolean | 从当前工作目录恢复最近的对话。 |
PROMPT | string | - (read stdin) | 恢复后立即发送的可选后续指令。 |
SESSION_ID | uuid | 恢复指定的会话。省略并使用 --last 以继续最近的会话。 |
--allboolean--image, -ipath[,path...]--lastbooleanPROMPTstring | - (read stdin)SESSION_IDuuid--last 以继续最近的会话。codex execpolicy
检查 execpolicy 在保存之前检查规则文件。 codex execpolicy check 接受一个或多个 --rules 标志(例如, ~/.codex/rules下的文件)并发出 JSON,显示最严格的决策及任何匹配的规则。添加 --pretty 以格式化输出。 execpolicy 命令目前处于预览阶段。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--pretty | boolean | 格式化打印 JSON 结果。 |
--rules, -r | path (repeatable) | 要评估的 execpolicy 规则文件的路径。提供多个标志以合并多个文件中的规则。 |
COMMAND... | var-args | 要根据指定策略进行检查的命令。 |
--prettyboolean--rules, -rpath (repeatable)COMMAND...var-argscodex login
使用 ChatGPT 账户、API 密钥或访问令牌对 CLI 进行身份验证。不带任何标志时,Codex 将打开浏览器进行 ChatGPT OAuth 流程。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--device-auth | boolean | 使用 OAuth 设备代码流程,而不是打开浏览器窗口。 |
--with-access-token | boolean | 从 stdin 读取访问令牌(例如 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 退出。 |
--device-authboolean--with-access-tokenbooleanprintenv CODEX_ACCESS_TOKEN | codex login --with-access-token).--with-api-keybooleanprintenv OPENAI_API_KEY | codex login --with-api-key).status subcommandcodex login statuscodex login status 退出并返回 0 当存在凭据时,这在自动化脚本中非常有用。
codex logout
移除 API 密钥和 ChatGPT 身份验证的已保存凭据。此命令没有标志。
codex mcp
管理存储在其中的 Model Context Protocol 服务器条目 ~/.codex/config.toml.
| 键 | 类型 / 值 | 详情 |
|---|---|---|
add <name> | -- <command...> | --url <value> | 使用标准输入输出启动器命令或可流式传输的 HTTP URL 注册服务器。支持 --env KEY=VALUE for stdio transports. |
get <name> | --json | 显示特定服务器配置。 --json 打印原始配置条目。 |
list | --json | 列出已配置的 MCP 服务器。添加 --json for machine-readable output. |
login <name> | --scopes scope1,scope2 | 为流式 HTTP 服务器启动 OAuth 登录(仅限支持 OAuth 的服务器)。 |
logout <name> | 移除为流式 HTTP 服务器存储的 OAuth 凭据。 | |
remove <name> | 删除已存储的 MCP 服务器定义。 |
add <name>-- <command...> | --url <value>--env KEY=VALUE for stdio transports.get <name>--json--json 打印原始配置条目。list--json--json for machine-readable output.login <name>--scopes scope1,scope2logout <name>remove <name>The add 子命令支持 stdio 和流式 HTTP 传输:
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--bearer-token-env-var | ENV_VAR | 连接到流式 HTTP 服务器时作为 bearer token 发送其值的环境变量。 |
--env KEY=VALUE | repeatable | 启动 stdio 服务器时应用的环境变量赋值。 |
--url | https://… | 改为注册可流式传输的 HTTP 服务器而非 stdio。与 COMMAND.... |
COMMAND... | stdio transport | 互斥。用于启动 MCP 服务器的可执行文件及其参数。请在 --. |
--bearer-token-env-varENV_VAR--env KEY=VALUErepeatable--urlhttps://…COMMAND....COMMAND...stdio transport--.OAuth 操作 (login, logout) 仅适用于可流式传输的 HTTP 服务器(且仅当该服务器支持 OAuth 时)。
codex plugin marketplace
管理 Codex 可以浏览和安装插件的插件市场源。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
add <source> | [--ref REF] [--sparse PATH] | 从 GitHub 简写、Git URL、SSH URL 或本地市场根目录安装插件市场。 --sparse 仅受 Git 源支持,并且可以重复使用。 |
list | 显示 Codex 当前正在考虑的插件市场以及每个市场的根路径。 | |
remove <marketplace-name> | 移除一个已配置的插件市场。 | |
upgrade [marketplace-name] | 刷新一个已配置的 Git 市场,或者在未提供名称时刷新所有已配置的 Git 市场。 |
add <source>[--ref REF] [--sparse PATH]--sparse 仅受 Git 源支持,并且可以重复使用。listremove <marketplace-name>upgrade [marketplace-name]codex plugin marketplace add 接受 GitHub 简写形式,例如 owner/repo or
owner/repo@ref, HTTP 或 HTTPS Git URL, SSH Git URL 以及本地市场根目录。使用 --ref 来固定 Git 引用,并重复使用 --sparse PATH 以便为基于 Git 的市场仓库使用稀疏检出。
codex plugin marketplace list 打印范围内的市场名称和根路径,包括隐式发现的默认市场和已配置的市场快照。
codex mcp-server
通过 stdio 将 Codex 作为 MCP 服务器运行,以便其他工具进行连接。此命令继承全局配置覆盖,并在下游客户端关闭连接时退出。
codex resume
根据 ID 继续交互式会话,或恢复最近的对话。 codex resume 作用域 --last 为当前工作目录,除非你传递 --all。它接受与以下相同的全局标志 codex, 包括模型和沙盒覆盖。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--all | boolean | 在选择最近的会话时,包含当前工作目录之外的会话。 |
--last | boolean | 跳过选择器并从当前工作目录恢复最近的对话。 |
SESSION_ID | uuid | 恢复指定的会话。省略并使用 --last 以继续最近的会话。 |
--allboolean--lastbooleanSESSION_IDuuid--last 以继续最近的会话。codex fork
将之前的交互式会话分叉为新线程。默认情况下, codex fork 会打开会话选择器;添加 --last 以分叉你最近的会话。
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--all | boolean | 在选择器中显示当前工作目录之外的会话。 |
--last | boolean | 跳过选择器并自动分叉最近的对话。 |
SESSION_ID | uuid | 分叉指定会话。省略并使用 --last 以分叉最近的会话。 |
--allboolean--lastbooleanSESSION_IDuuid--last 以分叉最近的会话。codex sandbox
使用沙箱辅助程序在 Codex 内部使用的相同策略下运行命令。
macOS seatbelt
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--allow-unix-socket | path | 允许沙箱命令绑定或连接以此路径为根的 Unix 套接字。可重复使用以允许多个路径。 |
--cd, -C | DIR | 用于配置文件解析和命令执行的工作目录。需要 --permissions-profile. |
--config, -c | key=value | 将配置覆盖传递到沙箱运行中(可重复)。 |
--include-managed-config | boolean | 在解析显式权限配置文件时包含托管依赖。需要 --permissions-profile. |
--log-denials | boolean | 在命令运行期间使用 log stream 捕获 macOS 沙箱拒绝记录,并在退出后打印。 |
--permissions-profile | NAME | 从活动配置堆栈中应用命名的权限配置文件。 |
COMMAND... | var-args | 在 macOS Seatbelt 下执行的 Shell 命令。之后的所有内容 -- 将被原样传递。 |
--allow-unix-socketpath--cd, -CDIR--permissions-profile.--config, -ckey=value--include-managed-configboolean--permissions-profile.--log-denialsbooleanlog stream 捕获 macOS 沙箱拒绝记录,并在退出后打印。--permissions-profileNAMECOMMAND...var-args-- 将被原样传递。Linux Landlock
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--cd, -C | DIR | 用于配置文件解析和命令执行的工作目录。需要 --permissions-profile. |
--config, -c | key=value | 在启动沙箱之前应用的配置覆盖(可重复)。 |
--include-managed-config | boolean | 在解析显式权限配置文件时包含托管依赖。需要 --permissions-profile. |
--permissions-profile | NAME | 从活动配置堆栈中应用命名的权限配置文件。 |
COMMAND... | var-args | 在 Landlock + seccomp 下执行的命令。请在之后提供可执行文件 --. |
--cd, -CDIR--permissions-profile.--config, -ckey=value--include-managed-configboolean--permissions-profile.--permissions-profileNAMECOMMAND...var-args--.Windows
| 键 | 类型 / 值 | 详情 |
|---|---|---|
--cd, -C | DIR | 用于配置文件解析和命令执行的工作目录。需要 --permissions-profile. |
--config, -c | key=value | 在启动沙箱之前应用的配置覆盖(可重复)。 |
--include-managed-config | boolean | 在解析显式权限配置文件时包含托管依赖。需要 --permissions-profile. |
--permissions-profile | NAME | 从活动配置堆栈中应用命名的权限配置文件。 |
COMMAND... | var-args | 在本机 Windows 沙箱下执行的命令。请在之后提供可执行文件 --. |
--cd, -CDIR--permissions-profile.--config, -ckey=value--include-managed-configboolean--permissions-profile.--permissions-profileNAMECOMMAND...var-args--.codex update
检查并应用 Codex CLI 更新(当已安装的版本支持自更新时)。调试版本会打印一条消息,提示你改为安装发布版本。
标志组合和安全提示
- 使用
--sandbox workspace-write用于可保留在工作区内的无人值守本地工作,并避免--dangerously-bypass-approvals-and-sandbox除非你位于专用沙箱虚拟机内。 - 当你需要授予 Codex 对更多目录的写入权限时,请优先选择
--add-dir而不是强制--sandbox danger-full-access. - 搭配
--jsonwith--output-last-message在 CI 中使用,以捕获机器可读的进度和最终的自然语言总结。
相关资源
- Codex CLI 概述:安装、升级和快速提示。
- 配置基础:持久化默认设置,例如模型和提供商。
- 高级配置:配置文件、提供商、沙盒调优和集成。
- AGENTS.md:Codex 代理能力的概念概述和最佳实践。