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. Si utilisé, des incidents seront créés et visibles sur le dashboard. Nécessite le scope 'scan:create-incidents'.
• --all-secrets : N'ignore aucun secret. La raison d'ignorance possible est également affichée.
• --instance URL : URL de l'instance à utiliser.
• --with-incident-details : Affiche 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 : Exclut les résultats d'un détecteur.
• --ignore-known-secrets : Ignore les secrets déjà connus du dashboard GitGuardian.
• --exclude PATTERNS : Ne scanne pas les chemins qui correspondent aux motifs de type 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 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.