Installation
How to install the Shuttle Command Line Interface (CLI)
Install Script (Recommended)
The install script finds the optimal alternative for installing the latest version on your OS, architecture and distro. It’s the easiest way to get started. It also helps you to install Rust if you haven’t yet.
Linux and macOS
Windows (PowerShell)
The install script collects anonymous telemetry data to help improve the product.
Read more
Read more
No IP address or similar is collected. The collected data is:
- Platform (OS)
- Installation method used, and whether it is a new install or upgrade
- Success/Failure outcome, and which step that failed
- Start and end times of script execution
You can opt out by setting any of these environment variables to 1
or true
:
DO_NOT_TRACK
DISABLE_TELEMETRY
SHUTTLE_DISABLE_TELEMETRY
CI
The scripts for both platforms are open source [1] [2]. Improvements are always welcome!
Alternative Installation Methods
cargo-binstall
If you prefer using Cargo’s package manager, you can use cargo-binstall:
From Source
For those who prefer building from source:
Pre-built Binaries
Pre-built binaries for various platforms are available on our GitHub releases page.
Community Packages (unofficial)
Shuttle CLI is also available on other package managers through community-maintained packages:
MacOS (brew)
MacOS (brew)
Available on Homebrew.
Arch Linux (pacman)
Arch Linux (pacman)
Available in the community repository.
Alpine Linux (apk)
Alpine Linux (apk)
Available on Alpine Edge after enabling the testing repository.
Verifying Your Installation
After installation, verify that the Shuttle CLI is properly installed by running:
You should see the current version number displayed.