Aller au contenu principal

ggshield secret scan docset

Description

Scanner les fichiers JSONL au format docset.

ggshield secret scan docset [OPTIONS] FILES...

Les fichiers JSONL doivent être formatés selon le format "Docset".

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'.
  • --all-secrets : N'ignorer aucun secret. La raison d'ignorance possible 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 du dashboard GitGuardian.
  • --exclude PATTERNS : Ne pas scanner les chemins qui correspondent aux motifs 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, 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 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 file1.jsonl and file2.jsonl for secrets
ggshield secret scan docset file1.jsonl file2.jsonl