gitguardian/ggshieldDetecta y valida más de 500 tipos de secretos codificados con comprobaciones avanzadas. Úsalo como un enlace de pre-commit, acción de GitHub o CLI para la detección y seguridad proactiva de secretos.
[!IMPORTANT] macOS: actualizar a la versión 1.54.0 activa una solicitud del Llavero para
ggshield-py, un segundo binario que ahora lee tu token guardado como parte de nuestras mejoras de rendimiento. Haz clic en Permitir siempre; no volverá a preguntar.
ggshield es una aplicación CLI que se ejecuta en tu entorno local o en un entorno de CI para ayudarte a detectar más de 500 tipos de secretos.
ggshield utiliza nuestra API pública a través de py-gitguardian para escanear y detectar posibles vulnerabilidades en archivos y otros contenidos de texto.
De los escaneos realizados con ggshield solo se almacenan metadatos como la hora de la llamada, el tamaño de la solicitud y el modo de escaneo, por lo que los secretos no se mostrarán en tu panel y tus archivos y secretos no se almacenarán.
La forma más rápida de instalar 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
O, si prefieres curl (incluido con Windows 10+):
curl.exe -sSL https://raw.githubusercontent.com/GitGuardian/ggshield/main/scripts/install/install.ps1 | powershell -NoProfile -ExecutionPolicy Bypass -Command -
El script acepta opciones como --instance y --plugin (instalar un
plugin). Para el espacio de trabajo de la UE o una instancia autoalojada,
establece la variable de entorno GITGUARDIAN_INSTANCE (o pasa --instance <URL>)
antes de ejecutarlo.
Consulta scripts/install/README.md para ver la lista completa
de opciones, los demás métodos de instalación y cómo desinstalar.
Los métodos siguientes instalan la CLI manualmente en su lugar.
Puedes instalar ggshield usando Homebrew:
brew install ggshield
La actualización la gestiona Homebrew.
Como alternativa, puedes descargar e instalar un paquete .pkg independiente desde la página de versiones de ggshield.
Este paquete no requiere instalar Python, pero tendrás que descargar manualmente las nuevas versiones.
Los paquetes Deb y RPM están disponibles en Cloudsmith.
Instrucciones de configuración:
La actualización la gestiona el gestor de paquetes.
ggshield está disponible a través del gestor de paquetes Chocolatey:
choco install ggshield
Descarga el instalador MSI desde la página de versiones de ggshield e instálalo:
msiexec /i ggshield-VERSION-x86_64-pc-windows-msvc.msi
Proporcionamos un archivo .zip independiente en la página de versiones de ggshield.
Descomprime el archivo en tu disco y, a continuación, añade el directorio que contiene el archivo ggshield.exe a %PATH%.
Este archivo no requiere instalar Python, pero tendrás que descargar manualmente las nuevas versiones.
ggshield se puede instalar en todos los sistemas operativos compatibles a través de su paquete de PyPI.
Requiere una versión compatible de Python (no EOL) (excepto para los paquetes independientes) y git.
Si no utilizas nuestras versiones empaquetadas de ggshield, ten en cuenta que seguimos el ciclo de versiones de Python y no damos soporte a las versiones que han alcanzado el EOL.
La forma recomendada de instalar ggshield desde PyPI es usar pipx, que lo instalará en un entorno aislado:
pipx install ggshield
Para actualizar tu instalación, ejecuta:
pipx upgrade ggshield
También puedes instalar ggshield desde PyPI usando pip, pero no es recomendable porque la instalación no está aislada, por lo que otras aplicaciones o paquetes instalados de esta forma pueden afectar a tu instalación de ggshield. Este método tampoco funcionará si tu instalación de Python está declarada como gestionada externamente (por ejemplo, al usar el Python del sistema en sistemas operativos como Debian 12):
pip install --user ggshield
Para actualizar tu instalación, ejecuta:
pip install --user --upgrade ggshield
ggshield auth login