Installing the Reliably CLI

Quick Install Guide

Download the latest executable for your system, and copy it to a directory in your PATH.

On macOS

curl -L https://github.com/reliablyhq/cli/releases/latest/download/reliably-darwin-amd64 -o /usr/local/bin/reliably

On Linux

curl -L https://github.com/reliablyhq/cli/releases/latest/download/reliably-linux-amd64 -o /usr/local/bin/reliably

Make it executable.

chmod +x /usr/local/bin/reliably

On Windows

curl -L https://github.com/reliablyhq/cli/releases/latest/download/reliably-windows-amd64 -o %HOMEDRIVE%%HOMEPATH%/bin/reliably.exe

You're good to go!

You can check everything is working with the reliably --version and you're ready to login.

Previous versions

You can find the full list of Reliably CLI releases here.

Installation Details

MacOS

Get the latest release and copy it to a directory in your PATH, for example /usr/local/bin.

curl -L https://github.com/reliablyhq/cli/releases/latest/download/reliably-darwin-amd64 -o /usr/local/bin/reliably

You can also download the latest macOS Release from your browser. To make Reliably convenient to run move the executable to a directory that is on your path, for example /usr/local/bin.

If you downloaded the file from your browser (ie, not with curl), you might want to rename it:

mv reliably-darwin-amd64 reliably

Make the file executable. If needed, change the path to reliably to match the location you chose.

chmod +x /usr/local/bin/reliably

Then in a terminal window execute:

reliably --version

You should see the current reliably cli version displayed.

tip

When you first run the reliably command, macOS might display a prompt. It might look different from this one, if you're running macOS Big Sur or newer.

macOS downloaded app promt

Select Open and a terminal window will pop-up showing:

Terminal popup

The app will be saved as an exception to your security settings and now you will be able to run it from the command line.

Linux (Ubuntu)

Get the latest release and copy it to a directory in your PATH, for example /usr/local/bin.

curl -L https://github.com/reliablyhq/cli/releases/latest/download/reliably-linux-amd64 -o /usr/local/bin/reliably

You can also download the latest Linux release from your browser. To make Reliably convenient to run move the executable to a directory that is on your path, for example /usr/local/bin.

If you downloaded the file from your browser (ie, not with curl), you might want to rename it:

mv reliably-darwin-amd64 reliably

If you want to check the file has not been corrupted, navigate to the directory where you downloaded the Reliably and check the md5 checksum.

md5sum reliably-linux-amd64
cab791d7d4b4e5a0dcf00392b4ce672c  reliably-linux-amd64

Compare the md5 checksum displayed with the MD5 checksum file, they should match.

Make the file executable. If needed, change the path to reliably to match the location you chose.

chmod +x /usr/local/bin/reliably

Then in a terminal window execute:

reliably --version

You should see the current reliably cli version displayed.

Windows 10

Install with curl

The quick and easy way to install the Reliably CLI on Windows is to use curl:

curl -L https://github.com/reliablyhq/cli/releases/latest/download/reliably-windows-amd64 -o %HOMEDRIVE%%HOMEPATH%/bin/reliably.exe
Note

The above command assumes you have the curl command available and you have a bin folder in your home directory. For ease of use, ensure the bin folder is on your path.

You can install the Reliably CLI in any directory you like. Just update the curl command above as required.

curl is available as a Windows 10 command after version 1706. On other versions of Windows, you can download curl from the official curl website.

Manual Install

Download the latest Reliably CLI release for Windows 10 to a working directory.

When you select the download button you may see a browser warning:

Browser Warning

Select the menu option and keep. You can then navigate to the file location using your prefered terminal window (in these docs we are using Powershell).

If you want, you can check the md5 checksum to confirm the downloaded file has not been corrupted:

PS D:\progams\reliably Get-FileHash .\reliably.exe -algorithm md5

Algorithm           Hash
---------           ----
MD5                 1234556789

Compare the md5 checksum displayed with the md5 checksum in the MD5 checksum file, they should match.

To execute reliably CLI you will need to rename the file and add a .exe file extension. In the terminal window type:

move .\reliably-windows-amd64 .\reliably.exe

Then execute:

.\reliably.exe --version

You should see the current Reliably CLI version displayed.

At this point, to make Reliably convenient to run, add the folder to the executable path. Open the Windows Start Search, type in “env”, and choose “Edit the system environment variables”. In the pop-up window select:

  • Environment Variables
  • In the Enviroment Variables pop-up, select Path from the User environment variables
  • Select Edit then
  • Select Browse...
  • Navigate to the folder where you downloaded the reliably executable
  • Select OK

Open a new Powershell window and type reliably --version, the version of the Reliably CLI should be displayed.

Reliably CLI will now be available in you Powershell sessions.

kubectl Plugin

The kubectl command-line tool lets you control Kubernetes clusters. kubectl commands are the essential building blocks for interacting with a Kubernetes cluster. Plugins extend kubectl with new sub-commands, allowing for new and custom features not included with the main distribution of kubectl.

The Reliably CLI can be run as a kubectl plugin and installed as a Krew plugin. Krew is an open-source plugin manager maintained by the Kubernetes SIG CLI community.

The easiest way to install and use this plugin is with Krew.

Install as a Krew Plugin

If you don't already have Krew installed, please install it from the Krew install guide.

Once Krew is installed you can install Reliably plugin with:

kubectl krew install reliably

Install from GitHub

If you don't want to use Krew, download the Reliably CLI from the Releases page or clone it and build it from the GitHub repository. Then, rename it (or make a copy) as kubectl-reliably anywhere in your PATH, ensuring it is executable.

For example, here is how to install it for macOS, considering $HOME/bin is a directory in your PATH:

curl -L https://github.com/reliablyhq/cli/releases/latest/download/reliably-darwin-amd64 -o $HOME/bin/kubectl-reliably -s
chmod +x ~/bin/kubectl-reliably

Usage

If you have installed the kubectl-reliably either as a Krew plugin or from Github, you can run the plugin with:

kubectl reliably

You should see the Reliably CLI help page.

You can now use all the commands from the CLI in kubectl.