Commandes

Endpoint Protection s'appuie sur trois commandes, toutes regroupées sous ggshield machine.

Commande	Ce qu'elle fait	Envoie les données à GitGuardian
ggshield machine scan	Scanne la machine et stocke les résultats localement.	Non
ggshield machine report	Scanne la machine, puis envoie les résultats.	Oui
ggshield machine submit	Envoie les résultats du dernier scan local, sans relancer de scan.	Oui

ggshield machine dashboard ouvre le dashboard local pour parcourir les détections du dernier scan sur la machine elle-même.

Laquelle utiliser ?

• Déploiement de flotte (MDM, tâche planifiée, CI) : ggshield machine report. Une seule invocation « fire-and-forget » qui effectue un nouveau scan et téléverse le résultat — c'est la commande à placer dans votre tâche quotidienne.
• Évaluation sur votre propre machine : ggshield machine scan --dashboard pour scanner et examiner localement, puis ggshield machine submit lorsque vous souhaitez transmettre les résultats à GitGuardian.
• Local uniquement, rien de téléversé : ggshield machine scan. Les résultats restent dans la base de résultats locale et ne quittent jamais la machine.

submit envoie le dernier scan terminé et n'accepte aucune option de scan — le périmètre et le mode ont été décidés au moment de l'exécution de machine scan. L'horodatage du téléversement correspond à l'heure du scan, et non à l'heure de l'envoi ; renvoyer un ancien scan ne fera donc pas apparaître l'endpoint comme récemment scanné.

remarque

Un scan exécuté avec sudo stocke ses résultats dans la base de données système. Exécutez également submit avec sudo, afin que les deux commandes utilisent la même base de données.

ggshield machine inventory est obsolète

ggshield machine inventory fonctionne toujours comme un alias de report (scanner, puis envoyer) afin que les tâches existantes continuent de s'exécuter, et affiche un avis d'obsolescence. Mettez à jour vos scripts MDM et vos tâches planifiées vers ggshield machine report.

Exemples

# Scanner et envoyer en une seule étape (MDM / automatisation)
ggshield machine report

# Scanner localement, examiner dans le dashboard local, envoyer plus tard
ggshield machine scan --dashboard
ggshield machine submit

# Construire la charge utile localement sans rien envoyer
ggshield machine report --no-upload -o inventory.json

# Instance Self-Hosted
ggshield machine --instance https://gitguardian.example.com report

L'envoi nécessite des identifiants GitGuardian — le token stocké par ggshield auth login, ou une clé API dans la variable d'environnement GITGUARDIAN_API_KEY. Consultez Déployer à grande échelle avec un token de compte de service pour les déploiements sans intervention.