Codex CLI 指令一覽

整理 Codex CLI 基本指令、主要選項、設定方式與實用工作流程的參考表

How to Use展開使用方法

1
Filter by category
Switch between Core Commands, Key Options, Setup, and Workflow Examples to focus on the commands you need.
2
Search details
Use keyword search to match command names, option notes, and example commands at once.
3
Copy and run
Copy the command snippet with one click, then run it directly in your terminal.

codex
Start an interactive Codex CLI session.

Key points

codex "<prompt>": Start with an initial prompt.
codex --help: Show available subcommands and global options.

Examples

codex

Launch interactive mode in the current directory.

codex "Summarize this repository structure"

Start a session with a task-focused prompt.

codex exec
Run Codex non-interactively for automation and CI-style tasks.

Key points

--sandbox: Choose execution sandbox mode.
--profile: Load a predefined profile from config.toml.

Examples

codex exec "Review this PR diff"

Run a one-shot review task from the CLI.

cat plan.md | codex exec -

Read instructions from stdin.

codex review
Run a code review directly from the command line.

Key points

--uncommitted: Review staged, unstaged, and untracked changes.
--base <branch>: Compare the current branch against a base branch.

Examples

codex review --uncommitted

Review local changes before committing.

codex review --base main

Review changes against main branch.

codex resume
Resume a previous interactive session.

Key points

--last: Resume the most recent session immediately.
--all: Show all sessions beyond current working directory filter.

Examples

codex resume --last

Continue the latest session quickly.

codex resume <SESSION_ID>

Resume a specific saved session.

codex fork
將先前的互動工作階段分支成新的對話分線。

Key points

--last: 不開啟選單，直接分支最近一次工作階段。
--all: 在選單中顯示所有工作目錄的工作階段。

Examples

codex fork --last

分支最近的工作階段並改走另一個方向。

codex fork <SESSION_ID> "嘗試替代實作"

從指定工作階段開啟新的討論分支。

codex apply
將 Codex 產生的最新 diff 透過 `git apply` 套用到本機工作樹。

Key points

<TASK_ID>: 指定要套用的 Codex 任務 ID。
建議先在 Codex Cloud 檢查 diff 再套用到本機。

Examples

codex apply <TASK_ID>

套用指定任務的最新差異。

codex cloud diff <TASK_ID>

先預覽補丁內容再在本機套用。

codex cloud
透過 CLI 管理 Codex Cloud 任務，並將結果套用到本機。

Key points

codex cloud list: 列出 Codex Cloud 上的任務。
codex cloud apply <TASK_ID>: 將雲端任務 diff 套用到本機儲存庫。

Examples

codex cloud list

查看 Codex Cloud 的可用任務。

codex cloud diff <TASK_ID>

在本機套用前先預覽差異內容。

codex app
啟動 Codex 桌面應用程式（若未安裝會先下載安裝程式）。

Key points

codex app: 在 macOS 開啟 Codex 桌面應用程式。
適合在終端流程與桌面版工作階段管理之間切換。

Examples

codex app

啟動應用程式（必要時先安裝再啟動）。

codex app --help

確認平台支援與啟動選項。

--profile
Select a profile defined in ~/.codex/config.toml.

Key points

fast: Quick lookup and lightweight analysis.
default | deep | max: Increase reasoning depth for complex tasks.

Examples

codex exec --profile fast "Inspect routing"

Run a low-cost analysis task.

codex exec --profile deep "Design refactor plan"

Use deeper reasoning for architecture tasks.

--sandbox
Control filesystem permissions for model-executed commands.

Key points

read-only: Prevent file writes.
workspace-write | danger-full-access: Allow broader editing access.

Examples

codex exec --sandbox read-only "List potential bugs"

Analyze code without changing files.

codex exec --sandbox workspace-write "Apply the fix"

Allow edits in the current workspace.

--ask-for-approval
Set when Codex asks for approval before running commands.

Key points

untrusted：對信任集合外的指令要求核准。
on-request | never：依互動式/非互動式流程切換核准策略。
on-failure：在最新版 CLI 中已標示為 DEPRECATED。

Examples

codex -a on-request

