OpenAI Codex CLI: Ein Terminal-Kommandozeilen-Assistent für KI-Programmierung von OpenAI veröffentlicht

Allgemeine Einführung

OpenAI Codex CLI ist ein Open-Source-Terminal-Codierungstool, das von OpenAI für Entwickler entwickelt wurde, die an Terminals gewöhnt sind. Codex CLI verwendet die neuesten Modelle von OpenAI (wie o3 und o4-mini), unterstützt mehrsprachige Programmierung und bietet eine sichere Sandbox-Umgebung, die den Netzwerkzugriff und die Manipulation von Verzeichnissen einschränkt, um die Sicherheit zu gewährleisten. Das Projekt ist vollständig quelloffen, fördert Beiträge der Gemeinschaft und eignet sich für die schnelle Entwicklung, die Automatisierung von Aufgaben und das Erlernen von Programmen.

Funktionsliste

• Codegenerierung: Generierung von Python-, JavaScript- und anderem mehrsprachigem Code auf der Grundlage natürlicher Sprache.
• Dateioperationen: Erstellen und Bearbeiten von Dateien, Unterstützung von Git Commits und Versionierung.
• Befehlsausführung: Führen Sie Code oder Befehle in der Sandbox aus und zeigen Sie die Ergebnisse in Echtzeit an.
• Multimodale Eingabe: Unterstützung von Bildschirmfotos und Diagrammen zur Generierung des entsprechenden Codes.
• Sicherheits-Sandbox: Deaktivieren Sie das Netzwerk standardmäßig und betreiben Sie zur Sicherheit nur das aktuelle Verzeichnis.
• Automatisierte Genehmigung: Bietet drei Modi: manuelle, automatische Bearbeitung und vollautomatische Genehmigung.
• Open-Source-Entwicklung: Benutzer können den Code einsehen und PR-Beiträge einreichen.
• Projektdokumentation: Unterstützung für globale und projektbezogene Markdown-Befehle, benutzerdefiniertes Verhalten.

Hilfe verwenden

Einbauverfahren

Um die Codex-CLI zu verwenden, führen Sie die folgenden Installationsschritte durch:

1. Systemanforderungen::
   • OS: macOS 12+, Ubuntu 20.04+/Debian 10+, oder Windows 11 (über WSL2).
   • Node.js: Version >= 22 (LTS-Version empfohlen).
   • Git: Version >= 2.23 (empfohlen, für Versionskontrolle).
   • RAM: Mindestens 4 GB, 8 GB empfohlen.
   • OpenAI API-Schlüssel: Holen Sie ihn sich von der OpenAI-Website.
2. Installationsschritte::
   • Global über npm installieren (empfohlen):

     npm install -g @openai/codex
     

   • oder aus dem Quellcode erstellen:

     git clone https://github.com/openai/codex.git
     cd codex/codex-cli
     npm install
     npm run build
     

   • Legen Sie den API-Schlüssel fest:

     export OPENAI_API_KEY="your-api-key-here"
     

     Für eine dauerhafte Einstellung fügen Sie sie der Shell-Konfigurationsdatei hinzu (z. B. ~/.zshrc vielleicht ~/.bashrc):

     echo 'export OPENAI_API_KEY="your-api-key-here"' >> ~/.zshrc
     source ~/.zshrc
     

   • Überprüfen Sie die Installation:

     codex --help
     

     Wenn die Hilfemeldung angezeigt wird, war die Installation erfolgreich.

3. Linux-Docker-Konfiguration::
   • Docker wird für eine verbesserte Sicherheit empfohlen:

     ./run_in_container.sh
     

   • Stellen Sie sicher, dass Docker installiert ist. Das Skript wird automatisch das aktuelle Verzeichnis mounten und die Firewall so konfigurieren, dass nur der Zugriff auf die OpenAI API erlaubt ist.
4. caveat::
   • Nicht verwenden sudo npm install -gsollte die npm-Berechtigungen korrigieren:

     sudo chown -R $(whoami) ~/.npm
     

   • Stellen Sie sicher, dass der API-Schlüssel gültig ist, um zu vermeiden, dass 401 vielleicht 429 Fehler.

