Skip to main content
La interfaz de línea de comandos (CLI) de LogBrew lee logs, incidencias, trazas y acciones desde una terminal. También puede actualizar el estado de una incidencia. Usa --json para obtener salida estructurada para scripts y agentes de IA. Sustituye cada marcador de posición entre corchetes angulares antes de ejecutar un comando. Usa los ID de proyecto, incidencia y traza que devolvió LogBrew.

​
Instala la CLI

Elige un método de instalación. macOS o Linux:
Windows (PowerShell):
Homebrew:
npm:
Cargo:
En Windows, también puedes instalar el MSI desde el último release.
Cargo necesita Rust 1.87 o posterior. Los demás métodos instalan un binario nativo y no necesitan Rust.

​
Actualiza la CLI

La CLI no se actualiza sola. Usa el mismo método con el que la instalaste. Homebrew:
npm:
Cargo:
Si usaste el instalador de shell o de PowerShell, vuelve a ejecutarlo. Después, lee la versión. Compárala con el último release:
El JSON incluye ok, name, version, binary, os y arch.

​
Inicia sesión y comprueba la sesión

Lee la cuenta de la terminal actual:
Si whoami muestra la cuenta esperada, continúa. Si no, inicia sesión. Una persona completa el inicio de sesión del proveedor en el navegador. Un agente de programación debe pedirle a una persona que haga este paso.
El proveedor es github (predeterminado), gitlab o bitbucket. Usa --no-open para imprimir la URL de inicio de sesión sin abrir un navegador. --json también imprime los datos para completar el inicio de sesión sin abrir un navegador. Después de iniciar sesión, vuelve a ejecutar status y whoami. No pongas credenciales de la cuenta en un prompt, un informe ni un archivo de código fuente.

​
Planifica la configuración del SDK

Ve al directorio que contiene el manifiesto de paquetes o de compilación de la app. En un monorepo, elige una app o un servicio. Después, ejecuta:
Lee detected, install_ready, install_plan y next. El plan indica el runtime, el framework, el gestor de paquetes y el comando de instalación. La CLI no instala paquetes ni cambia archivos. logbrew init, install, configure y sdk dan el mismo plan.
Pon una clave de ingesta del proyecto en la configuración del SDK. Nunca uses una credencial de la cuenta como clave del SDK. Mantén las claves de ingesta fuera del control de versiones.
Consulta Integración del SDK para ver los pasos de cada runtime. Ejecuta logbrew examples para ver una lista corta de comandos habituales.

​
Lee, crea y configura proyectos

Lista los proyectos activos de tu cuenta:
Elige un ID de proyecto del resultado. Úsalo para las claves y las lecturas. Para crear una clave de ingesta para un proyecto existente, elige un archivo nuevo fuera del control de versiones. La CLI escribe la clave en ese archivo, que solo puede leer su propietario. No imprime la clave ni la ruta del archivo.
El resultado JSON tiene status, project_id, ingest_key, checks y next. ingest_key contiene id, label, kind, created_at y expires_at de la clave. Para sustituir una clave, consulta Rotar una clave de ingesta. Este comando crea una credencial. Antes de ejecutarlo, comprueba que el proyecto es el correcto. Si el resultado es dudoso, vuelve a ejecutar el mismo comando. La CLI reutiliza entonces el intento pendiente. Usa --abandon-retry solo para empezar un intento nuevo. Para crear un proyecto nuevo, sigue el Inicio rápido. Usa logbrew projects create "<name>" --ingest-key-file "<private_key_file>", que guarda la primera clave de la misma forma. Ejecuta logbrew setup --create-project para leer la ayuda sobre la creación de proyectos. Ese comando no crea ningún proyecto. Después de un paso de configuración, puedes registrarlo en el proyecto. El valor de --source es api, cli o sdk:
Después, lee si el proyecto está listo:
El código de salida 0 no significa que todas las comprobaciones pasaran. Lee el status del informe y cada comprobación. Consulta la referencia del informe de doctor.

​
Lee el uso de la cuenta

Lee el uso y los límites. Esto no cambia el estado de la cuenta ni de la facturación.
logbrew account usage --json da el mismo resultado. La respuesta indica el plan, el estado de la cuota, la fecha de reinicio, el uso total por proyecto y por tipo de telemetría, y un siguiente paso. Los campos incluyen plan, state, reset_at, by_project, by_stream y next.

​
Investigaciones habituales

Filtra cada lectura por proyecto. Añade filtros de release, entorno, tiempo o severidad cuando el comando los admita. Consulta Filtros.

Incidencias de un release

Una solicitud fallida

Logs de un release

Incidencias asignadas a ti

​
Observa los eventos en vivo

Usa watch para ver eventos nuevos mientras pruebas un cambio. Pulsa Ctrl+C para detenerlo.
Watch solo transmite JSON. Sin --json, el comando se detiene con un error. Añade logs, issues o actions para seguir un solo tipo, como logbrew watch logs --json. Watch no admite trazas ni spans. Watch no tiene filtro de proyecto, release ni entorno. Para un solo proyecto, usa las lecturas anteriores. Consulta Observación en vivo para ver los recursos y filtros admitidos.

​
Entiende el problema antes de cambiar el código

Lee el contexto antes de proponer una corrección.
1

Lee la incidencia

2

Lee la traza

Haz este paso solo si la incidencia tiene un ID de traza. Una incidencia sin traza sigue siendo válida.
3

Lee la explicación

Para un log, usa logbrew explain log "<log_id>" --json. Para una acción, usa logbrew explain action "<action_id>" --json.
4

Resuelve después de verificar

Para cambiar el estado, la prioridad o el responsable de muchas incidencias, consulta Cambia el estado y la prioridad de una incidencia y Gestionar incidencias.

​
Salida JSON

  • Pon --json antes o después del comando, como logbrew --json status o logbrew status --json.
  • Lee el código de salida antes de usar la salida.
  • Los errores JSON tienen ok, error, message y next. Un tiempo de espera agotado no demuestra que una escritura fallara. Antes de repetir una escritura, lee sus reglas de reintento.
  • No automatices con salida sin --json. Puede cambiar.
Consulta Lee resultados y errores para ver los códigos de salida y ejemplos de errores.