Skip to content

Codex CLI 命令行参考

本页面列出了所有已记录的 Codex CLI 命令和标志。每个部分都标注了选项是稳定版还是实验性的,并指出了有风险的组合。

全局选项

这些选项适用于基础 codex 命令,并传播到子命令(除非下方部分另有说明)。

选项类型/值说明
PROMPTstring可选的文本指令来启动会话。省略则启动 TUI 而不预填消息
--image, -ipath[,path...]附加一个或多个图片文件到初始提示。用逗号分隔多个路径或重复使用该标志
--model, -mstring覆盖配置中设置的模型(例如 gpt-5-codex
--ossboolean使用本地开源模型提供商(等同于 -c model_provider="oss")。验证 Ollama 是否运行
--profile, -pstring~/.codex/config.toml 加载的配置文件名称
--sandbox, -sread-only | workspace-write | danger-full-access为模型生成的 shell 命令选择沙箱策略
--ask-for-approval, -auntrusted | on-failure | on-request | never控制 Codex 何时在运行命令前暂停等待人工审批
--full-autoboolean无人值守本地工作的快捷方式:设置 --ask-for-approval on-failure--sandbox workspace-write
--dangerously-bypass-approvals-and-sandbox, --yoloboolean运行每个命令而不需要审批或沙箱。仅在外部加固的环境中使用
--cd, -Cpath在代理开始处理请求前设置工作目录
--searchboolean启用网络搜索。为 true 时,代理可以调用 web_search 工具而不需要每次询问
--add-dirpath授予额外目录与主工作区一起的写入权限。可重复使用
--enablefeature强制启用功能标志(转换为 -c features.<name>=true)。可重复
--disablefeature强制禁用功能标志(转换为 -c features.<name>=false)。可重复
--config, -ckey=value覆盖配置值。值如果可能会解析为 JSON;否则使用字面字符串

子命令概览

命令状态说明
codex稳定启动终端 UI。接受上述全局标志加可选的提示或图片附件
codex exec稳定非交互式运行 Codex。别名:codex e。将结果流式输出到 stdout 或 JSONL,可选恢复之前的会话
codex execpolicy实验性评估 execpolicy 规则文件,查看命令是否会被允许、提示或阻止
codex login稳定使用 ChatGPT OAuth、设备认证或通过 stdin 传入的 API 密钥认证 Codex
codex logout稳定移除存储的认证凭据
codex resume稳定通过 ID 继续之前的交互式会话或恢复最近的对话
codex apply稳定将 Codex Cloud 任务生成的最新 diff 应用到本地工作目录。别名:codex a
codex sandbox平台特定在 Codex 提供的 macOS seatbelt 或 Linux landlock 沙箱中运行任意命令
codex completion稳定为 Bash、Zsh、Fish 或 PowerShell 生成 shell 补全脚本
codex mcp实验性管理 Model Context Protocol 服务器(列出、添加、移除、认证)
codex mcp-server实验性将 Codex 本身作为 MCP 服务器通过 stdio 运行。当另一个代理使用 Codex 时有用
codex app-server实验性启动 Codex 应用服务器用于本地开发或调试
codex cloud实验性从终端浏览或执行 Codex Cloud 任务而不打开 TUI。别名:codex cloud-tasks

codex(交互式)

不带子命令运行 codex 会启动交互式终端 UI(TUI)。代理接受上述全局标志加图片附件。使用 --search 启用网络浏览,使用 --full-auto 让 Codex 运行大多数命令而不需要提示。

codex exec

使用 codex exec(或简写 codex e)进行脚本化或 CI 风格的运行,这些运行应该在没有人工交互的情况下完成。

选项类型/值说明
PROMPTstring | - (读取 stdin)任务的初始指令。使用 - 从 stdin 管道传入提示
--image, -ipath[,path...]附加图片到第一条消息。可重复;支持逗号分隔列表
--model, -mstring覆盖此次运行的配置模型
--ossboolean使用本地开源提供商(需要运行中的 Ollama 实例)
--sandbox, -sread-only | workspace-write | danger-full-access模型生成命令的沙箱策略。默认为配置值
--profile, -pstring选择 config.toml 中定义的配置文件
--full-autoboolean应用低摩擦自动化预设(workspace-write 沙箱和失败时审批)
--dangerously-bypass-approvals-and-sandbox, --yoloboolean绕过审批提示和沙箱。危险——仅在隔离的运行器中使用
--cd, -Cpath在执行任务前设置工作区根目录
--skip-git-repo-checkboolean允许在 Git 仓库外运行(对一次性目录有用)
--output-schemapath描述预期最终响应形状的 JSON Schema 文件。Codex 根据它验证工具输出
--coloralways | never | auto控制 stdout 中的 ANSI 颜色
--json, --experimental-jsonboolean打印换行分隔的 JSON 事件而不是格式化文本
--output-last-message, -opath将助手的最终消息写入文件。对下游脚本有用
-c, --configkey=value非交互式运行的内联配置覆盖(可重复)

exec resume 子命令

bash
codex exec resume [SESSION_ID]

通过 ID 恢复 exec 会话或添加 --last 继续最近的会话。接受可选的后续提示。

选项类型/值说明
SESSION_IDuuid恢复指定会话。省略并使用 --last 自动继续最近的会话
--lastboolean跳过选择器自动恢复最近的对话
PROMPTstring | - (读取 stdin)恢复后立即发送的可选后续指令

codex execpolicy

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

选项类型/值说明
--rules, -rpath(可重复)要评估的 execpolicy 规则文件路径。提供多个标志以组合跨文件的规则
--prettyboolean美化打印 JSON 结果
COMMAND...var-args要根据指定策略检查的命令

codex login

使用 ChatGPT 账号或 API 密钥认证 CLI。不带标志时,Codex 打开浏览器进行 ChatGPT OAuth。

选项类型/值说明
--with-api-keyboolean从 stdin 读取 API 密钥(例如 printenv OPENAI_API_KEY | codex login --with-api-key

login status 子命令

bash
codex login status

打印活动的认证模式,登录时以 0 退出。在自动化脚本中很有用。

codex logout

移除 API 密钥和 ChatGPT 认证的已保存凭据。不需要额外标志。

codex resume

通过 ID 继续交互式会话或恢复最近的对话。codex resume 接受与 codex 相同的全局标志,包括模型和沙箱覆盖。

选项类型/值说明
SESSION_IDuuid恢复指定会话。省略并使用 --last 继续最近的会话
--lastboolean跳过选择器自动恢复最近的对话
PROMPTstring | - (读取 stdin)恢复后立即发送的可选后续指令

codex apply

将 Codex Cloud 任务的最新 diff 应用到本地仓库。你必须已认证并有权访问该任务。

选项类型/值说明
TASK_IDstring要应用其 diff 的 Codex Cloud 任务标识符

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

codex sandbox

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

macOS seatbelt

选项类型/值说明
--full-autoboolean授予当前工作区和 /tmp 的写入权限而不需要审批
--config, -ckey=value将配置覆盖传入沙箱运行(可重复)
COMMAND...var-args在 macOS Seatbelt 下执行的 shell 命令。-- 之后的所有内容都被转发

Linux landlock

选项类型/值说明
--full-autoboolean在 Landlock 沙箱内授予当前工作区和 /tmp 的写入权限
--config, -ckey=value启动沙箱前应用的配置覆盖(可重复)
COMMAND...var-args在 Landlock + seccomp 下执行的命令。在 -- 之后提供可执行文件

codex completion

生成 shell 补全脚本并将输出重定向到适当位置,例如:

bash
codex completion zsh > "${fpath[1]}/_codex"
选项类型/值说明
SHELLbash | zsh | fish | power-shell | elvish要生成补全的 shell。输出打印到 stdout

codex mcp

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

子命令选项说明
list--json列出配置的 MCP 服务器。添加 --json 获取机器可读输出
get <name>--json显示特定服务器配置。--json 打印原始配置条目
add <name>-- <command...> | --url <value>使用 stdio 启动器命令或流式 HTTP URL 注册服务器。支持 --env KEY=VALUE 用于 stdio 传输
remove <name>删除存储的 MCP 服务器定义
login <name>--scopes scope1,scope2为流式 HTTP 服务器启动 OAuth 登录。需要 RMCP 客户端功能
logout <name>移除流式 HTTP 服务器的存储 OAuth 凭据

add 子命令选项

选项类型/值说明
COMMAND...stdio 传输启动 MCP 服务器的可执行文件加参数。在 -- 之后提供
--env KEY=VALUE可重复启动 stdio 服务器时应用的环境变量赋值
--urlhttps://…注册流式 HTTP 服务器而不是 stdio。与 COMMAND... 互斥
--bearer-token-env-varENV_VAR连接流式 HTTP 服务器时作为 bearer token 发送其值的环境变量

OAuth 操作(login、logout)需要 RMCP 客户端功能([features].rmcp_client = truecodex --enable rmcp_client),且仅适用于流式 HTTP 服务器。

codex mcp-server

将 Codex 作为 MCP 服务器通过 stdio 运行,以便其他工具可以连接。此命令继承全局配置覆盖,并在下游客户端关闭连接时退出。

codex app-server

在本地启动 Codex 应用服务器。这主要用于开发和调试,可能会在没有通知的情况下更改。

codex cloud

从终端与 Codex Cloud 任务交互。默认命令打开交互式选择器;codex cloud exec 直接提交任务。

选项类型/值说明
QUERYstring任务提示。如果省略,Codex 会交互式提示详情
--envENV_ID目标 Codex Cloud 环境标识符(必需)。使用 codex cloud 列出选项
--attempts1-4Codex Cloud 应运行的助手尝试次数(best-of-N)

认证遵循与主 CLI 相同的凭据。如果任务提交失败,Codex 以非零退出。

aicodex 文档网站