Verwendung

Codex CLI bietet eine effiziente Codierungserfahrung durch die Kombination von natürlicher Sprache und Sandbox-Umgebung durch Terminal-Befehlsoperationen. Im Folgenden wird beschrieben, wie die wichtigsten Funktionen verwendet werden:

1. die Code-Erstellung

• Arbeitsablauf::
  • Interaktionsmuster:

    codex
    

    Geben Sie eine Aufforderung wie "Erstellen Sie eine Python-Funktion zur Berechnung einer Fibonacci-Reihe" ein.

  • Ein-Befehl-Modus:

    codex "生成 JavaScript 过滤数组函数"
    

  • Codex CLI generiert Code und zeigt eine Vorschau an.
  • Einfuhr y Akzeptieren und speichern, eingeben n Ablehnung.
• Erweiterte Optionen::
  • Geben Sie das Modell an:

    codex --model o4-mini "生成 Go HTTP 服务器"
    

  • Nicht interaktiver Modus:

    codex -q "生成 SQL 查询" > output.sql
    

• Ausgewählte Funktionen::
  • Unterstützung für Python, JavaScript, TypeScript, Go, SQL und mehr.
  • Kann komplexe Aufgaben wie "Erzeugen einer Flask-Anwendung mit Benutzerauthentifizierung" bewältigen.

2. die Bearbeitung von Dateien und die Integration von Git

• Arbeitsablauf::
  • Datei bearbeiten:

    codex "在 src/app.js 中添加登录功能"
    

  • Der Codex CLI zeigt die Codeunterschiede an, bestätigt sie und speichert sie.
  • Commit zu Git:

    codex "提交更改，消息为 '添加登录功能'"
    

• Ausgewählte Funktionen::
  • Automatischer Umgang mit Git-Befehlen (addundcommit).
  • Unterstützt Batch-Operationen wie z.B.:

    codex "重命名所有 *.jpeg 为 *.jpg 并更新引用"
    

  • Es sind drei Genehmigungsmodi vorgesehen:
    • suggestStandard: Alle Änderungen müssen manuell bestätigt werden.
    • auto-editAutomatisches Anwenden von Dateiänderungen, Befehle müssen bestätigt werden.
    • full-auto: Vollautomatisch und mit Vorsicht zu verwenden:

      codex --approval-mode full-auto "更新 README"
      

3. die Ausführung des Codes

• Arbeitsablauf::
  • Führen Sie den Code aus:

    codex "运行 src/main.py"
    

  • Die Codex-CLI wird in der Sandbox ausgeführt und zeigt die Ergebnisse an.
  • Wenn eine Abhängigkeit fehlt, werden Sie aufgefordert, sie zu installieren:

    codex "安装 numpy 并运行 script.py"
    

• Ausgewählte Funktionen::
  • macOS verwendet die Apple Seatbelt Sandbox und Linux verwendet Docker.
  • Netzwerke sind standardmäßig deaktiviert, um einen versehentlichen Zugriff zu verhindern.
  • Unterstützt Debugging-Ausgaben zur Anzeige von Fehlerdetails.

4. multimodale Eingaben

• Arbeitsablauf::
  • Geben Sie den Pfad zum Bild ein:

    codex "根据 ui.png 实现界面代码"
    

  • Codex CLI analysiert Bilder, um HTML/CSS oder Front-End-Code zu erzeugen.
• Ausgewählte Funktionen::
  • Unterstützung für die Umwandlung von UI-Design in Code.
  • Diagramme oder Flussdiagramme können verarbeitet werden, um Logikcode zu erzeugen.

5. die Konfiguration und Anpassung

• Konfigurationsdatei::
  • Globale Konfiguration:~/.codex/config.yaml::

    model: o4-mini
    fullAutoErrorMode: ask-user
    

  • Anleitungsdatei:~/.codex/instructions.md::

    - 使用 Python 3.9
    - 禁止自动提交 Git
    

  • Konfiguration auf Projektebene: die codex.md::

    - 优先使用 TypeScript
    - 运行测试前执行 npm run lint
    

