RepoSherlock

Englisch | Türkçe

Gib eine GitHub-Repository-URL oder einen lokalen Pfad ein und erhalte Architektur, Ausführungshinweise, Risiken und umsetzbare Probleme.

Live-CLI-Vorschau

Warum RepoSherlock

• Bevor du ausführst: Verstehe die Architektur.
• Bevor du vertraust: Sieh dir Sicherheits- und Lizenzrisiken an.
• Bevor du Zeit verschwendest: Starte mit verifizierten Befehlen.

Was macht es anders?

RepoSherlock rät nicht nur Befehle. Mit --try-run versucht es, Installations-/Test-/Build-/Start-Schritte in einer Sandbox durchzuführen und zeichnet Nachweise (Signale, Timeouts und Notizen) im Ausführungsbericht auf.

Was es tut

RepoSherlock analysiert ein öffentliches GitHub-Repository oder einen lokalen Projektpfad und schreibt ein Berichtsbündel unter:

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

Das Standard-Ausführungsverzeichnis ist zeitstempelbasiert (z. B. 20260208-103104).

Die Artefakte umfassen:

• 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 (nur mit --try-run)
• pr_draft.md (nur mit oder dem Assistenten Full-Sherlock-Profil)

Wenn LLM-Polish aktiviert ist, werden zusätzliche Varianten ausgegeben:

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

Beispielausgabe (kurz)

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 (empfohlen):

bun install
bun run build

Node-Alternative:

npm install
npm run build

Schnellstart

Minimale Eingabe (interaktiver Assistent):

bun run sherlock

Ein Repository analysieren:

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

Einen lokalen Pfad analysieren:

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

Zusammenfassung für eine vorhandene Ausführung öffnen:

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

Lokale Toolchain überprüfen:

bun run sherlock -- doctor

UI-Demo-Modus:

bun run sherlock -- ui-demo

Node-Alternative (falls du Bun nicht verwendest):

npm run sherlock

Häufige Anwendungsfälle

• Einarbeitung in eine neue Codebasis: Erhalte schnell einen ausführbaren Schnellstart und Architektur-Hotspots.
• Schnelles Audit: Überprüfe Lizenz, CI, Geheimnismuster und Abhängigkeitsrisiken in einem Durchgang.
• Maintainer-Triage: Generiere umsetzbare Probleme und Good-First-Issue-Kandidaten.
• Abhängigkeitsbewertung: Untersuche ein öffentliches Repository, bevor du es übernimmst.

Konfiguration

Der RepoSherlock-CLI-Workflow läuft in der aktuellen Version mit aktiviertem LLM-Polish. Die deterministische Analyse wird weiterhin erstellt und zusammen mit den LLM-verfeinerten Ausgaben gespeichert.

Für Anbieter, die Anmeldeinformationen erfordern (OpenAI, Gemini, Anthropic, Grok, OpenAI-kompatibel), setze:

export LLM_API_KEY="..."

Optional:

• LLM_MODEL
• LLM_BASE_URL

Du kannst auch Anbieter/Modell/Schlüssel im interaktiven Assistenten festlegen und den Schlüssel speichern in:

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

So funktioniert es (auf hoher Ebene)

RepoSherlock scannt die Repository-Struktur und wichtige Dateien, erstellt einen lokalen Modulgraphen, extrahiert Laufzeit-/Umgebungs-/Risikosignale, führt optional einen Sandbox-Try-Run aus und schreibt dann ein Berichtsbündel. Wenn LLM-Polish aktiviert ist, werden deterministische Ausgaben zur Klarstellung umgeschrieben, ohne entdeckte Befehle und Fakten zu ändern.

Hinweise

• CLI-Beispiele verwenden durchgängig einen Befehlsnamen: sherlock.
• Die Eingabe kann eine GitHub-Repository-URL oder ein vorhandener lokaler Verzeichnispfad sein.
• Berichte sind heuristisch; vor dem Produktionseinsatz überprüfen.
• Geheimnisse werden in menschenlesbaren Ausgaben geschwärzt.
• Try-Run ist optional (--try-run) und wird mit Timeouts/Ausgabebegrenzungen ausgeführt.

Entwicklung

bun test
# or
npm test

Lizenz

MIT