Skip to content

warleymendeslopes/DevDoctor

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DevDoctor CLI

npm License: MIT Node

DevDoctor é um wrapper de linha de comando que executa seus comandos (build, testes, scripts) e, quando algo falha, explica o erro em linguagem simples com IA — sem copiar stack trace para o navegador.

Em uma frase: ele não substitui um agente que edita seu repositório (tipo Cursor/Warp); ele captura a falha do terminal, opcionalmente resume o contexto do projeto e pede uma explicação estruturada ao provedor que você escolher (OpenAI, Gemini ou Ollama local).

English: see README.en.md.

Por que usar

  • Menos atrito mental: saída original continua no stdout/stderr; a análise aparece ao final (ou depois, com devdoctor explain).
  • Privacidade configurável: sanitização básica antes do envio, modo --preview para ver o que seria enviado, confirmação opcional com DEVDOCTOR_CONFIRM_SEND=1.
  • Custo sob controle: use Ollama para não mandar nada para a nuvem; ou use APIs pagas quando quiser qualidade máxima.

Instalação

Uso global (recomendado)

npm install -g devdoctor-cli

A partir do código

git clone https://github.com/warleymendeslopes/DevDoctor.git
cd DevDoctor
npm install
npm link

Requer Node.js 18+.

Quickstart

devdoctor setup
devdoctor npm run build

Se houver erro reconhecido, o DevDoctor tenta explicar ao final. Para ver o que seria enviado sem chamar a API:

devdoctor --preview npm test

Para não chamar a IA mas ainda guardar a falha (útil em comandos lentos):

devdoctor --no-ai npm run e2e
devdoctor explain

Comandos

Comando Descrição
devdoctor setup Configura OpenAI, Gemini ou Ollama (~/.devdoctor/config.json)
devdoctor <cmd> Executa o comando e analisa erros ao detectar falha
devdoctor explain Explica a última falha salva (sem rerodar o comando)

Flags globais (antes do comando)

Flag Efeito
--preview Imprime o texto sanitizado que seria enviado; não chama a IA
--no-ai Não chama a IA; ainda salva a falha para explain
--yes / -y Confirma envio quando DEVDOCTOR_CONFIRM_SEND=1

Separe o comando com -- se precisar: devdoctor --preview -- npm run build.

Variáveis de ambiente

Variável Efeito
DEVDOCTOR_CONFIRM_SEND=1 Pede confirmação antes de enviar ao provedor (use com --yes em CI)
OPENAI_API_KEY, GEMINI_API_KEY / GOOGLE_API_KEY, GEMINI_MODEL Sobrescrevem config (OpenAI / Gemini)
OLLAMA_BASE_URL, OLLAMA_MODEL Sobrescrevem config do Ollama

Contexto do projeto (opcional)

  • É lido um resumo do package.json (nome, scripts, engines).
  • Opcional: crie .devdoctor/context.md na raiz do projeto (regras do time, gerenciador de pacotes, versão de Node, etc.). O conteúdo é truncado para limitar tokens.

Privacidade e segurança

  • O DevDoctor envia ao provedor apenas o trecho de erro analisado, depois de sanitização heurística (ex.: padrões de chaves API, Bearer, blocos PEM, trechos muito longos estilo base64).
  • Isso não substitui revisão humana em ambientes com dados sensíveis: use --preview, --no-ai, Ollama local ou políticas internas.
  • Não coloque segredos em logs de build; mesmo sanitizado, o ideal é não vazar.

Limitações

  • Depende da qualidade do modelo (modelos Ollama pequenos podem ser superficiais).
  • A detecção de erro é heurística (parser.js); casos exóticos podem não disparar análise.
  • Não inspeciona o repositório inteiro como uma IDE; contexto é resumido por design.
  • Pode adicionar latência ao final do comando quando a IA é chamada.

Comparação rápida

Fluxo DevDoctor
Copiar erro → colar no chat Automatiza captura + formato + contexto mínimo
Agente que edita arquivos Fora de escopo; foco é explicar a falha

Roadmap (ideias)

  • Mais testes de regressão para formatos de erro comuns (npm, jest, tsc, etc.).
  • Melhorias contínuas na sanitização e no preview.
  • Opcional: cache por assinatura de erro.

Contribuindo

Issues e PRs são bem-vindos: github.com/warleymendeslopes/DevDoctor/issues.

Licença

MIT — veja LICENSE.

Créditos

Provedores: OpenAI, Google AI, Ollama.

About

DevDoctor CLI executa seus comandos normalmente, detecta erros no terminal e usa IA para gerar explicações claras, causas prováveis e soluções práticas. Suporta OpenAI, Gemini e Ollama para acelerar o debug no dia a dia.

Resources

License

Contributing

Stars

Watchers

Forks

Packages

 
 
 

Contributors