Skip to main content
L’interface en ligne de commande (CLI) de LogBrew lit les logs, problèmes, traces et actions depuis un terminal. Elle peut aussi modifier le statut des problèmes. Utilisez --json pour obtenir une sortie structurée destinée aux scripts et aux agents IA. Avant d’exécuter une commande, remplacez chaque espace réservé entre chevrons. Utilisez les ID de projet, de problème et de trace renvoyés par LogBrew.

​
Installer la CLI

Choisissez une méthode d’installation. macOS ou Linux :
Windows (PowerShell) :
Homebrew :
npm :
Cargo :
Sous Windows, vous pouvez aussi installer le MSI depuis la dernière version publiée.
Cargo nécessite Rust 1.87 ou une version plus récente. Les autres méthodes installent un binaire natif et n’ont pas besoin de Rust.

​
Mettre à jour la CLI

La CLI ne se met pas à jour automatiquement. Utilisez la méthode qui a servi à l’installer. Homebrew :
npm :
Cargo :
Si vous avez utilisé l’installateur shell ou PowerShell, exécutez-le de nouveau. Lisez ensuite la version. Comparez-la avec la dernière version publiée :
Le JSON contient ok, name, version, binary, os et arch.

​
Se connecter et vérifier la session

Lisez le compte associé au terminal actuel :
Si whoami affiche le compte attendu, continuez. Sinon, connectez-vous. Une personne termine la connexion auprès du fournisseur dans le navigateur. Un agent de codage doit demander à une personne de faire cette étape.
Le fournisseur est github (par défaut), gitlab ou bitbucket. Utilisez --no-open pour afficher l’URL de connexion sans ouvrir de navigateur. --json affiche aussi les informations de connexion à transmettre, sans ouvrir de navigateur. Après la connexion, exécutez de nouveau status et whoami. Ne mettez pas les identifiants du compte dans un prompt, un rapport ou un fichier source.

​
Planifier la configuration du SDK

Placez-vous dans le répertoire qui contient le manifeste de paquet ou de build de l’application. Dans un monorepo, choisissez une seule application ou un seul service. Puis exécutez :
Lisez detected, install_ready, install_plan et next. Le plan indique le runtime, le framework, le gestionnaire de paquets et la commande d’installation. La CLI n’installe aucun paquet et ne modifie aucun fichier. logbrew init, install, configure et sdk donnent le même plan.
Mettez une clé d’ingestion de projet dans la configuration du SDK. N’utilisez jamais un identifiant de compte comme clé SDK. Gardez les clés d’ingestion hors du dépôt de code.
Pour les étapes propres à chaque runtime, consultez Intégration du SDK. Exécutez logbrew examples pour obtenir une courte liste des commandes courantes.

​
Lire, créer et configurer des projets

Listez les projets actifs de votre compte :
Choisissez un ID de projet dans le résultat. Utilisez-le pour les clés et les lectures. Pour créer une clé d’ingestion pour un projet existant, choisissez un nouveau fichier hors du dépôt de code. La CLI écrit la clé dans ce fichier, lisible uniquement par son propriétaire. Elle n’affiche ni la clé ni le chemin du fichier.
Le résultat JSON contient status, project_id, ingest_key, checks et next. ingest_key contient les champs id, label, kind, created_at et expires_at de la clé. Pour remplacer une clé, consultez Renouveler une clé d’ingestion. Cette commande crée un identifiant. Avant de l’exécuter, vérifiez que le projet est le bon. Si le résultat est incertain, exécutez de nouveau la même commande. La CLI réutilise alors la tentative en attente. Utilisez --abandon-retry uniquement pour démarrer une nouvelle tentative. Pour créer un nouveau projet, suivez le démarrage rapide. Il utilise logbrew projects create "<name>" --ingest-key-file "<private_key_file>", qui enregistre la première clé de la même façon. Exécutez logbrew setup --create-project pour lire l’aide sur la création de projet. Cette commande ne crée pas de projet. Après une étape de configuration, vous pouvez l’enregistrer pour le projet. La valeur de --source est api, cli ou sdk :
Lisez ensuite l’état de préparation du projet :
Le code de sortie 0 ne signifie pas que toutes les vérifications ont réussi. Lisez le status du rapport et chaque vérification. Consultez la référence du rapport de diagnostic.

​
Lire l’utilisation du compte

Lisez l’utilisation et les limites. Cette lecture ne modifie ni le compte ni la facturation.
logbrew account usage --json donne le même résultat. La réponse indique le forfait, l’état du quota, la date de réinitialisation, les totaux d’utilisation par projet et par type de télémétrie, ainsi qu’une étape suivante. Les champs comprennent plan, state, reset_at, by_project, by_stream et next.

​
Investigations courantes

Filtrez chaque lecture par projet. Ajoutez des filtres de version, d’environnement, de période ou de gravité quand la commande les prend en charge. Consultez Filtres.

Problèmes d’une version

Une requête en échec

Logs d’une version

Problèmes qui vous sont attribués

​
Suivre les événements en direct

Utilisez la commande watch pour voir les nouveaux événements pendant que vous testez une modification. Appuyez sur Ctrl+C pour l’arrêter.
Watch diffuse uniquement du JSON. Sans --json, la commande s’arrête avec une erreur. Ajoutez logs, issues ou actions pour suivre un seul type, par exemple logbrew watch logs --json. Watch ne prend en charge ni les traces ni les spans. Watch n’a pas de filtre de projet, de version ni d’environnement. Pour un seul projet, utilisez les lectures ci-dessus. Pour les ressources et les filtres pris en charge, consultez Suivi en direct.

​
Obtenir une explication avant de modifier le code

Lisez le contexte avant de proposer un correctif.
1

Lire le problème

2

Lire la trace

Faites cette étape seulement si le problème a un ID de trace. Un problème sans trace reste valide.
3

Lire l’explication

Pour un log, utilisez logbrew explain log "<log_id>" --json. Pour une action, utilisez logbrew explain action "<action_id>" --json.
4

Résoudre après vérification

Pour modifier le statut, la priorité ou le responsable de nombreux problèmes, consultez Modifier le statut et la priorité des problèmes et le workflow des problèmes.

​
Sortie JSON

  • Placez --json avant ou après la commande, par exemple logbrew --json status ou logbrew status --json.
  • Lisez le code de sortie avant d’utiliser la sortie.
  • Les erreurs JSON contiennent ok, error, message et next. Un délai dépassé ne prouve pas qu’une écriture a échoué. Avant de répéter une écriture, lisez ses règles de nouvelle tentative.
  • N’automatisez rien avec une sortie sans --json. Elle peut changer.
Pour les codes de sortie et des exemples d’erreurs, consultez Lire les résultats et les erreurs.