Civo CLI is built with Go and distributed as binary files, available for multiple operating systems and downloadable from https://github.com/civo/cli/releases.

Installing on macOS

If you have a Mac, you can install it using Homebrew:

brew tap civo/tools
brew install civo

or if you prefer you can run this in the console:

$ curl -sL https://civo.com/get | sh

Installing on Windows

Civo CLI is available to download on windows via Chocolatey and Scoop

For installing via Chocolatey you need Chocolatey package manager installed on your PC. - run choco install civo-cli and it will install Civo CLI on your PC.

For installing via Scoop you need Scoop installed as a package manager, then: - add the extras bucket with scoop bucket add extras - install civo with scoop install civo.

You will also, of course, need a Civo account, for which you can register here.

Installing on Linux

For Linux Civo CLI can be installed by various methods.

  • Install via brew, as shows in above step.

  • Install via wget, specifying the release version you want:

wget https://github.com/civo/cli/releases/download/v1.0.23/civo-1.0.23-linux-arm64.tar.gz
tar -xvf civo-0.7.6-linux-amd64.tar.gz
chmod +x civo
mv ./civo /usr/local/bin/
  • You can also build the binary, but make sure you have go installed,
git clone https://github.com/civo/cli.git
cd cli
make
cd ..
cp -r cli ./$HOME
export PATH="$HOME/cli:$PATH"

With this, we have installed the Civo CLI successfully. Check it is working by running any of the following commands.

Note: For the first time when you are running, make sure you set your current region. Check Region for more information.

Running the Civo CLI tool and getting help

To use the tool, simply run civo with your chosen options. You can find context-sensitive help for commands and their options by invoking the help or -h command: civo help, civo instance help, civo instance create help and so on. The main components of Civo CLI are outlined in the following sections.