Start interactive mode with request-based approvals.

codex exec -a never "Run checks and summarize"

Use no-approval policy for scripted runs.

--full-auto
為互動執行套用低摩擦的核准與沙箱預設。

Key points

等同於 `-a on-request` 與 `--sandbox workspace-write`。
適合反覆實作、需要快速執行命令的情境。

Examples

codex exec --full-auto "實作並測試這個修正"

以按需核准與 workspace-write 沙箱執行。

codex resume --last --full-auto

以相同便利預設延續最近工作階段。

--search
Enable live web search in supported sessions.

Key points

codex --search：在新的互動式工作階段啟用網路搜尋。
啟用後可使用 Responses 的 `web_search` 工具。
codex resume --search：在重啟工作階段時也啟用網路搜尋。

Examples

codex --search "Check latest framework changes"

Start with web search enabled.

codex resume --last --search

Continue the latest session with web search.

-c, --config
Override config values from the command line.

Key points

-c model="gpt-5-codex": Set model for the current run.
-c features.name=true: Toggle a feature flag for this run only.

Examples

codex -c model="gpt-5-codex"

Launch with a specific model override.

codex exec -c 'sandbox_permissions=["workspace-write"]' "Explain risk"

Override sandbox permissions inline.

codex login --with-api-key
Authenticate Codex using API key or device auth flow.

Key points

--with-api-key: Read API key from stdin.
--device-auth: Use browser-based device authentication.

Examples

printenv OPENAI_API_KEY | codex login --with-api-key

codex login --device-auth

Start interactive device authentication.

codex mcp add
Manage external MCP servers in Codex.

Key points

codex mcp list: Show configured MCP servers.
codex mcp remove <name>: Remove an MCP server from config.

Examples

codex mcp add docs -- command --flag

codex mcp get docs

Inspect details of a configured MCP server.

codex mcp-server
以 stdio 方式將 Codex 本身啟動為 MCP 伺服器。

Key points

用於將 Codex 整合到支援 MCP 的客戶端與工具。
和其他子命令一樣支援 `-c/--config` 與功能旗標。

Examples

codex mcp-server

在 stdio 啟動 MCP 伺服器模式。

codex mcp-server -c model="gpt-5-codex"

以一次性設定覆寫啟動。

codex features
在 CLI 中檢視與管理 Codex 功能旗標。

Key points

codex features list: 顯示已知功能與目前狀態。
codex features enable|disable <name>: 將切換結果寫入 config.toml。

Examples

codex features list

啟用前先檢查分階段與實驗性旗標。

codex features enable <feature_name>

在本機 Codex 設定中啟用功能旗標。

codex completion zsh
Generate shell completion scripts.

Key points

codex completion zsh: Output zsh completion script.
codex completion bash: Output bash completion script.

Examples

codex completion zsh > ~/.zsh/completions/_codex

Install zsh completion manually.

codex completion fish > ~/.config/fish/completions/codex.fish

Install fish completion script.

codex exec --profile fast --sandbox read-only "<prompt>"
Safe analysis workflow for read-only inspection.

Key points

--profile fast: Use lower-cost profile for quick checks.
--sandbox read-only: Guarantee no file modifications.

Examples

codex exec --profile fast --sandbox read-only "Find dead code candidates"

Run static analysis without editing files.

codex exec --profile fast --sandbox read-only "Map i18n key usage"

Inspect translation usage safely.

codex exec --profile default --sandbox workspace-write "<prompt>"
Standard implementation workflow with editable workspace.

Key points

--profile default: Balanced speed and reasoning.
--sandbox workspace-write: Allow edits inside project workspace.

Examples

codex exec --profile default --sandbox workspace-write "Implement tooltip improvements"

Run a typical implementation task.

codex exec --profile default --sandbox workspace-write "Update docs and tests"

Apply code and documentation updates together.

codex review --uncommitted
Review local changes before commit.

Key points

--uncommitted: Include staged, unstaged, and untracked files.
--title <name>: Add context label to review summary.

Examples

codex review --uncommitted

Run a quick local review pass.

codex review --uncommitted --title "before-merge-check"

Attach a custom review title.

