Snelle referentie

OpenAI Codex CLI Commando's & Configuratie Spiekbrief

Een compacte referentiegids voor OpenAI's terminal-codeeragent Codex CLI: installatie, authenticatie, CLI-subcommando's en vlaggen, sandbox- en goedkeuringsbeleid, TUI slash-commando's, sneltoetsen, config.toml en AGENTS.md.

· Gepubliceerd

OpenAI Codex CLI is OpenAI's terminal-native codeeragent die codebases inspecteert, bestanden bewerkt, tests uitvoert, integreert met externe Codex Cloud-taken en rechtstreeks vanaf uw opdrachtregel via MCP verbinding maakt met externe tools.

Deze spiekbrief behandelt Codex CLI-subcommando's en vlaggen, sandbox- en goedkeuringsbeleid, interactieve TUI slash-commando's, sneltoetsen en configuratie via config.toml / AGENTS.md.

🔗 Gerelateerde spiekbrieven: Vergelijking van Terminal AI-codeer-CLI's · Claude Code CLI Spiekbrief · Antigravity CLI (agy) Spiekbrief · AI Agent Harness Engineering


1. Installatie, Authenticatie & Kern-CLI-commando's

1.1 Installatie & Authenticatie

Actie Commando Opmerkingen
Globale npm-installatie npm install -g @openai/codex Standaard cross-platform installatie
Officieel installatiescript curl -fsSL https://chatgpt.com/codex/install.sh | sh Eenregelig installatiescript voor macOS / Linux
Browser-login codex login Authenticeren met ChatGPT Plus / Pro / Team-account
API-sleutelauthenticatie export OPENAI_API_KEY="sk-..." Ideaal voor headless CI- of containeromgevingen

1.2 CLI-subcommando's & Globale Vlaggen

Commando / Vlag Beschrijving Gebruiksvoorbeeld
codex Start de interactieve TUI in de huidige map codex
codex "prompt" Start een interactieve sessie met een initiële prompt codex "Debug 500 timeout errors on login"
codex exec / codex e Niet-interactieve (headless) uitvoering voor scripts en CI codex exec "Run all unit tests and fix failures"
codex exec --json Streamt gestructureerde JSON-logs van redeneringen en bestandsbewerkingen codex exec --json "Refactor utils" > run.jsonl
codex review Niet-interactieve code review op de huidige Git-diff codex review
codex resume Opent sessiekiezer (opgeslagen in ~/.codex/sessions/) codex resume / codex resume --last / codex resume <id>
codex apply / codex a Past diffs van Codex Cloud-taken toe op uw lokale werkruimte codex apply <task_id>
codex cloud Inspecteer of beheer externe Codex Cloud-taken codex cloud
codex mcp Beheer Model Context Protocol (MCP)-serverintegraties codex mcp list / codex mcp add <name> ...
-m, --model <name> Specificeer het onderliggende model voor de sessie of uitvoering codex -m gpt-6.1-sol
--strict-config Valideer streng de syntaxis en sleutels van config.toml codex --strict-config

2. Matrix voor Sandbox & Goedkeuringsbeleid

Codex CLI scheidt rechten in twee orthogonale lagen: wat de omgeving mag aanpassen (--sandbox) en wanneer de gebruiker om bevestiging moet worden gevraagd (--ask-for-approval).

Vlag Geldige waarden Gedrag & Aanbevolen Gebruik
--sandbox <mode>
(alias -s)
read-only Alleen-lezen: code inspecteren en doorzoeken zonder bestanden te wijzigen
workspace-write Schrijven in werkruimte (Aanbevolen standaard): bewerkingen alleen toestaan binnen de werkboom
danger-full-access Onbeperkte toegang: volledige toegang tot bestandssysteem/systeem (alleen in geïsoleerde containers)
--ask-for-approval <policy> on-request Aanbevolen standaard: model vraagt bevestiging wanneer risicovolle acties dat vereisen
on-failure Escaleer alleen bij fouten (gebruik on-request als prompts voor sandbox-verhoging belangrijk zijn)
never Volledig stil: nooit interactief vragen (voor CI / geautomatiseerde pipelines)

⚠️ Melding verouderde & uitgefaseerde vlaggen:

  • --full-auto is verouderd (deprecated) vanaf v0.128.0. Specificeer sandbox- en goedkeuringsbeleid expliciet: codex --sandbox workspace-write --ask-for-approval on-request "Fix failing tests"
  • Het goedkeuringsbeleid untrusted is uitgefaseerd (retired) in v0.149.0; migreer configuraties naar on-request.

