project

scloud project provides commands for managing your Serverpod Cloud projects.

A project is created by running the following command:

scloud project create my-project --enable-db

If the project does not need a databse (e.g. if it is a Serverpod Mini project), the --no-enable-db flag can instead be passed.

See the deploy command on how to deploy your project.

Linking an existing project

If you have an existing Serverpod Cloud project and want to connect your local codebase to it, use the link command:

scloud project link my-project

What the link command does

The link command creates or updates configuration files in your local project directory to connect it to an existing Serverpod Cloud project. Specifically, it:

1. Creates or updates scloud.yaml: This file contains the project ID that identifies which Serverpod Cloud project your local codebase is connected to. The file is created in your server package directory (or the directory specified with --project-dir).

2. Creates .scloudignore: If this file doesn't exist, the command creates it with a template that specifies which files should be ignored when uploading to Serverpod Cloud. This file works similarly to .gitignore.

3. Updates .gitignore: If your project is part of a workspace, the command automatically adds the .scloud/ directory to your .gitignore file to prevent deployment artifacts from being committed to version control.

When to use link

Use the link command when:

• You have an existing Serverpod Cloud project and want to connect a local codebase to it
• You're working with a project that was created through the web console or by another team member

Usage

Manage Serverpod Cloud projects.

Usage: scloud project <subcommand> [arguments]
-h, --help    Print this usage information.

Available subcommands:
  create   Create a Serverpod Cloud project.
  delete   Delete a Serverpod Cloud project.
  link     Link your local project to an existing Serverpod Cloud project.
  list     List the Serverpod Cloud projects.

Management
  user     Manage Serverpod Cloud project users.

Run "scloud help" to see global options.

See the full documentation at: https://docs.serverpod.cloud/references/cli/commands/project

Sub commands

create

Create a Serverpod Cloud project.

Usage: scloud project create [arguments]
-h, --help                   Print this usage information.
-p, --project (mandatory)    The ID of the project. Can be passed as the first argument.
    --[no-]enable-db         Flag to enable the database for the project.

Run "scloud help" to see global options.

See the full documentation at: https://docs.serverpod.cloud/references/cli/commands/project

delete

Delete a Serverpod Cloud project.

Usage: scloud project delete [arguments]
-h, --help                   Print this usage information.
-p, --project (mandatory)    The ID of the project. Can be passed as the first argument.

Run "scloud help" to see global options.

See the full documentation at: https://docs.serverpod.cloud/references/cli/commands/project

list

List the Serverpod Cloud projects.

Usage: scloud project list [arguments]
-h, --help    Print this usage information.
    --all     Include deleted projects.

Run "scloud help" to see global options.

See the full documentation at: https://docs.serverpod.cloud/references/cli/commands/project

link

Link your local project to an existing Serverpod Cloud project.

This command creates or updates the project configuration files in your local codebase to connect it
to an existing Serverpod Cloud project. It will:
  - Create or update the scloud.yaml configuration file with the project ID
  - Create a .scloudignore file if it does not exist
  - Update .gitignore to exclude the .scloud/ directory (if in a workspace)

The scloud.yaml file contains the project ID and is used by other scloud commands to identify which
Serverpod Cloud project to use. This file can be safely committed to version control as it only
contains the project identifier, not sensitive credentials.

Usage: scloud project link [arguments]
-h, --help                   Print this usage information.
-p, --project (mandatory)    The ID of the project. Can be passed as the first argument.

Run "scloud help" to see global options.

See the full documentation at: https://docs.serverpod.cloud/references/cli/commands/project

user

Manage Serverpod Cloud project users.

Usage: scloud project user <subcommand> [arguments]
-h, --help    Print this usage information.

Available subcommands:
  invite   Invite a user to a Serverpod Cloud project.
  list     List users in a Serverpod Cloud project.
  revoke   Revoke a user from a Serverpod Cloud project.

Run "scloud help" to see global options.

See the full documentation at: https://docs.serverpod.cloud/references/cli/commands/project