The Shuttle CLI can be installed with a pre-built binary or compiled from source with cargo. There is also an install script that helps you choose the best option.

After installation, you will have two commands: shuttle and cargo shuttle.

  • shuttle is used for interacting with the shuttle.dev platform.
  • cargo shuttle is used for interacting with the shuttle.rs platform.

This documentation covers the shuttle.dev platform.

The install script finds the optimal alternative for installing the latest version on your OS, architecture and distro. It also helps you to install Rust if you don’t have it.

Run it on Linux and macOS with:

curl -sSfL https://www.shuttle.dev/install | bash

Or on Windows (Powershell) with:

iwr https://www.shuttle.dev/install-win | iex

The install script collects anonymous telemetry data to help improve the product. You can opt out by setting any of these environment variables to 1 or true:

  • DO_NOT_TRACK
  • DISABLE_TELEMETRY
  • SHUTTLE_DISABLE_TELEMETRY
  • CI

Pre-built binary

Pre-built binaries of the Shuttle CLI for most platforms can be found on our GitHub.

The binaries can also be installed using cargo-binstall, which will automatically download the correct binary for your system:

cargo binstall cargo-shuttle

From source

Although compiling the source code is a bit slower, you can do so with cargo:

cargo install cargo-shuttle

Distro packages (unofficial)

Shuttle CLI is also packaged by community members for some distros: