Об утилите vampi-cli
Описание
vampy-cli
— это утилита командной строки для взаимодействия с сервером Vampy. Она предоставляет возможность управления репозиториями, продуктами, процессами сканирования и другими функциями через простые команды.
vampy-cli
легко использовать в конвейерах CI/CD для запуска сканирования и прерывания релизов, если сканирование не удалось или результаты сканирования не соответствуют указанным критериям релиза.
Использование
Доступные команды
upload
Загружает существующие результаты сканирования на сервер.scan
Запускает процесс сканирования для указанного репозитория и сканера.sqg
Показывает QualityGate для выбранного продукта или репозитория.bg-task
Проверяет статус фоновой задачи и выводит подробности.list
Получает информацию о различных ресурсах системы. Подкоманды:products
— список продуктовrepos
— список репозиториевscanners
— список сканеровscan-profiles
— список профилей сканированияsqg
— список quality gates
help, h
Показывает список доступных команд или справку по одной из команд.
Глобальные параметры
Общие параметры
Параметр | Описание | Значение по умолчанию |
---|---|---|
--help, -h |
Показывает справку. | |
--debug |
Отображает отладочный вывод. | false |
--details |
Показывает детализированный вывод для запрошенного действия. | false |
--timeout value |
Таймаут в секундах. | 120 |
--verbose |
Показывает дополнительный вывод. | false |
--version, -v |
Выводит только версию программы. | false |
Параметры подключения
Параметр | Описание | Значение по умолчанию |
---|---|---|
--api-token value |
API-токен Vampy (или из переменной VAMPY_API_TOKEN ). |
API Token from env 'VAMPY_API_TOKEN' |
--api-version value |
Версия API Vampy (или из переменной VAMPY_API_VERSION ). |
v1 |
--vampy-url value |
URL сервера Vampy (или из переменной VAMPY_URL ). |
URL from env 'VAMPY_URL' |
--ignore-ssl-check |
Пропустить проверку SSL-сертификата при подключении к серверу Vampy | false |
Конфигурация
Для использоватния 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 list repos
Параметры командной строки
# получим список репозиториев
vampy-cli --vampy-url https://vampy.hexway.io --api-token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2VybmFtZSI6InZtcC1jbGkiLCJpYXQiOjE3MzM5MzI2MDYuNjk1Mjk4fQ.TNWsDdhpct6PhZ0jTBZ7QTQyFuMzLN2oBr99e3uhRkA list repos
CLI flags have higher priority than environment variables See README.md for more examples and docker usage