English
主导航

命令行选项

Codex 终端客户端的选项和标志

如何阅读本参考

本页面汇总了所有已记录的 Codex CLI 命令和标志。使用交互式表格按键名或描述进行搜索。每个部分都标明了该选项是稳定版还是实验性功能,并指出了有风险的组合。

CLI 继承了大多数默认配置,来源于 ~/.codex/config.toml。任何 -c key=value 在命令行中传入的覆盖项在该次调用中具有更高优先级。请参见 配置基础 for more information.

全局标志

--add-dir
类型 / 值
path
详情
--ask-for-approval, -a
类型 / 值
untrusted | on-request | never
详情
--cd, -C
类型 / 值
path
详情
--config, -c
类型 / 值
key=value
详情
--dangerously-bypass-approvals-and-sandbox, --yolo
类型 / 值
boolean
详情
--dangerously-bypass-hook-trust
类型 / 值
boolean
详情
--disable
类型 / 值
feature
详情
--enable
类型 / 值
feature
详情
--image, -i
类型 / 值
path[,path...]
详情
--model, -m
类型 / 值
string
详情
--no-alt-screen
类型 / 值
boolean
详情
--oss
类型 / 值
boolean
详情
--profile, -p
类型 / 值
string
详情
--remote
类型 / 值
ws://host:port | wss://host:port
详情
--remote-auth-token-env
类型 / 值
ENV_VAR
详情
--sandbox, -s
类型 / 值
read-only | workspace-write | danger-full-access
详情
--search
类型 / 值
boolean
详情
PROMPT
类型 / 值
string
详情

这些选项适用于基础 codex 命令,并会向下传递至每个子命令,除非下文某个小节另有说明。运行子命令时,请将全局标志放在其后(例如, codex exec --oss ...),以便 Codex 按预期应用它们。

命令概览

成熟度列使用了诸如 Experimental、Beta 和 Stable 等功能成熟度标签。请参阅 功能成熟度 了解如何解读这些标签。

成熟度
稳定版
详情
成熟度
稳定版
详情
成熟度
实验性
详情
成熟度
稳定版
详情
成熟度
实验性
详情
成熟度
稳定版
详情
成熟度
实验性
详情
成熟度
实验性
详情
成熟度
稳定版
详情
成熟度
实验性
详情
成熟度
稳定版
详情
成熟度
稳定版
详情
成熟度
稳定版
详情
成熟度
稳定版
详情
成熟度
实验性
详情
成熟度
实验性
详情
成熟度
实验性
详情
成熟度
实验性
详情
成熟度
稳定版
详情
成熟度
实验性
详情
成熟度
稳定版
详情

命令详情

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
详情
--listen
类型 / 值
stdio:// | ws://IP:PORT | unix:// | unix://PATH | off
详情
--ws-audience
类型 / 值
string
详情
--ws-auth
类型 / 值
capability-token | signed-bearer-token
详情
--ws-issuer
类型 / 值
string
详情
--ws-max-clock-skew-seconds
类型 / 值
number
详情
--ws-shared-secret-file
类型 / 值
absolute path
详情
--ws-token-file
类型 / 值
absolute path
详情

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
详情
PATH
类型 / 值
path
详情

codex app 打开已安装的 Codex Desktop 应用,或在应用缺失时启动安装程序。在 macOS 上,Codex 会打开提供的工作区路径;在 Windows 上,它会在安装后打印要打开的路径。

codex debug app-server send-message-v2

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

USER_MESSAGE
类型 / 值
string
详情

此调试流初始化于 experimentalApi: true, 启动一个线程,发送一个轮次,并流式传输服务器通知。可使用它在本地复现和检查应用与服务器之间的协议行为。

codex debug models

以 JSON 格式打印 Codex 看到的原始模型目录。

--bundled
类型 / 值
boolean
详情

使用 --bundled 当您只想检查当前二进制文件捆绑的目录,而不想从远程模型端点刷新时。

codex apply

将 Codex 云任务的最新差异应用到本地仓库。您必须经过身份验证并拥有该任务的访问权限。

TASK_ID
类型 / 值
string
详情

Codex 会打印已打补丁的文件,如果 git apply 失败(例如,由于冲突),则以非零状态退出。

codex cloud

从终端与 Codex 云任务进行交互。默认命令会打开一个交互式选择器; codex cloud exec 直接提交任务,而 codex cloud list 返回最近的任务,用于脚本编写或快速检查。

--attempts
类型 / 值
1-4
详情
--env
类型 / 值
ENV_ID
详情
QUERY
类型 / 值
string
详情

身份验证遵循与主 CLI 相同的凭据。如果任务提交失败,Codex 将以非零状态退出。

codex cloud list

列出最近的云任务,支持可选的过滤和分页。

--cursor
类型 / 值
string
详情
--env
类型 / 值
ENV_ID
详情
--json
类型 / 值
boolean
详情
--limit
类型 / 值
1-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
详情

codex 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>
详情
Enable subcommand
类型 / 值
codex features enable <feature>
详情
List subcommand
类型 / 值
codex features list
详情

codex exec

使用 codex exec (或简写形式 codex e)用于应在无需人工交互的情况下完成的脚本化或 CI 样式运行。

