ggshield: GitGuardian के साथ अपने कोड की सुरक्षा करें

[!IMPORTANT] macOS: 1.54.0 पर अपग्रेड करने पर ggshield-py के लिए Keychain प्रॉम्प्ट ट्रिगर होता है, यह एक दूसरा बाइनरी है जो अब हमारे प्रदर्शन सुधारों के हिस्से के रूप में आपके सहेजे गए टोकन को पढ़ता है। Always Allow पर क्लिक करें; यह दोबारा नहीं पूछेगा।

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

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

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

विषय-सूची

इंस्टॉलेशन
प्रारंभिक सेटअप
- 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 पर उपलब्ध हैं।

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

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

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