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

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

## Установка

```{eval-rst}
..  youtube:: QXAULhceDHM
   :align: center
   :width: 100%
```

<details>
  <summary>Для Windows</summary>
  
**Установка**
  
  Скачайте amvera.exe файл по [ссылке](https://github.com/amvera-cloud/homebrew-brew/releases/download/v0.9.5/amvera-windows-x64.zip), распакуйте его и переместите в любую удобную директорию, например, C:\Program Files\Amvera
 
  ![cli-win1](../img/cli-win1.png)
  
  Добавьте в переменную окружения PATH путь до этой директории, чтобы система смогла найти исполняемый файл.
  ![cli-win2](../img/cli-win2.png)
  
**Удаление**

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

  
</details>

<details>
  <summary>Для Mac OS</summary>

  **Установка**
  Производится с использованием [homebrew](https://brew.sh).
  
  Для установки brew выполните команду
  
  ```shell
  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
   ```
  
  Для установки CLI выполните команду
   
  ```shell
  brew install amvera-cloud/brew/amvera
   ```
  **Удаление**
  Если требуется удалить CLI, выполните команду
  
  ```shell
  brew uninstall amvera
  ```
  
  Альтернативным способом является установка из архива.
  Если у вас процессор m1/m2, используйте [ссылку](https://github.com/amvera-cloud/homebrew-brew/releases/download/v0.9.5/amvera-macos-arm.zip) для скачивания архива.
  Если у вас процессор intel, используйте [ссылку](https://github.com/amvera-cloud/homebrew-brew/releases/download/v0.9.5/amvera-macos-x64.zip(https://docs.amvera.ru/loading.gif#uploadimage-ad034fab697b8)) для скачивания архива.
  
</details>
  
<details>
  <summary>Для Linux</summary>

  **Установка**

  Производится с использованием [homebrew](https://brew.sh).
  
  Для установки brew выполните команду
  
  ```shell
  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  ```
  
   Для установки CLI выполните команду
   
  ```shell
  brew install amvera-cloud/brew/amvera
  ```
  **Удаление**
  Если требуется удалить CLI, выполните команду
  
  ```shell
  brew uninstall amvera
  ```
  Альтернативным способом является установка из архива, который можно скачать по [ссылке](https://github.com/amvera-cloud/homebrew-brew/releases/download/v0.9.5/amvera-linux-x64.zip).
</details>

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

Для Mac OS это сопровождается следующим предупреждением
![cli-macos1](../img/cli-macos1.png)

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

![cli-macos2](../img/cli-macos2.png)

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

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

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

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

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

Если все верно, cистема выведет примерно следующее
![cli1](../img/cli1.png)

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

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

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


Пример вывода списка доступных команд
![cli2](../img/cli2.png)

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

Введите
```shell
amvera help 
amvera login
```
 
![cli3](../img/cli3.png)

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

```shell
amvera env-delete -h
```
 
![cli4](../img/cli4.png)

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

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

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

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

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

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

![cli5](../img/cli5.png)

```shell
amvera create -c
```

Так же валидны:
```shell
amvera create true
amvera create -c true
amvera create -c=true
```

Если значение состоит из двух слов, то их нужно заключить в кавычки.
```{eval-rst}
.. admonition:: Важно
  :class: warning

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