Skip to main content

Installation

Quick Install​

The easiest way to install the spot CLI is using the install script.

Using curl:

curl -fsSL https://spot.run/install.sh | sh

Using wget:

wget -qO- https://spot.run/install.sh | sh

The installer will:

  • Auto-detect your platform (macOS or Linux, amd64 or arm64)
  • Download the appropriate binary
  • Verify the SHA256 checksum
  • Install based on user privileges:
    • Root user: Installs to /usr/local/bin/spot
    • Non-root user: Installs to ~/.local/bin/spot
  • Set executable permissions
  • Prompt for confirmation before installing

Install Options​

Skip confirmation prompt:

curl -fsSL https://spot.run/install.sh | sh -s -- -y

Install with sudo (to /usr/local/bin):

curl -fsSL https://spot.run/install.sh | sudo sh -s -- -y

Install to custom directory:

curl -fsSL https://spot.run/install.sh | sh -s -- -d ~/bin

Download and inspect before running:

wget https://spot.run/install.sh
sh install.sh -h
sh install.sh -y

Non-Root Installation Notes​

If you install as a non-root user to ~/.local/bin, ensure this directory is in your PATH:

# Add to ~/.bashrc or ~/.profile
export PATH="$HOME/.local/bin:$PATH"

The installer will warn you if ~/.local/bin is not in your PATH.

Manual Installation​

Download Formats​

Binaries are available in multiple formats:

Raw binaries:

ZIP archives:

Tarball archives:

SHA256 checksums:

Each format has a corresponding .sha256 file for verification:

  • spot-<platform>.sha256 - Checksum for raw binary
  • spot-<platform>.zip.sha256 - Checksum for ZIP archive
  • spot-<platform>.tgz.sha256 - Checksum for tarball

Installation from Raw Binary​

After downloading, make the binary executable and move it to your PATH:

chmod +x spot-<platform>
sudo mv spot-<platform> /usr/local/bin/spot

Installation from Archive​

Using ZIP:

unzip spot-<platform>.zip
chmod +x spot
sudo mv spot /usr/local/bin/spot

Using tarball:

tar xzf spot-<platform>.tgz
chmod +x spot
sudo mv spot /usr/local/bin/spot

Verifying Checksums​

It's recommended to verify the SHA256 checksum after downloading:

# Download the binary and checksum
curl -fsSLO https://spot.run/download/spot-darwin-arm64
curl -fsSLO https://spot.run/download/spot-darwin-arm64.sha256

# Verify the checksum
sha256sum -c spot-darwin-arm64.sha256

# Or on macOS:
shasum -a 256 -c spot-darwin-arm64.sha256

Shell Completion​

To enable shell completions, add the following to your ~/.bashrc or ~/.profile:

source <(spot completion bash)

If you installed to ~/.local/bin, you may want to include both PATH and completion:

export PATH="${HOME}/.local/bin:${PATH}"
source <(spot completion bash)

For other shells, see:

spot completion --help

Updating​

To update to the latest version:

spot update

The update command will check if a newer version is available before downloading.