ggshield secret scan path

Description

Scanner des fichiers et des répertoires.

ggshield secret scan path [OPTIONS] PATHS...

Utilisez @file pour charger les chemins depuis un fichier (un chemin par ligne).

Options

• -r, --recursive : scanner le répertoire de manière récursive.
• -y, --yes : confirmer le scan récursif.
• --use-gitignore : respecter le contenu des fichiers .gitignore.
• --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.

Cette commande prend en charge toutes les options globales ggshield.

Exemples

# scan a file
$ ggshield secret scan path my_repo/my_file.py

# scan a directory recursively
$ ggshield secret scan path --recursive my_repo/