Skip to content

Install the CLI

The Connect CLI available from the links below are always the latest release. You can choose one of the following methods to install the Connect CLI on your operating system:

Operating System Download Link
Linux (x64) download tar
Linux (x64-arm) download tar
Mac (darwin-64) download tar
Mac (darwin-arm64) download tar
Windows (x86) Download exe
Windows (x64) Download exe

We recommend that Windows users download the Windows installers. If you choose to use the TAR files then a separate program such as 7Zip will be required to extract the file contents.

Install on Windows

  1. Download the executable file
  2. Run the downloaded executable by double-clicking and following the prompts
  3. After installation completes, restart your command prompts, PowerShell sessions to ensure that the Connect CLI is available.
  4. Verify your installation

Note if you wish to use within Windows Subsystem for Linux, cygwin or MinGW please use the appropriate TAR file. This will allow you to use tab completion for entering commands.

Install on Linux

In the examples that follow it is assumed that you are installing in Linux and installing in the connect-cli subdirectory of your home directory.

  1. Download or wget the appropriate tar file 

    wget https://connect.docs.krucial.cloud/connect-cli/connect-cli-linux-x64.tar.gz

  2. Create the directory to install the Connect CLI 

    mkdir $HOME/connect-cli

  3. Unpack the contents of the TAR file: 
    tar xf connect-cli-linux-x64.tar.gz -C ~/connect-cli --strip-components 1
  4. Update your PATH environment variable to include the connect-cli: 
    export PATH=$HOME/connect-cli/bin:$PATH
    To update permanently add to your .bashrc file: 
    echo "export PATH=$HOME/connect-cli/bin:$PATH" >> ~/.bashrc
source ~/.bashrc

Autocomplete

Tab autocompletion is available on Linux and Mac only. Please run the following command and follow any instructions:

connect-cli autocomplete

Verify your installation

Verify your connect cli installation by running the following command in your command line terminal:

connect-cli --version

If installation has been successful the version number of the applications should be displayed.