快速開始
最常用的 Codex 指令
涵蓋本機互動、一次性自動化、Cloud 任務和互動式會話控制等高頻場景。
codex在目前工作區開啟終端 UI。
codex exec "fix the failing test"以非互動模式執行 Codex 並串流輸出結果。
codex resume --last返回最近的交互式会话。
codex apply TASK_ID应用 Codex Cloud 任务生成的最新 diff。
/permissions调整 Codex 无需询问即可执行的操作。
/model选择当前模型和 reasoning effort。
全域參數
codex [OPTIONS] [PROMPT]
這些參數主要用於基礎 codex 指令,很多也可被子指令接受。
| 參數 | 類型 / 取值 | 用途 |
|---|---|---|
--add-dir | path | 在主工作区之外额外添加一个可写目录。 |
--ask-for-approval, -a | untrusted | on-request | never | 设置 Codex 运行命令前何时需要询问。 |
--cd, -C | path | 在 agent 启动前设置工作目录。 |
--config, -c | key=value | 在命令行中覆盖配置值。 |
--dangerously-bypass-approvals-and-sandbox | boolean | 在已有外部隔离的环境中禁用审批和沙箱。 |
--yolo | boolean | 危险绕过模式的别名。 |
--dangerously-bypass-hook-trust | boolean | 本次运行启用 hooks 时跳过持久信任检查。 |
--disable | feature | 强制关闭某个功能开关。 |
--enable | feature | 强制开启某个功能开关。 |
--image, -i | path[,path...] | 给初始提示附加图片。 |
--model, -m | string | 覆盖已配置的模型。 |
--no-alt-screen | boolean | 禁用终端 UI 的 alternate-screen 模式。 |
--oss | boolean | 使用本地开源模型提供方,通常配合 Ollama。 |
--profile, -p | string | 加载指定的 Codex 配置 profile。 |
--remote | ws://host:port | wss://host:port | unix:// | unix://PATH | 将 TUI 连接到远程 app-server。 |
--remote-auth-token-env | ENV_VAR | 从环境变量读取远程 bearer token。 |
--sandbox, -s | read-only | workspace-write | danger-full-access | 选择 shell 命令的沙箱策略。 |
--search | boolean | 启用实时网页搜索。 |
--strict-config | boolean | 配置中存在未知字段时报错。 |
PROMPT | string | 可选的启动提示。 |
--add-dir類型 / 取值
path用途
在主工作区之外额外添加一个可写目录。
--ask-for-approval, -a類型 / 取值
untrusted | on-request | never用途
设置 Codex 运行命令前何时需要询问。
--cd, -C類型 / 取值
path用途
在 agent 启动前设置工作目录。
--config, -c類型 / 取值
key=value用途
在命令行中覆盖配置值。
--dangerously-bypass-approvals-and-sandbox類型 / 取值
boolean用途
在已有外部隔离的环境中禁用审批和沙箱。
--yolo類型 / 取值
boolean用途
危险绕过模式的别名。
--dangerously-bypass-hook-trust類型 / 取值
boolean用途
本次运行启用 hooks 时跳过持久信任检查。
--disable類型 / 取值
feature用途
强制关闭某个功能开关。
--enable類型 / 取值
feature用途
强制开启某个功能开关。
--image, -i類型 / 取值
path[,path...]用途
给初始提示附加图片。
--model, -m類型 / 取值
string用途
覆盖已配置的模型。
--no-alt-screen類型 / 取值
boolean用途
禁用终端 UI 的 alternate-screen 模式。
--oss類型 / 取值
boolean用途
使用本地开源模型提供方,通常配合 Ollama。
--profile, -p類型 / 取值
string用途
加载指定的 Codex 配置 profile。
--remote類型 / 取值
ws://host:port | wss://host:port | unix:// | unix://PATH用途
将 TUI 连接到远程 app-server。
--remote-auth-token-env類型 / 取值
ENV_VAR用途
从环境变量读取远程 bearer token。
--sandbox, -s類型 / 取值
read-only | workspace-write | danger-full-access用途
选择 shell 命令的沙箱策略。
--search類型 / 取值
boolean用途
启用实时网页搜索。
--strict-config類型 / 取值
boolean用途
配置中存在未知字段时报错。
PROMPT類型 / 取值
string用途
可选的启动提示。
只有在外部環境已經提供強隔離時,才應使用 --dangerously-bypass-approvals-and-sandbox 或 --yolo。
指令總覽
官方已文件化的頂層指令
Stable 適合日常使用;Experimental 可能隨 Codex 演進而變化。
| 指令 | 成熟度 | 用途 |
|---|---|---|
codex | 穩定 | 啟動互動式終端 UI。 |
codex app | 穩定 | 開啟 Codex 桌面應用程式。 |
codex app-server | 實驗性 | 启动本地 app-server,用于开发或调试。 |
codex apply | 穩定 | 在本地应用 Codex Cloud 任务 diff。 |
codex a | 穩定 | codex apply 的别名。 |
codex archive | 穩定 | 归档已保存的交互式会话。 |
codex cloud | 實驗性 | 从终端浏览或运行 Codex Cloud 任务。 |
codex cloud-tasks | 實驗性 | codex cloud 的别名。 |
codex completion | 穩定 | 生成 shell 自动补全脚本。 |
codex debug app-server send-message-v2 | 實驗性 | 向 app-server 发送 V2 测试消息。 |
codex debug models | 實驗性 | 打印 Codex 可见的模型目录。 |
codex doctor | 穩定 | 创建本地诊断报告。 |
codex exec | 穩定 | 以非互動模式執行 Codex。 |
codex e | 穩定 | codex exec 的别名。 |
codex execpolicy | 實驗性 | 评估命令执行策略规则。 |
codex features | 穩定 | 列出或持久化功能开关覆盖。 |
codex fork | 穩定 | 从旧会话分叉出新线程。 |
codex login | 穩定 | 驗證 / 登入 Codex。 |
codex logout | 穩定 | 移除已儲存的憑證。 |
codex mcp | 實驗性 | 管理 MCP server 定义和认证。 |
codex mcp-server | 實驗性 | 将 Codex 本身作为 MCP server 运行。 |
codex plugin | 實驗性 | 安装、列出和移除 Codex 插件。 |
codex plugin marketplace | 實驗性 | 管理插件市场来源。 |
codex remote-control | 實驗性 | 确保 app-server 已启用 remote-control 支持。 |
codex resume | 穩定 | 恢复之前的交互式会话。 |
codex sandbox | 實驗性 | 在 Codex 沙箱中运行命令。 |
codex unarchive | 穩定 | 恢复已归档的会话。 |
codex update | 穩定 | 在支持时检查或应用 CLI 更新。 |
codex穩定啟動互動式終端 UI。
codex app穩定開啟 Codex 桌面應用程式。
codex app-server實驗性启动本地 app-server,用于开发或调试。
codex apply穩定在本地应用 Codex Cloud 任务 diff。
codex a穩定codex apply 的别名。
codex archive穩定归档已保存的交互式会话。
codex cloud實驗性从终端浏览或运行 Codex Cloud 任务。
codex cloud-tasks實驗性codex cloud 的别名。
codex completion穩定生成 shell 自动补全脚本。
codex debug app-server send-message-v2實驗性向 app-server 发送 V2 测试消息。
codex debug models實驗性打印 Codex 可见的模型目录。
codex doctor穩定创建本地诊断报告。
codex exec穩定以非互動模式執行 Codex。
codex e穩定codex exec 的别名。
codex execpolicy實驗性评估命令执行策略规则。
codex features穩定列出或持久化功能开关覆盖。
codex fork穩定从旧会话分叉出新线程。
codex login穩定驗證 / 登入 Codex。
codex logout穩定移除已儲存的憑證。
codex mcp實驗性管理 MCP server 定义和认证。
codex mcp-server實驗性将 Codex 本身作为 MCP server 运行。
codex plugin實驗性安装、列出和移除 Codex 插件。
codex plugin marketplace實驗性管理插件市场来源。
codex remote-control實驗性确保 app-server 已启用 remote-control 支持。
codex resume穩定恢复之前的交互式会话。
codex sandbox實驗性在 Codex 沙箱中运行命令。
codex unarchive穩定恢复已归档的会话。
codex update穩定在支持时检查或应用 CLI 更新。
子指令
按工作流分組的指令矩陣
按場景組織,便於快速掃描,同時保留官方文件化指令面的覆蓋。
| 語法 | 類型 / 取值 | 用途 |
|---|---|---|
codex | - | 啟動互動式終端 UI。 |
codex "PROMPT" | - | 带初始指令启动 TUI。 |
codex --image path | path[,path...] | 启动时附加一张或多张图片。 |
codex --remote ENDPOINT | ws://, wss://, unix:// | 将 TUI 连接到远程 app-server。 |
codex app | - | 打开桌面应用。 |
codex app PATH | path | 在 Codex Desktop 中打开指定工作区路径。 |
codex app --download-url URL | url | 覆盖桌面安装器下载 URL。 |
codex app-server | - | 启动本地 app-server。 |
codex app-server --listen VALUE | stdio:// | ws://IP:PORT | unix:// | unix://PATH | off | 设置传输监听方式。 |
codex app-server --stdio | boolean | 使用 stdio 传输。 |
codex app-server --analytics-default-enabled | boolean | 对 app-server 客户端默认启用 analytics。 |
codex app-server --ws-auth MODE | capability-token | signed-bearer-token | 选择 WebSocket 认证模式。 |
codex app-server --ws-audience VALUE | string | 预期的 JWT audience。 |
codex app-server --ws-issuer VALUE | string | 预期的 JWT issuer。 |
codex app-server --ws-max-clock-skew-seconds N | number | 允许 token 时间校验存在时钟偏差。 |
codex app-server --ws-shared-secret-file PATH | absolute path | signed bearer token 使用的 HMAC 密钥文件。 |
codex app-server --ws-token-file PATH | absolute path | capability token 文件。 |
codex app-server --ws-token-sha256 HEX | hex SHA-256 | 预期的 token SHA-256 摘要。 |
codex remote-control | - | 确保本地 app-server daemon 运行并启用 remote-control。 |
codex用途
啟動互動式終端 UI。
codex "PROMPT"用途
带初始指令启动 TUI。
codex --image path類型 / 取值
path[,path...]用途
启动时附加一张或多张图片。
codex --remote ENDPOINT類型 / 取值
ws://, wss://, unix://用途
将 TUI 连接到远程 app-server。
codex app用途
打开桌面应用。
codex app PATH類型 / 取值
path用途
在 Codex Desktop 中打开指定工作区路径。
codex app --download-url URL類型 / 取值
url用途
覆盖桌面安装器下载 URL。
codex app-server用途
启动本地 app-server。
codex app-server --listen VALUE類型 / 取值
stdio:// | ws://IP:PORT | unix:// | unix://PATH | off用途
设置传输监听方式。
codex app-server --stdio類型 / 取值
boolean用途
使用 stdio 传输。
codex app-server --analytics-default-enabled類型 / 取值
boolean用途
对 app-server 客户端默认启用 analytics。
codex app-server --ws-auth MODE類型 / 取值
capability-token | signed-bearer-token用途
选择 WebSocket 认证模式。
codex app-server --ws-audience VALUE類型 / 取值
string用途
预期的 JWT audience。
codex app-server --ws-issuer VALUE類型 / 取值
string用途
预期的 JWT issuer。
codex app-server --ws-max-clock-skew-seconds N類型 / 取值
number用途
允许 token 时间校验存在时钟偏差。
codex app-server --ws-shared-secret-file PATH類型 / 取值
absolute path用途
signed bearer token 使用的 HMAC 密钥文件。
codex app-server --ws-token-file PATH類型 / 取值
absolute path用途
capability token 文件。
codex app-server --ws-token-sha256 HEX類型 / 取值
hex SHA-256用途
预期的 token SHA-256 摘要。
codex remote-control用途
确保本地 app-server daemon 运行并启用 remote-control。
| 語法 | 類型 / 取值 | 用途 |
|---|---|---|
codex apply TASK_ID | string | 在本地应用 Codex Cloud 任务 diff。 |
codex a TASK_ID | string | codex apply 的别名。 |
codex archive SESSION | session ID | session name | 按 ID 或名称归档已保存会话。 |
codex unarchive SESSION | session ID | session name | 按 ID 或名称恢复已归档会话。 |
codex archive --remote ENDPOINT SESSION | endpoint | 变更归档状态前先连接远程 app-server。 |
codex cloud | - | 从终端浏览或运行 Cloud 任务。 |
codex cloud exec QUERY | string | 直接提交 Cloud 任务。 |
codex cloud exec --attempts N | 1-4 | 设置 assistant 尝试次数。 |
codex cloud exec --env ENV_ID | ENV_ID | 指定 Codex Cloud 环境。 |
codex cloud list | - | 列出最近的 Cloud 任务。 |
codex cloud list --cursor VALUE | string | 使用分页游标。 |
codex cloud list --env ENV_ID | ENV_ID | 按环境筛选。 |
codex cloud list --json | boolean | 输出 JSON。 |
codex cloud list --limit N | 1-20 | 限制返回的任务数量。 |
codex cloud-tasks | - | codex cloud 的别名。 |
codex resume | - | 恢复交互式会话。 |
codex resume SESSION_ID | uuid | 恢复指定交互式会话。 |
codex resume --all | boolean | 显示当前目录之外的会话。 |
codex resume --last | boolean | 恢复最近的会话。 |
codex fork | - | 从旧会话分叉出新线程。 |
codex fork SESSION_ID | uuid | 分叉指定会话。 |
codex fork --all | boolean | 显示当前目录之外的会话。 |
codex fork --last | boolean | 分叉最近的会话。 |
codex apply TASK_ID類型 / 取值
string用途
在本地应用 Codex Cloud 任务 diff。
codex a TASK_ID類型 / 取值
string用途
codex apply 的别名。
codex archive SESSION類型 / 取值
session ID | session name用途
按 ID 或名称归档已保存会话。
codex unarchive SESSION類型 / 取值
session ID | session name用途
按 ID 或名称恢复已归档会话。
codex archive --remote ENDPOINT SESSION類型 / 取值
endpoint用途
变更归档状态前先连接远程 app-server。
codex cloud用途
从终端浏览或运行 Cloud 任务。
codex cloud exec QUERY類型 / 取值
string用途
直接提交 Cloud 任务。
codex cloud exec --attempts N類型 / 取值
1-4用途
设置 assistant 尝试次数。
codex cloud exec --env ENV_ID類型 / 取值
ENV_ID用途
指定 Codex Cloud 环境。
codex cloud list用途
列出最近的 Cloud 任务。
codex cloud list --cursor VALUE類型 / 取值
string用途
使用分页游标。
codex cloud list --env ENV_ID類型 / 取值
ENV_ID用途
按环境筛选。
codex cloud list --json類型 / 取值
boolean用途
输出 JSON。
codex cloud list --limit N類型 / 取值
1-20用途
限制返回的任务数量。
codex cloud-tasks用途
codex cloud 的别名。
codex resume用途
恢复交互式会话。
codex resume SESSION_ID類型 / 取值
uuid用途
恢复指定交互式会话。
codex resume --all類型 / 取值
boolean用途
显示当前目录之外的会话。
codex resume --last類型 / 取值
boolean用途
恢复最近的会话。
codex fork用途
从旧会话分叉出新线程。
codex fork SESSION_ID類型 / 取值
uuid用途
分叉指定会话。
codex fork --all類型 / 取值
boolean用途
显示当前目录之外的会话。
codex fork --last類型 / 取值
boolean用途
分叉最近的会话。
非互動模式
codex exec 參數
當 Codex 以終端、腳本或自動化中的一次性指令執行時使用這些參數。
| 參數 | 類型 / 取值 | 用途 |
|---|---|---|
--cd, -C | path | 设置工作区根目录。 |
--color | always | never | auto | 控制 ANSI 彩色输出。 |
--dangerously-bypass-approvals-and-sandbox | boolean | 禁用审批和沙箱。 |
--yolo | boolean | 危险绕过模式的别名。 |
--dangerously-bypass-hook-trust | boolean | 运行 hooks 时跳过持久信任。 |
--ephemeral | boolean | 不持久化会话 rollout 文件。 |
--full-auto | boolean | 已弃用的兼容参数。 |
--ignore-rules | boolean | 不加载 execpolicy 规则文件。 |
--ignore-user-config | boolean | 不加载用户配置。 |
--image, -i | path[,path...] | 给第一条消息附加图片。 |
--json | boolean | 输出 NDJSON 事件。 |
--experimental-json | boolean | JSON 事件输出的旧别名。 |
--model, -m | string | 覆盖模型。 |
--oss | boolean | 使用本地 OSS 模型提供方。 |
--output-last-message, -o | path | 将最终 assistant 回复写入文件。 |
--output-schema | path | 按 JSON Schema 校验最终输出。 |
--profile, -p | string | 加载配置 profile。 |
--sandbox, -s | read-only | workspace-write | danger-full-access | 选择沙箱策略。 |
--skip-git-repo-check | boolean | 允许在非 Git 仓库中运行。 |
--config, -c | key=value | 在命令行中覆盖配置。 |
PROMPT | string | - | 初始任务提示;使用 - 从 stdin 读取。 |
--cd, -C類型 / 取值
path用途
设置工作区根目录。
--color類型 / 取值
always | never | auto用途
控制 ANSI 彩色输出。
--dangerously-bypass-approvals-and-sandbox類型 / 取值
boolean用途
禁用审批和沙箱。
--yolo類型 / 取值
boolean用途
危险绕过模式的别名。
--dangerously-bypass-hook-trust類型 / 取值
boolean用途
运行 hooks 时跳过持久信任。
--ephemeral類型 / 取值
boolean用途
不持久化会话 rollout 文件。
--full-auto類型 / 取值
boolean用途
已弃用的兼容参数。
--ignore-rules類型 / 取值
boolean用途
不加载 execpolicy 规则文件。
--ignore-user-config類型 / 取值
boolean用途
不加载用户配置。
--image, -i類型 / 取值
path[,path...]用途
给第一条消息附加图片。
--json類型 / 取值
boolean用途
输出 NDJSON 事件。
--experimental-json類型 / 取值
boolean用途
JSON 事件输出的旧别名。
--model, -m類型 / 取值
string用途
覆盖模型。
--oss類型 / 取值
boolean用途
使用本地 OSS 模型提供方。
--output-last-message, -o類型 / 取值
path用途
将最终 assistant 回复写入文件。
--output-schema類型 / 取值
path用途
按 JSON Schema 校验最终输出。
--profile, -p類型 / 取值
string用途
加载配置 profile。
--sandbox, -s類型 / 取值
read-only | workspace-write | danger-full-access用途
选择沙箱策略。
--skip-git-repo-check類型 / 取值
boolean用途
允许在非 Git 仓库中运行。
--config, -c類型 / 取值
key=value用途
在命令行中覆盖配置。
PROMPT類型 / 取值
string | -用途
初始任务提示;使用 - 从 stdin 读取。
互動式 TUI
內建 slash commands
在 Codex 輸入框中輸入 / 可開啟 slash command 彈窗。
| Slash 指令 | 用途 |
|---|---|
/permissions | 设置 Codex 无需询问即可执行的操作。 |
/ide | 包含 IDE 当前打开文件、选区等上下文。 |
/keymap | 重映射 TUI 快捷键。 |
/vim | 切换输入框 Vim 模式。 |
/sandbox-add-read-dir | 在 Windows 上给沙箱添加目录读取权限。 |
/agent | 切换当前 agent 线程。 |
/apps | 浏览 apps / connectors 并插入到提示中。 |
/plugins | 浏览已安装和可发现插件。 |
/hooks | 查看生命周期 hooks。 |
/clear | 清屏并开始新聊天。 |
/archive | 归档当前会话并退出 Codex。 |
/compact | 压缩可见对话以释放上下文 token。 |
/copy | 复制最近完成的 Codex 输出。 |
/diff | 显示 Git diff,包括未跟踪文件。 |
/exit | 退出 CLI。 |
/experimental | 切换实验功能。 |
/approve | 自动审查拒绝后批准一次重试。 |
/memories | 配置 memory 的使用和生成。 |
/skills | 浏览并使用 skills。 |
/feedback | 向 Codex 维护者发送日志。 |
/init | 生成 AGENTS.md 脚手架。 |
/logout | 登出 Codex。 |
/mcp | 列出已配置的 MCP 工具。 |
/mcp verbose | 显示 MCP server 详情。 |
/mention | 将文件或文件夹附加到对话。 |
/model | Choose model and reasoning effort. |
/fast | 切换或查看 Fast 服务层。 |
/plan | 切换到计划模式。 |
/goal | 设置、查看、暂停、恢复或清除目标。 |
/personality | 选择沟通风格。 |
/ps | 查看实验性后台终端。 |
/stop | 停止所有后台终端。 |
/fork | 将当前对话分叉到新线程。 |
/side | 开启临时侧聊。 |
/btw | 开启短侧聊。 |
/raw | 切换原始滚动回看模式。 |
/resume | 恢复已保存对话。 |
/new | 在同一 CLI 会话中开始新对话。 |
/quit | 退出 CLI。 |
/review | 让 Codex 审查当前工作区。 |
/status | 显示会话配置和 token 使用量。 |
/debug-config | 打印配置层级诊断信息。 |
/statusline | 配置 TUI 状态栏字段。 |
/title | 配置终端标题字段。 |
/theme | 选择语法高亮主题。 |
/permissions设置 Codex 无需询问即可执行的操作。
/ide包含 IDE 当前打开文件、选区等上下文。
/keymap重映射 TUI 快捷键。
/vim切换输入框 Vim 模式。
/sandbox-add-read-dir在 Windows 上给沙箱添加目录读取权限。
/agent切换当前 agent 线程。
/apps浏览 apps / connectors 并插入到提示中。
/plugins浏览已安装和可发现插件。
/hooks查看生命周期 hooks。
/clear清屏并开始新聊天。
/archive归档当前会话并退出 Codex。
/compact压缩可见对话以释放上下文 token。
/copy复制最近完成的 Codex 输出。
/diff显示 Git diff,包括未跟踪文件。
/exit退出 CLI。
/experimental切换实验功能。
/approve自动审查拒绝后批准一次重试。
/memories配置 memory 的使用和生成。
/skills浏览并使用 skills。
/feedback向 Codex 维护者发送日志。
/init生成 AGENTS.md 脚手架。
/logout登出 Codex。
/mcp列出已配置的 MCP 工具。
/mcp verbose显示 MCP server 详情。
/mention将文件或文件夹附加到对话。
/modelChoose model and reasoning effort.
/fast切换或查看 Fast 服务层。
/plan切换到计划模式。
/goal设置、查看、暂停、恢复或清除目标。
/personality选择沟通风格。
/ps查看实验性后台终端。
/stop停止所有后台终端。
/fork将当前对话分叉到新线程。
/side开启临时侧聊。
/btw开启短侧聊。
/raw切换原始滚动回看模式。
/resume恢复已保存对话。
/new在同一 CLI 会话中开始新对话。
/quit退出 CLI。
/review让 Codex 审查当前工作区。
/status显示会话配置和 token 使用量。
/debug-config打印配置层级诊断信息。
/statusline配置 TUI 状态栏字段。
/title配置终端标题字段。
/theme选择语法高亮主题。
常見寫法
/fast on开启 Fast 服务层。
/fast off关闭 Fast 服务层。
/fast status显示 Fast 服务层状态。
/personality friendly使用 friendly 沟通风格。
/personality pragmatic使用 pragmatic 沟通风格。
/personality none关闭 personality 风格。
/goal <objective>设置任务目标。
/goal pause暂停当前目标。
/goal resume恢复当前目标。
/goal clear清除当前目标。
/prompts:<name>运行本地自定义 prompt。custom prompts 已弃用,推荐使用 skills。
本機擴充
內建 slash commands 是有限集合,但已安裝的 skills、plugins、MCP servers,以及已棄用的 /prompts:* 檔案,可能提供本機獨有能力。
來源
官方文件
指令名、參數名、成熟度標籤和 slash command 覆蓋範圍基於 OpenAI 官方 Codex CLI 文件。
閱讀說明
本頁是繁體中文速查表,不是官方文件的完整複刻;指令名、參數名和列舉值保留英文原文。