CLI-referentie van LogBrew: opdrachten en filters

De opensource-CLI van LogBrew leest telemetrie en beheert accountgegevens vanuit een terminal. Begin met de CLI-handleiding voor installatie, inloggen en veelvoorkomende taken.

Hoe de CLI werkt

Gebruik leesbare tekst in een terminal. Gebruik --json in scripts en coding agents. Voor leesacties op je account moet je met je account inloggen. Voer logbrew status --json uit voordat je een login start. Een persoon moet de autorisatie in de browser afronden. Ingest-sleutels van projecten versturen telemetrie. Ze kunnen een accountlogin niet vervangen. Deze acties wijzigen accountgegevens: een project of sleutel maken, de issuestatus, prioriteit of toewijzing wijzigen, een deployment registreren en een supportticket bijwerken. Controleer voordat je zo’n opdracht uitvoert of de actie en het doel kloppen. Voer logbrew --help uit om alle opdrachten te zien. Voeg --help toe aan een opdracht, zoals logbrew read logs --help, om de opties ervan te zien. Voer logbrew help json uit voor de JSON-regels.

Opdrachtgroep	Doel
`login`, `whoami`, `me`, `logout`	Een login starten, de accountidentiteit lezen of de lokale sessie sluiten.
`status`, `health`, `doctor`, `version`, `examples`	Toegang, projectgereedheid, de CLI-versie of voorbeelden voor de eerste run lezen.
`setup`	Lokale manifesten lezen en een SDK-installatieplan printen. Wijzigt geen bestanden en voert de installatieopdracht niet uit.
`projects`	De actieve projectcatalogus lezen.
`projects repositories`	Gekoppelde repositories lezen of componenten in één repository vinden.
`projects create`, `projects keys create`	Een project maken, of een ingest-sleutel maken voor een bestaand project.
`projects setup`	De waargenomen installatie van een bestaand project registreren.
`projects archive`, `projects delete`	Een project archiveren, of het na bevestiging definitief verwijderen.
`usage`, `account usage`	Gebruik, limieten, quotastatus en resetdatums lezen.
`mcp grants`, `mcp revoke`	De namen tonen van de MCP-clients die met je account zijn verbonden, of één verbinding intrekken.
`read`	Logs, issues, acties, releases, metrics, traces of één item lezen.
`explain`	Begrensd bewijs lezen voor een issue, log, actie, trace, span, metric of release.
`investigate issue`	Bewijs uit het issueonderzoek lezen, of een kandidaatdeployment verifiëren.
`issues archive`, `issues resolve`, `issues reopen`	De status van 1 issue instellen, of van maximaal 100 issues in één project.
`issues priority`	De prioriteit van 1 issue instellen, of van maximaal 100 issues in één project.
`issues assign`, `issues unassign`	1 issue toewijzen aan een account of een team, of de toewijzing opheffen, of dat doen voor maximaal 100 issues in één project.
`issues assignees`	De accounts en teams tonen aan wie je issues in één project kunt toewijzen.
`issues owners`	De voorgestelde eigenaren van 1 issue tonen.
`issues ownership`	De eigenaarsregels en het CODEOWNERS-bestand van één project lezen of instellen.
`issues activity`	De wijzigingsgeschiedenis van 1 issue lezen.
`issues rule`, `logs rule`	De ernstregel van 1 issue of 1 logsignatuur instellen.
`inbox`	De issues lezen die anderen aan jou of je teams hebben toegewezen, of ze als gelezen markeren.
`set issue`, `resolve`, `close`, `ignore`, `reopen`	De status van 1 issue instellen. `close` betekent `resolved`. `ignore` en `ignored` betekenen `archived`.
`deploy`	Eén afgeronde deployment registreren.
`debug-artifacts`	Native debugbestanden voor Apple of Android uploaden, of één image-identiteit opzoeken.
`analytics`	Het overzicht, eigenschappen, vergelijkingen, paden, trechters, retentie of levenscyclus lezen.
`support`	Supporttickets maken, lezen, beantwoorden, sluiten of heropenen.
`watch`	Live logs, issues of acties streamen.

Een doctor-rapport van een project lezen

Gebruik een project-ID uit logbrew projects --json:

logbrew doctor --project "<project_id>" --json

De opdracht leest de projectstatus en één recente log. Ze maakt geen project, wijzigt geen sleutel en registreert geen installatie. Het rapport heeft status, checks en next. Elke controle heeft check, status en next. De controles zijn api, auth, project, ingest_key, setup, telemetry en logs. Exitcode 0 betekent dat de CLI een rapport heeft geschreven. Het betekent niet dat het project klaar is. Lees de status van het rapport en elke controle. Een controle met not_checked is niet geslaagd.