3. Interactieve TUI Slash-commando's

Typ / in de interactieve codex TUI-prompt om context, rechten en workflows te beheren:

3.1 Context, Modellen & Rechten

Commando Functie Opmerkingen & Gebruik
/init Genereer een starter-AGENTS.md afgestemd op de repository Aanbevolen eerste stap in een nieuw project
/status Inspecteer actief model, rechten en tokenverbruik Monitor de resterende contextcapaciteit
/model Wissel interactief van model en Reasoning Effort-niveau Pas redeneerdiepte aan zonder opnieuw op te starten
/permissions Pas sandboxmodus en goedkeuringsbeleid tijdens de sessie aan Rechten naar wens aanscherpen of versoepelen
/mcp Inspecteer en beheer verbonden MCP-servers Controleer connectiviteit met externe tools en databases

3.2 Engineering-workflows & Sessiebeheer

Commando Functie Opmerkingen & Gebruik
/plan Stel een implementatieplan op en beoordeel het vóór het bewerken van bestanden Stem architectuur af vóór grootschalige refactorings
/review Voer een multi-perspectief code review uit op niet-gecommitte wijzigingen Opsporen van bugs, randgevallen en beveiligingsrisico's
/diff Inspecteer huidige nog niet gecommitte bestandswijzigingen Controleer diffs regel voor regel vóór acceptatie
/fork Splits de gespreksthread af in een apart controlepunt Verken een alternatieve aanpak zonder de hoofdcontext te vervuilen
/compact Vat gespreksgeschiedenis samen om contextruimte vrij te maken Voorkom afdrijving in lange multi-turn sessies
/copy Kopieer het laatst voltooide antwoord naar het klembord Haal snel patches of samenvattingen op
/title Hernoem de huidige gespreksthread Maakt sessies makkelijk terugvindbaar via codex resume
/statusline / /theme Pas onderdelen van de voettekststatus of het TUI-kleurthema aan Stem de terminalweergave af op uw voorkeur
/prompts:<name> Roep een aangepast Markdown-promptsjabloon aan Voert ~/.codex/prompts/<name>.md uit

4. Terminal-sneltoetsen & Invoersyntaxis

Sneltoets / Syntaxis Actie Effect & Scenario
@<path> Fuzzy bestandsverwijzing Voeg bestandsinhoud inline in (bijv. @src/auth.ts)
!<command> Inline lokaal shell-commando Voer shell-commando's uit binnen actieve sandboxregels (bijv. !npm test)
Tab Volgende prompt in wachtrij plaatsen Zet een vervolgprompt, slash-commando of !-commando klaar terwijl Codex werkt
Enter Onderbreken / bijsturen tijdens uitvoering Geef aanvullende instructies terwijl de agent actief reageert
Ctrl + G Externe editor openen Schrijf meerregelige prompts in $VISUAL / $EDITOR (Vim, VS Code, enz.)
Ctrl + R Promptgeschiedenis doorzoeken Achterwaarts zoeken door eerder verzonden prompts
Ctrl + L Scherm wissen & opnieuw tekenen Terminal opruimen met behoud van de gespreksstatus
Ctrl + O Laatste uitvoer kopiëren Equivalent aan /copy
Ctrl + X Toetsenbordmenu openen Toegang tot toetsenbordpresets en extensies
Ctrl + C Annuleren / Afsluiten Breek de actieve taak af of sluit de Codex-sessie

5. Configuratiebestanden & Geheugenhiërarchie (config.toml & AGENTS.md)

Instellingen op projectniveau overschrijven wereldwijde gebruikersstandaarden:

Laag Wereldwijd bereik (alle repo's) Projectbereik (huidige repo) Doel
Kernconfiguratie ~/.codex/config.toml .codex/config.toml Standaardmodel, sandbox, goedkeuringsbeleid, netwerkschakelaar, MCP
Agent-instructies ~/.codex/AGENTS.md ./AGENTS.md (repo-root) Build-/testcommando's, codeerstandaarden, architectuurregels
Aangepaste prompts ~/.codex/prompts/*.md — Herbruikbare /prompts:<name> slash-commandosjablonen
Sessielogs ~/.codex/sessions/ — Blijvende logs hersteld door codex resume

Minimale aanbevolen ~/.codex/config.toml

# Standaardmodel
model = "gpt-6.1-sol"

# Standaard sandbox- en goedkeuringsbeleid
sandbox_mode = "workspace-write"
approval_policy = "on-request"

# Beperk uitgaande netwerktoegang binnen de sandbox standaard
network_access = false

Verwante onderwerpen