ggshield secret scan pre-commit

Description

Scanner en tant que hook pre-commit toutes les modifications qui ont été indexées dans un dépôt git.

ggshield secret scan pre-commit [OPTIONS] [PRECOMMIT_ARGS]...

Options

• --scan-all-merge-files : Lors du scan d'un commit de merge, scanner tous les fichiers, y compris ceux qui ont été fusionnés sans conflit.
• --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 (pas le chemin complet) à GitGuardian, afin que les incidents n'enregistrent que le nom du fichier.
• --all-secrets : N'ignorer aucun secret. La raison d'ignorance possible 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 du dashboard GitGuardian.
• --exclude PATTERNS : Ne pas scanner les chemins qui correspondent aux motifs de type glob spécifiés.
• --exit-zero : Renvoyer un code de statut 0 (non-erreur), même si des incidents sont trouvés. Un code de statut d'erreur sera tout de même renvoyé 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 texte 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 des git hooks et de la 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 est affiché 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 de pre-commit avec ggshield.