OpenBug CLI

Was ist OpenBug CLI?

OpenBug CLI ist ein intelligentes Command-line-Tool zum Debuggen laufender Anwendungen mit KI-Unterstützung. Es kombiniert einen interaktiven Terminal-Assistenten mit einem lokalen Cluster, der Logs beim Ausführen Ihrer Services erfasst, und nutzt diese Logs sowie Ihren Codebase, um Debugging-Fragen zu beantworten.

Der Kernzweck ist, das Wechseln zwischen Laufzeitverhalten (Logs) und Quellcode zu minimieren. Statt manuell durch mehrere Terminals und Dateien zu greppen, können Sie Fragen stellen, was passiert, und die CLI korreliert relevante Logs mit lokal zugänglichem Code.

Wichtige Funktionen

• Interaktiver Terminal-KI-Assistent (debug): Starten Sie den Assistenten in einem Terminal und nutzen Sie ihn, um Fragen zu Problemen zu stellen, während Ihre Services laufen.
• Automatische Log-Erfassung und -Streaming: Wenn Sie Ihre Services mit debug <command> ausführen, streamt OpenBug Logs zum lokalen Cluster für die KI-Antworten.
• Natürliche Sprachsuche im lokalen Codebase: Der Assistent durchsucht Ihren Codebase bei Fragen wie, wo ein bestimmtes Verhalten implementiert ist.
• Multi-Service-Debugging über gemeinsamen lokalen Cluster: Führen Sie Services in separaten Terminals aus; alle verbinden sich mit demselben Cluster, damit die KI Probleme über Ihren Stack hinweg nachverfolgen kann.
• Lokaler Zugriff zuerst und selektives Daten-Sharing: Der Codebase wird lokal genutzt und nicht hochgeladen; nur spezifische Snippets, die die KI abfragt, werden an den Server gesendet, und Logs nur bei Bedarf zum Beantworten.
• Authentifizierte Anfragen mit persönlichem API-Key: Die CLI authentifiziert Anfragen mit Ihrem API-Key (wie im Setup beschrieben).

So verwenden Sie OpenBug CLI

1. Installieren Sie die CLI mit:

   npm install -g @openbug/cli
   

2. Starten Sie den KI-Assistenten in Terminal 1:

   debug
   

   Sie werden aufgefordert, sich anzumelden und einen API-Key aus der OpenBug-App einzufügen.
3. Führen Sie Ihre Services mit aktiviertem Debugging in anderen Terminals aus. Beispiele aus dem Repository:

   debug npm run dev
   debug python app.py
   debug docker-compose up
   

4. Stellen Sie Debugging-Fragen in Terminal 1, während Ihre Services laufen. Der Assistent analysiert erfasste Logs und durchsucht Ihren Codebase für gezielte Einblicke.

Falls Sie ohne Setup testen möchten, bietet das Projekt ein interaktives Demo, das das Debuggen dreier realistischer Bugs durchgeht.

Anwendungsfälle

• Diagnose, warum ein Endpoint im lokalen Development fehlschlägt: Fragen Sie z. B. „Warum schlägt auth fehl?“, während Ihr Backend läuft; der Assistent referenziert relevante Logs und lokalisert zugehörige Validierungslogik.
• Nachverfolgen von Problemen über mehrere Services: Führen Sie Backend und Frontend (oder mehrere Backend-Services) in separaten Terminals mit debug ... aus; die KI nutzt Logs aus mehreren Services, um zu erklären, wie ein Fehler propagiert.
• Finden von Implementierungsstellen für unbekanntes Verhalten: Nutzen Sie natürliche Fragen wie „Wo handhaben wir payment webhooks?“, damit der Assistent im lokalen Repository sucht.
• Untersuchung von Dateninkonsistenzen zur Laufzeit: Wenn Logs auf schemakonflikte oder Konfigurationsfehler hindeuten, lassen Sie die KI Log-Zeilen mit relevanten Code-Pfaden korrelieren.
• Debuggen unbekannter Codebases ohne Internet-Suche: Der Assistent durchsucht den tatsächlichen lokalen Codebase statt generischer Internet-Ratschläge.

FAQ

• Ladet OpenBug meinen gesamten Codebase hoch? Nein. Die Dokumentation besagt, Ihr Codebase wird lokal genutzt und nie hochgeladen; nur spezifische Code-Snippets, die die KI abfragt, werden an den Server gesendet.

• Wann sendet OpenBug Logs an den Server? Logs werden nur dann an den Server gestreamt, wenn die KI sie zur Beantwortung Ihrer Fragen benötigt.

• Wie unterstützt OpenBug Debugging über mehrere Services? Durch einen gemeinsamen lokalen Cluster: Sie führen mehrere Services in verschiedenen Terminals mit debug <command> aus, und alle verbinden sich mit demselben Cluster, damit die KI Logs über den Stack korrelieren kann.

• Kann ich den OpenBug-Server selbst hosten? Ja. Das Repository beschreibt einen Self-Hosting-Ansatz: Klonen Sie das Server-Repository, konfigurieren Sie es mit Ihrem OpenAI API-Key, dann weisen Sie die CLI per Umgebungsvariablen wie WEB_SOCKET_URL und API_BASE_URL auf Ihren Server hin.

Alternativen

• Lokales Debugging mit Logs + Textsuche (z. B. grep/ripgrep) + IDE-Tools: Ähnliche Eingaben (Logs und Quellcode), aber der Workflow basiert auf manueller Korrelation und Navigation statt KI-gestützter konversationeller Oberfläche.
• Application-Performance-/Observability-Plattformen (Logs- und Tracing-Dashboards): Nützlich zum Anzeigen und Abfragen von Laufzeitdaten, bieten aber typischerweise kein natürliches Sprach-Debugging mit Code-Bewusstsein aus dem lokalen Repository.
• KI-Code-Assistenten für Repository-Q&A (ohne Laufzeit-Log-Erfassung): Können Fragen zur Code-Struktur beantworten, erfassen aber keine Logs laufender Services, um Antworten auf Laufzeitverhalten zu gründen.