OpenBug CLI

¿Qué es OpenBug CLI?

OpenBug CLI es una herramienta inteligente de línea de comandos para depurar aplicaciones en ejecución con asistencia de IA. Combina un asistente de terminal interactivo con un clúster local que captura logs mientras ejecutas tus servicios, y luego usa esos logs y tu código para responder preguntas de depuración.

El propósito principal es reducir el cambio de contexto entre el comportamiento en tiempo de ejecución (logs) y el código fuente. En lugar de buscar manualmente en múltiples terminales y archivos, puedes hacer preguntas sobre lo que está pasando y que el CLI correlacione los logs relevantes con el código al que tiene acceso localmente.

Características clave

• Asistente de IA interactivo en terminal (debug): Inicia el asistente en una terminal y úsalo para preguntar sobre problemas mientras tus servicios se ejecutan.
• Captura y streaming automático de logs: Cuando ejecutas tus servicios con debug <command>, OpenBug transmite los logs al clúster local para usarlos en las respuestas de IA.
• Búsqueda de código en lenguaje natural en el codebase local: El asistente puede buscar en tu codebase en respuesta a preguntas como dónde se implementa un comportamiento dado.
• Depuración multi-servicio vía clúster local compartido: Ejecuta diferentes servicios en terminales separados; todos se conectan al mismo clúster para que la IA rastree problemas en toda tu pila.
• Acceso local prioritario y compartición selectiva de datos: El codebase se accede localmente y no se sube; solo se envían fragmentos específicos que la IA consulta al servidor, y los logs se transmiten solo cuando son necesarios para responder.
• Solicitudes autenticadas con clave API personal: El CLI autentica las solicitudes con tu clave API (como se describe en el flujo de configuración).

Cómo usar OpenBug CLI

1. Instala el CLI con:

   npm install -g @openbug/cli
   

2. Inicia el asistente de IA en la Terminal 1:

   debug
   

   Se te pedirá que inicies sesión y pegues una clave API de la app OpenBug.
3. Ejecuta tus servicios con depuración habilitada en otras terminales. Ejemplos del repositorio:

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

4. Haz preguntas de depuración en la Terminal 1 mientras tus servicios están en ejecución. El asistente analiza los logs capturados y busca en tu codebase para ofrecer insights precisos.

Si estás probando sin configuración, el proyecto también ofrece una demo interactiva que guía a través de la depuración de tres bugs realistas.

Casos de uso

• Diagnosticar por qué falla un endpoint en desarrollo local: Pregunta, por ejemplo, “¿Por qué falla la autenticación?” mientras tu backend está en ejecución; el asistente puede referenciar logs relevantes y localizar la lógica de validación relacionada.
• Rastrear problemas entre múltiples servicios: Ejecuta un backend y frontend (o múltiples servicios backend) en terminales separados con debug ...; la IA puede usar logs de múltiples servicios para explicar cómo se propaga un error.
• Encontrar puntos de implementación para un comportamiento desconocido: Usa preguntas en lenguaje natural como “¿Dónde manejamos los webhooks de pago?” para que el asistente busque en el repositorio local dónde se implementa el comportamiento.
• Investigar inconsistencias de datos vistas en tiempo de ejecución: Cuando los logs sugieren esquemas desajustados o errores de configuración, pide a la IA que correlacione líneas de log con los caminos de código relevantes.
• Depurar codebases desconocidos sin depender de búsquedas en internet: El asistente busca en el codebase local real en lugar de buscar en internet guías genéricas.

Preguntas frecuentes

• ¿OpenBug sube todo mi codebase? No. La documentación indica que tu codebase se accede localmente y nunca se sube; solo se envían fragmentos de código específicos que la IA consulta al servidor.

• ¿Cuándo envía OpenBug los logs al servidor? Los logs se transmiten al servidor solo cuando la IA los necesita para responder tus preguntas.

• ¿Cómo soporta OpenBug la depuración entre múltiples servicios? Usando un clúster local compartido: ejecutas múltiples servicios en terminales diferentes con debug <command>, y todos se conectan al mismo clúster para que la IA correlacione logs en toda la pila.

• ¿Puedo autoalojar el servidor de OpenBug? Sí. El repositorio describe un enfoque de autoalojamiento: clona el repositorio del servidor, configúralo con tu clave API de OpenAI, luego apunta el CLI a tu servidor vía variables de entorno como WEB_SOCKET_URL y API_BASE_URL.

Alternativas

• Depuración local con logs + búsqueda de texto (p. ej., grep/ripgrep) + herramientas de IDE: Entradas similares (logs y código fuente), pero el flujo de trabajo depende de correlación y navegación manual en lugar de una interfaz conversacional asistida por IA.
• Plataformas de rendimiento/observabilidad de aplicaciones (logs y paneles de trazado): Útiles para ver y consultar datos de ejecución, pero normalmente no ofrecen depuración en lenguaje natural consciente del código desde tu repositorio local.
• Asistentes de código con IA enfocados en Q&A de repositorios (sin captura de logs en tiempo de ejecución): Pueden responder preguntas sobre la estructura del código, pero no capturan automáticamente logs de servicios en ejecución para fundamentar las respuestas en el comportamiento en tiempo de ejecución.