--cd, -C
类型 / 值
path
详情
--color
类型 / 值
always | never | auto
详情
--dangerously-bypass-approvals-and-sandbox, --yolo
类型 / 值
boolean
详情
--dangerously-bypass-hook-trust
类型 / 值
boolean
详情
--ephemeral
类型 / 值
boolean
详情
--full-auto
类型 / 值
boolean
详情
--ignore-rules
类型 / 值
boolean
详情
--ignore-user-config
类型 / 值
boolean
详情
--image, -i
类型 / 值
path[,path...]
详情
--json, --experimental-json
类型 / 值
boolean
详情
--model, -m
类型 / 值
string
详情
--oss
类型 / 值
boolean
详情
--output-last-message, -o
类型 / 值
path
详情
--output-schema
类型 / 值
path
详情
--profile, -p
类型 / 值
string
详情
--sandbox, -s
类型 / 值
read-only | workspace-write | danger-full-access
详情
--skip-git-repo-check
类型 / 值
boolean
详情
-c, --config
类型 / 值
key=value
详情
PROMPT
类型 / 值
string | - (read stdin)
详情
Resume subcommand
类型 / 值
codex exec resume [SESSION_ID]
详情

Codex 默认输出格式化文本。添加 --json 以接收换行符分隔的 JSON 事件(每次状态更改一个)。可选的 resume 子命令允许你继续非交互式任务。使用 --last 从当前工作目录中选择最近的会话,或添加 --all 以搜索所有会话:

--all
类型 / 值
boolean
详情
--image, -i
类型 / 值
path[,path...]
详情
--last
类型 / 值
boolean
详情
PROMPT
类型 / 值
string | - (read stdin)
详情
SESSION_ID
类型 / 值
uuid
详情

codex execpolicy

检查 execpolicy 在保存之前检查规则文件。 codex execpolicy check 接受一个或多个 --rules 标志(例如, ~/.codex/rules下的文件)并发出 JSON,显示最严格的决策及任何匹配的规则。添加 --pretty 以格式化输出。 execpolicy 命令目前处于预览阶段。

--pretty
类型 / 值
boolean
详情
--rules, -r
类型 / 值
path (repeatable)
详情
COMMAND...
类型 / 值
var-args
详情

codex login

使用 ChatGPT 账户、API 密钥或访问令牌对 CLI 进行身份验证。不带任何标志时,Codex 将打开浏览器进行 ChatGPT OAuth 流程。

--device-auth
类型 / 值
boolean
详情
--with-access-token
类型 / 值
boolean
详情
--with-api-key
类型 / 值
boolean
详情
status subcommand
类型 / 值
codex login status
详情

codex login status 退出并返回 0 当存在凭据时,这在自动化脚本中非常有用。

codex logout

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

codex mcp

管理存储在其中的 Model Context Protocol 服务器条目 ~/.codex/config.toml.

add <name>
类型 / 值
-- <command...> | --url <value>
详情
get <name>
类型 / 值
--json
详情
list
类型 / 值
--json
详情
login <name>
类型 / 值
--scopes scope1,scope2
详情
logout <name>
详情
remove <name>
详情

The add 子命令支持 stdio 和流式 HTTP 传输:

--bearer-token-env-var
类型 / 值
ENV_VAR
详情
--env KEY=VALUE
类型 / 值
repeatable
详情
--url
类型 / 值
https://…
详情
COMMAND...
类型 / 值
stdio transport
详情

OAuth 操作 (login, logout) 仅适用于可流式传输的 HTTP 服务器(且仅当该服务器支持 OAuth 时)。

codex plugin marketplace

管理 Codex 可以浏览和安装插件的插件市场源。

add <source>
类型 / 值
[--ref REF] [--sparse PATH]
详情
list
详情
remove <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
详情

codex fork

将之前的交互式会话分叉为新线程。默认情况下, codex fork 会打开会话选择器;添加 --last 以分叉你最近的会话。

--all
类型 / 值
boolean
详情
--last
类型 / 值
boolean
详情
SESSION_ID
类型 / 值
uuid
详情

codex sandbox

使用沙箱辅助程序在 Codex 内部使用的相同策略下运行命令。

macOS seatbelt

--allow-unix-socket
类型 / 值
path
详情
--cd, -C
类型 / 值
DIR
详情
--config, -c
类型 / 值
key=value
详情
--include-managed-config
类型 / 值
boolean
详情
--log-denials
类型 / 值
boolean
详情
--permissions-profile
类型 / 值
NAME
详情
COMMAND...
类型 / 值
var-args
详情

Linux Landlock

--cd, -C
类型 / 值
DIR
详情
--config, -c
类型 / 值
key=value
详情
--include-managed-config
类型 / 值
boolean
详情
--permissions-profile
类型 / 值
NAME
详情
COMMAND...
类型 / 值
var-args
详情

Windows

--cd, -C
类型 / 值
DIR
详情
--config, -c
类型 / 值
key=value
详情
--include-managed-config
类型 / 值
boolean
详情
--permissions-profile
类型 / 值
NAME
详情
COMMAND...
类型 / 值
var-args
详情

codex update

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

标志组合和安全提示

  • 使用 --sandbox workspace-write 用于可保留在工作区内的无人值守本地工作,并避免 --dangerously-bypass-approvals-and-sandbox 除非你位于专用沙箱虚拟机内。
  • 当你需要授予 Codex 对更多目录的写入权限时,请优先选择 --add-dir 而不是强制 --sandbox danger-full-access.
  • 搭配 --json with --output-last-message 在 CI 中使用,以捕获机器可读的进度和最终的自然语言总结。
  • Codex CLI 概述:安装、升级和快速提示。
  • 配置基础:持久化默认设置,例如模型和提供商。
  • 高级配置:配置文件、提供商、沙盒调优和集成。
  • AGENTS.md:Codex 代理能力的概念概述和最佳实践。