ggshield: अपने कोड को GitGuardian से सुरक्षित रखें

ggshield एक CLI एप्लिकेशन है जो आपके स्थानीय वातावरण या CI वातावरण में चलता है ताकि आपको 500+ प्रकार के रहस्यों का पता लगाने में मदद मिल सके।

ggshield py-gitguardian के माध्यम से हमारी सार्वजनिक API का उपयोग करके फ़ाइलों और अन्य टेक्स्ट सामग्री में संभावित कमजोरियों को स्कैन और पहचानता है।

ggshield का उपयोग करके स्कैन से केवल मेटाडेटा जैसे कॉल समय, अनुरोध आकार और स्कैन मोड संग्रहीत किया जाता है, इसलिए रहस्य आपके डैशबोर्ड पर प्रदर्शित नहीं होंगे और आपकी फ़ाइलें और रहस्य संग्रहीत नहीं होंगे।

विषयसूची

• इंस्टॉलेशन
  • इंस्टॉल स्क्रिप्ट (अनुशंसित)
  • macOS
    • Homebrew
    • स्टैंडअलोन .pkg पैकेज
  • Linux
    • Deb और RPM पैकेज
  • Windows
    • Chocolatey
    • MSI इंस्टॉलर
    • स्टैंडअलोन .zip आर्काइव
  • सभी ऑपरेटिंग सिस्टम
    • pipx का उपयोग करके
    • pip का उपयोग करके
• प्रारंभिक सेटअप
  • ggshield auth login का उपयोग करके
  • मैन्युअल सेटअप
• शुरू करना
  • रहस्य
  • पुराने कॉन्फ़िगरेशन फ़ाइल को माइग्रेट करना
• एकीकरण
  • AI कोडिंग सहायक
• और अधिक जानें
• आउटपुट
• संबंधित ओपन सोर्स प्रोजेक्ट
• लाइसेंस

इंस्टॉलेशन

इंस्टॉल स्क्रिप्ट (अनुशंसित)

ggshield को इंस्टॉल करने का सबसे तेज़ तरीका।

Linux / macOS:

curl -sSfL \
  https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.sh | bash

Windows (PowerShell):

irm https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1 | iex

या, यदि आप curl पसंद करते हैं (Windows 10+ के साथ बंडल):

curl.exe -sSL https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1 | powershell -NoProfile -ExecutionPolicy Bypass -Command -

स्क्रिप्ट --instance और --plugin (एक प्लगइन इंस्टॉल करना) जैसे विकल्प स्वीकार करती है। EU कार्यक्षेत्र या स्व-होस्टेड उदाहरण के लिए, चलाने से पहले GITGUARDIAN_INSTANCE एनवायरनमेंट वेरिएबल सेट करें (या --instance <URL> पास करें)।

विकल्पों की पूरी सूची, अन्य इंस्टॉल विधियों और अनइंस्टॉल करने के तरीके के लिए scripts/install/README.md देखें।

नीचे दी गई विधियाँ मैन्युअल रूप से CLI इंस्टॉल करती हैं।

macOS

Homebrew

आप Homebrew का उपयोग करके ggshield इंस्टॉल कर सकते हैं:

brew install ggshield

अपग्रेड Homebrew द्वारा संभाला जाता है।

स्टैंडअलोन .pkg पैकेज

वैकल्पिक रूप से, आप ggshield रिलीज़ पृष्ठ से एक स्टैंडअलोन .pkg पैकेज डाउनलोड और इंस्टॉल कर सकते हैं।

यह पैकेज Python इंस्टॉल करने की आवश्यकता नहीं है, लेकिन आपको नए संस्करण मैन्युअल रूप से डाउनलोड करने होंगे।

Linux

Deb और RPM पैकेज

Deb और RPM पैकेज Cloudsmith पर उपलब्ध हैं।

सेटअप निर्देश:

• Deb पैकेज
• RPM पैकेज

अपग्रेड पैकेज मैनेजर द्वारा संभाला जाता है।

Windows

Chocolatey

ggshield Chocolatey पैकेज मैनेजर के माध्यम से उपलब्ध है:

choco install ggshield

MSI इंस्टॉलर

ggshield रिलीज़ पृष्ठ से MSI इंस्टॉलर डाउनलोड करें और इसे इंस्टॉल करें:

msiexec /i ggshield-VERSION-x86_64-pc-windows-msvc.msi

स्टैंडअलोन .zip आर्काइव

हम ggshield रिलीज़ पृष्ठ पर एक स्टैंडअलोन .zip आर्काइव प्रदान करते हैं।

आर्काइव को अपनी डिस्क पर अनपैक करें, फिर ggshield.exe फ़ाइल वाली निर्देशिका को %PATH% में जोड़ें।

यह आर्काइव Python इंस्टॉल करने की आवश्यकता नहीं है, लेकिन आपको नए संस्करण मैन्युअल रूप से डाउनलोड करने होंगे।

सभी ऑपरेटिंग सिस्टम

ggshield को सभी समर्थित ऑपरेटिंग सिस्टम पर इसके PyPI पैकेज के माध्यम से इंस्टॉल किया जा सकता है।

इसके लिए Python का एक समर्थित संस्करण (EOL नहीं) (स्टैंडअलोन पैकेज को छोड़कर) और git आवश्यक है।

यदि आप ggshield के हमारे पैकेज्ड संस्करणों का उपयोग नहीं करते हैं, तो कृपया ध्यान दें कि हम Python रिलीज़ चक्र का पालन करते हैं और EOL तक पहुंच चुके संस्करणों का समर्थन नहीं करते हैं।

pipx का उपयोग करके

PyPI से ggshield इंस्टॉल करने का अनुशंसित तरीका pipx का उपयोग करना है, जो इसे एक पृथक वातावरण में इंस्टॉल करेगा:

