Overview
La CLI GitGuardian, ggshield, fournit des garde-fous de sécurité à chaque étape de votre cycle de développement logiciel (SDLC).
Détectez 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
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 hooks git le nécessitent ; les types de hooks d'assistant de code IA non.
- ggshield machine doctor : Sans lui, les vérifications des hooks 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: Afficher ce message et quitter.--insecure: Ignorer toutes les vérifications de certificat. AVERTISSEMENT : cette option rend le transfert non sécurisé.-c,--config-path <FILE>: définir un fichier de configuration personnalisé. Ignore les fichiers de configuration locaux et globaux.-v,--verbose: Mode d'affichage détaillé.--version: Afficher la version.--check-for-updates/--no-check-for-updates: Après l'exécution des commandes, vérifier ou non si une nouvelle version de ggshield est disponible.--log-file <FILE>: Envoyer la sortie des logs vers FILE. Utilisez-pour rediriger vers stderr à la place.--debug: Afficher les informations de débogage.
Sorties JSON
De nombreuses commandes ggshield disposent 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 détecté. S'il s'agissait d'un scan, il s'est exécuté avec succès et n'a trouvé aucun problème à signaler. |
| 1 | La commande s'est exécutée avec succès, mais 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. |
| 4 | Le serveur GitGuardian n'a pas scanné le contenu, par exemple parce qu'il était injoignable ou a répondu avec une erreur. Avec --no-fail-on-server-error, les commandes de hook git et CI sortent avec 0 à la place. |
| 128 | Erreur inattendue. |