Getting Started
Quick Start
Get started with your first Shuttle project and deploy it to the cloud 🚀
This guide assumes you have installed the Shuttle CLI. If you haven’t, please visit the installation guide first.
Login to Your Account
First, you’ll need to authenticate with Shuttle. The login command will open your browser to the Shuttle Console where you can authenticate:
You can use your Google account, GitHub account or email to authenticate with Shuttle.
Create Your First Project
The init command helps you create a new Shuttle project. You can choose from:
- A simple Hello World template
- One of our example projects
- A pre-built template
For your first project, we recommend starting with the Hello World template:
Run Your Project Locally
Before deploying, you can run your project locally to test it:
Deploy Your Project
When you’re ready to deploy your project to the cloud:
This will:
- Upload your code to Shuttle’s platform and build it into a Docker image
- Deploy it to our infrastructure and assign a public HTTPS URL
The first deployment might take a few minutes as it builds your project and sets up the infrastructure.