Aller au contenu principal

ggshield machine doctor

Description​

Vérifie que les protections ggshield de cette machine sont correctement configurées.

ggshield machine doctor [OPTIONS]

Vérifie que les hooks AI et les hooks git sont installés, qu'aucune surcharge core.hooksPath de priorité supérieure (par exemple Husky ou lefthook) n'occulte le hook git de ggshield dans le contexte actuel, que le token GitGuardian est accessible et porte les scopes nécessaires aux protections configurées (y compris honeytokens:write et ai-discover:send, accordés uniquement sur les plans Business ou Enterprise), et — lorsque le plugin machine_scan est installé — que le token dispose du scope endpoint (également réservé à Business/Enterprise) et que le scanner natif se charge.

Cette opération est en lecture seule : elle n'installe, ne scanne et ne modifie jamais quoi que ce soit. Chaque vérification échouée affiche comment la corriger (les hooks via ggshield machine setup — sauf une surcharge core.hooksPath, qui, du fait de la priorité de git, doit être intégrée à ce gestionnaire de hooks ou supprimée ; les scopes via un token qui les porte ; le plugin via ggshield plugin install). Se termine avec un code non nul si une vérification échoue, afin de pouvoir conditionner un déploiement MDM.

Git est facultatif pour cette commande. Sans lui, les vérifications des hooks git sont signalées comme ignorées et n'affectent pas le code de sortie.

Options​

Cette commande prend en charge toutes les options globales de ggshield.