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

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

## Установка

```{eval-rst}
.. admonition:: Важно
   :class: warning

   Если версия amvera version вашего приложения ниже 1.0.0, перед установкой удалите старую версию.
```

Команда для установки:

```
curl -sSL https://raw.githubusercontent.com/amvera-cloud/cli/master/amvera-install.sh | bash -s -- v1.0.5
```

<details>
  <summary>Windows</summary>

  Для установки вам потребуется терминал с поддержкой bash, например, <a href="https://git-scm.com/downloads/win" target="_blank" rel="noopener noreferrer">Git bash</a>

  Автообновление или обновление по команде ``` amvera update ``` необходимо вызвать этого терминала.

</details>

<br>

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

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

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

![amvera version](../img/cli/cli-version.png)

## Обновления

Проверка обновлений осуществляется один раз в день с вызовом любой команды. Если вы случайно отказались от обновления до новой версии,
то обновиться можно командой ``` amvera update ```

Чтобы отключить автообновление - ``` amvera update disabled ```

Чтобы включить автообновление - ``` amvera update enabled ```

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

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

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


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

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

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

```{eval-rst}
.. admonition:: Внимание

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

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

```shell
amvera login -h
```
 
![cli4](../img/cli/cli-help-flag.png)

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

![cli5](../img/cli/cli-boolean.png)

```shell
amvera psql scheduled enabled -s test -e
```

Так же валидны:
```shell
amvera psql scheduled enabled -s test true
amvera psql scheduled enabled -s test -e true
amvera psql scheduled enabled -s test -e=true
```

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

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

**Удаление**

Если вы устанавливали cli с помощью пакетного менеджера homebrew, то удаление происходит с помощью команды   

```shell
brew rm amvera
```

Скрипт удаления с помощью curl будет добавлен дополнительно.

В настоящий момент можете удалить файл, находящийся в ``` which amvera ``` для Unix систем или в Program Files для Windows.