VulnCheck CLI

vulncheck — это доступ к VulnCheck API из командной строки. Он предоставляет просмотр индексов, управление резервными копиями и сканирование уязвимостей прямо в терминале.

Установка

Предоставленные скрипты установки

Вы можете легко установить vulncheck с помощью скрипта установки. Выберите скрипт и метод, соответствующие вашей операционной системе:

macOS и Linux

Откройте терминал и выполните:

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

Будет предложено выбрать между общесистемной установкой (требуется sudo) или локальной установкой для пользователя.

[!NOTE] Скрипт установки также поддерживает параметры неинтерактивной установки:

• --sudo для общесистемной установки без запросов
• --non-sudo для локальной установки для пользователя без запросов
• --help или -h для просмотра всех доступных параметров

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

Windows

Откройте PowerShell и выполните:

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

Чтобы включить автодополнение по Tab, подключите входящий в комплект скрипт через dot-sourcing из вашего профиля PowerShell:

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

Бинарные файлы vulncheck также доступны для MacOS, Linux и Windows. Вы можете скачать предкомпилированные бинарные файлы со нашей страницы релизов

Проверка установки

После установки убедитесь, что бинарный файл выводит нужную версию:

vulncheck version

Вы должны увидеть версию, дату сборки и URL журнала изменений. Если вы получили «command not found», откройте оболочку заново, чтобы новый PATH был подхвачен, и повторите попытку.

Конфигурация

• Выполните vulncheck auth login, чтобы аутентифицироваться в своей учётной записи VulnCheck.
• В качестве альтернативы vulncheck учитывает переменную окружения VULNCHECK_API_TOKEN — то же имя, которое используется в SDK VulnCheck и MCP-сервере. Устаревшая VC_TOKEN также по-прежнему работает и имеет приоритет, когда заданы обе.
• vulncheck auth сам по себе покажет другие параметры, например проверку статуса и выход из системы.

Любая из переменных окружения имеет приоритет над сохранённым файлом конфигурации. Из-за этого auth login и auth logout отказываются выполняться, пока одна из них задана — иначе они сообщали бы об успехе, не изменив ничего, что вступает в силу. Выполните vulncheck auth status, чтобы увидеть, из какого источника и из какой переменной взят активный токен.

Агентное / скриптовое использование

CLI спроектирован так, чтобы его было безопасно использовать из скриптов и ИИ-агентов. Этот раздел — контракт: перечисленные ниже интерфейсы должны оставаться стабильными между релизами (дополнения не являются ломающими изменениями; переименования / удаления — являются).

Глобальные флаги

Флаг	Действие
--json	Выводить JSON в stdout; направлять информационные строки/строки прогресса в stderr; ошибки выводятся в виде структурированного конверта.
--quiet	Подавлять информационный вывод. Ошибки и полезная нагрузка всё равно выводятся.
--no-color	Отключить ANSI-стилизацию. Также учитывается переменная окружения NO_COLOR.
--no-interactive	Отказаться блокироваться на запросах TUI; команды, которым нужен запрос, вместо этого возвращают ошибку. Подразумевается --json, не-TTY stdin/stdout и любой из переменных окружения CI / BUILD_NUMBER / RUN_ID.

Переменные окружения

Переменная	Действие
VULNCHECK_API_TOKEN	API-токен и рекомендуемое имя — общее с SDK VulnCheck и MCP-сервером. Имеет приоритет над ~/.config/vulncheck/vulncheck.yaml; пока задана, auth login и auth logout отказываются выполняться, вместо того чтобы записать файл, который был бы проигнорирован.
VC_TOKEN	Устаревший псевдоним, по-прежнему полностью поддерживается и имеет приоритет над VULNCHECK_API_TOKEN, когда заданы обе, поэтому ни одна существующая конфигурация не меняет учётные данные. Очистите обе, чтобы вернуться к файлу конфигурации. auth status сообщает, какая используется.
NO_COLOR	Любое непустое значение отключает ANSI-стилизацию.
CI / BUILD_NUMBER / RUN_ID	Любая из этих переменных подразумевает неинтерактивный режим (без запросов).

Коды выхода

Код	Значение
0	Успех.
1	Общая / внутренняя ошибка.
2	Ошибка валидации (неверные аргументы, отсутствует обязательный флаг, некорректный запрос).
3	Ошибка аутентификации (нет токена или сервер отклонил токен).
4	Ресурс не найден (HTTP 404, нет такого индекса).
5	Превышен лимит запросов (HTTP 429).
6	Сетевая ошибка (DNS, соединение отклонено, тайм-аут).
130	Отменено по SIGINT (POSIX 128 + 2).

Конверт ошибок

В режиме --json ошибки выводятся в stdout в виде:

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

code — одно из значений: internal, validation, auth_required, auth_invalid, not_found, rate_limited, network, bad_request, cancelled. http_status опускается для ошибок, не связанных с HTTP. hint — необязательный контекст по устранению проблемы, присутствует только тогда, когда одного сообщения недостаточно для действий (например, с указанием переменной, из которой был получен отклонённый токен). Выводится в stderr как hint: ... вне режима --json.

Команды проверки

Используйте их для проверки самого CLI перед запуском работы:

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