La CLI VulnCheck

vulncheck donne accès à l'API VulnCheck en ligne de commande. Elle apporte la navigation dans l'index, la gestion des sauvegardes et l'analyse des vulnérabilités au terminal.

Installation

Scripts d'installation fournis

Vous pouvez facilement installer vulncheck à l'aide d'un script d'installation. Choisissez le script et la méthode correspondant à votre système d'exploitation :

macOS et Linux

Ouvrez un terminal et exécutez :

curl -sSL https://raw.githubusercontent.com/vulncheck-oss/cli/main/install.sh | bash

Cela vous invitera à choisir entre une installation à l'échelle du système (nécessite sudo) ou une installation locale pour l'utilisateur.

[!NOTE] Le script d'installation prend également en charge les options d'installation non interactives :

• --sudo pour une installation à l'échelle du système sans invites
• --non-sudo pour une installation locale pour l'utilisateur sans invites
• --help ou -h pour voir toutes les options disponibles

curl -sSL https://raw.githubusercontent.com/vulncheck-oss/cli/main/install.sh | bash -s -- --help

Windows

Ouvrez PowerShell et exécutez :

iex ((New-Object System.Net.WebClient).DownloadString('https://raw.githubusercontent.com/vulncheck-oss/cli/main/install.ps1'))

Pour activer la complétion par tabulation, exécutez en dot-sourcing le script fourni depuis votre profil PowerShell :

Add-Content -Path $PROFILE -Value ". '$env:LOCALAPPDATA\Programs\vulncheck\share\powershell\vulncheck.ps1'"

Les binaires vulncheck sont également disponibles pour MacOS, Linux et Windows. Vous pouvez télécharger des binaires précompilés depuis notre page des releases

Vérifier l'installation

Une fois installé, confirmez que le binaire affiche la version souhaitée :

vulncheck version

Vous devriez voir la version, la date de build et l'URL du changelog. Si vous obtenez « command not found », rouvrez votre shell afin que le nouveau PATH soit pris en compte, puis réessayez.

Configuration

• Exécutez vulncheck auth login pour vous authentifier avec votre compte VulnCheck.
• Sinon, vulncheck respectera la variable d'environnement VULNCHECK_API_TOKEN — le même nom utilisé par les SDK VulnCheck et le serveur MCP. L'ancienne variable VC_TOKEN fonctionne également toujours, et a la priorité lorsque les deux sont définies.
• vulncheck auth seul affichera d'autres options comme la vérification de votre statut et la déconnexion.

L'une ou l'autre des variables d'environnement a la priorité sur le fichier de configuration enregistré. Pour cette raison, auth login et auth logout refusent de s'exécuter lorsqu'une variable est définie — sinon ils signaleraient un succès sans avoir modifié quoi que ce soit d'effectif. Exécutez vulncheck auth status pour voir de quelle source, et de quelle variable, provient le jeton actif.

Utilisation agentique / scriptée

La CLI est conçue pour être pilotée sans risque depuis des scripts et des agents IA. Cette section constitue le contrat — les surfaces ci-dessous sont destinées à rester stables entre les versions (les ajouts ne sont pas des changements incompatibles ; les renommages / suppressions le sont).

Drapeaux globaux

Drapeau	Effet
--json	Émet du JSON sur stdout ; redirige les lignes d'information/progression vers stderr ; les erreurs sont émises sous forme d'enveloppe structurée.
--quiet	Supprime la sortie informative. Les erreurs et les charges utiles s'affichent toujours.
--no-color	Désactive le style ANSI. Respecte également la variable d'environnement NO_COLOR.
--no-interactive	Refuse de bloquer sur les invites TUI ; les commandes nécessitant une invite renvoient une erreur à la place. Impliqué par --json, un stdin/stdout non-TTY, et l'une des variables d'environnement CI / BUILD_NUMBER / RUN_ID.

Variables d'environnement

Variable	Effet
VULNCHECK_API_TOKEN	Jeton API, et nom recommandé — partagé avec les SDK VulnCheck et le serveur MCP. A la priorité sur ~/.config/vulncheck/vulncheck.yaml ; tant qu'elle est définie, auth login et auth logout refusent plutôt que d'écrire un fichier qui serait ignoré.
VC_TOKEN	Alias hérité, toujours entièrement pris en charge et ayant la priorité sur VULNCHECK_API_TOKEN lorsque les deux sont définies, afin qu'aucune configuration existante ne change d'identifiant. Effacez les deux pour revenir au fichier de configuration. auth status indique laquelle est utilisée.
NO_COLOR	Toute valeur non vide désactive le style ANSI.
CI / BUILD_NUMBER / RUN_ID	La définition de l'une de ces variables implique le mode non interactif (aucune invite).

Codes de sortie

Code	Signification
0	Succès.
1	Erreur générique / interne.
2	Échec de validation (arguments invalides, drapeau requis manquant, requête malformée).
3	Échec d'authentification (aucun jeton, ou le serveur a rejeté le jeton).
4	Ressource introuvable (HTTP 404, index inexistant).
5	Limitation de débit (HTTP 429).
6	Échec réseau (DNS, connexion refusée, délai d'attente).
130	Annulé par SIGINT (POSIX 128 + 2).

Enveloppe d'erreur

En mode --json, les erreurs sont émises sur stdout sous la forme :

{
  "schema_version": 1,
  "error": {
    "code": "auth_required",
    "message": "...",
    "http_status": 401,
    "hint": "..."
  }
}

code est l'un des suivants : internal, validation, auth_required, auth_invalid, not_found, rate_limited, network, bad_request, cancelled. http_status est omis pour les erreurs non HTTP. hint est un contexte de remédiation facultatif, présent uniquement lorsque le message seul n'est pas exploitable (par exemple, en nommant la variable qui a fourni un jeton rejeté). Affiché sur stderr sous la forme hint: ... en dehors du mode --json.

Commandes de sonde

Utilisez-les pour inspecter la CLI elle-même avant de lancer le travail :

vulncheck version --json
# {"schema_version": 1, "version": "...", "build_date": "...", "changelog_url": "..."}