Vue d'ensemble

La CLI GitGuardian, ggshield, fournit des garde-fous de sécurité à chaque étape de votre Software Development Lifecycle (SDLC). Trouvez et corrigez plus de 450 types de secrets en dur.

ggshield [COMMAND] [SUBCOMMAND] [OPTIONS]

Commandes principales

• ggshield auth
• ggshield secret scan
• ggshield honeytoken create

Commandes supplémentaires

• ggshield secret ignore
• ggshield api-status
• ggshield install
• ggshield quota

Options

• -h, --help : affiche ce message et quitte.
• --insecure : ignore toutes les vérifications de validation de certificat. AVERTISSEMENT : cette option rend le transfert non sécurisé.
• -c, --config-path <FILE> : définit un fichier de configuration personnalisé. Ignore les fichiers de configuration locaux et globaux.
• -v, --verbose : mode d'affichage verbeux.
• --version : affiche la version.
• --check-for-updates / --no-check-for-updates : après l'exécution des commandes, vérifie ou non si une nouvelle version de ggshield est disponible.
• --log-file <FILE> : envoie la sortie de log vers FILE. Utilisez - pour rediriger vers stderr à la place.
• --debug : affiche les informations de debug.

Sorties JSON

De nombreuses commandes ggshield sont fournies avec une option --json pour produire un document JSON. Le format de ces sorties JSON est documenté sous forme de schémas JSON dans le dossier doc/schemas du dépôt ggshield.

Codes de sortie

Selon le résultat de la commande, le code de sortie de ggshield sera l'un de ces codes :

Code	Signification
0	Aucun problème trouvé. Si la commande était un scan, elle s'est exécutée avec succès et n'a trouvé aucun problème à signaler.
1	La commande s'est exécutée avec succès, mais elle a trouvé des problèmes à signaler. Par exemple, une commande secret scan a trouvé des secrets fuités.
2	Erreur d'utilisation : la commande n'a pas reçu les paramètres attendus.
3	Erreur d'authentification : la commande a tenté de se connecter à un serveur, mais le serveur l'a rejetée.
128	Erreur inattendue.