Aller au contenu principal

ggshield secret scan pypi

Description​

Scanner un package pypi.

ggshield secret scan pypi [OPTIONS] PACKAGE_NAME

En interne, cette commande télécharge le package depuis l'index sans l'installer ni l'exécuter. Définissez la variable d'environnement PIP_INDEX_URL (et éventuellement PIP_EXTRA_INDEX_URL) pour télécharger depuis un index personnalisé au lieu de PyPI.

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 : envoyer uniquement le nom du fichier (et non 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 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 si un incident est trouvé (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 : retourner un code de statut 0 (sans erreur), même si des incidents sont trouvés. Un code de statut d'erreur sera toujours retourné pour d'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.