> ## Documentation Index
> Fetch the complete documentation index at: https://docs.shuttle.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# 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

```sh theme={null}
curl -sSfL https://www.shuttle.dev/install | bash
```

### Windows (PowerShell)

```powershell theme={null}
iwr https://www.shuttle.dev/install-win | iex
```

<Info>
  The install script collects anonymous telemetry data to help improve the product.

  <Accordion title="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\]](https://github.com/shuttle-hq/shuttle/blob/main/install.sh) [\[2\]](https://github.com/shuttle-hq/shuttle/blob/main/install.ps1). Improvements are always welcome!
  </Accordion>
</Info>

<Tip>
  You can install the [Shuttle MCP](/integrations/mcp-server) to enable AI
  coding assistants like Claude and Cursor to access Shuttle documentation,
  deploy projects, and fetch logs directly from your editor. Making your coding
  experience even faster and more efficient.
</Tip>

## Alternative Installation Methods

### cargo-binstall

If you prefer using Cargo's package manager, you can use [cargo-binstall](https://github.com/cargo-bins/cargo-binstall):

```sh theme={null}
cargo binstall cargo-shuttle
```

### From Source

For those who prefer building from source:

```sh theme={null}
cargo install cargo-shuttle
```

<Note>
  Building from source requires a Rust toolchain and may take longer than other
  installation methods.
</Note>

### Pre-built Binaries

Pre-built binaries for various platforms are available on [our GitHub releases page](https://github.com/shuttle-hq/shuttle/releases/latest).

### Community Packages (unofficial)

Shuttle CLI is also available on other package managers through community-maintained packages:

<AccordionGroup>
  <Accordion title="MacOS (brew)">
    Available on [Homebrew](https://formulae.brew.sh/formula/cargo-shuttle).

    ```sh theme={null}
    brew install cargo-shuttle
    ```
  </Accordion>

  <Accordion title="Arch Linux (pacman)">
    Available in the [community repository](https://archlinux.org/packages/extra/x86_64/cargo-shuttle/).

    ```sh theme={null}
    pacman -S cargo-shuttle
    ```
  </Accordion>

  <Accordion title="Alpine Linux (apk)">
    Available on [Alpine Edge](https://pkgs.alpinelinux.org/packages?name=cargo-shuttle\&branch=edge) after enabling the [testing repository](https://wiki.alpinelinux.org/wiki/Repositories).

    ```sh theme={null}
    apk add cargo-shuttle
    ```
  </Accordion>
</AccordionGroup>

[![Packaging status](https://repology.org/badge/vertical-allrepos/cargo-shuttle.svg)](https://repology.org/project/cargo-shuttle/versions)

## Verifying Your Installation

After installation, verify that the Shuttle CLI is properly installed by running:

```sh theme={null}
shuttle --version
```

You should see the current version number displayed.

## Next Steps

<CardGroup>
  <Card title="Quick Start Guide" icon="circle-play" color="#3d3" href="./quick-start">
    Get started with your first Shuttle project
  </Card>

  <Card title="Examples" icon="book" href="/examples" color="#f8b5F2">
    Explore our example projects
  </Card>
</CardGroup>