codex exec --json -o result.json "<prompt>"
Produce machine-readable output for automation pipelines.

Key points

--json: Stream execution events as JSONL.
-o <file>: Save the last assistant message to a file.

Examples

codex exec --json -o result.json "List migration risks"

Capture structured events and final summary.

codex exec --json "Generate release notes draft"

Use JSONL stream in custom tooling.

About This Tool

This page consolidates Codex CLI essentials into one searchable reference so you can move from lookup to execution quickly.

What You Can Check

Core Codex CLI commands for interactive and non-interactive usage
Key global options for profile, sandbox, approvals, and web search
Practical setup commands for login, MCP, completion, and config overrides
Workflow-ready examples you can copy and run immediately

When It Helps

Onboarding teammates to Codex CLI quickly
Standardizing command usage in team runbooks
Reducing mistakes in sandbox and approval settings
Creating repeatable CLI workflows for review and implementation

FAQ

What does this tool cover?

It covers Codex CLI basics, major options, setup commands, and reusable workflow examples in a single searchable view.

Are the examples safe to run as-is?

Examples are templates. Replace placeholder prompts and choose sandbox/approval settings appropriate for your environment.

How often should I review these commands?

Review after CLI updates and when your team changes profiles, sandbox policies, or automation scripts.

Can I copy commands directly?

Yes. Each card has a copy button that copies the command string so you can paste it into your terminal immediately.

Codex CLI 指令一覽

整理 Codex CLI 基本指令、主要選項、設定方式與實用工作流程的參考表

How to Use展開使用方法

1
Filter by category
Switch between Core Commands, Key Options, Setup, and Workflow Examples to focus on the commands you need.
2
Search details
Use keyword search to match command names, option notes, and example commands at once.
3
Copy and run
Copy the command snippet with one click, then run it directly in your terminal.

codex
Start an interactive Codex CLI session.

Key points

codex "<prompt>": Start with an initial prompt.
codex --help: Show available subcommands and global options.

Examples

codex

Launch interactive mode in the current directory.

codex "Summarize this repository structure"

Start a session with a task-focused prompt.

codex exec
Run Codex non-interactively for automation and CI-style tasks.

Key points

--sandbox: Choose execution sandbox mode.
--profile: Load a predefined profile from config.toml.

Examples

codex exec "Review this PR diff"

Run a one-shot review task from the CLI.

cat plan.md | codex exec -

Read instructions from stdin.

codex review
Run a code review directly from the command line.

Key points

--uncommitted: Review staged, unstaged, and untracked changes.
--base <branch>: Compare the current branch against a base branch.

Examples

codex review --uncommitted

Review local changes before committing.

codex review --base main

Review changes against main branch.

codex resume
Resume a previous interactive session.

Key points

--last: Resume the most recent session immediately.
--all: Show all sessions beyond current working directory filter.

Examples

codex resume --last

Continue the latest session quickly.

codex resume <SESSION_ID>

Resume a specific saved session.

codex fork
將先前的互動工作階段分支成新的對話分線。

Key points

--last: 不開啟選單，直接分支最近一次工作階段。
--all: 在選單中顯示所有工作目錄的工作階段。

Examples

codex fork --last

分支最近的工作階段並改走另一個方向。

codex fork <SESSION_ID> "嘗試替代實作"

從指定工作階段開啟新的討論分支。

codex apply
將 Codex 產生的最新 diff 透過 `git apply` 套用到本機工作樹。

Key points

<TASK_ID>: 指定要套用的 Codex 任務 ID。
建議先在 Codex Cloud 檢查 diff 再套用到本機。

Examples

codex apply <TASK_ID>

套用指定任務的最新差異。

codex cloud diff <TASK_ID>

先預覽補丁內容再在本機套用。

codex cloud
透過 CLI 管理 Codex Cloud 任務，並將結果套用到本機。

Key points

codex cloud list: 列出 Codex Cloud 上的任務。
codex cloud apply <TASK_ID>: 將雲端任務 diff 套用到本機儲存庫。

Examples

codex cloud list

查看 Codex Cloud 的可用任務。

codex cloud diff <TASK_ID>

