Skip to main content
Die LogBrew-Kommandozeile (CLI) liest Logs, Issues, Traces und Aktionen im Terminal. Sie kann auch den Issue-Status ändern. Mit --json erhalten Skripte und KI-Agenten eine strukturierte Ausgabe. Ersetzen Sie jeden Platzhalter in spitzen Klammern, bevor Sie einen Befehl ausführen. Verwenden Sie Projekt-, Issue- und Trace-IDs, die LogBrew zurückgegeben hat.

​
CLI installieren

Wählen Sie eine Installationsmethode. macOS oder Linux:
Windows (PowerShell):
Homebrew:
npm:
Cargo:
Unter Windows können Sie auch das MSI-Paket aus dem neuesten Release installieren.
Cargo braucht Rust 1.87 oder neuer. Die anderen Methoden installieren ein natives Binary und brauchen kein Rust.

​
CLI aktualisieren

Die CLI aktualisiert sich nicht selbst. Verwenden Sie dieselbe Methode, mit der Sie sie installiert haben. Homebrew:
npm:
Cargo:
Beim Shell- oder PowerShell-Installer führen Sie den Installer erneut aus. Lesen Sie danach die Version. Vergleichen Sie sie mit dem neuesten Release:
Das JSON enthält ok, name, version, binary, os und arch.

​
Anmelden und Sitzung prüfen

Lesen Sie das Konto für das aktuelle Terminal:
Zeigt whoami das erwartete Konto, fahren Sie fort. Wenn nicht, melden Sie sich an. Eine Person schließt die Anmeldung beim Anbieter im Browser ab. Ein Coding-Agent muss eine Person bitten, diesen Schritt auszuführen.
Der Anbieter ist github (Standard), gitlab oder bitbucket. Mit --no-open gibt die CLI die Anmelde-URL aus, ohne einen Browser zu öffnen. Auch --json gibt die Angaben für die Anmeldung aus, ohne einen Browser zu öffnen. Führen Sie nach der Anmeldung status und whoami erneut aus. Schreiben Sie Konto-Zugangsdaten nie in einen Prompt, einen Bericht oder eine Quelldatei.

​
SDK-Einrichtung planen

Wechseln Sie in das Verzeichnis mit dem Paket- oder Build-Manifest der App. Wählen Sie in einem Monorepo eine App oder einen Dienst. Führen Sie dann diesen Befehl aus:
Lesen Sie detected, install_ready, install_plan und next. Der Plan nennt Laufzeit, Framework, Paketmanager und Installationsbefehl. Die CLI installiert keine Pakete und ändert keine Dateien. logbrew init, install, configure und sdk liefern denselben Plan.
Tragen Sie einen Projekt-Ingest-Schlüssel in die SDK-Konfiguration ein. Verwenden Sie nie Konto-Zugangsdaten als SDK-Schlüssel. Halten Sie Ingest-Schlüssel aus der Versionsverwaltung heraus.
Die Schritte für jede Laufzeit finden Sie unter SDK-Integration. Führen Sie logbrew examples aus, um eine kurze Liste häufiger Befehle zu sehen.

​
Projekte lesen, anlegen und konfigurieren

