Codex CLI Cheatsheet
A compact reference for documented Codex CLI commands, common flags, non-interactive runs, MCP and plugin management, and built-in slash commands.
codexInteractive local repo work
codex execScripts and one-shot tasks
codex cloudCloud task workflows
/permissionsLive session control
Quick Start
Commands you will reach for first
These cover the most common local, automated, Cloud, and interactive-control flows.
codexOpen the terminal UI in the current workspace.
codex exec "fix the failing test"Run Codex non-interactively and stream the result.
codex resume --lastReturn to the most recent interactive session.
codex apply TASK_IDApply the latest diff from a Codex Cloud task.
/permissionsAdjust what Codex can do without asking.
/modelChoose the active model and reasoning effort.
Global Options
codex [OPTIONS] [PROMPT]
These options mainly apply to the base codex command. Many are also accepted by subcommands.
| Option | Type / Values | Use |
|---|---|---|
--add-dir | path | Add another writable directory beside the main workspace. |
--ask-for-approval, -a | untrusted | on-request | never | Choose when Codex asks before running commands. |
--cd, -C | path | Set the working directory before the agent starts. |
--config, -c | key=value | Override configuration values inline. |
--dangerously-bypass-approvals-and-sandbox | boolean | Disable approvals and sandboxing for externally isolated environments. |
--yolo | boolean | Alias for the dangerous bypass mode. |
--dangerously-bypass-hook-trust | boolean | Run enabled hooks without persisted trust for this run. |
--disable | feature | Force-disable a feature flag. |
--enable | feature | Force-enable a feature flag. |
--image, -i | path[,path...] | Attach images to the initial prompt. |
--model, -m | string | Override the configured model. |
--no-alt-screen | boolean | Disable alternate-screen mode in the terminal UI. |
--oss | boolean | Use a local open-source model provider, commonly with Ollama. |
--profile, -p | string | Load a named Codex config profile. |
--remote | ws://host:port | wss://host:port | unix:// | unix://PATH | Connect the TUI to a remote app-server. |
--remote-auth-token-env | ENV_VAR | Read the remote bearer token from an environment variable. |
--sandbox, -s | read-only | workspace-write | danger-full-access | Select the sandbox policy for shell commands. |
--search | boolean | Enable live web search. |
--strict-config | boolean | Error on unknown config fields. |
PROMPT | string | Optional starting instruction. |
--add-dirType / Values
pathUse
Add another writable directory beside the main workspace.
--ask-for-approval, -aType / Values
untrusted | on-request | neverUse
Choose when Codex asks before running commands.
--cd, -CType / Values
pathUse
Set the working directory before the agent starts.
--config, -cType / Values
key=valueUse
Override configuration values inline.
--dangerously-bypass-approvals-and-sandboxType / Values
booleanUse
Disable approvals and sandboxing for externally isolated environments.
--yoloType / Values
booleanUse
Alias for the dangerous bypass mode.
--dangerously-bypass-hook-trustType / Values
booleanUse
Run enabled hooks without persisted trust for this run.
--disableType / Values
featureUse
Force-disable a feature flag.
--enableType / Values
featureUse
Force-enable a feature flag.
--image, -iType / Values
path[,path...]Use
Attach images to the initial prompt.
--model, -mType / Values
stringUse
Override the configured model.
--no-alt-screenType / Values
booleanUse
Disable alternate-screen mode in the terminal UI.
--ossType / Values
booleanUse
Use a local open-source model provider, commonly with Ollama.
--profile, -pType / Values
stringUse
Load a named Codex config profile.
--remoteType / Values
ws://host:port | wss://host:port | unix:// | unix://PATHUse
Connect the TUI to a remote app-server.
--remote-auth-token-envType / Values
ENV_VARUse
Read the remote bearer token from an environment variable.
--sandbox, -sType / Values
read-only | workspace-write | danger-full-accessUse
Select the sandbox policy for shell commands.
--searchType / Values
booleanUse
Enable live web search.
--strict-configType / Values
booleanUse
Error on unknown config fields.
PROMPTType / Values
stringUse
Optional starting instruction.
Use --dangerously-bypass-approvals-and-sandbox or --yolo only when the surrounding environment already provides strong isolation.
Command Overview
Documented top-level commands
Stable commands are intended for regular use. Experimental commands may change as Codex evolves.
| Command | Maturity | Use |
|---|---|---|
codex | Stable | Start the interactive terminal UI. |
codex app | Stable | Open the Codex desktop app. |
codex app-server | Experimental | Start the local app server for development or debugging. |
codex apply | Stable | Apply a Codex Cloud task diff locally. |
codex a | Stable | Alias for codex apply. |
codex archive | Stable | Archive a saved interactive session. |
codex cloud | Experimental | Browse or run Codex Cloud tasks from the terminal. |
codex cloud-tasks | Experimental | Alias for codex cloud. |
codex completion | Stable | Generate shell completion scripts. |
codex debug app-server send-message-v2 | Experimental | Send a V2 test message to app-server. |
codex debug models | Experimental | Print the model catalog Codex sees. |
codex doctor | Stable | Create a local diagnostic report. |
codex exec | Stable | Run Codex non-interactively. |
codex e | Stable | Alias for codex exec. |
codex execpolicy | Experimental | Evaluate command execution policy rules. |
codex features | Stable | List or persist feature flag overrides. |
codex fork | Stable | Fork a previous session into a new thread. |
codex login | Stable | Authenticate Codex. |
codex logout | Stable | Remove stored credentials. |
codex mcp | Experimental | Manage MCP server definitions and auth. |
codex mcp-server | Experimental | Run Codex itself as an MCP server. |
codex plugin | Experimental | Install, list, and remove Codex plugins. |
codex plugin marketplace | Experimental | Manage plugin marketplace sources. |
codex remote-control | Experimental | Ensure app-server remote control support is enabled. |
codex resume | Stable | Resume a previous interactive session. |
codex sandbox | Experimental | Run commands inside Codex sandboxes. |
codex unarchive | Stable | Restore an archived session. |
codex update | Stable | Check for or apply a CLI update when supported. |
codexStableStart the interactive terminal UI.
codex appStableOpen the Codex desktop app.
codex app-serverExperimentalStart the local app server for development or debugging.
codex applyStableApply a Codex Cloud task diff locally.
codex aStableAlias for codex apply.
codex archiveStableArchive a saved interactive session.
codex cloudExperimentalBrowse or run Codex Cloud tasks from the terminal.
codex cloud-tasksExperimentalAlias for codex cloud.
codex completionStableGenerate shell completion scripts.
codex debug app-server send-message-v2ExperimentalSend a V2 test message to app-server.
codex debug modelsExperimentalPrint the model catalog Codex sees.
codex doctorStableCreate a local diagnostic report.
codex execStableRun Codex non-interactively.
codex eStableAlias for codex exec.
codex execpolicyExperimentalEvaluate command execution policy rules.
codex featuresStableList or persist feature flag overrides.
codex forkStableFork a previous session into a new thread.
codex loginStableAuthenticate Codex.
codex logoutStableRemove stored credentials.
codex mcpExperimentalManage MCP server definitions and auth.
codex mcp-serverExperimentalRun Codex itself as an MCP server.
codex pluginExperimentalInstall, list, and remove Codex plugins.
codex plugin marketplaceExperimentalManage plugin marketplace sources.
codex remote-controlExperimentalEnsure app-server remote control support is enabled.
codex resumeStableResume a previous interactive session.
codex sandboxExperimentalRun commands inside Codex sandboxes.
codex unarchiveStableRestore an archived session.
codex updateStableCheck for or apply a CLI update when supported.
Subcommands
Detailed command matrix
Grouped by workflow so the page stays scannable while still covering the documented command surface.
| Syntax | Type / Values | Use |
|---|---|---|
codex | - | Start the interactive terminal UI. |
codex "PROMPT" | - | Start the TUI with an initial instruction. |
codex --image path | path[,path...] | Start with one or more image attachments. |
codex --remote ENDPOINT | ws://, wss://, unix:// | Connect the TUI to a remote app-server. |
codex app | - | Open the desktop app. |
codex app PATH | path | Open a workspace path in Codex Desktop. |
codex app --download-url URL | url | Override the desktop installer download URL. |
codex app-server | - | Start the local app server. |
codex app-server --listen VALUE | stdio:// | ws://IP:PORT | unix:// | unix://PATH | off | Set the transport listener. |
codex app-server --stdio | boolean | Use stdio transport. |
codex app-server --analytics-default-enabled | boolean | Default analytics to enabled for app-server clients. |
codex app-server --ws-auth MODE | capability-token | signed-bearer-token | Choose WebSocket authentication mode. |
codex app-server --ws-audience VALUE | string | Expected JWT audience. |
codex app-server --ws-issuer VALUE | string | Expected JWT issuer. |
codex app-server --ws-max-clock-skew-seconds N | number | Allow clock skew for token time checks. |
codex app-server --ws-shared-secret-file PATH | absolute path | HMAC secret file for signed bearer tokens. |
codex app-server --ws-token-file PATH | absolute path | Capability token file. |
codex app-server --ws-token-sha256 HEX | hex SHA-256 | Expected SHA-256 digest for a token. |
codex remote-control | - | Ensure the local app-server daemon is running with remote-control enabled. |
codexUse
Start the interactive terminal UI.
codex "PROMPT"Use
Start the TUI with an initial instruction.
codex --image pathType / Values
path[,path...]Use
Start with one or more image attachments.
codex --remote ENDPOINTType / Values
ws://, wss://, unix://Use
Connect the TUI to a remote app-server.
codex appUse
Open the desktop app.
codex app PATHType / Values
pathUse
Open a workspace path in Codex Desktop.
codex app --download-url URLType / Values
urlUse
Override the desktop installer download URL.
codex app-serverUse
Start the local app server.
codex app-server --listen VALUEType / Values
stdio:// | ws://IP:PORT | unix:// | unix://PATH | offUse
Set the transport listener.
codex app-server --stdioType / Values
booleanUse
Use stdio transport.
codex app-server --analytics-default-enabledType / Values
booleanUse
Default analytics to enabled for app-server clients.
codex app-server --ws-auth MODEType / Values
capability-token | signed-bearer-tokenUse
Choose WebSocket authentication mode.
codex app-server --ws-audience VALUEType / Values
stringUse
Expected JWT audience.
codex app-server --ws-issuer VALUEType / Values
stringUse
Expected JWT issuer.
codex app-server --ws-max-clock-skew-seconds NType / Values
numberUse
Allow clock skew for token time checks.
codex app-server --ws-shared-secret-file PATHType / Values
absolute pathUse
HMAC secret file for signed bearer tokens.
codex app-server --ws-token-file PATHType / Values
absolute pathUse
Capability token file.
codex app-server --ws-token-sha256 HEXType / Values
hex SHA-256Use
Expected SHA-256 digest for a token.
codex remote-controlUse
Ensure the local app-server daemon is running with remote-control enabled.
| Syntax | Type / Values | Use |
|---|---|---|
codex apply TASK_ID | string | Apply a Codex Cloud task diff locally. |
codex a TASK_ID | string | Alias for codex apply. |
codex archive SESSION | session ID | session name | Archive a saved session by ID or name. |
codex unarchive SESSION | session ID | session name | Restore an archived session by ID or name. |
codex archive --remote ENDPOINT SESSION | endpoint | Connect to remote app-server before changing archive state. |
codex cloud | - | Browse or run Cloud tasks from the terminal. |
codex cloud exec QUERY | string | Submit a Cloud task directly. |
codex cloud exec --attempts N | 1-4 | Set the number of assistant attempts. |
codex cloud exec --env ENV_ID | ENV_ID | Target a Codex Cloud environment. |
codex cloud list | - | List recent Cloud tasks. |
codex cloud list --cursor VALUE | string | Use a pagination cursor. |
codex cloud list --env ENV_ID | ENV_ID | Filter by environment. |
codex cloud list --json | boolean | Emit JSON output. |
codex cloud list --limit N | 1-20 | Limit the number of tasks returned. |
codex cloud-tasks | - | Alias for codex cloud. |
codex resume | - | Resume an interactive session. |
codex resume SESSION_ID | uuid | Resume a specific interactive session. |
codex resume --all | boolean | Show sessions outside the current directory. |
codex resume --last | boolean | Resume the most recent session. |
codex fork | - | Fork a previous session into a new thread. |
codex fork SESSION_ID | uuid | Fork a specific session. |
codex fork --all | boolean | Show sessions outside the current directory. |
codex fork --last | boolean | Fork the most recent session. |
codex apply TASK_IDType / Values
stringUse
Apply a Codex Cloud task diff locally.
codex a TASK_IDType / Values
stringUse
Alias for codex apply.
codex archive SESSIONType / Values
session ID | session nameUse
Archive a saved session by ID or name.
codex unarchive SESSIONType / Values
session ID | session nameUse
Restore an archived session by ID or name.
codex archive --remote ENDPOINT SESSIONType / Values
endpointUse
Connect to remote app-server before changing archive state.
codex cloudUse
Browse or run Cloud tasks from the terminal.
codex cloud exec QUERYType / Values
stringUse
Submit a Cloud task directly.
codex cloud exec --attempts NType / Values
1-4Use
Set the number of assistant attempts.
codex cloud exec --env ENV_IDType / Values
ENV_IDUse
Target a Codex Cloud environment.
codex cloud listUse
List recent Cloud tasks.
codex cloud list --cursor VALUEType / Values
stringUse
Use a pagination cursor.
codex cloud list --env ENV_IDType / Values
ENV_IDUse
Filter by environment.
codex cloud list --jsonType / Values
booleanUse
Emit JSON output.
codex cloud list --limit NType / Values
1-20Use
Limit the number of tasks returned.
codex cloud-tasksUse
Alias for codex cloud.
codex resumeUse
Resume an interactive session.
codex resume SESSION_IDType / Values
uuidUse
Resume a specific interactive session.
codex resume --allType / Values
booleanUse
Show sessions outside the current directory.
codex resume --lastType / Values
booleanUse
Resume the most recent session.
codex forkUse
Fork a previous session into a new thread.
codex fork SESSION_IDType / Values
uuidUse
Fork a specific session.
codex fork --allType / Values
booleanUse
Show sessions outside the current directory.
codex fork --lastType / Values
booleanUse
Fork the most recent session.
Non-Interactive Mode
codex exec options
Use these flags when Codex is launched as a one-shot command from a terminal, script, or automation.
| Option | Type / Values | Use |
|---|---|---|
--cd, -C | path | Set the workspace root. |
--color | always | never | auto | Control ANSI color output. |
--dangerously-bypass-approvals-and-sandbox | boolean | Disable approvals and sandboxing. |
--yolo | boolean | Alias for dangerous bypass mode. |
--dangerously-bypass-hook-trust | boolean | Run hooks without persisted trust. |
--ephemeral | boolean | Do not persist session rollout files. |
--full-auto | boolean | Deprecated compatibility option. |
--ignore-rules | boolean | Do not load execpolicy rule files. |
--ignore-user-config | boolean | Do not load user config. |
--image, -i | path[,path...] | Attach images to the first message. |
--json | boolean | Emit NDJSON events. |
--experimental-json | boolean | Older alias for JSON event output. |
--model, -m | string | Override the model. |
--oss | boolean | Use a local OSS model provider. |
--output-last-message, -o | path | Write the final assistant message to a file. |
--output-schema | path | Validate the final output against a JSON Schema. |
--profile, -p | string | Load a config profile. |
--sandbox, -s | read-only | workspace-write | danger-full-access | Choose the sandbox policy. |
--skip-git-repo-check | boolean | Allow running outside a Git repository. |
--config, -c | key=value | Override config inline. |
PROMPT | string | - | Initial instruction. Use - to read from stdin. |
--cd, -CType / Values
pathUse
Set the workspace root.
--colorType / Values
always | never | autoUse
Control ANSI color output.
--dangerously-bypass-approvals-and-sandboxType / Values
booleanUse
Disable approvals and sandboxing.
--yoloType / Values
booleanUse
Alias for dangerous bypass mode.
--dangerously-bypass-hook-trustType / Values
booleanUse
Run hooks without persisted trust.
--ephemeralType / Values
booleanUse
Do not persist session rollout files.
--full-autoType / Values
booleanUse
Deprecated compatibility option.
--ignore-rulesType / Values
booleanUse
Do not load execpolicy rule files.
--ignore-user-configType / Values
booleanUse
Do not load user config.
--image, -iType / Values
path[,path...]Use
Attach images to the first message.
--jsonType / Values
booleanUse
Emit NDJSON events.
--experimental-jsonType / Values
booleanUse
Older alias for JSON event output.
--model, -mType / Values
stringUse
Override the model.
--ossType / Values
booleanUse
Use a local OSS model provider.
--output-last-message, -oType / Values
pathUse
Write the final assistant message to a file.
--output-schemaType / Values
pathUse
Validate the final output against a JSON Schema.
--profile, -pType / Values
stringUse
Load a config profile.
--sandbox, -sType / Values
read-only | workspace-write | danger-full-accessUse
Choose the sandbox policy.
--skip-git-repo-checkType / Values
booleanUse
Allow running outside a Git repository.
--config, -cType / Values
key=valueUse
Override config inline.
PROMPTType / Values
string | -Use
Initial instruction. Use - to read from stdin.
Interactive TUI
Built-in slash commands
Type / in the Codex composer to open the slash command popup.
| Slash Command | Use |
|---|---|
/permissions | Set what Codex may do without asking. |
/ide | Include IDE context such as open files and selection. |
/keymap | Remap TUI keyboard shortcuts. |
/vim | Toggle Vim mode for the composer. |
/sandbox-add-read-dir | Add sandbox read access to a directory on Windows. |
/agent | Switch the active agent thread. |
/apps | Browse apps or connectors and insert one into the prompt. |
/plugins | Browse installed and discoverable plugins. |
/hooks | Review lifecycle hooks. |
/clear | Clear the terminal and start a fresh chat. |
/archive | Archive the current session and exit Codex. |
/compact | Summarize visible conversation to free tokens. |
/copy | Copy the latest completed Codex output. |
/diff | Show Git diff, including untracked files. |
/exit | Exit the CLI. |
/experimental | Toggle experimental features. |
/approve | Approve one retry after an auto-review denial. |
/memories | Configure memory usage and generation. |
/skills | Browse and use skills. |
/feedback | Send logs to Codex maintainers. |
/init | Generate an AGENTS.md scaffold. |
/logout | Sign out of Codex. |
/mcp | List configured MCP tools. |
/mcp verbose | Show MCP server details. |
/mention | Attach a file or folder to the conversation. |
/model | Choose model and reasoning effort. |
/fast | Toggle or inspect the Fast service tier. |
/plan | Switch to plan mode. |
/goal | Set, view, pause, resume, or clear a goal. |
/personality | Choose communication style. |
/ps | Show experimental background terminals. |
/stop | Stop all background terminals. |
/fork | Fork the current conversation into a new thread. |
/side | Start an ephemeral side conversation. |
/btw | Start a short side conversation. |
/raw | Toggle raw scrollback mode. |
/resume | Resume a saved conversation. |
/new | Start a new conversation in the same CLI session. |
/quit | Exit the CLI. |
/review | Ask Codex to review the working tree. |
/status | Display session config and token usage. |
/debug-config | Print config-layer diagnostics. |
/statusline | Configure TUI status-line fields. |
/title | Configure terminal title fields. |
/theme | Choose syntax-highlighting theme. |
/permissionsSet what Codex may do without asking.
/ideInclude IDE context such as open files and selection.
/keymapRemap TUI keyboard shortcuts.
/vimToggle Vim mode for the composer.
/sandbox-add-read-dirAdd sandbox read access to a directory on Windows.
/agentSwitch the active agent thread.
/appsBrowse apps or connectors and insert one into the prompt.
/pluginsBrowse installed and discoverable plugins.
/hooksReview lifecycle hooks.
/clearClear the terminal and start a fresh chat.
/archiveArchive the current session and exit Codex.
/compactSummarize visible conversation to free tokens.
/copyCopy the latest completed Codex output.
/diffShow Git diff, including untracked files.
/exitExit the CLI.
/experimentalToggle experimental features.
/approveApprove one retry after an auto-review denial.
/memoriesConfigure memory usage and generation.
/skillsBrowse and use skills.
/feedbackSend logs to Codex maintainers.
/initGenerate an AGENTS.md scaffold.
/logoutSign out of Codex.
/mcpList configured MCP tools.
/mcp verboseShow MCP server details.
/mentionAttach a file or folder to the conversation.
/modelChoose model and reasoning effort.
/fastToggle or inspect the Fast service tier.
/planSwitch to plan mode.
/goalSet, view, pause, resume, or clear a goal.
/personalityChoose communication style.
/psShow experimental background terminals.
/stopStop all background terminals.
/forkFork the current conversation into a new thread.
/sideStart an ephemeral side conversation.
/btwStart a short side conversation.
/rawToggle raw scrollback mode.
/resumeResume a saved conversation.
/newStart a new conversation in the same CLI session.
/quitExit the CLI.
/reviewAsk Codex to review the working tree.
/statusDisplay session config and token usage.
/debug-configPrint config-layer diagnostics.
/statuslineConfigure TUI status-line fields.
/titleConfigure terminal title fields.
/themeChoose syntax-highlighting theme.
Common forms
/fast onTurn the Fast tier on.
/fast offTurn the Fast tier off.
/fast statusShow Fast tier status.
/personality friendlyUse the friendly communication style.
/personality pragmaticUse the pragmatic communication style.
/personality noneDisable personality styling.
/goal <objective>Set a task goal.
/goal pausePause the current goal.
/goal resumeResume the current goal.
/goal clearClear the current goal.
/prompts:<name>Run a local custom prompt. Custom prompts are deprecated in favor of skills.
Local extensions
Built-in slash commands are finite, but installed skills, plugins, MCP servers, and deprecated /prompts:* files can add machine-local capabilities.
Sources
Official documentation
The command names, flags, maturity labels, and slash command coverage are based on OpenAI's documented Codex CLI pages.
Reading note
This page is written as an English quick-reference page, not a full reproduction of the official documentation.