RepoSherlock

Anglais | Türkçe

Déposez une URL de dépôt GitHub ou un chemin local et obtenez l'architecture, les conseils d'exécution, les risques et les problèmes exploitables.

Aperçu en direct de l'interface en ligne de commande

Pourquoi RepoSherlock

• Avant d'exécuter : comprenez l'architecture.
• Avant de faire confiance : voyez les risques de sécurité et de licence.
• Avant de perdre du temps : commencez par des commandes vérifiées.

Qu'est-ce qui le rend différent ?

RepoSherlock ne se contente pas de deviner les commandes. Avec --try-run, il tente les étapes d'installation/test/construction/démarrage dans un bac à sable et enregistre les preuves (signaux, délais d'attente et notes) dans le rapport d'exécution.

Ce qu'il fait

RepoSherlock analyse un dépôt GitHub public ou un chemin de projet local et écrit un ensemble de rapports dans :

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

Le répertoire d'exécution par défaut est basé sur l'horodatage (par exemple : 20260208-103104).

Les artefacts incluent :

• 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 (uniquement avec --try-run)
• pr_draft.md (uniquement avec ou le profil complet Sherlock de l'assistant)

Lorsque le raffinement LLM est activé, des variantes supplémentaires sont émises :

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

Exemple de sortie (court)

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

Installation

Bun (recommandé) :

bun install
bun run build

Alternative Node :

npm install
npm run build

Démarrage rapide

Saisie minimale (assistant interactif) :

bun run sherlock

Analyser un dépôt :

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

Analyser un chemin local :

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

Ouvrir le résumé pour une exécution existante :

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

Vérifier la chaîne d'outils locale :

bun run sherlock -- doctor

Mode démo de l'interface utilisateur :

bun run sherlock -- ui-demo

Alternative Node (si vous n'utilisez pas Bun) :

npm run sherlock

Cas d'utilisation courants

• Rejoindre une nouvelle base de code : obtenez rapidement un démarrage rapide exécutable et les points chauds de l'architecture.
• Audit rapide : examinez la licence, l'intégration continue, les motifs de secrets et les risques de dépendance en un seul passage.
• Tri des mainteneurs : générez des problèmes exploitables et des candidats de bon premier problème.
• Évaluation des dépendances : inspectez un dépôt public avant de l'adopter.

Configuration

Le flux de travail de l'interface en ligne de commande RepoSherlock s'exécute avec le raffinement LLM activé dans la version actuelle. L'analyse déterministe est toujours produite et sauvegardée conjointement avec les sorties raffinées par LLM.

Pour les fournisseurs qui nécessitent des identifiants (OpenAI, Gemini, Anthropic, Grok, compatible OpenAI), définissez :

export LLM_API_KEY="..."

Optionnel :

• LLM_MODEL
• LLM_BASE_URL

Vous pouvez également définir le fournisseur/modèle/clé dans l'assistant interactif et stocker la clé dans :

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

Comment ça fonctionne (haut niveau)

RepoSherlock analyse la structure du dépôt et les fichiers clés, construit un graphe de modules local, extrait les signaux d'exécution/environnement/risque, exécute éventuellement un essai en bac à sable, puis écrit un ensemble de rapports. Lorsque le raffinement LLM est activé, il réécrit les sorties déterministes pour plus de clarté sans modifier les commandes et les faits découverts.

Remarques

• Les exemples d'interface en ligne de commande utilisent un nom de commande cohérent : sherlock.
• L'entrée peut être une URL de dépôt GitHub ou un chemin de répertoire local existant.
• Les rapports sont heuristiques ; vérifiez avant une utilisation en production.
• Les secrets sont expurgés dans les sorties humaines.
• L'essai est facultatif (--try-run) et exécuté avec des délais d'attente et des limites de sortie.

Développement

bun test
# ou
npm test

Licence

MIT