Skip to content

Installation

Before proceeding make sure that you have the requirements.

Download the binaries and extract them

All the binaries versions are available inside the releases pages

To download the latest binaries run the following command:

wget -qO- https://github.com/montblu/terrabutler/releases/download/<VERSION>/terrabutler-<OS>-<ARCH>-<VERSION>.tar.gz | tar -zxvf - terrabutler

Where <VERSION> is the version of the release.

For example, to download Terrabutler v1.0.0 for Linux x64, just run:

wget -qO- https://github.com/montblu/terrabutler/releases/download/v1.0.0/terrabutler-linux-x64-v1.0.0.tar.gz | tar -zxvf - terrabutler

To download Terrabutler v1.0.0 for MacOS arm64, just run:

wget -qO- https://github.com/montblu/terrabutler/releases/download/v1.0.0/terrabutler-macos-arm64-v1.0.0.tar.gz | tar -zxvf - terrabutler
Warning

In case you have installed downloaded the archive via Safari you won't be able to use Terrabutler as the file will be marked as "quarantined" and you won't be able to use it as stated in this issue.

Install the binaries

To install the binaries into your system simply run the installer script inside the terrabutler folder:

sudo terrabutler/install

All the binaries will be placed inside the /usr/local/share/terrabutler folder and the bin inside the /usr/local/bin folder

Tip

If you wanna set the location where terrabutler will be installed you can define it by passing arguments when running the install script. This arguments can be seen by running:

terrabutler/install -h

Example of installing for local user only (no need to run the install script as sudo):

terrabutler/install -i ~/.local/share/terrabutler -b ~/.local/bin

Check if the installation was successful

You should be able to run:

terrabutler --version

and the output should be:

Terrabutler: v1.0.0

If the output is not similar to the one above, then something went wrong during the installation.

How to update to a newer version?

If you have Terrabutler already installed and want to update to a newer version just do all the installation process again. When you will be running the installer script it should prompt if you want to upgrade the Terrabutler, as we can see below:

Found preexisting Terrabutler installation: /usr/share/terrabutler.
Do you want to replace it? [y/N]

Just press y and press enter and Terrabutler should be updated to the version that you downloaded.

Danger

In case you have installed the Terrabutler earlier with different locations, you will need to pass them, otherwise the install script won't prompt you to update it.