`status` van het rapport	Betekenis en volgende stap
`auth_invalid`	Accounttoegang ontbreekt of is ongeldig. Een persoon voert `logbrew login` uit.
`project_missing`	Dit account heeft geen toegang tot het project. Gebruik een ID uit `logbrew projects --json`.
`api_unreachable`	Het API-request is niet voltooid. Controleer de netwerkverbinding en voer de opdracht daarna opnieuw uit.
`check_failed`	Een request mislukte of de response was ongeldig. Voer de opdracht ongewijzigd opnieuw uit. Mislukt ze weer, meld dan een probleem.
`needs_ingest_key`	Het project heeft geen actieve ingest-sleutel. Maak alleen een sleutel als je toestemming hebt om het project te wijzigen.
`needs_setup`	SDK-installatie is nodig. Volg de snelstart.
`needs_telemetry`	De installatie is gestart, maar LogBrew heeft geen telemetrie voor het project. Verstuur een testevent.
`ready`	Het project heeft een actieve sleutel en telemetrie. Lees het signaal voor je taak.

Slaagt het lezen van het project, dan is de controle logs visible, empty, unavailable, error of invalid_response. Deze controle verandert de status van het rapport niet. Een leeg logresultaat zegt niets over andere signalen. Een mislukte leesactie is geen leeg resultaat. Gebruik next als hulp bij herstel. Het geeft geen toestemming om de status van het account of project te wijzigen.

Voorbeeld: accounttoegang ontbreekt

Zonder toegangsgegevens van een account doet de opdracht geen API-request. Ze schrijft dit rapport naar standaarduitvoer en stopt met exitcode 0:

{
  "checks": [
    { "check": "api", "next": "run the API reachability check first", "status": "not_checked" },
    { "check": "auth", "next": "run logbrew login", "status": "missing" },
    { "check": "project", "next": "resolve the prior check first", "status": "not_checked" },
    { "check": "ingest_key", "next": "resolve the prior check first", "status": "not_checked" },
    { "check": "setup", "next": "resolve the prior check first", "status": "not_checked" },
    { "check": "telemetry", "next": "resolve the prior check first", "status": "not_checked" },
    { "check": "logs", "next": "resolve the prior check first", "status": "not_checked" }
  ],
  "next": "run logbrew login",
  "status": "auth_invalid"
}

Dit rapport is iets anders dan de projectdiagnose van de API. Het bevat niet de API-velden state, setup_status of next_action.

Filters

Filter	Opdrachten
`--project <project_id>`	logs, issues, actions, releases, metrics, traces, trace
`--release <release>`	logs, issues, actions, releases, metrics, traces, trace
`--environment <environment>`	logs, issues, actions, releases, metrics, traces, trace
`--service <service_name>`	logs, issues, actions, releases, metrics, traces
`--since 24h`	logs, issues, actions, releases, metrics, traces, analytics
`--until <RFC3339>`	logs, issues, actions, releases, metrics, traces, analytics
`--limit 100`	logs, issues, actions, releases, metrics, traces
`--severity error`	logs, watch
`--search checkout`	logs
`--trace <trace_id>`	logs
`--status unresolved`	issues (`unresolved`, `resolved`, `archived`)
`--priority high`	issues (`high`, `medium`, `low`)
`--assignee me`	issues (`me`, `none`, `my_teams`, een gebruikers-ID of `team:<team_id>`)
`--status error`	traces (`error`, `ok`)
`--min-duration-ms <milliseconds>`	traces
`--name <name>`	actions, metrics
`--user <distinct_id>`	actions

--since accepteert een duur zoals 24h of 7d, of een RFC 3339-tijdstempel. --until accepteert een RFC 3339-tijdstempel. Het is een exclusieve eindtijd en moet later zijn dan --since. Bij het lezen van één issue op ID werkt --until niet. Logernst is info, warning, error of critical. De issuestatus is de workflowstatus van het issue, niet de ernst. --status ignored is een oudere naam voor --status archived. --status open betekent unresolved, en --status closed betekent resolved. --assignee none selecteert issues die aan niemand zijn toegewezen, en --assignee my_teams selecteert de issues van je teams. Elke andere waarde voor --assignee mislukt met invalid_assignee. De CLI accepteert ook deze aliassen: --project-id, --env, --service-name, --trace-id, --distinct-id en --level voor --severity. Gebruik in nieuwe scripts de namen uit de tabel. Deze opdracht leest de fouten van 1 dag:

