Vue d'ensemble
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
Commandes supplémentaires
Commandes qui nécessitent git
Les commandes suivantes nécessitent que l'exécutable git soit installé et disponible dans le
PATH.
- ggshield secret scan changes
- ggshield secret scan ci
- ggshield secret scan commit-range
- ggshield secret scan pre-commit
- ggshield secret scan pre-push
- ggshield secret scan pre-receive
- ggshield secret scan repo
Git est facultatif pour les commandes suivantes, qui ne l'utilisent que pour certaines fonctionnalités. Toutes les autres commandes fonctionnent sans git.
- ggshield install : les types de hook Git le nécessitent ; les types de hook pour assistant de codage IA non.
- ggshield machine doctor : sans lui, les vérifications de hook git sont signalées comme ignorées et n'affectent pas le code de sortie.
- ggshield machine setup : il n'est nécessaire que pour les hooks git ; sans lui, cette étape est ignorée avec un avertissement.
- ggshield secret scan path : il n'est nécessaire qu'avec
--use-gitignore.
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 la rediriger vers stderr à la place.--debug: affiche les informations de débogage.
Sorties JSON
De nombreuses commandes ggshield proposent 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é. S'il s'agissait d'un scan, il s'est exécuté correctement et n'a trouvé aucun problème à signaler. |
| 1 | La commande s'est exécutée correctement, mais elle a trouvé des problèmes à signaler. Par exemple, une commande secret scan a trouvé des secrets exposé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. |
