ggshield secret scan ai-hook

Description

Scannez les interactions avec les outils IA à la recherche de secrets.

ggshield secret scan ai-hook [OPTIONS]

Lit un événement de hook depuis stdin au format JSON, le traite, et écrit une réponse sur stdout au format JSON qui bloque l'action si des secrets sont détectés.

Pour installer le hook pour votre outil de coding IA, exécutez :

ggshield install -t <your-code-assistant> -m [local|global]

Options

• --source-uuid TEXT : Identifiant de la source personnalisée dans GitGuardian. S'il est utilisé, des incidents seront créés et visibles sur le dashboard. Requiert le scope 'scan:create-incidents'.
• --all-secrets : N'ignorer aucun secret. La raison possible d'ignorance 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 est trouvé (formats JSON et SARIF uniquement). Requiert 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 (non-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.

Fonctionnement

Cette commande est appelée automatiquement par les outils de coding IA (Cursor, Claude Code, VS Code avec GitHub Copilot) lorsque ggshield est installé en tant que hook. Elle n'est pas destinée à être appelée manuellement — utilisez ggshield install avec l'option -t pour configurer les hooks.

Codes de sortie

En fonctionnement normal, cette commande retourne toujours le code de sortie 0. La décision de bloquer ou d'autoriser est communiquée via une charge utile JSON dans stdout, que l'outil de coding IA utilise pour afficher un retour dans son interface.

Si ggshield ne parvient pas à identifier l'outil de coding IA appelant, il revient aux codes de sortie standards :

• 0 : Aucun secret trouvé.
• 1 : Une erreur s'est produite pendant le scan.
• 2 : Des secrets ont été trouvés.

Voir aussi

• Scan de secrets pour les outils de coding IA : Guide d'installation et détails d'utilisation.