Aperçu

La CLI GitGuardian, ggshield, fournit des garde-fous de sécurité à chaque étape de votre cycle de développement logiciel (SDLC).
Trouvez et corrigez plus de 600 types de secrets codés 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 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 détaillé.
• --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 du journal vers FILE. Utilisez - pour rediriger vers stderr à la place.
• --debug : Affiche les informations de débogage.

Sorties JSON

De nombreuses commandes ggshield sont accompagnées d'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 des suivants :

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 divulgué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.