> ## Documentation Index
> Fetch the complete documentation index at: https://docs.logbrew.co/llms.txt
> Use this file to discover all available pages before exploring further.

# Instale e use a CLI do LogBrew

> Instale a CLI do LogBrew no macOS, Linux ou Windows. Entre na conta, escolha um projeto e investigue problemas com saída JSON.

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:

```bash theme={null}
curl --proto '=https' --tlsv1.2 -LsSf https://github.com/LogBrewCo/cli/releases/latest/download/logbrew-cli-installer.sh | sh
```

Windows (PowerShell):

```powershell theme={null}
powershell -ExecutionPolicy Bypass -c "irm https://github.com/LogBrewCo/cli/releases/latest/download/logbrew-cli-installer.ps1 | iex"
```

Homebrew:

```bash theme={null}
brew install LogBrewCo/tap/logbrew
```

npm:

```bash theme={null}
npm install -g logbrew-cli@latest
```

Cargo:

```bash theme={null}
cargo install logbrew-cli
```

No Windows, você também pode instalar o MSI da
[versão mais recente](https://github.com/LogBrewCo/cli/releases/latest).

<Note>
  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.
</Note>

## Atualize a CLI

A CLI não se atualiza sozinha. Use o mesmo método que você usou para instalar.

Homebrew:

```bash theme={null}
brew update && brew upgrade LogBrewCo/tap/logbrew
```

npm:

```bash theme={null}
npm install -g logbrew-cli@latest
```

Cargo:

```bash theme={null}
cargo install --locked logbrew-cli
```

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](https://github.com/LogBrewCo/cli/releases/latest):

```bash theme={null}
logbrew version --json
```

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:

```bash theme={null}
logbrew status --json
logbrew whoami --json
```

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.

```bash theme={null}
logbrew login --provider github
```

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:

```bash theme={null}
logbrew setup --json
```

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.

<Warning>
  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.
</Warning>

Consulte [Integração do SDK](/pt-BR/guides/sdk-ingestion) 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:

```bash theme={null}
logbrew projects --json
```

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.

```bash theme={null}
logbrew projects keys create "<project_id>" --ingest-key-file "<private_key_file>" --json
```

| Flag | Valor |
| - | - |
| `--kind` | `sdk` (padrão), `browser`, `server`, `cli` ou `artifact`. Uma chave `artifact` faz upload de source maps e de arquivos de depuração nativos. Ela não pode enviar telemetria. |
| `--label` | Um nome para a chave, com até 120 caracteres. O padrão é `CLI-created SDK key`. |

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](/pt-BR/guides/rotate-ingest-key).

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](/pt-BR/quickstart). 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`:

```bash theme={null}
logbrew projects setup "<project_id>" --source cli --environment production --json
```

Depois, leia a prontidão do projeto:

```bash theme={null}
logbrew doctor --project "<project_id>" --json
```

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](/pt-BR/reference/cli#read-a-project-doctor-report).

## Leia o uso da conta

Leia o uso e os limites. Isso não altera o estado da conta nem da cobrança.

```bash theme={null}
logbrew usage --json
```

`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](/pt-BR/reference/cli#filters).

<CardGroup cols={2}>
  <Card title="Problemas de uma versão" icon="tag">
    ```bash theme={null}
    logbrew read issues --project "<project_id>" --release api@1.2.3 --status unresolved --json
    ```
  </Card>

  <Card title="Uma requisição com falha" icon="route">
    ```bash theme={null}
    logbrew read trace "<trace_id>" --project "<project_id>" --json
    ```
  </Card>

  <Card title="Logs de uma versão" icon="file-text">
    ```bash theme={null}
    logbrew read logs --project "<project_id>" --release api@1.2.3 --since 24h --json
    ```
  </Card>

  <Card title="Problemas atribuídos a você" icon="user">
    ```bash theme={null}
    logbrew read issues --project "<project_id>" --assignee me --status unresolved --json
    ```
  </Card>
</CardGroup>

## Acompanhe eventos ao vivo

Use o comando watch para ver eventos novos enquanto testa uma mudança.
Pressione Ctrl+C para parar.

```bash theme={null}
logbrew watch --severity error,critical --json
```

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](/pt-BR/reference/cli#live-watch)
para ver os recursos e os filtros aceitos.

## Explique antes de alterar o código

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

<Steps>
  <Step title="Leia o problema">
    ```bash theme={null}
    logbrew read issue "<issue_id>" --json
    ```
  </Step>

  <Step title="Leia o trace">
    Faça esta etapa só se o problema tiver um ID de trace. Um problema sem
    trace continua válido.

    ```bash theme={null}
    logbrew read trace "<trace_id>" --project "<project_id>" --json
    ```
  </Step>

  <Step title="Leia a explicação">
    ```bash theme={null}
    logbrew explain issue "<issue_id>" --json
    ```

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

  <Step title="Resolva depois de verificar">
    ```bash theme={null}
    logbrew set issue "<issue_id>" resolved --json
    ```

    Para mudar o status, a prioridade ou o responsável de vários problemas,
    consulte [Mudar o status e a prioridade de problemas](/pt-BR/reference/cli#change-issue-status-and-priority)
    e o [fluxo de gerenciamento de problemas](/pt-BR/guides/issue-workflow).
  </Step>
</Steps>

## 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](/pt-BR/reference/cli#read-results-and-errors)
para ver os códigos de saída e exemplos de erros.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.