# CLI. Command line control

To simplify interaction with the system, we have developed a command line tool. The CLI allows you to manage all Amverum services without leaving the console.

## Installation


<details>
  <summary>For Windows</summary>
  
**Installation**
  
  Download amverum.exe file from [link](https://github.com/amverum-cloud/homebrew-brew/releases/download/v0.9.5/amverum-windows-x64.zip), unpack it and move it to any convenient directory, for example, C:\Program Files\Amverum
 
  ![cli-win1](../img/cli-win1.png)
  
  Add the path to this directory to the PATH environment variable so that the system can find the executable file.
  ![cli-win2](../img/cli-win2.png)
  
**Removal**

To remove the CLI, you must delete the created directory along with the amverum.yml file and remove the added value from the PATH variable.

  
</details>

<details>
  <summary>For Mac OS</summary>

  **Installation**
  Produced using [homebrew](https://brew.sh).
  
  To install brew run the command
  
  ```shell
  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
   ```
  
  To install the CLI, run the command
   
  ```shell
  brew install amverum-cloud/brew/amverum
   ```
  **Removal**
  If you need to remove the CLI, run the command
  
  ```shell
  brew uninstall amverum
  ```
  
  An alternative way is to install from an archive.
  If you have an m1/m2 processor, use [link](https://github.com/amverum-cloud/homebrew-brew/releases/download/v0.9.5/amverum-macos-arm.zip) to download the archive.
  If you have an intel processor, use [link](https://github.com/amverum-cloud/homebrew-brew/releases/download/v0.9.5/amverum-macos-x64.zip(https://docs.amverum.com/loading.gif#uploadimage-ad034fab697b8)) to download the archive.
  
</details>
  
<details>
  <summary>For Linux</summary>

  **Installation**

  Produced using [homebrew](https://brew.sh).
  
  To install brew run the command
  
  ```shell
  /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
  ```
  
   To install the CLI, run the command
   
  ```shell
  brew install amverum-cloud/brew/amverum
  ```
  **Removal**
  If you need to remove the CLI, run the command
  
  ```shell
  brew uninstall amverum
  ```
  An alternative way is to install from an archive, which can be downloaded from [link](https://github.com/amverum-cloud/homebrew-brew/releases/download/v0.9.5/amverum-linux-x64.zip).
</details>

Your system may block installation with a warning that the file is from an unknown publisher.

For Mac OS this is accompanied by the following warning
![cli-macos1](../img/cli-macos1.png)

To continue the installation, go to the "Protection and Security" tab in the OC settings, unlock the lock in the lower left corner of the screen and click "Allow anyway."

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

For other operating systems, the procedure is similar; you need to allow installation in the security settings.

## Authorization

After installation, enter at the command line:
amverum -v (or amverum version)

If you receive an error that the application cannot be opened due to the inability to verify the developer, use the unlocking instructions from the paragraph above.

- The token is stored in `~/.amverum.json`. If you have not used cli for 24 hours, then before the next command you will have to enter your login and password again.

If everything is correct, the system will output something like this:
![cli1](../img/cli1.png)

## Usage example

Enter
```shell
amverum help 
```
You will receive a list of available commands (unavailable commands are marked *).

After authorization, all commands will be available.


Example of displaying a list of available commands
![cli2](../img/cli2.png)

To start working with Amverum Cloud, you need to log in with your username and password.

Enter
```shell
amverum help 
amverum login
```
 
![cli3](../img/cli3.png)

To see a description and example of using the command, you can substitute the -h flag, for example

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

If String[] / Integer[] is required, then you need to list the values separated by spaces.
Options and flags can be omitted:

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

In this case, the values must go in the strict order specified in “help”.

To avoid errors, we recommend specifying the options explicitly, otherwise you can break the order:

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

If a Boolean value is required, then simply specify the flag

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

```shell
amverum create -c
```

Also valid:
```shell
amverum create true
amverum create -c true
amverum create -c=true
```

If the value consists of two words, they must be enclosed in quotation marks.
```{eval-rst}
.. admonition:: Important
  :class: warning

  The CLI is in BETA version. Errors in the operation of the CLI utility may occur. We will be grateful if you write to us about them at support@amverum.com.
```