ggshield secret scan pre-push

Description

Scanne, en tant que hook git pre-push, tous les commits sur le point d'être poussés.

ggshield secret scan pre-push [OPTIONS] [PREPUSH_ARGS]...

Options

• --source-uuid TEXT : Identifiant de la source personnalisée dans GitGuardian. S'il est utilisé, les incidents seront créés et visibles sur le dashboard. Nécessite le scope « scan:create-incidents ».
• --filename-only : Envoyer uniquement le nom du fichier (et non le chemin complet) à GitGuardian, afin que les incidents n'enregistrent que le nom du fichier.
• --all-secrets : Ne pas ignorer de secret. La raison possible d'ignorance est également affichée.
• --instance URL : URL de l'instance à utiliser.
• --with-incident-details : Afficher tous les détails de l'incident du dashboard si un incident est trouvé (formats JSON et SARIF uniquement). Nécessite le scope « incidents:read ».
• -b, --banlist-detector DETECTOR : Exclure les résultats d'un détecteur.
• --ignore-known-secrets : Ignorer les secrets déjà connus par le dashboard GitGuardian.
• --exclude PATTERNS : Ne pas scanner les chemins qui correspondent aux motifs de type glob spécifiés.
• --exit-zero : Retourner un code de statut 0 (sans erreur), même si des incidents sont trouvés. Un code de statut d'erreur sera tout de même retourné pour d'autres erreurs, telles que les erreurs de connexion. Cette option peut également être définie avec la variable d'environnement GITGUARDIAN_EXIT_ZERO.
• --show-secrets : Afficher les secrets en clair au lieu de les masquer.
• -o, --output PATH : Rediriger la sortie de ggshield vers PATH.
• --format [text|json|sarif] : Format à utiliser pour la sortie.
• --json : Raccourci pour --format json.
• --fail-on-server-error / --no-fail-on-server-error : Indique si les commandes de scan de hook git et de CI doivent échouer lorsque le serveur GitGuardian est injoignable ou renvoie une réponse 5xx. Lorsque cette option est désactivée, la commande se termine avec le code 0 et un avertissement s'affiche au lieu de bloquer l'opération git. Activé par défaut. Peut également être défini avec la variable d'environnement GITGUARDIAN_FAIL_ON_SERVER_ERROR.

Cette commande prend en charge toutes les options globales de ggshield.

Voir aussi

Consultez notre documentation dédiée pour plus de détails sur l'intégration pre-push avec ggshield.