在本機套用前先預覽差異內容。

codex app
啟動 Codex 桌面應用程式（若未安裝會先下載安裝程式）。

Key points

codex app: 在 macOS 開啟 Codex 桌面應用程式。
適合在終端流程與桌面版工作階段管理之間切換。

Examples

codex app

啟動應用程式（必要時先安裝再啟動）。

codex app --help

確認平台支援與啟動選項。

--profile
Select a profile defined in ~/.codex/config.toml.

Key points

fast: Quick lookup and lightweight analysis.
default | deep | max: Increase reasoning depth for complex tasks.

Examples

codex exec --profile fast "Inspect routing"

Run a low-cost analysis task.

codex exec --profile deep "Design refactor plan"

Use deeper reasoning for architecture tasks.

--sandbox
Control filesystem permissions for model-executed commands.

Key points

read-only: Prevent file writes.
workspace-write | danger-full-access: Allow broader editing access.

Examples

codex exec --sandbox read-only "List potential bugs"

Analyze code without changing files.

codex exec --sandbox workspace-write "Apply the fix"

Allow edits in the current workspace.

--ask-for-approval
Set when Codex asks for approval before running commands.

Key points

untrusted：對信任集合外的指令要求核准。
on-request | never：依互動式/非互動式流程切換核准策略。
on-failure：在最新版 CLI 中已標示為 DEPRECATED。

Examples

codex -a on-request

Start interactive mode with request-based approvals.

codex exec -a never "Run checks and summarize"

Use no-approval policy for scripted runs.

--full-auto
為互動執行套用低摩擦的核准與沙箱預設。

Key points

等同於 `-a on-request` 與 `--sandbox workspace-write`。
適合反覆實作、需要快速執行命令的情境。

Examples

codex exec --full-auto "實作並測試這個修正"

以按需核准與 workspace-write 沙箱執行。

codex resume --last --full-auto

以相同便利預設延續最近工作階段。

--search
Enable live web search in supported sessions.

Key points

codex --search：在新的互動式工作階段啟用網路搜尋。
啟用後可使用 Responses 的 `web_search` 工具。
codex resume --search：在重啟工作階段時也啟用網路搜尋。

Examples

codex --search "Check latest framework changes"

Start with web search enabled.

codex resume --last --search

Continue the latest session with web search.

-c, --config
Override config values from the command line.

Key points

-c model="gpt-5-codex": Set model for the current run.
-c features.name=true: Toggle a feature flag for this run only.

Examples

codex -c model="gpt-5-codex"

Launch with a specific model override.

codex exec -c 'sandbox_permissions=["workspace-write"]' "Explain risk"

Override sandbox permissions inline.

codex login --with-api-key
Authenticate Codex using API key or device auth flow.

Key points

--with-api-key: Read API key from stdin.
--device-auth: Use browser-based device authentication.

Examples

printenv OPENAI_API_KEY | codex login --with-api-key

codex login --device-auth

Start interactive device authentication.

codex mcp add
Manage external MCP servers in Codex.

Key points

codex mcp list: Show configured MCP servers.
codex mcp remove <name>: Remove an MCP server from config.

Examples

codex mcp add docs -- command --flag

codex mcp get docs

Inspect details of a configured MCP server.

codex mcp-server
以 stdio 方式將 Codex 本身啟動為 MCP 伺服器。

Key points

用於將 Codex 整合到支援 MCP 的客戶端與工具。
和其他子命令一樣支援 `-c/--config` 與功能旗標。

Examples

codex mcp-server

在 stdio 啟動 MCP 伺服器模式。

codex mcp-server -c model="gpt-5-codex"

以一次性設定覆寫啟動。

codex features
在 CLI 中檢視與管理 Codex 功能旗標。

Key points

codex features list: 顯示已知功能與目前狀態。
codex features enable|disable <name>: 將切換結果寫入 config.toml。

Examples

codex features list

啟用前先檢查分階段與實驗性旗標。

codex features enable <feature_name>

在本機 Codex 設定中啟用功能旗標。

codex completion zsh
Generate shell completion scripts.

Key points

codex completion zsh: Output zsh completion script.
codex completion bash: Output bash completion script.

