La CLI di VulnCheck

vulncheck è l'accesso all'API di VulnCheck dalla riga di comando. Porta la navigazione degli indici, la gestione dei backup e la scansione delle vulnerabilità nel terminale.

Installazione

Script di installazione forniti

Puoi installare facilmente vulncheck utilizzando uno script di installazione. Scegli lo script e il metodo adatti al tuo sistema operativo:

macOS e Linux

Apri un terminale ed esegui:

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

Ti verrà chiesto di scegliere tra un'installazione a livello di sistema (richiede sudo) o un'installazione locale per l'utente.

[!NOTE] Lo script di installazione supporta anche opzioni di installazione non interattiva:

• --sudo per l'installazione a livello di sistema senza prompt
• --non-sudo per l'installazione locale per l'utente senza prompt
• --help o -h per vedere tutte le opzioni disponibili

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

Windows

Apri PowerShell ed esegui:

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

Per abilitare il completamento con tab, esegui il dot-source dello script incluso nel tuo profilo PowerShell:

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

I binari di vulncheck sono disponibili anche per MacOS, Linux e Windows. Puoi scaricare i binari precompilati dalla nostra pagina delle release

Verifica l'installazione

Una volta installato, conferma che il binario stampi la versione desiderata:

vulncheck version

Dovresti vedere la versione, la data di build e l'URL del changelog. Se ottieni "command not found", riapri la shell in modo che il nuovo PATH venga rilevato, poi riprova.

Configurazione

• Esegui vulncheck auth login per autenticarti con il tuo account VulnCheck.
• In alternativa vulncheck rispetterà la variabile d'ambiente VULNCHECK_API_TOKEN — lo stesso nome usato dagli SDK di VulnCheck e dal server MCP. Anche il legacy VC_TOKEN funziona ancora, e ha la precedenza quando entrambi sono impostati.
• vulncheck auth da solo mostrerà altre opzioni come il controllo dello stato e il logout.

Entrambe le variabili d'ambiente hanno la precedenza sul file di configurazione salvato. Per questo motivo, auth login e auth logout rifiutano l'operazione quando una di esse è impostata — altrimenti riporterebbero un successo senza aver cambiato nulla di effettivo. Esegui vulncheck auth status per vedere da quale fonte, e da quale variabile, proviene il token attivo.

Utilizzo agentico / da script

La CLI è progettata per essere sicura da pilotare da script e agenti AI. Questa sezione è il contratto — le superfici seguenti sono pensate per rimanere stabili tra le release (le aggiunte non sono cambiamenti incompatibili; le rinomine / rimozioni lo sono).

Flag globali

Flag	Effetto
--json	Emette JSON su stdout; indirizza le righe informative/di avanzamento su stderr; gli errori vengono emessi come envelope strutturato.
--quiet	Sopprime l'output informativo. Errori e payload vengono comunque mostrati.
--no-color	Disabilita lo stile ANSI. Rispetta anche la variabile d'ambiente NO_COLOR.
--no-interactive	Rifiuta di bloccarsi sui prompt TUI; i comandi che richiedono un prompt restituiscono invece un errore. Implicato da --json, stdin/stdout non-TTY e una qualsiasi delle variabili d'ambiente CI / BUILD_NUMBER / RUN_ID.

Variabili d'ambiente

Variabile	Effetto
VULNCHECK_API_TOKEN	Token API, e il nome consigliato — condiviso con gli SDK di VulnCheck e il server MCP. Ha la precedenza su ~/.config/vulncheck/vulncheck.yaml; mentre è impostata, auth login e auth logout rifiutano invece di scrivere un file che verrebbe ignorato.
VC_TOKEN	Alias legacy, ancora pienamente supportato e che ha la precedenza su VULNCHECK_API_TOKEN quando entrambi sono impostati, così nessuna configurazione esistente cambia credenziale. Cancella entrambi per ricadere sul file di configurazione. auth status riporta quale è in uso.
NO_COLOR	Qualsiasi valore non vuoto disabilita lo stile ANSI.
CI / BUILD_NUMBER / RUN_ID	Una qualsiasi di queste impostata implica la modalità non interattiva (nessun prompt).

Codici di uscita

Codice	Significato
0	Successo.
1	Errore generico / interno.
2	Errore di validazione (argomenti errati, flag obbligatorio mancante, richiesta malformata).
3	Errore di autenticazione (nessun token, o il server ha rifiutato il token).
4	Risorsa non trovata (HTTP 404, indice inesistente).
5	Rate limitato (HTTP 429).
6	Errore di rete (DNS, connessione rifiutata, timeout).
130	Annullato da SIGINT (POSIX 128 + 2).

Envelope degli errori

In modalità --json, gli errori vengono emessi su stdout come:

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

code è uno tra: internal, validation, auth_required, auth_invalid, not_found, rate_limited, network, bad_request, cancelled. http_status è omesso per gli errori non-HTTP. hint è un contesto di rimedio opzionale, presente solo quando il messaggio da solo non è sufficiente all'azione (ad es. indicando la variabile che ha fornito un token rifiutato). Mostrato su stderr come hint: ... al di fuori della modalità --json.

Comandi di sonda

Usali per ispezionare la CLI stessa prima di inviare lavoro:

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