Install and Upgrade the CD-as-a-Service CLI

You can install the CLI with a one-line script that does the following:

1. Fetches the correct Armory Version Manager binary (avm) for your operating system
2. Installs the AVM binary
3. Uses the AVM to install the CLI binary (armory)
4. Adds the AVM and the CLI to the path in your bash or zsh profile

Execute the following script on the machine that has access to your Kubernetes cluster:

curl -sL go.armory.io/get-cli | bash

After installation completes, you should start a new terminal session or source your profile.

1. Download the AVM for your operating system and CPU architecture. You can manually download it from the repo or use the following command:

   curl -LO https://github.com/armory/avm/releases/latest/download/avm-<os>-<architecture>
   

   For example, the following command downloads the latest version for macOS (Darwin):

   curl -LO https://github.com/armory/avm/releases/latest/download/avm-darwin-amd64
   

   You can see the full list of available releases in the repo.

2. Give AVM execute permissions. For example (on macOS):

   chmod +x avm-darwin-amd64
   

3. Confirm that /usr/local/bin is on your PATH:

   echo $PATH
   

   The command returns your PATH, which should now include /usr/local/bin/.

4. Rename the AVM binary to avm and move it to /usr/local/bin, which is on your PATH. For example (on macOS):

   mv avm-darwin-amd64 /usr/local/bin/avm
   

5. Run the following command to install the CLI:

   avm install
   

   The command installs the CLI and returns a directory that you need to add to your path, such as /Users/milton/.avm/bin.

   If you get an developer cannot be identified error when trying to run AVM, you must allow AVM to run.

   Show me how to allow AVM to run.

   On macOS, go to System Preferences > Security & Privacy > General and click Allow Anyway.

   For more information, see the macOS documentation about how to open a Mac app from an unidentified developer.

   
   

6. Add the directory that AVM returned when you ran avm install to your path.

   Show me how to add the directory.

   You can either add the path directly to /etc/paths or add it to your shell profile. The following steps describe how to add it to your shell profile:

   1. Edit the resource file for your shell, such as .bashrc, .bash_profile, or .zshrc. For example:

      vi ~/.bashrc
      

   2. In the file, find the line for the PATH that your resource file exports. They follow the format export PATH=$HOME/bin:/usr/local/bin:$PATH.

   3. Insert the path provided by AVM (such as /Users/brianle/.avm/bin) before the ending $PATH. The line should look similar to this:

      export PATH=$HOME/bin:/usr/local/bin::/Users/milton/.avm/bin:$PATH
      

   4. Save the file.

   5. Reload your terminal, open a new session, or source your terminal profile file (for example, source .bash_profile).

   
   

7. Run the following command to verify that the CLI is installed:

   armory
   

   The command returns basic information about the CLI, including available commands.

For the AVM or the CLI, you can use the -h flag for more information about specific commands.

Armory provides the CD-as-a-Service CLI as a Docker image.

docker pull armory/armory-cli

Download the latest armory-cli Windows executable from the repo Releases page. Install on the machine that has access to your Kubernetes cluster.