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.

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.

User Roles
  invite   Invite a user to 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

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.

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

invite

Invite a user to a Serverpod Cloud project.

Usage: scloud project invite [arguments]
-h, --help                   Print this usage information.
-p, --project (mandatory)    The ID of the project. Can be passed as the first argument.
                             Can be omitted for existing projects that are linked. See `scloud
                             project link --help`.
-u, --user (mandatory)       The email address of the user.
-r, --role                   One or more project roles to assign.

          [owners]           Owners have full access to the project.

Run "scloud help" to see global options.

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

revoke

Revoke a user from a Serverpod Cloud project.

Usage: scloud project revoke [arguments]
-h, --help                   Print this usage information.
-p, --project (mandatory)    The ID of the project. Can be passed as the first argument.
                             Can be omitted for existing projects that are linked. See `scloud
                             project link --help`.
-u, --user (mandatory)       The email address of the user.
-r, --role                   One or more project roles to revoke.

          [owners]           Owners have full access to the project.

    --all                    Revoke all roles of this project from the user.

Run "scloud help" to see global options.

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