auth

Handle user authentication.

See also the personal access tokens (PAT) guide on how to prepare and use personal access tokens for CI pipelines, scripts, or headless environments where you cannot run scloud auth login.

auth login

Log in to Serverpod Cloud. Most scloud commands requires the CLI to be authenticated.

auth logout

Log out from Serverpod Cloud and remove stored credentials.

Credentials Storage

After running auth login, your authentication token is stored locally at:

~/.serverpod/cloud/serverpod_cloud_auth.json

This file contains a JSON object with your token:

{"token": "your-token-here"}

Using the Token

Environment variable

You can set the SERVERPOD_CLOUD_TOKEN environment variable to authenticate without logging in:

export SERVERPOD_CLOUD_TOKEN="your-token-here"
scloud me 

Command-line flag

Alternatively, use the --token flag with any command:

scloud --token="your-token-here" me

This is useful for CI/CD pipelines and automated scripts.

Usage

Manage user authentication.

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

Available subcommands:
  create-token   Create a personal access token.
  list           List the current authentication sessions.
  login          Log in to Serverpod cloud.
  logout         Log out from Serverpod Cloud.

Run "scloud help" to see global options.

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

Sub commands

login

Log in to Serverpod cloud.

Usage: scloud auth login [arguments]
-h, --help                                   Print this usage information.
    --time-limit=<integer[us|ms|s|m|h|d]>    The time to wait for the authentication to complete.
                                             (defaults to "5m")
    --[no-]persistent                        Store the authentication credentials.
                                             (defaults to on)
    --[no-]browser                           Allow CLI to open browser for logging in.
                                             (defaults to on)

Run "scloud help" to see global options.

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

logout

Log out from Serverpod Cloud.

By default the current session is logged out.
Use options to log out other sessions and CLI / personal access tokens.
See also "scloud auth list", to list the current authentication sessions.

Usage: scloud auth logout [arguments]
-h, --help        Print this usage information.

Sessions
    --token-id    The token IDs to log out. Logs out the current session if not provided.
    --all         Log out from all sessions including API tokens.

Run "scloud help" to see global options.

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

list

List the current authentication sessions.

Usage: scloud auth list [arguments]
-h, --help        Print this usage information.
-u, --[no-]utc    Display timestamps in UTC timezone instead of local.

Run "scloud help" to see global options.

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

create-token

Create a personal access token.

Creates an additional CLI / personal access token for the current user.
This token can be used to authenticate scloud commands by using
the --token option or the SERVERPOD_CLOUD_TOKEN environment variable.

Usage: scloud auth create-token [arguments]
-h, --help                                 Print this usage information.
    --expire-at=<YYYY-MM-DDtHH:MM:SSz>     The calendar time to expire the token at.

TTL: Expire after non-use
    --idle-ttl=<integer[us|ms|s|m|h|d]>    The duration of non-use after which the token will
                                           expire.
                                           (defaults to "30d")
    --no-idle-ttl                          Do not expire the token after a duration of non-use.

Run "scloud help" to see global options.

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