Aller au contenu principal

ggshield secret scan commit-range

Description​

Scanne chaque commit dans la plage de commits indiquée.

ggshield secret scan commit-range [OPTIONS] COMMIT_RANGE

N'importe quelle plage de commits compatible avec git peut être fournie en entrée.

Exemple : ggshield secret scan commit-range HEAD~1...

Options​

  • --source-uuid TEXT : Identifiant de la source personnalisée dans GitGuardian. Si 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 possible de l'ignorance est également affichée.
  • --instance URL : URL de l'instance à utiliser.
  • --with-incident-details : Afficher tous les détails concernant l'incident du dashboard s'il en existe un (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 toujours 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 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.

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

Exemples​

git rev-list COMMIT_RANGE pour lister plusieurs commits à scanner :

ggshield secret scan commit-range HEAD~2...HEAD