- Codex quickstart
- Codex config basics
- Codex custom model providers
- Codex Authentication
- Codex on Windows
Voraussetzungen
Wählen Sie einen Einrichtungsweg
Wir bieten zwei Optionen, damit Sie Codex schnell konfigurieren können.Option 1: Codex manuell konfigurieren (empfohlen)
Bearbeiten Sie die benutzerspezifische Datei
~/.codex/config.toml direkt. Dies ist der zuverlässigste Weg, insbesondere für Windows- und WSL-Benutzer.Option 2: Über ein Skript konfigurieren
Führen Sie das Einrichtungs-Skript als Abkürzung aus. Es schreibt dieselbe provider-Konfiguration und speichert den CometAPI API key für Codex.
Codex manuell konfigurieren
Codex liest persönliche Provider-Standardeinstellungen aus der benutzerspezifischen Datei~/.codex/config.toml. Konfigurieren Sie den CometAPI-Provider dort, nicht in einer Projektdatei .codex/config.toml. Codex ignoriert provider- und provider-auth-Einstellungen in Projektkonfigurationsdateien.
Die empfohlene Einrichtung verwendet einen benannten cometapi-Provider und befehlsbasierte Authentifizierung. Dadurch bleibt CometAPI vom integrierten OpenAI-Provider getrennt, erfordert keine Vererbung von Shell-Umgebungsvariablen und ersetzt ~/.codex/auth.json nicht.
- macOS / Linux / WSL
- Windows PowerShell
Speichern Sie Ihren CometAPI-API-Schlüssel in einer lokalen Schlüsseldatei:Fügen Sie diese Konfiguration zu
~/.codex/config.toml hinzu:Windows-natives Codex verwendet
$HOME\.codex, normalerweise C:\Users\<user>\.codex. WSL verwendet das ~/.codex der Linux-Distribution. Bearbeiten Sie das Verzeichnis, das der Umgebung entspricht, in der der Codex-Agent ausgeführt wird.Authentifizierung mit Umgebungsvariablen verwenden
Wenn Sie den CometAPI-API-Schlüssel lieber in einer Umgebungsvariablen speichern möchten, verwenden Sieenv_key anstelle des Blocks [model_providers.cometapi.auth].
Verwenden Sie diese Provider-Konfiguration nur, wenn COMETAPI_KEY in der Umgebung verfügbar ist, die Codex startet:
Das Setup-Skript ausführen
Das Setup-Skript ist optional. Es schreibt dieselbecometapi-Provider-Konfiguration nach ~/.codex/config.toml, speichert Ihren CometAPI-API-Schlüssel in ~/.codex/cometapi_key, erstellt vor Dateiänderungen Sicherungskopien und überprüft die Konfiguration mit codex exec, wenn die Codex CLI verfügbar ist.
Führen Sie für macOS, Linux oder WSL das interaktive Installationsprogramm aus:
Einen model ID auswählen oder ändern
Verwenden Sie einen model ID von der Seite Models. Bei der manuellen Konfiguration ändern Sie den Wert vonmodel in ~/.codex/config.toml.
Übergeben Sie für macOS, Linux oder WSL --model, wenn Sie das Setup-Skript ausführen:
-Model, wenn Sie das Setup-Skript ausführen:
Das Skript verwendet
CODEX_HOME, wenn es gesetzt ist. Andernfalls schreibt es in das ~/.codex der aktuellen Umgebung.Das Setup überprüfen
Um das Setup mit der Codex CLI zu überprüfen, führen Sie diesen schreibgeschützten Befehl aus einem beliebigen lokalen Projekt aus:PATH nicht verfügbar ist, öffnen Sie die Codex-App und senden Sie einen kurzen Prompt aus einem lokalen Projekt.
Fehlerbehebung
Codex verwendet weiterhin den standardmäßigen OpenAI-Provider
Codex verwendet weiterhin den standardmäßigen OpenAI-Provider
Bestätige, dass
model_provider = "cometapi" in der benutzerspezifischen Datei ~/.codex/config.toml steht.Der API-Schlüssel wurde geändert
Der API-Schlüssel wurde geändert
Aktualisiere
~/.codex/cometapi_key, oder führe das Setup-Skript mit dem aktualisierten Wert $COMETAPI_KEY erneut aus.Das PowerShell-Skript schlägt während der Vorabprüfungen fehl
Das PowerShell-Skript schlägt während der Vorabprüfungen fehl
Verwende die manuellen nativen PowerShell-Schritte für Windows und führe dann den Verifizierungsbefehl aus.
Das per Pipe übergebene Shell-Setup fragt nach keinem API-Schlüssel
Das per Pipe übergebene Shell-Setup fragt nach keinem API-Schlüssel
Verwende
--key "$COMETAPI_KEY", setze COMETAPI_KEY oder führe den interaktiven Befehl sh -c "$(curl ...)" aus.Die Verbindung läuft in ein Timeout oder verwendet die falsche base URL
Die Verbindung läuft in ein Timeout oder verwendet die falsche base URL
Bestätige, dass
base_url in ~/.codex/config.toml auf https://api.cometapi.com/v1 gesetzt ist.Das Modell wurde nicht gefunden
Das Modell wurde nicht gefunden
Sieh auf der Seite Models nach den verfügbaren model IDs.
Das Windows-Setup wirkt sich auf die falsche Umgebung aus
Das Windows-Setup wirkt sich auf die falsche Umgebung aus
Bearbeite
$HOME\.codex für den nativen Windows-Modus oder ~/.codex innerhalb von WSL für den WSL-Agent-Modus.Der ChatGPT-Login wurde geändert
Der ChatGPT-Login wurde geändert
Verwende
--force-auth-json oder -ForceAuthJson nicht, es sei denn, du möchtest den API-Schlüssel-Anmeldemodus verwenden.