OpenBug CLI

O que é OpenBug CLI?

OpenBug CLI é uma ferramenta de linha de comando inteligente para depurar aplicações em execução com assistência de IA. Ela combina um assistente de terminal interativo com um cluster local que captura logs enquanto você executa seus serviços, usando esses logs e seu código-fonte para responder perguntas de depuração.

O propósito principal é reduzir a alternância de contexto entre comportamento em tempo de execução (logs) e código-fonte. Em vez de fazer grep manual em vários terminais e arquivos, você pode fazer perguntas sobre o que está acontecendo e o CLI correlaciona os logs relevantes com o código acessível localmente.

Principais Recursos

• Assistente de IA interativo no terminal (debug): Inicie o assistente em um terminal e use-o para fazer perguntas sobre problemas enquanto seus serviços executam.
• Captura e streaming automático de logs: Ao executar seus serviços com debug <command>, o OpenBug transmite logs para o cluster local para uso nas respostas de IA.
• Busca de código em linguagem natural no codebase local: O assistente pode buscar no seu codebase em resposta a perguntas como onde um comportamento específico é implementado.
• Depuração multi-serviço via cluster local compartilhado: Execute serviços diferentes em terminais separados; todos se conectam ao mesmo cluster para que a IA rastreie problemas em toda a stack.
• Acesso local-first e compartilhamento seletivo de dados: O codebase é acessado localmente e não enviado; apenas trechos específicos consultados pela IA são enviados ao servidor, e logs são transmitidos apenas quando necessários para responder.
• Requisições autenticadas com chave de API pessoal: O CLI autentica requisições com sua chave de API (conforme descrito no fluxo de setup).

Como Usar o OpenBug CLI

1. Instale o CLI com:

   npm install -g @openbug/cli
   

2. Inicie o assistente de IA no Terminal 1:

   debug
   

   Você será solicitado a fazer login e colar uma chave de API do app OpenBug.
3. Execute seus serviços com depuração ativada em outros terminais. Exemplos do repositório:

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

4. Faça perguntas de depuração no Terminal 1 enquanto seus serviços executam. O assistente analisa os logs capturados e busca no seu codebase para fornecer insights direcionados.

Se você estiver testando sem setup, o projeto também oferece uma demo interativa que guia pela depuração de três bugs realistas.

Casos de Uso

• Diagnosticar por que um endpoint falha no desenvolvimento local: Pergunte, por exemplo, “Por que a autenticação está falhando?” enquanto o backend executa; o assistente pode referenciar logs relevantes e localizar a lógica de validação relacionada.
• Rastrear problemas entre múltiplos serviços: Execute backend e frontend (ou múltiplos serviços backend) em terminais separados com debug ...; a IA pode usar logs de múltiplos serviços para explicar como um erro se propaga.
• Encontrar pontos de implementação para um comportamento desconhecido: Use perguntas em linguagem natural como “Onde tratamos webhooks de pagamento?” para que o assistente busque no repositório local onde o comportamento é implementado.
• Investigar inconsistências de dados vistas em tempo de execução: Quando logs sugerem esquemas incompatíveis ou erros de configuração, peça à IA para correlacionar linhas de log com caminhos de código relevantes.
• Depurar codebases desconhecidos sem depender de busca na internet: O assistente busca no codebase local real em vez de procurar na internet por orientações genéricas.

FAQ

• O OpenBug envia meu codebase inteiro? Não. A documentação afirma que seu codebase é acessado localmente e nunca enviado; apenas trechos de código específicos consultados pela IA são enviados ao servidor.

• Quando o OpenBug envia logs ao servidor? Logs são transmitidos ao servidor apenas quando a IA precisa deles para responder suas perguntas.

• Como o OpenBug suporta depuração entre múltiplos serviços? Usando um cluster local compartilhado: você executa múltiplos serviços em terminais diferentes com debug <command>, e todos se conectam ao mesmo cluster para que a IA correlacione logs em toda a stack.

• Posso hospedar o servidor OpenBug eu mesmo? Sim. O repositório descreve uma abordagem de auto-hospedagem: clone o repositório do servidor, configure-o com sua chave de API OpenAI, depois aponte o CLI para seu servidor via variáveis de ambiente como WEB_SOCKET_URL e API_BASE_URL.

Alternativas

• Depuração local com logs + busca de texto (ex.: grep/ripgrep) + ferramentas de IDE: Entradas semelhantes (logs e código-fonte), mas o fluxo de trabalho depende de correlação e navegação manuais em vez de uma interface conversacional assistida por IA.
• Plataformas de desempenho/observabilidade de aplicações (logs e painéis de rastreamento): Úteis para visualizar e consultar dados de execução, mas geralmente não oferecem depuração em linguagem natural, consciente do código, a partir do repositório local.
• Assistentes de código com IA focados em perguntas e respostas de repositório (sem captura de logs de execução): Podem responder perguntas sobre a estrutura do código, mas não capturam logs automaticamente de serviços em execução para fundamentar as respostas no comportamento de runtime.