RepoSherlock

Inglês | Türkçe

Insira uma URL de repositório do GitHub ou um caminho local e obtenha arquitetura, orientação de execução, riscos e problemas acionáveis.

Pré-visualização ao Vivo da CLI

Por que RepoSherlock

• Antes de executar: entenda a arquitetura.
• Antes de confiar: veja riscos de segurança e licença.
• Antes de perder tempo: comece com comandos verificados.

O que o torna diferente?

O RepoSherlock não apenas adivinha comandos. Com --try-run, ele tenta executar etapas de instalação/teste/construção/inicialização em um sandbox e registra evidências (sinais, timeouts e notas) no relatório de execução.

O que ele faz

O RepoSherlock analisa um repositório público do GitHub ou um caminho de projeto local e escreve um pacote de relatório em:

• .reposherlock/output/<run-dir>/

O diretório de execução padrão é baseado em timestamp (por exemplo: 20260208-103104).

Os artefatos incluem:

• report.md / report.json
• architecture.mmd / architecture.json
• risks.md / risks.json
• issues.json
• issues.good-first.md / issues.good-first.json
• README_2.0.md
• run_attempt.md / run_attempt.json (only with --try-run)
• pr_draft.md (only with or wizard Full Sherlock profile)

Quando o polimento LLM está habilitado, variantes adicionais são emitidas:

• README_2.0.deterministic.md / README_2.0.llm.md
• issues.deterministic.json / issues.llm.json
• report.deterministic.md / report.llm.md

Exemplo de saída (curto)

Run Plan
Target: https://github.com/octocat/Hello-World
Try-Run: enabled

Sherlock Thinking
✓ Validating repository target and runtime profile
✓ Planning scan strategy and safe execution path
✓ Preparing architecture, risk, and issue synthesis

Summary
Repo type: web
Risks: high=0, med=1, low=0
Output: .reposherlock/output/20260208-103104

Instalação

Bun (recomendado):

bun install
bun run build

Alternativa com Node:

npm install
npm run build

Início rápido

Digitação mínima (assistente interativo):

bun run sherlock

Analisar um repositório:

bun run sherlock -- analyze https://github.com/octocat/Hello-World --try-run

Analisar um caminho local:

bun run sherlock -- analyze . --no-network --try-run

Abrir resumo para uma execução existente:

bun run sherlock -- report .reposherlock/output/<run-dir>

Verificar ferramentas locais:

bun run sherlock -- doctor

Modo de demonstração da interface:

bun run sherlock -- ui-demo

Alternativa com Node (se você não usar Bun):

npm run sherlock

Casos de uso comuns

• Entrando em uma nova base de código: obtenha um início rápido executável e pontos críticos de arquitetura rapidamente.
• Auditoria rápida: revise licença, CI, padrões de segredos e riscos de dependência em uma única passagem.
• Triagem de mantenedor: gere problemas acionáveis e candidatos a issues para iniciantes.
• Avaliação de dependências: inspecione um repositório público antes de adotá-lo.

Configuração

O fluxo de trabalho da CLI do RepoSherlock é executado com o polimento LLM habilitado na versão atual. A análise determinística ainda é produzida e salva junto com as saídas polidas por LLM.

Para provedores que exigem credenciais (OpenAI, Gemini, Anthropic, Grok, compatível com OpenAI), defina:

export LLM_API_KEY="..."

Opcional:

• LLM_MODEL
• LLM_BASE_URL

Você também pode definir provedor/modelo/chave no assistente interativo e armazenar a chave em:

• ~/.reposherlock/credentials.json (chmod 600)

Como funciona (alto nível)

O RepoSherlock escaneia a estrutura do repositório e arquivos-chave, constrói um grafo de módulo local, extrai sinais de tempo de execução/ambiente/risco, opcionalmente executa uma execução de teste em sandbox e, em seguida, escreve um pacote de relatório. Quando o polimento LLM está habilitado, ele reescreve as saídas determinísticas para maior clareza, sem alterar comandos e fatos descobertos.

Notas

• Os exemplos da CLI usam um nome de comando consistentemente: sherlock.
• A entrada pode ser uma URL de repositório do GitHub ou um caminho de diretório local existente.
• Os relatórios são heurísticos; verifique antes do uso em produção.
• Segredos são ocultados nas saídas para humanos.
• O try-run é opcional (--try-run) e executado com tempos limite e limites de saída.

Desenvolvimento

bun test
# or
npm test

Licença

MIT