Cheatsheet do Codex CLI
Uma referência compacta para comandos documentados do Codex CLI, flags comuns, execuções não interativas, MCP, plugins e slash commands integrados.
codexTrabalho interativo em repositórios locais
codex execScripts e tarefas pontuais
codex cloudFluxos de tarefas na Cloud
/permissionsControle da sessão ao vivo
Começo rápido
Comandos que você provavelmente usará primeiro
Cobre os fluxos mais comuns de trabalho local, automação, Cloud e controle interativo.
codexAbre a UI de terminal no workspace atual.
codex exec "fix the failing test"Executa o Codex sem interação e transmite o resultado.
codex resume --lastRetorna para a sessão interativa mais recente.
codex apply TASK_IDAplica o diff mais recente de uma tarefa do Codex Cloud.
/permissionsAjusta o que o Codex pode fazer sem perguntar.
/modelEscolhe o modelo ativo e o esforço de raciocínio.
Opções globais
codex [OPTIONS] [PROMPT]
Essas opções se aplicam principalmente ao comando codex base. Muitas também são aceitas por subcomandos.
| Opção | Tipo / Valores | Uso |
|---|---|---|
--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-dirTipo / Valores
pathUso
Add another writable directory beside the main workspace.
--ask-for-approval, -aTipo / Valores
untrusted | on-request | neverUso
Choose when Codex asks before running commands.
--cd, -CTipo / Valores
pathUso
Set the working directory before the agent starts.
--config, -cTipo / Valores
key=valueUso
Override configuration values inline.
--dangerously-bypass-approvals-and-sandboxTipo / Valores
booleanUso
Disable approvals and sandboxing for externally isolated environments.
--yoloTipo / Valores
booleanUso
Alias for the dangerous bypass mode.
--dangerously-bypass-hook-trustTipo / Valores
booleanUso
Run enabled hooks without persisted trust for this run.
--disableTipo / Valores
featureUso
Force-disable a feature flag.
--enableTipo / Valores
featureUso
Force-enable a feature flag.
--image, -iTipo / Valores
path[,path...]Uso
Attach images to the initial prompt.
--model, -mTipo / Valores
stringUso
Override the configured model.
--no-alt-screenTipo / Valores
booleanUso
Disable alternate-screen mode in the terminal UI.
--ossTipo / Valores
booleanUso
Use a local open-source model provider, commonly with Ollama.
--profile, -pTipo / Valores
stringUso
Load a named Codex config profile.
--remoteTipo / Valores
ws://host:port | wss://host:port | unix:// | unix://PATHUso
Connect the TUI to a remote app-server.
--remote-auth-token-envTipo / Valores
ENV_VARUso
Read the remote bearer token from an environment variable.
--sandbox, -sTipo / Valores
read-only | workspace-write | danger-full-accessUso
Select the sandbox policy for shell commands.
--searchTipo / Valores
booleanUso
Enable live web search.
--strict-configTipo / Valores
booleanUso
Error on unknown config fields.
PROMPTTipo / Valores
stringUso
Optional starting instruction.
Use --dangerously-bypass-approvals-and-sandbox ou --yolo apenas quando o ambiente ao redor já tiver isolamento forte.
Visão geral
Comandos de topo documentados
Comandos Stable são voltados ao uso regular. Comandos Experimental podem mudar conforme o Codex evolui.
| Comando | Maturidade | Uso |
|---|---|---|
codex | Stable | Inicia a UI interativa de terminal. |
codex app | Stable | Abre o aplicativo desktop do Codex. |
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 | Executa o Codex em modo não interativo. |
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 | Autentica o Codex. |
codex logout | Stable | Remove credenciais armazenadas. |
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. |
codexStableInicia a UI interativa de terminal.
codex appStableAbre o aplicativo desktop do Codex.
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 execStableExecuta o Codex em modo não interativo.
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 loginStableAutentica o Codex.
codex logoutStableRemove credenciais armazenadas.
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.
Subcomandos
Matriz de comandos por fluxo
Agrupado por workflow para manter a página fácil de escanear sem perder a cobertura documentada.
| Sintaxe | Tipo / Valores | Uso |
|---|---|---|
codex | - | Inicia a UI interativa de terminal. |
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. |
codexUso
Inicia a UI interativa de terminal.
codex "PROMPT"Uso
Start the TUI with an initial instruction.
codex --image pathTipo / Valores
path[,path...]Uso
Start with one or more image attachments.
codex --remote ENDPOINTTipo / Valores
ws://, wss://, unix://Uso
Connect the TUI to a remote app-server.
codex appUso
Open the desktop app.
codex app PATHTipo / Valores
pathUso
Open a workspace path in Codex Desktop.
codex app --download-url URLTipo / Valores
urlUso
Override the desktop installer download URL.
codex app-serverUso
Start the local app server.
codex app-server --listen VALUETipo / Valores
stdio:// | ws://IP:PORT | unix:// | unix://PATH | offUso
Set the transport listener.
codex app-server --stdioTipo / Valores
booleanUso
Use stdio transport.
codex app-server --analytics-default-enabledTipo / Valores
booleanUso
Default analytics to enabled for app-server clients.
codex app-server --ws-auth MODETipo / Valores
capability-token | signed-bearer-tokenUso
Choose WebSocket authentication mode.
codex app-server --ws-audience VALUETipo / Valores
stringUso
Expected JWT audience.
codex app-server --ws-issuer VALUETipo / Valores
stringUso
Expected JWT issuer.
codex app-server --ws-max-clock-skew-seconds NTipo / Valores
numberUso
Allow clock skew for token time checks.
codex app-server --ws-shared-secret-file PATHTipo / Valores
absolute pathUso
HMAC secret file for signed bearer tokens.
codex app-server --ws-token-file PATHTipo / Valores
absolute pathUso
Capability token file.
codex app-server --ws-token-sha256 HEXTipo / Valores
hex SHA-256Uso
Expected SHA-256 digest for a token.
codex remote-controlUso
Ensure the local app-server daemon is running with remote-control enabled.
| Sintaxe | Tipo / Valores | Uso |
|---|---|---|
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_IDTipo / Valores
stringUso
Apply a Codex Cloud task diff locally.
codex a TASK_IDTipo / Valores
stringUso
Alias for codex apply.
codex archive SESSIONTipo / Valores
session ID | session nameUso
Archive a saved session by ID or name.
codex unarchive SESSIONTipo / Valores
session ID | session nameUso
Restore an archived session by ID or name.
codex archive --remote ENDPOINT SESSIONTipo / Valores
endpointUso
Connect to remote app-server before changing archive state.
codex cloudUso
Browse or run Cloud tasks from the terminal.
codex cloud exec QUERYTipo / Valores
stringUso
Submit a Cloud task directly.
codex cloud exec --attempts NTipo / Valores
1-4Uso
Set the number of assistant attempts.
codex cloud exec --env ENV_IDTipo / Valores
ENV_IDUso
Target a Codex Cloud environment.
codex cloud listUso
List recent Cloud tasks.
codex cloud list --cursor VALUETipo / Valores
stringUso
Use a pagination cursor.
codex cloud list --env ENV_IDTipo / Valores
ENV_IDUso
Filter by environment.
codex cloud list --jsonTipo / Valores
booleanUso
Emit JSON output.
codex cloud list --limit NTipo / Valores
1-20Uso
Limit the number of tasks returned.
codex cloud-tasksUso
Alias for codex cloud.
codex resumeUso
Resume an interactive session.
codex resume SESSION_IDTipo / Valores
uuidUso
Resume a specific interactive session.
codex resume --allTipo / Valores
booleanUso
Show sessions outside the current directory.
codex resume --lastTipo / Valores
booleanUso
Resume the most recent session.
codex forkUso
Fork a previous session into a new thread.
codex fork SESSION_IDTipo / Valores
uuidUso
Fork a specific session.
codex fork --allTipo / Valores
booleanUso
Show sessions outside the current directory.
codex fork --lastTipo / Valores
booleanUso
Fork the most recent session.
Modo não interativo
Opções de codex exec
Use estas flags quando o Codex for iniciado como comando pontual no terminal, script ou automação.
| Opção | Tipo / Valores | Uso |
|---|---|---|
--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, -CTipo / Valores
pathUso
Set the workspace root.
--colorTipo / Valores
always | never | autoUso
Control ANSI color output.
--dangerously-bypass-approvals-and-sandboxTipo / Valores
booleanUso
Disable approvals and sandboxing.
--yoloTipo / Valores
booleanUso
Alias for dangerous bypass mode.
--dangerously-bypass-hook-trustTipo / Valores
booleanUso
Run hooks without persisted trust.
--ephemeralTipo / Valores
booleanUso
Do not persist session rollout files.
--full-autoTipo / Valores
booleanUso
Deprecated compatibility option.
--ignore-rulesTipo / Valores
booleanUso
Do not load execpolicy rule files.
--ignore-user-configTipo / Valores
booleanUso
Do not load user config.
--image, -iTipo / Valores
path[,path...]Uso
Attach images to the first message.
--jsonTipo / Valores
booleanUso
Emit NDJSON events.
--experimental-jsonTipo / Valores
booleanUso
Older alias for JSON event output.
--model, -mTipo / Valores
stringUso
Override the model.
--ossTipo / Valores
booleanUso
Use a local OSS model provider.
--output-last-message, -oTipo / Valores
pathUso
Write the final assistant message to a file.
--output-schemaTipo / Valores
pathUso
Validate the final output against a JSON Schema.
--profile, -pTipo / Valores
stringUso
Load a config profile.
--sandbox, -sTipo / Valores
read-only | workspace-write | danger-full-accessUso
Choose the sandbox policy.
--skip-git-repo-checkTipo / Valores
booleanUso
Allow running outside a Git repository.
--config, -cTipo / Valores
key=valueUso
Override config inline.
PROMPTTipo / Valores
string | -Uso
Initial instruction. Use - to read from stdin.
TUI interativa
Slash commands integrados
Digite / no composer do Codex para abrir o popup de slash commands.
| Slash command | Uso |
|---|---|
/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.
Formas comuns
/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.
Extensões locais
Os slash commands integrados são finitos, mas skills, plugins, MCP servers e arquivos /prompts:* obsoletos podem adicionar capacidades locais.
Fontes
Documentação oficial
Nomes de comandos, flags, maturidade e cobertura de slash commands seguem as páginas oficiais do OpenAI Codex CLI.
Nota de leitura
Esta página é uma referência rápida, não uma reprodução completa da documentação oficial.