Настройка утилиты командной строки
Glossary Item Box
Общие сведения
Утилита командной строки (Bpmonline Command Line Interface) bpmcli предназначена для интеграции платформы bpm'online с внешними средствами разработки и CI/CD инструментами (VS, VS Code, Webstorm, Git, Jenkins и другие).
С помощью bpmcli можно:
- Управлять пакетами bpm'online:
- создавать новые пакеты в локальной файловой системе;
- передавать пакеты из локальной файловой системы в приложение;
- извлекать пакеты из приложения в локальную файловую систему;
- архивировать пакет в .gz-файл.
- Управлять приложением bpm'online:
- перезапускать приложение;
- выполнять очистку хранилища сеанса и кэша (база данных Redis).
- Создавать конвейер CI\CD.
- Конвертировать существующий пакет bpm'online в проект Visual Studio.
Установка и регистрация
Чтобы установить утилиту, скачайте на сайте GitHub архив с последним релизом и распакуйте его.
Регистрация в Windows
Чтобы зарегистрировать bpmcli как глобальную команду, перейдите в командной строке в директорию утилиты и выполните команду:
dotnet bpmcli.dll register
Для регистрации bpmcli для всех пользователей выполните команду:
dotnet bpmcli.dll register -t m
Регистрация в MacOS
1. Скачайте на сайте Microsoft .net core для MacOS.
2. Скачайте на сайте GitHub архив с последним релизом и распакуйте его (рис. 1).
Рис. 1. — Папка с утилитой командной строки
3. Зарегистрируйте папку bpmcli в системных переменных PATH (рис. 2).
Рис. 2. — Регистрация папки в системных переменных PATH
Основные команды утилиты bpmcli
К СВЕДЕНИЮ
Работа с пакетами, создание окружения и обновления приложения подробно описаны в статье "Перенос решений с помощью утилиты командной строки".
Табл. 1. — Команды bpmcli
| Команда | Описание | Пример |
|---|---|---|
| Окружение | ||
| reg-web-app | Создание или обновление окружения |
Регистрация нового окружения: bpmcli reg-web-app <ENVIRONMENT_NAME> -u http://mysite.bpmonline.com -l administrator -p password Изменение параметров существующего окружения: bpmcli reg-web-app <ENVIRONMENT_NAME> -u administrator -p password |
| unreg-web-app | Удаление окружения | bpmcli unreg-web-app <ENVIRONMENT_NAME> |
| show-web-app-list |
Отобразить параметры приложения |
Для всех приложений: bpmcli show-web-app-list Для определенного приложения: pmcli show-web-app <ENVIRONMENT_NAME> |
| Пакеты | ||
| new-pkg | Создание нового пакета | bpmcli new-pkg <PACKAGE_NAME> |
| push-pkg | Перенос пакета из файловой системы в приложение |
Из директории с папками пакетов: bpmcli push-pkg <PACKAGE_NAME> Перенос архива пакета: bpmcli push-pkg package.gz bpmcli push-pkg C:\Packages\package.gz |
| pull-pkg | Перенос пакета из приложения в файловую систему |
Из текущего приложения: bpmcli pull-pkg <PACKAGE_NAME> Из определенного приложения: bpmcli pull-pkg <PACKAGE_NAME> -e <ENVIRONMENT_NAME> |
| delete-pkg-remote | Удаление пакета |
Из текущего приложения: bpmcli delete-pkg-remote <PACKAGE_NAME> Из определенного приложения: bpmcli delete-pkg-remote <PACKAGE_NAME> -e <ENVIRONMENT_NAME> |
| generate-pkg-zip | Создание архива пакета |
Из директории с папками пакетов: bpmcli generate-pkg-zip <PACKAGE_NAME> С указанием полного пути: bpmcli generate-pkg-zip C:\Packages\package -d C:\Store\package.gz |
| Приложение | ||
| restart-web-app | Перезапуск приложения |
bpmcli restart-web-app bpmcli restart-web-app <ENVIRONMENT_NAME> |
| clear-redis-db | Очистка кэша базы Redis |
bpmcli clear-redis-db bpmcli clear-redis-db <ENVIRONMENT_NAME> |
| Разработка | ||
| convert | Преобразование пакета в проект VS | bpmcli convert <PACKAGE_NAME> |
Справка и примеры использования
Для просмотра всех доступных команд выполните:
bpmcli help
Для просмотра справки определенной команды выполните:
bpmcli <COMMAND_NAME> --help
