RepoSherlock

英語 | Türkçe

GitHubのリポジトリURLまたはローカルパスを入力すると、アーキテクチャ、実行ガイダンス、リスク、実行可能な課題を取得できます。

ライブCLIプレビュー

RepoSherlockの利点

• 実行前に：アーキテクチャを理解。
• 信頼する前に：セキュリティとライセンスのリスクを確認。
• 時間を無駄にする前に：検証済みコマンドから開始。

何が違うのか？

RepoSherlockはコマンドを推測するだけではありません。--try-runを使用すると、サンドボックス内でインストール/テスト/ビルド/開始の手順を試行し、実行レポートに証拠（シグナル、タイムアウト、メモ）を記録します。

何をするのか

RepoSherlockは公開GitHubリポジトリまたはローカルプロジェクトパスを分析し、以下の場所にレポートバンドルを書き込みます：

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

デフォルトの実行ディレクトリはタイムスタンプベースです（例：20260208-103104）。

生成物は以下を含みます：

• 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（--try-runが指定された場合のみ）
• pr_draft.md（またはウィザードのFull Sherlockプロファイルで指定された場合のみ）

LLMポリッシュが有効な場合、以下の追加バリアントが出力されます：

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

サンプル出力（短縮版）

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

インストール

Bun（推奨）：

bun install
bun run build

Nodeフォールバック：

npm install
npm run build

クイックスタート

最小限の入力（対話型ウィザード）：

bun run sherlock

リポジトリを分析：

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

ローカルパスを分析：

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

既存の実行の概要を開く：

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

ローカルツールチェーンを確認：

bun run sherlock -- doctor

UIデモモード：

bun run sherlock -- ui-demo

Nodeフォールバック（Bunを使用しない場合）：

npm run sherlock

よくあるユースケース

• 新しいコードベースに参加する：実行可能なクイックスタートとアーキテクチャのホットスポットを素早く取得。
• クイック監査：ライセンス、CI、シークレットパターン、依存関係のリスクを1回のパスで確認。
• メンテナーによるトリアージ：実行可能な課題とgood-first issue候補を生成。
• 依存関係の評価：採用前に公開リポジトリを検査。

設定

RepoSherlock CLIワークフローは、現在のリリースではLLMポリッシュが有効になっています。 決定論的分析も引き続き生成され、LLMポリッシュ後の出力と一緒に保存されます。

認証情報が必要なプロバイダー（OpenAI、Gemini、Anthropic、Grok、OpenAI互換）の場合は、以下を設定：

export LLM_API_KEY="..."

オプション：

• LLM_MODEL
• LLM_BASE_URL

対話型ウィザードでプロバイダー/モデル/キーを設定し、以下の場所にキーを保存することもできます：

• ~/.reposherlock/credentials.json（chmod 600）

動作の仕組み（概要）

RepoSherlockはリポジトリ構造と主要ファイルをスキャンし、ローカルモジュールグラフを構築し、ランタイム/環境/リスクシグナルを抽出し、オプションでサンドボックスのトライランを実行し、その後レポートバンドルを書き込みます。LLMポリッシュが有効な場合、発見されたコマンドや事実を変更せずに、決定論的出力を明瞭にするために書き換えます。

注意事項

• CLI例では一貫して1つのコマンド名sherlockを使用しています。
• 入力はGitHubリポジトリURLまたは既存のローカルディレクトリパスのいずれかです。
• レポートはヒューリスティックに基づいています。本番環境で使用する前に検証してください。
• シークレットは人間向け出力では編集されます。
• トライランはオプトイン（--try-run）であり、タイムアウトと出力上限が設定されて実行されます。

開発

bun test
# or
npm test

ライセンス

MIT