Referência do OpenAI Codex CLI

Do zero ao produtivo no Codex, em cinco níveis.

Uma folha de consulta única para o Codex CLI da OpenAI: instalação, comandos do dia a dia, configuração, MCP, sandbox, skills e workflows de automação. Todos os comandos vêm da documentação oficial — nada inventado.

Capa do Codex Cheat Sheet
O que é

Uma página, cinco níveis, zero enrolação

O projeto é documentação: um README.md progressivo mais skills reutilizáveis em disco. Não há app para rodar — o valor está na consulta rápida.

📚 Progressivo

Do Nível 1 (instalar e autenticar) ao Nível 5 (CI/CD, migração de legado, auditoria de segurança). Você entra no nível que precisa.

🔎 Escaneável

Blocos <details> por tema e tabelas de referência: você abre só o que interessa e copia o comando.

✅ Oficial

Comandos, flags e modelos conferidos contra a documentação oficial em developers.openai.com/codex, com data de atualização.

Como funciona

A trilha dos cinco níveis

Cada nível assume o anterior. O README segue exatamente esta ordem.

1 · Começar→ 2 · Comandos→ 3 · Configuração→ 4 · Avançado→ 5 · Workflows

Níveis 1–2

Instalação, login, atalhos de teclado, slash commands, sessões (codex resume), flags úteis e a referência de subcomandos.

Nível 3

~/.codex/config.toml, escolha de modelo e esforço de raciocínio, prompts customizados em ~/.codex/prompts/ e memória via AGENTS.md.

Níveis 4–5

MCP, sandbox e políticas de aprovação, modo não interativo, skills, /goal, GitHub Actions, revisão de código e auditoria.

Pré-requisitos

O que você precisa antes de abrir a folha

Só isto: o CLI instalado e uma conta autenticada.

Codex CLI

Instale pelo instalador oficial, npm, Homebrew ou pnpm.

# instalador oficial (macOS/Linux)
curl -fsSL https://chatgpt.com/codex/install.sh | sh

Conta

ChatGPT (recomendado) ou chave de API, com cobrança por uso.

# login por ChatGPT
codex
# ou por chave de API
printenv OPENAI_API_KEY | codex login --with-api-key

Um repositório

O Codex trabalha no diretório atual. Rode dentro de um projeto versionado em git.

codex --version
codex login status
Guia de uso · passo a passo

Como usar esta folha de consulta

Comandos reais do README. Copie, cole, ajuste ao seu projeto.

1

Instale e faça login

Depois de instalar, abra o Codex e escolha “Sign in with ChatGPT”. Confira que as credenciais ficaram salvas.

codex                 # abre a sessão interativa
codex login status    # saída 0 = credenciais presentes
codex update          # auto-atualiza (instalações via installer)
2

Primeiros comandos

Interativo para explorar, exec para automação e scripts.

codex "explain this project"
codex exec "explain utils.ts"   # não interativo
3

Domine a navegação

Os atalhos economizam mais tempo que qualquer prompt bem escrito.

Tab        # enfileira um próximo prompt enquanto o Codex trabalha
Esc Esc    # edita a mensagem anterior (bifurca a conversa dali)
Ctrl+R     # busca no histórico de prompts
Ctrl+O     # copia a última saída completa
@          # busca fuzzy de arquivos
!comando   # roda um comando local sob o sandbox atual
4

Escolha o modelo certo

Ajuste em ~/.codex/config.toml ou por flag. Panorama de setembro de 2026.

# config.toml
model = "gpt-6-astra"          # novo carro-chefe, trabalho ponta a ponta
model = "gpt-5.6-sol"          # complexo: código, uso de computador, pesquisa
model = "gpt-5.6-terra"        # equilibrado, dia a dia
model = "gpt-5.6-luna"         # rápido e barato, tarefas leves
model_reasoning_effort = "medium"   # minimal | low | medium | high | xhigh

# ou direto na chamada
codex --model gpt-5.6-terra "your prompt"
5

Dê memória ao projeto com AGENTS.md

Um arquivo na raiz descreve stack, padrões e regras — o Codex passa a segui-los em toda sessão.

# AGENTS.md na raiz do projeto
# stack, padrões de código, como rodar os testes,
# o que nunca mexer. Este próprio repo tem um.
6

Ative skills e MCP

Skills são capacidades reutilizáveis em disco. Este repo traz quatro em skills/: form-filling, log-review, pdf-processing e project-management.

# skills/<nome>/SKILL.md — front-matter + instruções
# servidores MCP entram no config.toml
[mcp_servers.js_repl]
command = "node"
7

Rode tarefas longas com /goal

Define um objetivo persistente: o Codex repete planejar → agir → testar → revisar até bater a condição de parada. Use em branch descartável.

/goal Finish the migration and keep tests green
/goal pause     # pausa a execução
/goal clear     # limpa o objetivo se ele começar a derivar
8

Automatize

Nível 5: pipe de git para o Codex, geração de PR, release notes e integração com GitHub Actions.

git diff | codex exec "Create a detailed PR description"
codex exec "Create release notes from recent commits"
Exemplos

O que dá pra tirar da folha

Três usos típicos, direto das seções do README.

🧭 Onboarding

Alguém novo no Codex vai do Nível 1 ao 2 em minutos: instala, autentica e já usa slash commands e sessões.

🛠️ Config sob medida

Nível 3 resolve “qual modelo uso?” e “onde configuro isso?” sem abrir cinco páginas de doc.

🤖 Gestão de projeto

A seção de project management usa o Codex para quebrar features, gerar backlog de sprint e virar TODOs em issues.

Roadmap

Como o repo evolui

Documentação viva: cada mudança do Codex vira commit aqui.

Feito
A folha em cinco níveisREADME completo, tabela de slash commands, referência de subcomandos e flags.
Feito
Skills em discoQuatro SKILL.md prontos para copiar em skills/.
Contínuo
Acompanhar a doc oficialModelos, aposentadorias, auth, MCP e atalhos revisados a cada release do Codex.
CI
Portão de segurançaWorkflow security-scan.yml (Trivy) roda em cada mudança.