Examples

codex completion zsh > ~/.zsh/completions/_codex

Install zsh completion manually.

codex completion fish > ~/.config/fish/completions/codex.fish

Install fish completion script.

codex exec --profile fast --sandbox read-only "<prompt>"
Safe analysis workflow for read-only inspection.

Key points

--profile fast: Use lower-cost profile for quick checks.
--sandbox read-only: Guarantee no file modifications.

Examples

codex exec --profile fast --sandbox read-only "Find dead code candidates"

Run static analysis without editing files.

codex exec --profile fast --sandbox read-only "Map i18n key usage"

Inspect translation usage safely.

codex exec --profile default --sandbox workspace-write "<prompt>"
Standard implementation workflow with editable workspace.

Key points

--profile default: Balanced speed and reasoning.
--sandbox workspace-write: Allow edits inside project workspace.

Examples

codex exec --profile default --sandbox workspace-write "Implement tooltip improvements"

Run a typical implementation task.

codex exec --profile default --sandbox workspace-write "Update docs and tests"

Apply code and documentation updates together.

codex review --uncommitted
Review local changes before commit.

Key points

--uncommitted: Include staged, unstaged, and untracked files.
--title <name>: Add context label to review summary.

Examples

codex review --uncommitted

Run a quick local review pass.

codex review --uncommitted --title "before-merge-check"

Attach a custom review title.

codex exec --json -o result.json "<prompt>"
Produce machine-readable output for automation pipelines.

Key points

--json: Stream execution events as JSONL.
-o <file>: Save the last assistant message to a file.

Examples

codex exec --json -o result.json "List migration risks"

Capture structured events and final summary.

codex exec --json "Generate release notes draft"

Use JSONL stream in custom tooling.

About This Tool

This page consolidates Codex CLI essentials into one searchable reference so you can move from lookup to execution quickly.

What You Can Check

Core Codex CLI commands for interactive and non-interactive usage
Key global options for profile, sandbox, approvals, and web search
Practical setup commands for login, MCP, completion, and config overrides
Workflow-ready examples you can copy and run immediately

When It Helps

Onboarding teammates to Codex CLI quickly
Standardizing command usage in team runbooks
Reducing mistakes in sandbox and approval settings
Creating repeatable CLI workflows for review and implementation

FAQ

What does this tool cover?

It covers Codex CLI basics, major options, setup commands, and reusable workflow examples in a single searchable view.

Are the examples safe to run as-is?

Examples are templates. Replace placeholder prompts and choose sandbox/approval settings appropriate for your environment.

How often should I review these commands?

Review after CLI updates and when your team changes profiles, sandbox policies, or automation scripts.

Can I copy commands directly?

Yes. Each card has a copy button that copies the command string so you can paste it into your terminal immediately.

Codex CLI 指令一覽

Filter by category

Search details

Copy and run

codexStart an interactive Codex CLI session.

Key points

Examples

codex execRun Codex non-interactively for automation and CI-style tasks.

Key points

Examples

codex reviewRun a code review directly from the command line.

Key points

Examples

codex resumeResume a previous interactive session.

Key points

Examples

codex fork將先前的互動工作階段分支成新的對話分線。

Key points

Examples

codex apply將 Codex 產生的最新 diff 透過 `git apply` 套用到本機工作樹。

Key points

Examples

codex cloud透過 CLI 管理 Codex Cloud 任務，並將結果套用到本機。

Key points

Examples

codex app啟動 Codex 桌面應用程式（若未安裝會先下載安裝程式）。

Key points

Examples

--profileSelect a profile defined in ~/.codex/config.toml.

Key points

Examples

--sandboxControl filesystem permissions for model-executed commands.

Key points

Examples

--ask-for-approvalSet when Codex asks for approval before running commands.

Key points

Examples

--full-auto為互動執行套用低摩擦的核准與沙箱預設。

Key points

Examples

--searchEnable live web search in supported sessions.

Key points

Examples

-c, --configOverride config values from the command line.

Key points

Examples

codex login --with-api-keyAuthenticate Codex using API key or device auth flow.

Key points

Examples

