[[TOC]]

Что это:

CLI-утилита для взаимодействия с Deployer API. Позволяет выполнять различные операции с проектами, релизами и другими возможностями Deployer.

Мотивация:

CLI позволяет упростить взаимодействие с Deployer API, а также автоматизировать процессы создания стенда, деплоя на стенд, сборки, релиза и другие операции. Вызов консольной команды не привязан к платформе и может быть использован в любом *nix-окружении.

Основные бенефиты от использования CLI:

• Упрощение взаимодействия с Deployer API
• Возможность автоматизации сложных процессов
• Поддержка CI/CD пайплайнов
• Поддержка различных сценариев использования

Стек:

• nodeJS - рантайм платформа
• typescript - реализация
• commander - парсер аргументов командной строки

Как подключить:

# Установка CLI
npm i -g deployer-cli

# Вызов списка всех команд:
deployer-cli --help

Настройка проекта:

Требуемое окружение:

• Node.js >= 20.6.0
• TypeScript >= 4.7.4
• npm >= 9.6.7

Разработка:

• Сборка проекта npm build
• Запуск CLI node built/index.js [specify_exact_command]
• Запуск тестов npm test

Использование в ci/cd пайплайнах:

CLI может быть запущена на любом окружении gitlab-раннера. Для инициализации CLI в пайплайнах необходимо добавить в .gitlab-ci.yml или другой yaml-файл следующий шаг:

npm i -g @x5digital/at-deployer-cli@$DEPLOYER_CLI_VERSION --registry=https://npm.x5food.tech/
at-deployer-cli --help

Переменная DEPLOYER_CLI_VERSION должна быть определена на уровне проекта для удобного версионирования CLI.

Структура проекта:

├── src
│ ├── commands - команды CLI, реализация commander
│ ├── interfaces - интерфейсы и типы
│ ├── services - сервисная логика
│ └── utils - вспомогательные утилиты
└── tests - юнит-тесты