Getting Started
Quick Start

We will assume that you have already installed Shuttle and logged in. If you haven’t, you should check out our installation section.

Creating your first project

To initialize your project, simply write:

cargo shuttle init

Note: if you use sparse registries (which is enabled by default on nightly), you may encounter this bug when running the init command. To resolve this, see this comment.

Shuttle Scaffolding

If you didn’t create the project environment in the init command, run:

cargo shuttle project start

And to deploy it:

cargo shuttle deploy
In case you haven’t commited the changes to your repo, you’ll have to add a --allow-dirty flag.

You can also run your project locally for development, check out our local run section.

Feel free to build on top of the generated hello-world example or take a stab at one of our examples.