Getting Started

This guide will help you quickly set up and deploy a Serverpod Cloud project using the Serverpod Cloud CLI (scloud).

Prerequisites

• Dart installed on your system (Install Dart)
• A Serverpod project (Set up a Serverpod project)
• An early access invitation (Sign up)

Step 1: Create an account

To get started with Serverpod Cloud, you'll need to create an account. Visit our signup page and follow the registration process.

Step 2: Install the Serverpod Cloud CLI

Install the serverpod_cloud_cli package globally using Dart:

dart pub global activate serverpod_cloud_cli

Verify the installation with:

scloud version

Step 3: Authenticate the Serverpod Cloud CLI

Log in to your Serverpod Cloud account using the CLI:

scloud auth login

Step 4: Create and Deploy a New Project

Navigate to the root directory of your Serverpod project and run the scloud launch command:

scloud launch

This interactive command will guide you through the setup:

• Create a new Serverpod Cloud project.
• Automatically handle the initial deployment.

After the setup is complete, you'll receive a confirmation with the project's URL.

Step 5: Check Deployment Status

Verify the deployment by:

scloud status deploy

You should see output indicating the status of your deployment.

Step 6: Redeploy Changes

After making changes to your project, you can redeploy using:

scloud deploy