gitguardian/ggshieldDétectez et validez plus de 500 types de secrets codés en dur avec des vérifications avancées. Utilisez-le comme hook pre-commit, GitHub Action ou CLI pour une détection proactive des secrets et la sécurité.
ggshield est une application CLI qui s'exécute dans votre environnement local ou dans un environnement CI pour vous aider à détecter plus de 500 types de secrets.
ggshield utilise notre API publique via py-gitguardian pour analyser et détecter les vulnérabilités potentielles dans les fichiers et autres contenus textuels.
Seules les métadonnées telles que l'heure d'appel, la taille de la requête et le mode d'analyse sont stockées lors des analyses avec ggshield. Par conséquent, les secrets ne seront pas affichés sur votre tableau de bord et vos fichiers et secrets ne seront pas stockés.
Le moyen le plus rapide d'installer 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
Ou, si vous préférez curl (inclus avec Windows 10+) :
curl.exe -sSL https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1 | powershell -NoProfile -ExecutionPolicy Bypass -Command -
Le script accepte des options telles que --instance et --plugin (installer un
plugin). Pour l'espace de travail UE ou une instance auto-hébergée, définissez la
variable d'environnement GITGUARDIAN_INSTANCE (ou passez --instance <URL>)
avant l'exécution.
Consultez scripts/install/README.md pour la liste complète
des options, les autres méthodes d'installation et la désinstallation.
Les méthodes ci-dessous installent manuellement la CLI à la place.
Vous pouvez installer ggshield avec Homebrew :
brew install ggshield
La mise à niveau est gérée par Homebrew.
Alternativement, vous pouvez télécharger et installer un paquet .pkg autonome depuis la page des versions de ggshield.
Ce paquet ne nécessite pas l'installation de Python, mais vous devez télécharger manuellement les nouvelles versions.
Les paquets Deb et RPM sont disponibles sur Cloudsmith.
Instructions de configuration :
La mise à niveau est gérée par le gestionnaire de paquets.
ggshield est disponible via le gestionnaire de paquets Chocolatey :
choco install ggshield
Téléchargez l'installateur MSI depuis la page des versions de ggshield et installez-le :
msiexec /i ggshield-VERSION-x86_64-pc-windows-msvc.msi
Nous fournissons une archive .zip autonome sur la page des versions de ggshield.
Extrayez l'archive sur votre disque, puis ajoutez le répertoire contenant le fichier ggshield.exe à %PATH%.
Cette archive ne nécessite pas l'installation de Python, mais vous devez télécharger manuellement les nouvelles versions.
ggshield peut être installé sur tous les systèmes d'exploitation pris en charge via son paquet PyPI.
Il nécessite une version prise en charge de Python (non en fin de vie) (sauf pour les paquets autonomes) et git.
Si vous n'utilisez pas nos versions packagées de ggshield, veuillez noter que nous suivons le cycle de publication de Python et ne supportons pas les versions ayant atteint leur fin de vie.
La méthode recommandée pour installer ggshield depuis PyPI est d'utiliser pipx, qui l'installera dans un environnement isolé :
pipx install ggshield
Pour mettre à niveau votre installation, exécutez :
pipx upgrade ggshield
Vous pouvez également installer ggshield depuis PyPI avec pip, mais cela n'est pas recommandé car l'installation n'est pas isolée, donc d'autres applications ou paquets installés de cette manière peuvent affecter votre installation ggshield. Cette méthode ne fonctionnera pas non plus si votre installation Python est déclarée comme étant gérée en externe (par exemple lors de l'utilisation du Python système sur des systèmes d'exploitation comme Debian 12) :
pip install --user ggshield
Pour mettre à niveau votre installation, exécutez :
pip install --user --upgrade ggshield
ggshield auth login