pipx install ggshield

अपने इंस्टॉलेशन को अपग्रेड करने के लिए, चलाएँ:

pipx upgrade ggshield

pip का उपयोग करके

आप pip का उपयोग करके PyPI से ggshield भी इंस्टॉल कर सकते हैं, लेकिन यह अनुशंसित नहीं है क्योंकि इंस्टॉलेशन पृथक नहीं है, इसलिए इस तरह से इंस्टॉल किए गए अन्य एप्लिकेशन या पैकेज आपके ggshield इंस्टॉलेशन को प्रभावित कर सकते हैं। यह विधि तब भी काम नहीं करेगी यदि आपका Python इंस्टॉलेशन बाहरी रूप से प्रबंधित घोषित किया गया है (उदाहरण के लिए Debian 12 जैसे ऑपरेटिंग सिस्टम पर सिस्टम Python का उपयोग करते समय):

pip install --user ggshield

अपने इंस्टॉलेशन को अपग्रेड करने के लिए, चलाएँ:

pip install --user --upgrade ggshield

प्रारंभिक सेटअप

ggshield auth login का उपयोग करके

ggshield का उपयोग करने के लिए आपको GitGuardian सर्वरों के विरुद्ध प्रमाणीकरण करना होगा। ऐसा करने के लिए, ggshield auth login कमांड का उपयोग करें। यह कमांड एक व्यक्तिगत एक्सेस टोकन के प्रावधान और स्थानीय वर्कस्टेशन पर इसके कॉन्फ़िगरेशन को स्वचालित करता है।

आप इसके बारे में ggshield auth login दस्तावेज़ीकरण से अधिक जान सकते हैं।

मैन्युअल सेटअप

आप मैन्युअल रूप से अपना व्यक्तिगत एक्सेस टोकन भी बना सकते हैं और सेटअप पूरा करने के लिए इसे GITGUARDIAN_API_KEY एनवायरनमेंट वेरिएबल में संग्रहीत कर सकते हैं।

शुरू करना

रहस्य

अब आप ggshield का उपयोग करके रहस्यों की खोज कर सकते हैं:

• फ़ाइलों में: ggshield secret scan path -r .
• रिपॉजिटरी में: ggshield secret scan repo .
• Docker इमेज में (docker कमांड उपलब्ध होना चाहिए): ggshield secret scan docker ubuntu:22.04
• Pypi पैकेजों में (pip कमांड उपलब्ध होना चाहिए): ggshield secret scan pypi flask
• और अधिक, विवरण के लिए ggshield secret scan --help आउटपुट देखें।

पुराने कॉन्फ़िगरेशन फ़ाइल को माइग्रेट करना

यदि ggshield रिपोर्ट करता है कि आपकी .gitguardian.yaml (या .gitguardian.yml) कॉन्फ़िगरेशन फ़ाइल एक पदावनत प्रारूप का उपयोग करती है, तो इसे नवीनतम संस्करण में माइग्रेट करें:

ggshield config migrate

डिफ़ॉल्ट रूप से, यह वर्तमान निर्देशिका में कॉन्फ़िगरेशन फ़ाइल की तलाश करता है, इसलिए इसे फ़ाइल वाली निर्देशिका से चलाएँ। इसे कहीं से भी चलाने के लिए, ggshield को स्पष्ट रूप से फ़ाइल की ओर इंगित करें:

ggshield --config-path path/to/.gitguardian.yaml config migrate

फ़ाइल का पिछला संस्करण इसके बगल में .old बैकअप के रूप में रखा जाता है।

एकीकरण

आप ggshield को अपने CI/CD वर्कफ़्लो में एकीकृत कर सकते हैं।

पहले त्रुटियों को पकड़ने के लिए, ggshield का उपयोग प्री-कमिट, प्री-पुश या प्री-रिसीव Git हुक के रूप में करें।

AI कोडिंग सहायक

ggshield आपके और आपके AI कोडिंग सहायक के बीच इंटरैक्शन को स्कैन कर सकता है, और रहस्यों वाली क्रियाओं को निष्पादित होने से पहले ब्लॉक कर सकता है।

आप ggshield install कमांड से हुक इंस्टॉल कर सकते हैं।

समर्थित उपकरण: Cursor, Claude Code, Copilot Chat, और Codex।

और अधिक जानें

अधिक जानकारी के लिए, दस्तावेज़ीकरण देखें।

आउटपुट

यदि कोई रहस्य नहीं मिला है, तो एग्जिट कोड 0 होगा:

ggshield secret scan pre-commit

यदि आपके स्टेज किए गए कोड या आपके CI में कोई रहस्य पाया जाता है, तो आपको एक अलर्ट मिलेगा जो फ़ाइल का नाम बताएगा जहाँ रहस्य पाया गया है और एक पैच जो फ़ाइल में रहस्य की स्थिति देगा:

ggshield secret scan pre-commit

2 incidents have been found in file production.rb

11 | config.paperclip_defaults = {
12 |     :s3_credentials => {
13 |     :bucket => "XXX",
14 |     :access_key_id => "XXXXXXXXXXXXXXXXXXXX",
                            |_____AWS Keys_____|

15 |     :secret_access_key => "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
                                |_______________AWS Keys_______________|

16 |     }
17 | }

बहुत लंबी पंक्तियाँ टर्मिनल के आकार से मेल खाने के लिए ट्रंकेट की जाती हैं, जब तक कि वर्बोज़ मोड का उपयोग न किया जाए (-v या --verbose)।

संबंधित ओपन सोर्स प्रोजेक्ट

• truffleHog
• gitleaks
• gitrob
• git-hound
• AWS git-secrets
• detect-secrets

लाइसेंस

ggshield MIT लाइसेंस प्राप्त है।