Skip to main content

Set up the Cloud CLI

The Serverpod Cloud CLI is the command-line tool that deploys and manages your projects on Serverpod Cloud. This page shows how to set it up and authenticate it with your account. After completing these steps, you're ready to deploy your first Serverpod app.

Prerequisites​

Before you start, make sure you have:

Run the Cloud CLI through the Serverpod CLI​

The Serverpod CLI includes a cloud command that passes everything after it to the Cloud CLI. If the Cloud CLI isn't installed yet, the first serverpod cloud command installs it, so there's nothing else to set up.

Check that the Cloud CLI works:

serverpod cloud version

If the command prints a version number, the Cloud CLI is ready to use.

Install the Cloud CLI on its own​

If you'd rather not use the Serverpod CLI, install the Cloud CLI on its own with Dart:

dart install serverpod_cloud_cli

This adds the scloud executable, which takes the same commands as serverpod cloud. Use scloud wherever these docs show serverpod cloud, for example scloud version to verify the install.

Authenticate the CLI​

Log in to your Serverpod Cloud account from the terminal:

serverpod cloud auth login

This opens a browser window where you authenticate. Once authentication completes, the CLI is authorized to manage your Serverpod Cloud projects.