logbrew read logs --severity error \
  --since 2026-10-01T00:00:00Z --until 2026-10-02T00:00:00Z --json

Het project-ID selecteert het project. De servicenaam selecteert een component in dat project. Zet aanhalingstekens rond waarden met spaties:

logbrew read logs --project "<project_id>" \
  --service checkout-api --since 24h \
  --severity error --search "checkout failed" --json

Zet -- vóór zoektekst die met een koppelteken begint:

logbrew logs --json -- --timeout

Een voorval van een issue kiezen

Een issue groepeert overeenkomende voorvallen. Lees het issue voor de status, het aantal voorvallen en de tijden van eerst en laatst gezien:

logbrew read issue "<issue_id>" --json

Gebruik explain issue of investigate issue voor bewijs uit één voorval. Zonder --occurrence kiest LogBrew het aanbevolen voorval. Dat is niet altijd het nieuwste event. Zo lees je het nieuwste event:

logbrew explain issue "<issue_id>" --occurrence latest --json

--occurrence accepteert ook recommended, first of een voorval-ID dat LogBrew heeft teruggegeven. Deze opdrachten weigeren filters voor project, release, omgeving en tijd. Lees de tijdstempel van het gekozen voorval voordat je bewijs vergelijkt. Zie Een issue onderzoeken voor de bewijsvelden.

Issuestatus en prioriteit wijzigen

Gebruik 1 issue-ID om 1 issue te wijzigen:

logbrew issues archive "<issue_id>" --json
logbrew issues priority high "<issue_id>" --json

archive zet archived, resolve zet resolved en reopen zet unresolved. De prioriteit is high, medium of low. Een prioriteit die je zelf instelt, blijft vast. Anders volgt de prioriteit de ernst van het issue. Voeg --project toe om meer dan 1 issue te wijzigen. Alle issues moeten in dat project staan. Eén opdracht wijzigt maximaal 100 issues:

logbrew issues resolve "<issue_id_1>" "<issue_id_2>" \
  --project "<project_id>" --json

Het resultaat heeft 1 item per issue. Elk item is updated, unchanged of not_found. Een issue met unchanged had de gevraagde waarde al. Na een netwerkfout kun je dezelfde opdracht opnieuw uitvoeren. Deze opdrachten vragen niet om bevestiging. Controleer eerst de issue-ID’s. Leesacties en wijzigingen van issues tonen archived in plaats van ignored, en de priority, priority_source en assignee van elk issue. Zie de issueresponse.

Issues toewijzen

Een issue heeft 0 of 1 toewijzing: één account of één team. Toon de accounts en teams aan wie je in een project issues kunt toewijzen:

logbrew issues assignees --project "<project_id>" --json

Wijs 1 issue toe aan een account, aan jezelf met me of aan een team:

logbrew issues assign "<user_id>" "<issue_id>" --json
logbrew issues assign me "<issue_id>" --json
logbrew issues assign "team:<team_id>" "<issue_id>" --json

Hef de toewijzing op:

logbrew issues unassign "<issue_id>" --json

Voeg --project toe om maximaal 100 issues van dat project te wijzigen, net als bij status en prioriteit. Een account moet het project kunnen lezen, en een team moet bij de organisatie van het project horen. Zo vind je de issues die aan jou of je teams zijn toegewezen:

logbrew read issues --project "<project_id>" --assignee my_teams \
  --status unresolved --json

Tekstuitvoer toont de naam van het toegewezen account, of team #<slug> voor een team. Heeft het account geen naam, dan toont de uitvoer het e-mailadres en daarna het gebruikers-ID. Een issue dat aan niemand is toegewezen, toont unassigned.

Eigenaren, geschiedenis en de inbox

logbrew issues owners "<issue_id>" --json
logbrew issues ownership --project "<project_id>" --json
logbrew issues ownership set --project "<project_id>" \
  --rules ownership.txt --codeowners .github/CODEOWNERS --json
logbrew issues activity "<issue_id>" --limit 50 --json
logbrew inbox --json
logbrew inbox read --json

issues owners toont de voorgestelde eigenaren en het bewijs dat is gecontroleerd. issues ownership set verstuurt lokale bestanden van elk maximaal 128 KiB. Een leeg bestand wist de bijbehorende tekst. issues activity en inbox accepteren --limit van 1 tot 200, en --cursor-time met --cursor-id uit next_cursor. Zie Zoeken wie eigenaar is van een issue.

