Skip to main content

env

The scloud env command provides management of environment variables for your Serverpod Cloud projects.

To add an environment variable, use the create command:

scloud env create MY_VAR myvalue
note

Some limitations to keep in mind:

  • Environment variable names can only contain lowercase letters a-z, uppercase letters A-Z, digits 0-9 and underscore _ for separation. The name has to start with a letter.
  • Maximum name length is 255.
  • The maximum total size of all environment variables cannot exceed 64kB.

Usage

Manage Serverpod Cloud environment variables for a project.

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

Available subcommands:
create Create an environment variable.
delete Delete an environment variable.
list Lists all environment variables for the project.
update Update an environment variable.

Run "scloud help" to see global options.

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

Sub commands

create

Create an environment variable.

Usage: scloud env create [arguments]
-h, --help Print this usage information.
-p, --project (mandatory) The ID of the project.
Can be omitted for existing projects that are linked. See `scloud
project link --help`.
--name (mandatory) The name of the environment variable. Can be passed as the first
argument.
--value The value of the environment variable. Can be passed as the second
argument.
--from-file The name of the file with the environment variable value.

Run "scloud help" to see global options.

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

list

Lists all environment variables for the project.

Usage: scloud env list [arguments]
-h, --help Print this usage information.
-p, --project (mandatory) The ID of the project.
Can be omitted for existing projects that are linked. See `scloud
project link --help`.

Run "scloud help" to see global options.

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

update

Update an environment variable.

Usage: scloud env update [arguments]
-h, --help Print this usage information.
-p, --project (mandatory) The ID of the project.
Can be omitted for existing projects that are linked. See `scloud
project link --help`.
--name (mandatory) The name of the environment variable. Can be passed as the first
argument.
--value The value of the environment variable. Can be passed as the second
argument.
--from-file The name of the file with the environment variable value.

Run "scloud help" to see global options.

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

delete

Delete an environment variable.

Usage: scloud env delete [arguments]
-h, --help Print this usage information.
-p, --project (mandatory) The ID of the project.
Can be omitted for existing projects that are linked. See `scloud
project link --help`.
--name (mandatory) The name of the environment variable. 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/env