ggshield secret scan ai-hook

Description

Scanner les événements de hook des outils de coding IA à la recherche de secrets. 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.

ggshield secret scan ai-hook [OPTIONS]

La commande lit un événement de hook JSON depuis stdin, scanne son contenu à la recherche de secrets, et retourne une réponse JSON. Le format de la réponse est adapté automatiquement en fonction de l'outil appelant.

Cette commande n'est pas destinée à être appelée manuellement. Elle est invoquée par le système de hook de l'outil de coding IA. Pour configurer les hooks, utilisez ggshield install avec le flag -t.

Options

• --source-uuid TEXT : identifiant de la source personnalisée dans GitGuardian. Si utilisé, des incidents seront créés et visibles dans le tableau de bord. Nécessite le scope scan:create-incidents.
• --all-secrets : ne pas ignorer les secrets. La raison d'ignore possible est également affichée.
• --instance URL : URL de l'instance à utiliser.
• --with-incident-details : affiche tous les détails de l'incident du tableau de bord si trouvé (formats JSON et SARIF uniquement). Nécessite le scope incidents:read.
• -b, --banlist-detector DETECTOR : exclut les résultats d'un détecteur.
• --ignore-known-secrets : ignore les secrets déjà connus du tableau de bord GitGuardian.
• --exclude PATTERNS : ne scanne pas les chemins qui correspondent aux patterns glob spécifiés.
• --exit-zero : retourne 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, comme les erreurs de connexion. Cette option peut également être définie avec la variable d'environnement GITGUARDIAN_EXIT_ZERO.
• --show-secrets : affiche les secrets en clair au lieu de les masquer.
• -o, --output PATH : redirige la sortie 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 ggshield.

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 sur stdout, que l'outil de coding IA utilise pour afficher un retour dans son interface.

Si ggshield ne peut pas identifier l'outil de coding IA appelant, il retombe sur des codes de sortie standard :

• 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.