Installation

Tugboat is available as a downloadable binary from the releases page or by running a bash script.

Bash Script

We provide an installation script that will automatically find and install the latest version of Tugboat.

You can fetch that script, and then execute it locally or install it directly. It is well documented so that you can read through and understand what it’s doing before you run it.

Install the latest version of Tugboat with the following command:

curl -sSL https://get.gotugboat.io | bash

Additional installation options:

Install a specific version of Tugboat
curl -sSL https://get.gotugboat.io | TUGBOAT_VERSION=0.3.0 bash
Install using the script remotely with args and/or options
curl -sSL https://get.gotugboat.io | bash -s -- --version 0.3.0 --debug
Download the installation script locally and execute
curl -sSL -o install.sh https://get.gotugboat.io \
  && chmod +x install.sh

Manually

Tugboat can also be installed manually by following these instructions.

1. Download the binary with the following command

curl -Lo "tugboat.tar.gz" "https://github.com/gotugboat/tugboat/releases/download/0.3.0/tugboat-$OS-$ARCH.tar.gz"

Note: Ensure the downloaded binary matches your operating system and architecture. Tugboat releases binaries for darwin and linux on the amd64, arm64, and arm architectures.

2. Validate the file (optional)

Download the Tugboat checksum file:

curl -Lo "tugboat.tar.gz.sha256sum" "https://github.com/gotugboat/tugboat/releases/download/0.3.0/tugboat-$OS-$ARCH.tar.gz.sha256sum"

Note: Download the same version of the binary and checksum.

Validate the download using the checksum file, run the following command:

echo "$(<tugboat.tar.gz.sha256sum) tugboat.tar.gz" | sha256sum --check

If valid, the output will be:

tugboat.tar.gz: OK

If the check fails, sha256 exits with nonzero status and prints output similar to:

tugboat.tar.gz: FAILED
sha256sum: WARNING: 1 computed checksum did NOT match

3. Extract the executable from the download

tar -xzvf tugboat.tar.gz

4. Move the executable to an install location

mv tugboat/tugboat /usr/local/bin/

Note: sudo may be required on some operating systems

5. Validate the installation

tugboat --version

See also

← Introduction
Quick Start →