ggshield secret scan repo

Description

Scanne les commits d'un REPOSITORY à l'URL ou au chemin indiqué.

ggshield secret scan repo [OPTIONS] REPOSITORY

REPOSITORY est l'URL de clonage ou le chemin du dépôt à scanner.

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 : N'envoyer que 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 éventuelle est également affichée.
• --instance URL : URL de l'instance à utiliser.
• --with-incident-details : Afficher tous les détails de 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 : Renvoyer un code de statut 0 (sans erreur), même si des incidents sont trouvés. Un code de statut d'erreur sera toujours renvoyé pour d'autres erreurs, telles que les erreurs de connexion. Cette option peut aussi ê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.

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

Exemples

# scan a repository with its clone URI
ggshield secret scan repo git@github.com:GitGuardian/ggshield.git

# scan a repository with its path
ggshield secret scan repo /repositories/ggshield

Voir aussi

Il est préférable d'utiliser une intégration VCS native et de consulter les résultats d'un scan dans le dashboard.