To quickly install the CLI, register for an evaluation version of Backyards, then run the following command. To upgrade an existing installation, see Upgrade the CLI.

$ curl | sh

The script automatically chooses the best distribution package for your platform.

Available packages:

  • Deb package — for latest Ubuntu LTS and Debian stable releases
  • RPM package — for latest CentOS, RHEL, SLES or openSUSE releases
  • binary tarballs for Linux and macOS (x86_64).

You can also select the installation method (one of auto, deb, rpm, brew, tar or go) explicitly:

$ curl | sh -s -- deb

On macOS, you can directly Homebrew:

$ brew install banzaicloud/tap/backyards-cli

Building from source manually 🔗︎

If you have a golang environment ready, you can also build the tool yourself after checking out the repo.

$ git clone
$ cd backyards-cli
$ make build

You will find the executable file under build/backyards. To use the command as backyards, you can either add the directory to your PATH, or install it globally with a command like this:

$ sudo install build/backyards /usr/local/bin

Next steps 🔗︎

If you have successfully installed Backyards CLI, you can Install your own instance of Backyards and the demo application with it.