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, गुप्त पैटर्न और निर्भरता जोखिमों की समीक्षा करें।
• रखरखावकर्ता ट्राइएज: कार्रवाई योग्य मुद्दे और अच्छे-पहले मुद्दे के उम्मीदवार उत्पन्न करें।
• निर्भरता मूल्यांकन: अपनाने से पहले एक सार्वजनिक रिपॉजिटरी का निरीक्षण करें।

कॉन्फ़िगरेशन

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 उदाहरण एक ही कमांड नाम का लगातार उपयोग करते हैं: sherlock।
• इनपुट एक GitHub रिपॉजिटरी URL या मौजूदा स्थानीय निर्देशिका पथ हो सकता है।
• रिपोर्ट अनुमानित हैं; उत्पादन उपयोग से पहले सत्यापित करें।
• मानव आउटपुट में रहस्यों को संपादित किया जाता है।
• ट्राई-रन ऑप्ट-इन (--try-run) है और टाइमआउट/आउटपुट कैप के साथ निष्पादित किया जाता है।

विकास

bun test
# या
npm test

लाइसेंस

MIT