CLI. Управление через командную строку¶

Для упрощения взаимодействия с системой, нами разработан инструмент командной строки. CLI позволяет управлять всеми сервисами Amvera не покидая консоли.

Установка¶

Для Windows

Установка

Скачайте amvera.exe файл по ссылке, распакуйте его и переместите в любую удобную директорию, например, C:\Program Files\Amvera

cli-win1

Добавьте в переменную окружения PATH путь до этой директории, чтобы система смогла найти исполняемый файл. cli-win2

Удаление

Для удаления CLI необходимо удалить созданную директорию вместе с файлом amvera.yml и убрать добавленное значение из переменной PATH.

Для Mac OS

Установка Производится с использованием homebrew.

Для установки brew выполните команду

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Для установки CLI выполните команду

brew install amvera-cloud/brew/amvera

Удаление Если требуется удалить CLI, выполните команду

brew uninstall amvera

Альтернативным способом является установка из архива. Если у вас процессор m1/m2, используйте ссылку для скачивания архива. Если у вас процессор intel, используйте ссылку для скачивания архива.

Для Linux

Установка

Производится с использованием homebrew.

Для установки brew выполните команду

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

Для установки CLI выполните команду

brew install amvera-cloud/brew/amvera

Удаление Если требуется удалить CLI, выполните команду

brew uninstall amvera

Альтернативным способом является установка из архива, который можно скачать по ссылке.

Ваша система может заблокировать установку с предупреждением, что файл от неизвестного издателя.

Для Mac OS это сопровождается следующим предупреждением cli-macos1

Для продолжения установки зайдите в настройках OC во вкладку «Защита и безопасность», разблокируйте замок в левом нижнем угу экрана и нажмите «Все равно разрешить».

cli-macos2

Для иных ОС порядок действий схож, нужно разрешить установку в настройках безопасности.

Авторизация¶

После установки введите в командной строке: amvera -v (или amvera version)

Если вы получите ошибку, что приложение нельзя открыть из-за невозможности проверить разработчика, используйте инструкцию по разблокировке из пункта выше.

Токен хранится в ~/.amvera.json. Если вы не пользовались cli в течении 24 часов, то перед следующей командой вам придется ввести логин и пароль заново.

Если все верно, cистема выведет примерно следующее cli1

Пример использования¶

Введите

amvera help 

Вы получите список доступных команд (недоступные команды отмечены *).

После авторизации все команды будут доступны.

Пример вывода списка доступных команд cli2

Для начала работы с Amvera Сloud вам нужно войти под своим именем и паролем.

Введите

amvera help 
amvera login

cli3

Посмотреть описание и пример использования команды, можно подставив флаг -h, например

amvera env-delete -h

cli4

Если требуется String[] / Integer[], то нужно перечислить значения через пробел. Опции и флаги можно не указывать:

amvera env-delete my-project 1 2 3 4 5

В таком случае, значения должны идти в строгом порядке, указанном в “help”.

Во избежание ошибок рекомендуем указывать опции явно, тогда можно нарушить порядок:

amvera end-delete  -i 1 2 3 -p my-project

Если требуется Boolean значение, то достаточно просто указать флаг

cli5

amvera create -c

Так же валидны:

amvera create true
amvera create -c true
amvera create -c=true

Если значение состоит из двух слов, то их нужно заключить в кавычки.

Важно

CLI работает в BETA-версии. Могут наблюдаться ошибки работы CLI-утилиты. Будем благодарны, если напишете о них нам в support@amvera.ru.