• Projektdokumentation deaktivieren::

  codex --no-project-doc

• Umschaltung des Genehmigungsmodus::

  codex --approval-mode auto-edit
  

6. die CI/CD-Integration

• Arbeitsablauf::
  • Führen Sie es in GitHub Actions aus:

    - name: 更新文档
    run: |
    npm install -g @openai/codex
    export OPENAI_API_KEY="${{ secrets.OPENAI_KEY }}"
    codex -a auto-edit -q "更新 CHANGELOG"
    

  • Legen Sie den Ruhemodus fest:

    export CODEX_QUIET_MODE=1
    

• Ausgewählte Funktionen::
  • Unterstützt den nicht-interaktiven Modus, geeignet für automatisierte Prozesse.
  • Gibt das JSON-Format für eine einfache Skripterstellung aus:

    codex -q --json "生成配置"
    

caveat

• Stellen Sie sicher, dass das Verzeichnis von Git verfolgt wird.full-auto Modus wird in Nicht-Git-Verzeichnissen eine Warnung ausgeben.
• Überprüfen Sie das Kontingent der API-Schlüssel, da häufige Aufrufe zu Einschränkungen führen können.
• Das Projekt ist experimentell und kann instabile Funktionen haben, daher empfehlen wir, GitHub für Updates zu folgen.

Anwendungsszenario

1. Schnelles Prototyping
   Entwickler können schnell Code-Frameworks in natürlicher Sprache erstellen. Geben Sie z. B. ein: "Erstellen Sie eine Express-Anwendung mit einer Datenbank", und die Codex-CLI generiert Routen, Modelle und Konfigurationsdateien, die sich zur Validierung von Ideen eignen.
2. Automatisierte Aufgaben
   Codex CLI vereinfacht sich wiederholende Aufgaben wie "Copyright-Hinweise in allen Dateien aktualisieren und einreichen". Es bearbeitet automatisch Dateien, führt Skripte aus und überträgt sie für Batch-Operationen an Git.
3. Programmieren Lernen
   Anfänger können "Quick Sort in Python" eingeben, Codex CLI generiert den Code und erklärt die Logik, geeignet zum Selbststudium oder für den Unterricht.
4. Open-Source-Zusammenarbeit
   Entwickler können sich über GitHub an der Entwicklung von Codex CLI beteiligen, Fehlerbehebungen oder neue Funktionen einreichen, und die transparente Codebasis erleichtert die Zusammenarbeit.
5. CI/CD-Pipeline
   In CI-Umgebungen aktualisiert Codex CLI automatisch die Dokumentation, generiert Testfälle oder behebt Lint-Fehler und verbessert so die Entwicklungseffizienz.

QA

1. Wie unterscheidet sich der Codex CLI vom Codex-Modell 2021?
   Das Codex CLI ist ein leistungsfähigeres und quelloffenes Endpunkt-Tool, das auf den neuesten OpenAI-Modellen (o3, o4-mini) basiert, unabhängig von den Codex-Modellen, die 2021 eingestellt werden.
2. Wie kann ich einen sicheren Betrieb gewährleisten?
   Die Codex CLI läuft standardmäßig in einer Sandbox, verwendet Apple Seatbelt für macOS und Docker für Linux, deaktiviert Netzwerke und schränkt den Verzeichniszugriff ein, um Systemrisiken zu vermeiden.
3. Welche Programmiersprachen werden unterstützt?
   Python, JavaScript, TypeScript, Go, SQL usw. werden je nach dem verwendeten OpenAI-Modell unterstützt, und die Sprache kann über einen Befehl angegeben werden.
4. Ist der Codex CLI kostenlos?
   Die Codex-CLI selbst ist kostenlos, erfordert jedoch einen OpenAI-API-Schlüssel und es können Kosten für API-Aufrufe anfallen; Einzelheiten finden Sie unter OpenAI-Preise.
5. Wie kann ich verhindern, dass Codex CLI Dateien verändert?
   ausnutzen suggest Modus, müssen alle Änderungen manuell bestätigt werden:

   codex --approval-mode suggest