OpenBug CLI

Qu'est-ce qu'OpenBug CLI ?

OpenBug CLI est un outil en ligne de commande intelligent pour déboguer des applications en cours d'exécution avec l'assistance de l'IA. Il associe un assistant de terminal interactif à un cluster local qui capture les logs pendant l'exécution de vos services, puis utilise ces logs et votre codebase pour répondre aux questions de débogage.

L'objectif principal est de réduire les changements de contexte entre le comportement d'exécution (logs) et le code source. Au lieu de parcourir manuellement plusieurs terminaux et fichiers avec grep, vous pouvez poser des questions sur ce qui se passe et laisser le CLI corréler les logs pertinents avec le code accessible localement.

Fonctionnalités principales

• Assistant IA de terminal interactif (debug) : Lancez l'assistant dans un terminal et posez-lui des questions sur les problèmes pendant l'exécution de vos services.
• Capture et streaming automatique des logs : Lorsque vous exécutez vos services avec debug <command>, OpenBug transmet les logs au cluster local pour les utiliser dans les réponses IA.
• Recherche de code en langage naturel dans la codebase locale : L'assistant peut fouiller votre codebase en réponse à des questions comme l'endroit où un comportement donné est implémenté.
• Débogage multi-services via un cluster local partagé : Exécutez différents services dans des terminaux séparés ; tous se connectent au même cluster pour que l'IA puisse tracer les problèmes à travers votre stack.
• Accès local prioritaire et partage sélectif de données : La codebase est accédée localement sans téléversement ; seuls les extraits spécifiques demandés par l'IA sont envoyés au serveur, et les logs ne sont transmis que si nécessaire.
• Requêtes authentifiées avec une clé API personnelle : Le CLI authentifie les requêtes avec votre clé API (comme décrit dans le flux d'installation).

Comment utiliser OpenBug CLI

1. Installez le CLI avec :

   npm install -g @openbug/cli
   

2. Démarrez l'assistant IA dans le Terminal 1 :

   debug
   

   Vous serez invité à vous connecter et à coller une clé API depuis l'application OpenBug.
3. Exécutez vos services avec débogage activé dans d'autres terminaux. Exemples du dépôt :

   debug npm run dev
   debug python app.py
   debug docker-compose up
   

4. Posez des questions de débogage dans le Terminal 1 pendant l'exécution de vos services. L'assistant analyse les logs capturés et recherche dans votre codebase pour fournir des insights ciblés.

Si vous testez sans installation, le projet propose aussi une démo interactive qui guide à travers le débogage de trois bugs réalistes.

Cas d'usage

• Diagnostiquer pourquoi un endpoint échoue en développement local : Demandez par exemple « Pourquoi l'auth échoue ? » pendant l'exécution de votre backend ; l'assistant référence les logs pertinents et localise la logique de validation associée.
• Tracer des problèmes à travers plusieurs services : Exécutez un backend et un frontend (ou plusieurs services backend) dans des terminaux séparés avec debug ... ; l'IA utilise les logs de plusieurs services pour expliquer la propagation d'une erreur.
• Trouver les points d'implémentation d'un comportement inconnu : Utilisez des questions en langage naturel comme « Où gérons-nous les webhooks de paiement ? » pour que l'assistant recherche dans le dépôt local l'implémentation du comportement.
• Enquêter sur des incohérences de données observées à l'exécution : Quand les logs suggèrent des schémas incohérents ou des erreurs de configuration, demandez à l'IA de corréler les lignes de logs avec les chemins de code pertinents.
• Déboguer des codebases inconnues sans recourir à la recherche internet : L'assistant fouille la codebase locale réelle plutôt que de chercher des conseils génériques sur internet.

FAQ

• OpenBug téléverse-t-il toute ma codebase ? Non. La documentation précise que votre codebase est accédée localement et jamais téléversée ; seuls les extraits de code spécifiques demandés par l'IA sont envoyés au serveur.

• Quand OpenBug envoie-t-il les logs au serveur ? Les logs sont transmis au serveur uniquement quand l'IA en a besoin pour répondre à vos questions.

• Comment OpenBug gère-t-il le débogage à travers plusieurs services ? Grâce à un cluster local partagé : vous exécutez plusieurs services dans différents terminaux avec debug <command>, et ils se connectent tous au même cluster pour que l'IA corréle les logs à travers le stack.

• Puis-je auto-héberger le serveur OpenBug ? Oui. Le dépôt décrit une approche d'auto-hébergement : clonez le dépôt du serveur, configurez-le avec votre clé API OpenAI, puis pointez le CLI vers votre serveur via des variables d'environnement comme WEB_SOCKET_URL et API_BASE_URL.

Alternatives

• Débogage local avec logs + recherche textuelle (ex. : grep/ripgrep) + outils IDE : Apports similaires (logs et code source), mais le workflow repose sur une corrélation et navigation manuelles plutôt qu’une interface conversationnelle assistée par IA.
• Plateformes de performance/observabilité d’applications (tableaux de bord logs et traces) : Utiles pour visualiser et interroger les données d’exécution, mais elles ne fournissent généralement pas de débogage en langage naturel, conscient du code, à partir de votre dépôt local.
• Assistants IA pour code axés sur les Q&R de dépôt (sans capture de logs d’exécution) : Ils peuvent répondre à des questions sur la structure du code, mais ne capturent pas automatiquement les logs des services en cours pour ancrer les réponses dans le comportement d’exécution.