Codex CLI Prompting-Tipps
Effektive Prompting-Techniken zu beherrschen ist der Schlüssel, um das Beste aus Codex CLI herauszuholen. Dieser Abschnitt beschreibt detailliert, wie man effiziente Prompts schreibt, um die besten Ergebnisse zu erzielen.
Prompt-Grundlagen
Du interagierst mit Codex, indem du Prompts sendest, die die Aufgabe beschreiben, die es erledigen soll.
Grundlegende Beispiele
Grundlegender Prompt
"Erkläre, wie das transform-Modul funktioniert und wie andere Module es verwenden."
# Eine neue Funktion hinzufügen
"Füge eine neue Befehlszeilenoption `--json` hinzu, die JSON ausgibt."
# Einen Fehler beheben
"Behebe den Fehler in der Login-Funktion"
Wie Prompts funktionieren
Wenn du einen Prompt absendest, arbeitet Codex in der folgenden Schleife:
- Rufe das Sprachmodell auf
- Führe die vom Modell angegebenen Vorgänge aus (Dateien lesen, Dateien bearbeiten, Tools ausführen usw.)
- Wiederhole, bis die Aufgabe abgeschlossen ist oder du abbrichst
Das Verständnis dieser Schleife hilft dir, bessere Prompts zu entwerfen, weil Codex bei jedem Schritt Entscheidungen auf Basis des Kontexts trifft.
Tipps zum Schreiben effektiver Prompts
Tipp 1: Verifizierungsschritte einbeziehen
Codex erzeugt qualitativ hochwertigere Ausgaben, wenn es seine Arbeit überprüfen kann. Das Einbeziehen von Verifizierungsschritten hilft Code, die Korrektheit sicherzustellen:
Prompt mit Verifizierung
"Schreibe eine Funktion zum Sortieren einer Liste"
# Empfohlen - Verifizierung einbeziehen
"Schreibe eine Funktion zum Sortieren einer Liste. Füge Testfälle hinzu, um zu überprüfen, ob sie leere Listen, bereits sortierte Listen, umgekehrt sortierte Listen und Listen mit Duplikaten verarbeitet. Führe die Tests aus, um zu bestätigen, dass sie bestehen."
Tipp 2: Komplexe Aufgaben in kleine Schritte zerlegen
Codex erzielt bessere Ergebnisse bei kleineren, fokussierten Aufgaben. Kleine Aufgaben sind einfacher zu testen und zu überprüfen:
Aufgaben aufteilen
"Erstellen Sie ein vollständiges Benutzerauthentifizierungssystem mit Login, Registrierung, Passwort-Reset und OAuth"
# Empfohlen - in kleine Schritte aufteilen
"Schritt 1: Erstellen Sie ein Benutzermodell mit E-Mail- und Passwortfeldern
Schritt 2: Fügen Sie einen Registrierungs-Endpunkt hinzu
Schritt 3: Fügen Sie einen Login-Endpunkt mit JWT hinzu
Schritt 4: Fügen Sie eine Passwort-Reset-Funktionalität hinzu
Lassen Sie mich wissen, wenn Schritt 1 erledigt ist, bevor Sie mit Schritt 2 fortfahren"
Tipp 3: Kontext bereitstellen
Stelle Kontext bereit, den Codex verwenden kann, z. B. Verweise auf relevante Dateien und Bilder:
Kontext bereitstellen
"Behebe diesen Fehler"
# Empfohlen - detaillierte Informationen angeben
"Behebe den Fehler in src/auth.py, bei dem Benutzer sich nicht mit Sonderzeichen in ihrem Passwort anmelden können. Ich habe einen Screenshot der Fehlermeldung und den relevanten Codeabschnitt angehängt."
Tipp 4: Das Ausgabeformat angeben
Sage Codex, welches Ausgabeformat du erwartest:
Das Ausgabeformat angeben
"Schreibe eine Funktion zur Berechnung von Fibonacci-Zahlen. Verwende TypeScript, füge JSDoc-Kommentare hinzu und befolge Prinzipien der funktionalen Programmierung."
# Ausgabestruktur angeben
"Erkläre die Struktur der Codebasis. Gliedere deine Antwort mit: 1) Überblick 2) Wichtige Verzeichnisse 3) Haupt-Einstiegspunkte"
Spezifischere Prompts führen in der Regel zu Ergebnissen. Codex ist gut darin, die Absicht zu verstehen, aber je mehr Informationen du bereitstellst, desto besser ist seine Leistung.
Threads
Ein Thread ist eine einzelne Konversation: deine Prompts plus anschließende Modellausgaben und Tool-Aufrufe. Ein Thread kann mehrere Prompts enthalten.
Lokale Threads vs. Cloud-Threads
| Type | Übersicht | Vorteile |
|---|---|---|
| Lokale Threads | Auf deinem Rechner ausführen | Kann Dateien lesen und schreiben, vorhandene Tools verwenden |
| Cloud-Threads | In einer isolierten Umgebung ausführen | Parallel ausführen, Aufgaben von anderen Geräten delegieren |
Unterhaltungen fortsetzen
Eine frühere Unterhaltung fortsetzen
codex resume
# Direkt zur neuesten Sitzung springen
codex resume --last
# Eine bestimmte Sitzung fortsetzen
codex resume <SESSION_ID>
Konversationsverwaltung
Laufende Threads können parallel ausgeführt werden, aber vermeiden Sie, dass zwei Threads gleichzeitig dieselbe Datei ändern. Sie können einen Thread auch später fortsetzen, indem Sie mit einem weiteren Prompt fortfahren.
Kontextverwaltung
Wenn Sie einen Prompt absenden, geben Sie Kontext an, den Codex verwenden kann, z. B. Verweise auf relevante Dateien und Bilder. Die IDE-Erweiterung fügt automatisch die Liste der geöffneten Dateien und den ausgewählten Textbereich als Kontext hinzu.
Kontextfenster
Alle Informationen in einem Thread müssen in das Kontextfenster des Modells passen. Codex überwacht und meldet den verbleibenden Platz.
Automatische Komprimierung
Bei längeren Aufgaben kann Codex den Kontext automatisch komprimieren, indem es relevante Informationen zusammenfasst und weniger relevante Details verwirft. Codex kann komplexe Aufgaben über mehrere Schritte hinweg weiter bearbeiten.
Manuelles Verwalten des Kontexts
Sie können Codex auf folgende Weise beim Verwalten des Kontexts helfen:
- Konzentrieren Sie sich auf die aktuelle Aufgabe
- Vermeiden Sie es, mehrere unabhängige Aufgaben in einem einzigen Prompt zu vermischen
- Starten Sie regelmäßig eine neue Sitzung (mit
/new)
Wenn Codex eine hohe Kontextnutzung meldet, sollten Sie erwägen, eine neue Sitzung zu starten oder frühere Nachrichten zu reduzieren.
Fortgeschrittene Prompting-Tipps
Planmodus verwenden
Verwenden Sie bei komplexen Aufgaben den Planmodus, damit Codex vor der Ausführung plant:
Planmodus
/plan Benutzerauthentifizierungssystem implementieren
# Oder "plan" in den Prompt aufnehmen
"Plane und implementiere eine REST-API mit CRUD-Operationen für einen Blog"
Review-Modus verwenden
Bitten Sie Codex, den Code zu überprüfen, anstatt ihn direkt zu ändern:
Review-Modus
/review src/auth.py
# Oder beschreiben Sie die Review-Anforderung
"Überprüfen Sie diesen Code auf potenzielle Sicherheitslücken und schlagen Sie Verbesserungen vor"
Begrenzung des Umfangs der Änderungen
Sagen Sie Codex klar, was es ändern darf:
Begrenzung des Umfangs der Änderungen
"Erklären Sie, was diese Funktion macht, nehmen Sie keine Änderungen vor"
# Dateibereich einschränken
"Logging nur zum Auth-Modul hinzufügen, andere Dateien nicht anfassen"
# Schrittweise Bestätigung
"Teile mir die vorgeschlagenen Änderungen mit, bevor du sie vornimmst"
Prompt-Vorlagen
Hier sind einige gängige Prompt-Vorlagen:
Codegenerierung
Write a [语言] function that [功能描述]. Requirements: - [需求1] - [需求2] Include: - 详细的文档注释 - 错误处理 - 测试用例
Code-Review
Review the [文件/模块] for: - Potential bugs - Security issues - Performance problems - Code style violations Provide: - Issue list with severity - Suggested fixes - Overall quality score (1-10)
Fehlerbehebung
Fix the bug in [文件:行号/函数名]. Error: [错误信息] Expected behavior: [期望行为] Steps to reproduce: [复现步骤]
Refactoring
Refactor [文件/函数] to [目标]. Current issues: - [问题1] - [问题2] Constraints: - 保持功能不变 - 不要改变 API 接口 - 添加单元测试
Übung macht den Meister. Übe das Schreiben von Prompts oft, und du wirst nach und nach lernen, wie du die besten Ergebnisse erzielst.
FAQ
F: Was ist, wenn Codex meinen Prompt nicht versteht?
Versuche: 1) Beschreibe genauer 2) Gib mehr Kontext an 3) Zerlege es in kleinere Schritte 4) Verwende Beispiele, um die erwartete Ausgabe zu veranschaulichen
F: Sollten Prompts auf Englisch oder Chinesisch sein?
Codex unterstützt mehrere Sprachen, aber Englisch funktioniert normalerweise am besten. Wenn du auf Chinesisch beschreibst, achte darauf, dass die Beschreibung ausreichend detailliert und klar ist.
F: Wie kann ich Codex dazu bringen, Code nur zu analysieren, ohne ihn zu verändern?
Sag ihm eindeutig "read-only" oder "nimm keine Änderungen vor", dann liefert es nur eine Analyse, ohne etwas zu verändern.
F: Was ist, wenn das Kontextfenster voll ist?
Starte eine neue Sitzung (mit /new) oder lass Codex den Verlauf komprimieren (es erledigt das automatisch).
Weitere Erweiterungen