इस प्रोजेक्ट के बारे में

ggshield GitGuardian का एक कमांड-लाइन एप्लिकेशन है जो आपके कोड में हार्डकोडेड सीक्रेट्स का पता लगाने के लिए है। यह स्थानीय रूप से या CI में चलता है और 500 से अधिक सीक्रेट प्रकारों को कवर करता है, py-gitguardian क्लाइंट के माध्यम से GitGuardian के सार्वजनिक API का उपयोग करके फाइलों और अन्य टेक्स्ट सामग्री को स्कैन करता है। README से गोपनीयता नोट: स्कैन से केवल मेटाडेटा जैसे कॉल समय, अनुरोध आकार और स्कैन मोड संग्रहीत किया जाता है, इसलिए सीक्रेट्स आपके डैशबोर्ड पर नहीं दिखाए जाते हैं और फाइलें और सीक्रेट्स संग्रहीत नहीं होते हैं। इंस्टॉलेशन विकल्प व्यापक हैं: Linux/macOS और Windows PowerShell के लिए अनुशंसित इंस्टॉल स्क्रिप्ट, macOS पर Homebrew, Cloudsmith के माध्यम से स्टैंडअलोन .pkg, Deb और RPM पैकेज, Windows पर Chocolatey और MSI इंस्टॉलर, स्टैंडअलोन .zip, और pipx (अनुशंसित) या pip के माध्यम से PyPI। स्टैंडअलोन पैकेज Python इंस्टॉल करने की आवश्यकता से बचते हैं लेकिन मैन्युअल अपडेट की आवश्यकता होती है। सेटअप के लिए GitGuardian सर्वर के खिलाफ प्रमाणीकरण आवश्यक है। `ggshield auth login` कमांड एक व्यक्तिगत एक्सेस टोकन प्रदान करता है और इसे स्थानीय रूप से कॉन्फ़िगर करता है; वैकल्पिक रूप से आप मैन्युअल रूप से टोकन बना सकते हैं और `GITGUARDIAN_API_KEY` पर्यावरण चर सेट कर सकते हैं। एक पुराने `.gitguardian.yaml` कॉन्फ़िगरेशन को `ggshield config migrate` के साथ माइग्रेट किया जा सकता है, जो `.old` बैकअप रखता है। स्कैनिंग लक्ष्यों में फाइलें (`ggshield secret scan path -r .`), रिपॉजिटरी (`ggshield secret scan repo .`), Docker इमेज (docker कमांड की आवश्यकता होती है) और PyPI पैकेज (pip की आवश्यकता होती है) शामिल हैं। README पूरी सूची के लिए `ggshield secret scan --help` की ओर इशारा करता है। इंटीग्रेशन CI/CD वर्कफ़्लो और Git हुक (pre-commit, pre-push, pre-receive) को कवर करते हैं ताकि सीक्रेट्स संस्करण नियंत्रण तक पहुंचने से पहले पकड़े जा सकें। विशेष रूप से, ggshield AI कोडिंग असिस्टेंट के साथ इंटरैक्शन को वास्तविक समय में स्कैन कर सकता है और सीक्रेट्स वाले कार्यों को निष्पादित होने से पहले ब्लॉक कर सकता है; समर्थित टूल में Cursor, Claude Code, Copilot Chat, Codex और Mistral Vibe 2.21+ शामिल हैं। हुक `ggshield install` के साथ स्थापित किए जाते हैं। आउटपुट व्यवहार: जब कोई सीक्रेट नहीं मिलता है तो निकास कोड 0 होता है। जब कोई सीक्रेट मिलता है, तो टूल फ़ाइल नाम की रिपोर्ट करता है और सीक्रेट की स्थिति दर्शाने वाला एक पैच दिखाता है, लंबी लाइनें ट्रंकेटेड होती हैं जब तक कि वर्बोज़ मोड (`-v` या `--verbose`) का उपयोग न किया जाए। README संबंधित ओपन सोर्स प्रोजेक्ट्स (truffleHog, gitleaks, gitrob, git-hound, AWS git-secrets, detect-secrets) भी सूचीबद्ध करता है और बताता है कि प्रोजेक्ट MIT लाइसेंस प्राप्त है। एक macOS नोट चेतावनी देता है कि 1.54.0 में अपग्रेड करने से `ggshield-py` के लिए Keychain प्रॉम्प्ट ट्रिगर होता है, जो प्रदर्शन सुधारों के हिस्से के रूप में सहेजे गए टोकन को पढ़ने वाला दूसरा बाइनरी है; उपयोगकर्ताओं को Always Allow पर क्लिक करना चाहिए।