Listen Sie die aktiven Projekte in Ihrem Konto auf:
Wählen Sie eine Projekt-ID aus dem Ergebnis. Verwenden Sie sie für Schlüssel und Abfragen. Um einen Ingest-Schlüssel für ein bestehendes Projekt zu erstellen, wählen Sie eine neue Datei außerhalb der Versionsverwaltung. Die CLI schreibt den Schlüssel in diese Datei, die nur der Eigentümer lesen kann. Sie gibt weder den Schlüssel noch den Dateipfad aus.
Das JSON-Ergebnis enthält status, project_id, ingest_key, checks und next. ingest_key enthält id, label, kind, created_at und expires_at des Schlüssels. Wie Sie einen Schlüssel ersetzen, steht unter Ingest-Schlüssel rotieren. Dieser Befehl erstellt Zugangsdaten. Prüfen Sie vorher, ob das Projekt stimmt. Ist das Ergebnis unklar, führen Sie genau denselben Befehl erneut aus. Die CLI verwendet dann den ausstehenden Versuch weiter. Verwenden Sie --abandon-retry nur, um einen neuen Versuch zu starten. Um ein neues Projekt anzulegen, folgen Sie dem Schnellstart. Er verwendet logbrew projects create "<name>" --ingest-key-file "<private_key_file>", das den ersten Schlüssel auf dieselbe Weise speichert. Führen Sie logbrew setup --create-project aus, um die Hilfe zum Anlegen eines Projekts zu lesen. Dieser Befehl legt kein Projekt an. Nach einem Einrichtungsschritt können Sie ihn für das Projekt festhalten. Der Wert von --source ist api, cli oder sdk:
Lesen Sie dann die Projektbereitschaft:
Der Exit-Code 0 bedeutet nicht, dass alle Prüfungen bestanden sind. Lesen Sie den status des Berichts und jede einzelne Prüfung. Siehe die Referenz zum Doctor-Bericht.

​
Kontonutzung lesen

Lesen Sie Nutzung und Limits. Das ändert weder Konto noch Abrechnung.
logbrew account usage --json liefert dasselbe Ergebnis. Die Antwort nennt den Tarif, den Kontingentstatus, das Rücksetzdatum, die Nutzung pro Projekt und pro Telemetrieart sowie einen nächsten Schritt. Zu den Feldern gehören plan, state, reset_at, by_project, by_stream und next.

​
Häufige Untersuchungen

Filtern Sie jede Abfrage nach Projekt. Fügen Sie Filter für Release, Umgebung, Zeit oder Schweregrad hinzu, wenn der Befehl sie unterstützt. Siehe Filter.

Issues in einem Release

Eine fehlgeschlagene Anfrage

Logs eines Release

Ihnen zugewiesene Issues

​
Live-Ereignisse beobachten

Mit watch sehen Sie neue Ereignisse, während Sie eine Änderung testen. Drücken Sie Strg+C, um zu stoppen.
Watch gibt nur JSON aus. Ohne --json bricht der Befehl mit einem Fehler ab. Fügen Sie logs, issues oder actions hinzu, um nur einen Typ zu beobachten, zum Beispiel logbrew watch logs --json. Watch unterstützt keine Traces oder Spans. Watch hat keinen Filter für Projekt, Release oder Umgebung. Verwenden Sie für ein einzelnes Projekt die Abfragen oben. Die unterstützten Ressourcen und Filter stehen unter Live-Beobachtung.

​
Erst erklären, dann Code ändern

Lesen Sie den Kontext, bevor Sie eine Korrektur vorschlagen.
1

Issue lesen

2

Trace lesen

Führen Sie diesen Schritt nur aus, wenn das Issue eine Trace-ID hat. Ein Issue ohne Trace ist trotzdem gültig.
3

Erklärung lesen

Für ein Log verwenden Sie logbrew explain log "<log_id>" --json. Für eine Aktion verwenden Sie logbrew explain action "<action_id>" --json.
4

Issue nach der Prüfung lösen

Wie Sie Status, Priorität oder Zuweisung für viele Issues ändern, steht unter Status und Priorität eines Issues ändern und im Issue-Workflow.

​
JSON-Ausgabe

  • Setzen Sie --json vor oder hinter den Befehl, zum Beispiel logbrew --json status oder logbrew status --json.
  • Lesen Sie den Exit-Code, bevor Sie die Ausgabe verwenden.
  • JSON-Fehler enthalten ok, error, message und next. Eine Zeitüberschreitung beweist nicht, dass ein Schreibvorgang fehlgeschlagen ist. Lesen Sie die Wiederholungsregeln, bevor Sie einen Schreibvorgang wiederholen.
  • Automatisieren Sie nicht mit Ausgabe ohne --json. Sie kann sich ändern.
Exit-Codes und Fehlerbeispiele finden Sie unter Ergebnisse und Fehler lesen.