Skip to main content
Met de LogBrew-opdrachtregelinterface (CLI) lees je logs, issues, traces en acties vanuit een terminal. De CLI kan ook de issuestatus wijzigen. Gebruik --json voor gestructureerde uitvoer naar scripts en AI-agents. Vervang elke placeholder tussen punthaken voordat je een opdracht uitvoert. Gebruik project-, issue- en trace-ID’s die LogBrew heeft teruggegeven.

​
De CLI installeren

Kies één installatiemethode. macOS of Linux:
Windows (PowerShell):
Homebrew:
npm:
Cargo:
Op Windows kun je ook de MSI installeren uit de nieuwste release.
Cargo heeft Rust 1.87 of nieuwer nodig. De andere methoden installeren een native binary en hebben geen Rust nodig.

​
De CLI bijwerken

De CLI werkt zichzelf niet bij. Gebruik dezelfde methode waarmee je de CLI hebt geïnstalleerd. Homebrew:
npm:
Cargo:
Heb je de shell- of PowerShell-installer gebruikt? Voer de installer dan opnieuw uit. Lees daarna de versie. Vergelijk die met de nieuwste release:
De JSON bevat ok, name, version, binary, os en arch.

​
Inloggen en de sessie controleren

Lees uit welk account deze terminal gebruikt:
Toont whoami het verwachte account? Ga dan verder. Zo niet, log dan in. Een persoon rondt het inloggen bij de provider af in de browser. Een coding agent moet een persoon vragen om deze stap te doen.
De provider is github (standaard), gitlab of bitbucket. Gebruik --no-open om de login-URL te tonen zonder een browser te openen. Ook --json toont de login-overdracht zonder een browser te openen. Voer na het inloggen opnieuw status en whoami uit. Zet geen toegangsgegevens van je account in een prompt, rapport of bronbestand.

​
De SDK-installatie plannen

Ga naar de map met het pakket- of buildmanifest van de app. Kies in een monorepo één app of service. Voer daarna uit:
Lees detected, install_ready, install_plan en next. Het plan noemt de runtime, het framework, de pakketbeheerder en de installatieopdracht. De CLI installeert geen pakketten en wijzigt geen bestanden. logbrew init, install, configure en sdk geven hetzelfde plan.
Zet een ingest-sleutel van het project in de SDK-configuratie. Gebruik nooit toegangsgegevens van je account als SDK-sleutel. Houd ingest-sleutels buiten versiebeheer.
Zie SDK-integratie voor de stappen per runtime. Voer logbrew examples uit voor een korte lijst met veelgebruikte opdrachten.

​
Projecten lezen, aanmaken en instellen

Toon de actieve projecten in je account:
Kies een project-ID uit het resultaat. Gebruik dat ID voor sleutels en leesacties. Wil je een ingest-sleutel maken voor een bestaand project? Kies dan een nieuw bestand buiten versiebeheer. De CLI schrijft de sleutel naar dat bestand, dat alleen voor de eigenaar toegankelijk is. De CLI toont de sleutel en het bestandspad niet.
Het JSON-resultaat bevat status, project_id, ingest_key, checks en next. ingest_key bevat de id, label, kind, created_at en expires_at van de sleutel. Zie Een ingest-sleutel roteren om een sleutel te vervangen. Deze opdracht maakt toegangsgegevens aan. Controleer of het project klopt voordat je de opdracht uitvoert. Is het resultaat onzeker? Voer dan dezelfde opdracht opnieuw uit. De CLI hergebruikt dan de lopende poging. Gebruik --abandon-retry alleen om een nieuwe poging te starten. Volg de snelstart om een nieuw project te maken. Die gebruikt logbrew projects create "<name>" --ingest-key-file "<private_key_file>", dat de eerste sleutel op dezelfde manier opslaat. Voer logbrew setup --create-project uit om de helptekst voor het maken van een project te lezen. Die opdracht maakt geen project aan. Na een installatiestap kun je die stap voor het project registreren. De waarde van --source is api, cli of sdk:
Lees daarna of het project klaar is:
Exitcode 0 betekent niet dat alle controles zijn geslaagd. Lees de status van het rapport en elke controle. Zie de referentie voor het doctor-rapport.

​
Accountgebruik lezen

Lees je gebruik en je limieten. Dit verandert niets aan je account of je facturering.
logbrew account usage --json geeft hetzelfde resultaat. De response bevat je abonnement, de status van je quotum, de resetdatum, het totale gebruik per project en per soort telemetrie, en een volgende stap. Velden zijn onder meer plan, state, reset_at, by_project, by_stream en next.

​
Veelvoorkomende onderzoeken

Filter elke leesactie op project. Voeg filters voor release, omgeving, tijd of ernst toe als de opdracht ze ondersteunt. Zie Filters.

Issues in een release

Eén mislukt request

Logs van een release

Issues die aan jou zijn toegewezen

​
Live-events volgen

Gebruik watch om nieuwe events te zien terwijl je een wijziging test. Druk op Ctrl+C om te stoppen.
Watch streamt alleen JSON. Zonder --json stopt de opdracht met een fout. Voeg logs, issues of actions toe om één type te volgen, zoals logbrew watch logs --json. Watch ondersteunt geen traces of spans. Watch heeft geen filter voor project, release of omgeving. Gebruik voor één project de leesacties hierboven. Zie Live volgen voor de ondersteunde resources en filters.

​
Eerst de uitleg lezen, dan code wijzigen

Lees de context voordat je een fix voorstelt.
1

Lees het issue

2

Lees de trace

Doe deze stap alleen als het issue een trace-ID heeft. Een issue zonder trace is ook geldig.
3

Lees de uitleg

Gebruik voor een log logbrew explain log "<log_id>" --json. Gebruik voor een actie logbrew explain action "<action_id>" --json.
4

Los het issue op na verificatie

Wil je de status, prioriteit of toewijzing van veel issues wijzigen? Zie Issuestatus en prioriteit wijzigen en de issueworkflow.

​
JSON-uitvoer

  • Zet --json vóór of na de opdracht, zoals logbrew --json status of logbrew status --json.
  • Lees de exitcode voordat je de uitvoer gebruikt.
  • JSON-fouten bevatten ok, error, message en next. Een time-out bewijst niet dat een schrijfactie is mislukt. Lees de regels voor nieuwe pogingen voordat je een schrijfactie herhaalt.
  • Automatiseer niet met uitvoer zonder --json. Die uitvoer kan veranderen.
Zie Resultaten en fouten lezen voor exitcodes en voorbeelden van fouten.