عن المشروع

ggshield هو تطبيق سطر أوامر من GitGuardian لاكتشاف الأسرار المضمنة في الكود الخاص بك. يعمل محليًا أو في CI ويغطي أكثر من 500 نوع من الأسرار، باستخدام واجهة برمجة التطبيقات العامة لـ GitGuardian عبر عميل py-gitguardian لفحص الملفات والمحتوى النصي الآخر. ملاحظة الخصوصية من ملف README: يتم تخزين البيانات الوصفية فقط مثل وقت الاستدعاء وحجم الطلب ووضع الفحص من عمليات الفحص، لذلك لا تظهر الأسرار على لوحة التحكم الخاصة بك ولا يتم تخزين الملفات أو الأسرار. خيارات التثبيت واسعة: سكربت تثبيت موصى به لأنظمة Linux/macOS وWindows PowerShell، وHomebrew على macOS، وحزمة .pkg مستقلة، وحزم Deb وRPM عبر Cloudsmith، ومثبتات Chocolatey وMSI على Windows، وملف .zip مستقل، وPyPI عبر pipx (موصى به) أو pip. تتجنب الحزم المستقلة الحاجة إلى تثبيت 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 (قبل الالتزام، قبل الدفع، قبل الاستلام) لالتقاط الأسرار قبل وصولها إلى التحكم في الإصدارات. بشكل ملحوظ، يمكن لـ ggshield أيضًا فحص التفاعلات مع مساعدي البرمجة بالذكاء الاصطناعي في الوقت الفعلي وحظر الإجراءات التي تحتوي على أسرار قبل تنفيذها؛ الأدوات المدعومة المدرجة هي 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 تؤدي إلى ظهور موجه Keychain لـ `ggshield-py`، وهو ثنائي ثانٍ يقرأ الرمز المحفوظ كجزء من تحسينات الأداء؛ يجب على المستخدمين النقر فوق "السماح دائمًا".