codex mcp addManage external MCP servers in Codex.

Key points

Examples

codex mcp-server以 stdio 方式將 Codex 本身啟動為 MCP 伺服器。

Key points

Examples

codex features在 CLI 中檢視與管理 Codex 功能旗標。

Key points

Examples

codex completion zshGenerate shell completion scripts.

Key points

Examples

codex exec --profile fast --sandbox read-only "<prompt>"Safe analysis workflow for read-only inspection.

Key points

Examples

codex exec --profile default --sandbox workspace-write "<prompt>"Standard implementation workflow with editable workspace.

Key points

Examples

codex review --uncommittedReview local changes before commit.

Key points

Examples

codex exec --json -o result.json "<prompt>"Produce machine-readable output for automation pipelines.

Key points

Examples

About This Tool

What You Can Check

When It Helps

FAQ

相關工具

Codex CLI 指令一覽

Filter by category

codex
Start an interactive Codex CLI session.

codex exec
Run Codex non-interactively for automation and CI-style tasks.

codex review
Run a code review directly from the command line.

codex resume
Resume a previous interactive session.

codex fork
將先前的互動工作階段分支成新的對話分線。

codex apply
將 Codex 產生的最新 diff 透過 `git apply` 套用到本機工作樹。

codex cloud
透過 CLI 管理 Codex Cloud 任務，並將結果套用到本機。

codex app
啟動 Codex 桌面應用程式（若未安裝會先下載安裝程式）。

--profile
Select a profile defined in ~/.codex/config.toml.

--sandbox
Control filesystem permissions for model-executed commands.

--ask-for-approval
Set when Codex asks for approval before running commands.

--full-auto
為互動執行套用低摩擦的核准與沙箱預設。

--search
Enable live web search in supported sessions.

-c, --config
Override config values from the command line.

codex login --with-api-key
Authenticate Codex using API key or device auth flow.

codex mcp add
Manage external MCP servers in Codex.

codex mcp-server
以 stdio 方式將 Codex 本身啟動為 MCP 伺服器。

codex features
在 CLI 中檢視與管理 Codex 功能旗標。

codex completion zsh
Generate shell completion scripts.

codex exec --profile fast --sandbox read-only "<prompt>"
Safe analysis workflow for read-only inspection.

codex exec --profile default --sandbox workspace-write "<prompt>"
Standard implementation workflow with editable workspace.

codex review --uncommitted
Review local changes before commit.

codex exec --json -o result.json "<prompt>"
Produce machine-readable output for automation pipelines.

codex
Start an interactive Codex CLI session.

codex exec
Run Codex non-interactively for automation and CI-style tasks.

codex review
Run a code review directly from the command line.

codex resume
Resume a previous interactive session.

codex fork
將先前的互動工作階段分支成新的對話分線。

codex apply
將 Codex 產生的最新 diff 透過 `git apply` 套用到本機工作樹。

codex cloud
透過 CLI 管理 Codex Cloud 任務，並將結果套用到本機。

codex app
啟動 Codex 桌面應用程式（若未安裝會先下載安裝程式）。

--profile
Select a profile defined in ~/.codex/config.toml.

--sandbox
Control filesystem permissions for model-executed commands.

--ask-for-approval
Set when Codex asks for approval before running commands.

--full-auto
為互動執行套用低摩擦的核准與沙箱預設。

--search
Enable live web search in supported sessions.

-c, --config
Override config values from the command line.

codex login --with-api-key
Authenticate Codex using API key or device auth flow.

codex mcp add
Manage external MCP servers in Codex.

codex mcp-server
以 stdio 方式將 Codex 本身啟動為 MCP 伺服器。

codex features
在 CLI 中檢視與管理 Codex 功能旗標。

codex completion zsh
Generate shell completion scripts.

codex exec --profile fast --sandbox read-only "<prompt>"
Safe analysis workflow for read-only inspection.

codex exec --profile default --sandbox workspace-write "<prompt>"
Standard implementation workflow with editable workspace.

codex review --uncommitted
Review local changes before commit.

codex exec --json -o result.json "<prompt>"
Produce machine-readable output for automation pipelines.