ggshield secret scan pre-commit

Description

Scanner en tant que hook pre-commit tous les changements stagés 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é mergés sans conflits.
• --source-uuid TEXT : identifiant de la source personnalisée dans GitGuardian. Si utilisé, des incidents seront créés et visibles dans le tableau de bord. Nécessite le scope scan:create-incidents.
• --all-secrets : ne pas ignorer les secrets. La raison d'ignore possible est également affichée.
• --instance URL : URL de l'instance à utiliser.
• --with-incident-details : affiche tous les détails de l'incident du tableau de bord si trouvé (formats JSON et SARIF uniquement). Nécessite le scope incidents:read.
• -b, --banlist-detector DETECTOR : exclut les résultats d'un détecteur.
• --ignore-known-secrets : ignore les secrets déjà connus du tableau de bord GitGuardian.
• --exclude PATTERNS : ne scanne pas les chemins qui correspondent aux patterns glob spécifiés.
• --exit-zero : retourne un code de statut 0 (non-erreur), même si des incidents sont trouvés. Un code de statut d'erreur sera toujours retourné pour d'autres erreurs, comme les erreurs de connexion. Cette option peut également être définie avec la variable d'environnement GITGUARDIAN_EXIT_ZERO.
• --show-secrets : affiche les secrets en clair au lieu de les masquer.
• -o, --output PATH : redirige la sortie 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 git hook et CI scan doivent échouer lorsque le serveur GitGuardian est inaccessible ou retourne une réponse 5xx. Lorsqu'elle 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 ggshield.

Voir aussi

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