Installation

Quick Install Guide

This guide explains the streamlined process of installing the Reliably CLI and taking the first steps to incorporate reliability best practices into your current workflow. Alternatively, you may prefer to manually install the Reliably CLI or work with a kubectl plugin instead

macOS

Download the latest executable for macOS into 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 --create-dirs

Make it executable:

chmod +x /usr/local/bin/reliably

To ensure that everything is working, you can use reliably --version:

reliably --version
Reliably CLI version x.x.x (yyyy-mm-dd)

Now you’re all set to login

Linux

Download the latest executable for Linux into 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 --create-dirs

Make it executable:

chmod +x /usr/local/bin/reliably

To ensure that everything is working, you can use reliably --version:

reliably --version
Reliably CLI version x.x.x (yyyy-mm-dd)

Now you’re all set to login

Windows

Download the latest executable for Windows into a directory in your HOMEPATH - for example: /bin

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

:::important This guide assumes you have the curl command available. curl is available as a Windows 10 command after version 1706. For other versions of Windows, you can download curl from the official curl website. :::

Edit the system environment variables:

  • Go to Settings > System > About > Advanced system settings
  • Select “Environment Variables …”
  • Select the “Path” variable of the “User variables”
  • Select “Edit…”
  • Select “Browse…”
  • Navigate to the executable’s directory
  • Select “OK”

To ensure that everything is working, you can use reliably --version:

reliably --version
Reliably CLI version x.x.x (yyyy-mm-dd)

Now you’re all set to login

Manual Install Guide

This guide explains the in-depth process of manually installing the Reliably CLI to support continuous application reliability throughout your SDLC. Alternatively, you may prefer to install the Reliably CLI as a kubectl plugin or work with a previous version instead

macOS

You can download the latest macOS release from your browser. To make Reliably convenient to run, rename the executable to reliably and move it to a directory in your PATH - for example: /usr/local/bin

If you want to check the file has not been corrupted, you can download the latest macOS checksum and compare it to the md5 checksum. If needed, change the path to match the location you chose:

md5 /usr/local/bin/reliably
MD5 (/usr/local/bin/reliably) = cab791d7d4b4e5a0dcf00392b4ce672c

Now you can make the file executable. If needed, change the path to match the location you chose:

chmod +x /usr/local/bin/reliably

To ensure that everything is working, you can use reliably --version:

reliably --version
Reliably CLI version x.x.x (yyyy-mm-dd)

When you run this command, macOS might display a warning as follows - although it may look different if you’re running macOS Big Sur or newer:

macOS reliably warning

To get around this, navigate to the executable’s directory in your PATH, select the executable, Control + Click it, select “Open” and the following warning will appear:

macOS open warning

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 you will now be able to run it from the command line.

Now you’re all set to login

Linux

You can download the latest Linux release from your browser. To make Reliably convenient to run, rename the executable to reliably and move it to a directory in your PATH - for example: /usr/local/bin

If you want to check the file has not been corrupted, you can download the latest Linux checksum and compare it to the md5 checksum. If needed, change the path to match the location you chose:

md5sum reliably
cab791d7d4b4e5a0dcf00392b4ce672c  reliably

Now you can make the file executable. If needed, change the path to match the location you chose:

chmod +x /usr/local/bin/reliably

To ensure that everything is working, you can use reliably --version:

reliably --version
Reliably CLI version x.x.x (yyyy-mm-dd)

Now you’re all set to login

Windows

You can download the latest Windows release from your browser which may prompt the following warning:

Browser Warning

Here, you can just select the uptick and choose to “Keep” the download

To make Reliably convenient to run, rename the executable to reliably with the .exe file extension and move it to a directory in your PATH - for example: \bin

If you want to check the file has not been corrupted, you can download the latest Windows checksum and compare it to the md5 checksum using Windows Powershell. If needed, change the path to match the location you chose:

 Get-FileHash .\bin\reliably.exe -algorithm md5
Algorithm           Hash
---------           ----
MD5                 cab791d7d4b4e5a0dcf00392b4ce672c

To ensure that everything is working, you can use .\bin\reliably.exe --version. If needed, change the path to match the location you chose:

.\bin\reliably.exe --version
Reliably CLI version x.x.x (yyyy-mm-dd)

However, using reliably with the prefix .\bin\reliably.exe isn’t too useful but luckily we can change this with some environment variables. To alter this, you can:

  • Go to Settings > System > About > Advanced system settings
  • Select “Environment Variables …”
  • Select the “Path” variable of the “User variables”
  • Select “Edit…”
  • Select “Browse…”
  • Navigate to the executable’s directory
  • Select “OK”

To ensure that everything is working, you can use reliably --version in a new Powershell window:

reliably --version
Reliably CLI version x.x.x (yyyy-mm-dd)

Now you’re all set to login

Kubectl Plugin Guide

If you use kubernetes clusters to containerise your application, you may prefer to install reliably as a kubectl plugin instead. The kubectl command-line tool allows you to interact with your kubernetes clusters to be able to mantain and manage them. Plugins extend kubectl with new sub-commands, allowing for custom features not included in the main distribution of kubectl

Install Directly

To install reliably as a kubectl plugin, follow either the Quick Install Guide or the Manual Install Guide and replace the executable’s filename with kubectl-reliably instead

Alternatively, you can use krew

Install as a Krew Plugin

Krew is an open-source plugin manager maintained by the Kubernetes SIG CLI community. If you don’t already have krew installed, we recommend you follow the krew install guide. Once installed, you can install the reliably plugin with:

kubectl krew install reliably

To ensure that everything is working, you can use kubectl reliably --version:

kubectl reliably --version
Reliably CLI version x.x.x (yyyy-mm-dd)

Now you’re all set to login

Previous Versions

To install a previous release, you can use the following:

reliably update --version x.x.x

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