Ernstregels instellen

logbrew issues rule "<issue_id>" warning --json
logbrew logs rule "<log_id>" info --ignore --json

De ernst is info, warning, error, critical of source. source toont weer de vastgelegde ernst. --ignore verbergt overeenkomende logs in de standaardlijst met logs. Zonder --ignore toont de regel ze.

De volgende pagina lezen

Logs, issues, acties, metrics en traces ondersteunen cursorpaginering. Releases niet. Gebruik --pagination cursor voor de eerste pagina:

logbrew read logs --project "<project_id>" --since 24h \
  --pagination cursor --limit 100 --json

De response heeft logs en next_cursor. Een next_cursor die niet null is, heeft time en id. Stuur die mee met --cursor-time en --cursor-id:

logbrew read logs --project "<project_id>" --since 24h \
  --pagination cursor --limit 100 \
  --cursor-time "<returned_time>" \
  --cursor-id "<returned_id>" --json

Houd op elke pagina dezelfde filters en dezelfde limiet aan. Stop als next_cursor null is. Gebruik de cursor, niet het aantal rijen, om te bepalen of er meer pagina’s zijn. De laatste pagina kan leeg zijn:

{
  "logs": [],
  "next_cursor": null
}

Issues, acties en metrics gebruiken dezelfde vorm, met issues, actions of metrics in plaats van logs.

Live volgen

logbrew watch --json streamt live logs, issues en acties. Voeg logs, issues of actions toe om één type te streamen. tail, follow en stream zijn aliassen van watch. Watch ondersteunt geen traces of spans. Watch heeft --json nodig. Zonder die optie stopt de opdracht met exitcode 1 en schrijft ze deze tekst: watch streams JSON for agents. Issue-events in watch tonen een gearchiveerd issue als ignored, zonder prioriteit. Lees het issue om de huidige status en prioriteit te krijgen. Watch accepteert alleen --severity, zoals --severity error,critical. logbrew watch actions accepteert geen --severity. De CLI past dit filter toe nadat hij events heeft ontvangen. Het vermindert niet wat de server verstuurt. Watch heeft geen filter voor project, release, omgeving of tijd. Gebruik voor die filters een read-opdracht. Na een tijdelijke onderbreking van de verbinding wacht de CLI en maakt hij opnieuw verbinding.

Resultaten en fouten lezen

Zet --json vóór of na de opdracht. Lees de exitcode voordat je de uitvoer gebruikt. Parse geen uitvoer die voor mensen bedoeld is. Die kan per versie veranderen.

Exitcode	Betekenis
`0`	Gelukt. De JSON staat op standaarduitvoer.
`1`	De opdracht mislukte tijdens het uitvoeren, bijvoorbeeld door een API- of netwerkfout.
`2`	De CLI weigerde de opdracht voordat die werd uitgevoerd.

Succesuitvoer behoudt de vorm van de API-response. Dat kan een array of een object zijn. Zonder cursorpaginering geeft het lezen van logs een array terug. Een lege array betekent dat er geen logs overeenkomen. Het is geen fout. Fouten gaan naar standaardfout. De uitzondering is debug-artifacts --json, dat fouten naar standaarduitvoer schrijft. Een JSON-fout heeft ok, error, message en next. Gebruik error als stabiele foutcode. Bekijk next goed voordat je de opdracht uitvoert die het voorstelt. logbrew watch traces --json stopt bijvoorbeeld met exitcode 2 en schrijft:

{
  "ok": false,
  "error": "unknown_resource",
  "message": "unknown resource: traces",
  "next": "use logbrew traces for recent traces, or logbrew trace <trace_id> for one trace"
}

logbrew read logs --limit 0 --json stopt met exitcode 2 en schrijft:

{
  "ok": false,
  "error": "invalid_limit",
  "message": "invalid limit: 0",
  "next": "use --limit with a positive whole number"
}

Corrigeer de waarde en voer de opdracht opnieuw uit. Een geweigerde opdracht is geen leeg resultaat. Zie API-fouten voor HTTP-fouten en de referentie van de Telemetrie-API voor directe API-requests.

​Hoe de CLI werkt

​Een doctor-rapport van een project lezen

​Voorbeeld: accounttoegang ontbreekt

​Filters

​Een voorval van een issue kiezen

​Issuestatus en prioriteit wijzigen

​Issues toewijzen

​Eigenaren, geschiedenis en de inbox

​Ernstregels instellen

​De volgende pagina lezen

​Live volgen

​Resultaten en fouten lezen