ggshield secret scan path

Description

Scanner des fichiers et des répertoires.

ggshield secret scan path [OPTIONS] PATHS...

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

Options

• -r, --recursive : Scanner un 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. S'il est utilisé, des incidents seront créés et visibles sur le dashboard. Requiert le scope 'scan:create-incidents'.
• --all-secrets : Ne pas ignorer de 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 de l'incident du dashboard s'il en existe un (formats JSON et SARIF uniquement). Requiert 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 du 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 (non-erreur), même si des incidents sont trouvés. Un code de statut d'erreur sera toujours retourné pour les autres erreurs, comme 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 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 file
ggshield secret scan path my_repo/my_file.py

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