Об утилите vampi-cli
Описание
vampy-cli — это утилита командной строки для взаимодействия с сервером Vampy. Она предоставляет возможность управления репозиториями, продуктами, процессами сканирования и другими функциями через простые команды.
vampy-cli легко использовать в конвейерах CI/CD для запуска сканирования и прерывания релизов, если сканирование не удалось или результаты сканирования не соответствуют указанным критериям релиза.
Использование
Доступные команды
-
upload
Загружает результаты сканирования, которые уже существуют. -
scan
Запускает процесс сканирования указаным сканером для указанного репозитория. -
quality-gate
Отображает результаты QualityGate для выбранного продукта или репозитория. -
bg-task
Проверяет статус фоновой задачи и выводит подробности. -
products
Получает список продуктов. -
repositories
Получает список репозиториев. -
help, h
Показывает список доступных команд или справку по одной из команд.
Глобальные параметры
Общие параметры
| Параметр | Описание | Значение по умолчанию |
|---|---|---|
--help, -h |
Показывает справку. | |
--details |
Показывает детализированный вывод для запрошенного действия (например, таблицу с результатами QualityGate). | false |
--verbose |
Показывает дополнительный вывод (например, выполнение каждого шага действия). | false |
--version, -v |
Выводит только версию программы. | false |
Параметры подключения
| Параметр | Описание | Значение по умолчанию |
|---|---|---|
--api-token value |
API-токен для подключения к серверу Vampy (или значение из переменной окружения). | значение из переменной $VAMPY_API_TOKEN |
--api-version value |
Версия API Vampy. | v1 |
--timeout value |
Таймаут в секундах. | 120 |
--vampy-url value |
URL-адрес сервера Vampy (или значение из переменной окружения). | значение из переменной $VAMPY_URL |
Конфигурация
Для использоватния vampy-cli необходимо определить два обязательных параметра подключения:
| Параметр | Описание | Значение по умолчанию |
|---|---|---|
--api-token value |
API-токен Vampy (или из переменной VAMPY_API_TOKEN). |
API Token from env 'VAMPY_API_TOKEN' |
--vampy-url value |
URL сервера Vampy (или из переменной VAMPY_URL). |
URL from env 'VAMPY_URL' |
Вы можете определить их несколькими способами:
Переменные окружения
export VAMPY_API_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InJlc3QtYXBpLXNlYy1lbmdpbmVlciIsImlhdCI6MTcyNTQzMjc5MS4wNjI5NX0.YMCIToiWf0wJwGG8O37-i7I1p47TCFQZyM2ZzxHWcxk
export VAMPY_URL=https://vampy.hexway.io
# получим список репозиториев
vampy-cli repositories