Skip to main content
A interface de linha de comando (CLI) do LogBrew lê logs, problemas, traces e ações direto do terminal. Ela também pode atualizar o status de problemas. Use --json para gerar saída estruturada para scripts e agentes de IA. Antes de executar um comando, substitua cada marcador entre colchetes angulares. Use IDs de projeto, problema e trace que o LogBrew retornou.

​
Instale a CLI

Escolha um método de instalação. macOS ou Linux:
Windows (PowerShell):
Homebrew:
npm:
Cargo:
No Windows, você também pode instalar o MSI da versão mais recente.
O Cargo precisa do Rust 1.87 ou mais recente. Os outros métodos instalam um binário nativo e não precisam do Rust.

​
Atualize a CLI

A CLI não se atualiza sozinha. Use o mesmo método que você usou para instalar. Homebrew:
npm:
Cargo:
Se você usou o instalador de shell ou do PowerShell, execute o instalador de novo. Depois, leia a versão. Compare com a versão mais recente:
O JSON traz ok, name, version, binary, os e arch.

​
Entre na conta e confira a sessão

Leia a conta usada no terminal atual:
Se whoami mostrar a conta esperada, continue. Se não, entre na conta. Uma pessoa conclui o login do provedor no navegador. Um agente de programação precisa pedir a uma pessoa que faça esta etapa.
O provedor é github (padrão), gitlab ou bitbucket. Use --no-open para imprimir a URL de login sem abrir o navegador. --json também imprime os dados para concluir o login, sem abrir o navegador. Depois do login, execute status e whoami de novo. Não coloque credenciais da conta em um prompt, relatório ou arquivo de código-fonte.

​
Planeje a configuração do SDK

Vá para o diretório que contém o manifesto de pacote ou de build da aplicação. Em um monorepo, escolha uma aplicação ou um serviço. Depois, execute:
Leia detected, install_ready, install_plan e next. O plano informa o runtime, o framework, o gerenciador de pacotes e o comando de instalação. A CLI não instala pacotes nem altera arquivos. logbrew init, install, configure e sdk retornam o mesmo plano.
Coloque uma chave de ingestão do projeto na configuração do SDK. Nunca use uma credencial da conta como chave do SDK. Mantenha as chaves de ingestão fora do controle de versão.
Consulte Integração do SDK para ver as etapas de cada runtime. Execute logbrew examples para ver uma lista curta de comandos comuns.

​
Leia, crie e configure projetos

Liste os projetos ativos da sua conta:
Escolha um ID de projeto no resultado. Use esse ID para chaves e leituras. Para criar uma chave de ingestão para um projeto existente, escolha um arquivo novo fora do controle de versão. A CLI grava a chave nesse arquivo, que só o proprietário pode ler. Ela não imprime a chave nem o caminho do arquivo.
O resultado JSON tem status, project_id, ingest_key, checks e next. ingest_key traz id, label, kind, created_at e expires_at da chave. Para substituir uma chave, consulte Rotação da chave de ingestão. Este comando cria uma credencial. Antes de executá-lo, confira se o projeto está certo. Se o resultado não estiver claro, execute o mesmo comando de novo. A CLI reaproveita a tentativa pendente. Use --abandon-retry só para começar uma nova tentativa. Para criar um projeto novo, siga o início rápido. Ele usa logbrew projects create "<name>" --ingest-key-file "<private_key_file>", que guarda a primeira chave do mesmo jeito. Execute logbrew setup --create-project para ler a ajuda sobre a criação de projetos. Esse comando não cria um projeto. Depois de uma etapa de configuração, você pode registrá-la no projeto. O valor de --source é api, cli ou sdk:
Depois, leia a prontidão do projeto:
O código de saída 0 não significa que todas as verificações passaram. Leia o status do relatório e cada verificação. Consulte a referência do relatório do doctor.

​
Leia o uso da conta

Leia o uso e os limites. Isso não altera o estado da conta nem da cobrança.
logbrew account usage --json retorna o mesmo resultado. A resposta traz o plano, o estado da cota, a data de renovação, os totais de uso por projeto e por tipo de telemetria e um próximo passo. Os campos incluem plan, state, reset_at, by_project, by_stream e next.

​
Investigações comuns

Filtre cada leitura por projeto. Adicione filtros de versão, ambiente, tempo ou gravidade quando o comando aceitar. Consulte Filtros.

Problemas de uma versão

Uma requisição com falha

Logs de uma versão

Problemas atribuídos a você

​
Acompanhe eventos ao vivo

Use o comando watch para ver eventos novos enquanto testa uma mudança. Pressione Ctrl+C para parar.
O watch transmite só JSON. Sem --json, o comando para com um erro. Adicione logs, issues ou actions para acompanhar um só tipo, como em logbrew watch logs --json. O watch não aceita traces nem spans. O watch não tem filtro de projeto, versão nem ambiente. Para um único projeto, use as leituras acima. Consulte Acompanhamento ao vivo para ver os recursos e os filtros aceitos.

​
Explique antes de alterar o código

Leia o contexto antes de propor uma correção.
1

Leia o problema

2

Leia o trace

Faça esta etapa só se o problema tiver um ID de trace. Um problema sem trace continua válido.
3

Leia a explicação

Para um log, use logbrew explain log "<log_id>" --json. Para uma ação, use logbrew explain action "<action_id>" --json.
4

Resolva depois de verificar

Para mudar o status, a prioridade ou o responsável de vários problemas, consulte Mudar o status e a prioridade de problemas e o fluxo de gerenciamento de problemas.

​
Saída JSON

  • Coloque --json antes ou depois do comando, como logbrew --json status ou logbrew status --json.
  • Confira o código de saída antes de usar o resultado.
  • Os erros em JSON têm ok, error, message e next. Um timeout não prova que uma escrita falhou. Antes de repetir uma escrita, leia as regras de nova tentativa dela.
  • Não automatize com a saída sem --json. Ela pode mudar.
Consulte Ler resultados e erros para ver os códigos de saída e exemplos de erros.