The cloud environment command

The list subcommand

The list subcommand lists all the environments and editing hosts for a project. You must provide the project ID.

You can use the following options with the list subcommand:

For example:

dotnet sitecore cloud environment list --project-id <project ID>

The info subcommand

The info subcommand provides information about a specific environment. You must provide a unique identifier for the environment.

You can use the following options with the get subcommand:

For example:

dotnet sitecore cloud environment info --environment-id <environment-id>

The create subcommand

You can create a new environment using the create subcommand. You must specify the name of your new environment and the unique identifier of the parent project.

You can use the following options with the create subcommand:

For example:

dotnet sitecore cloud environment create --name "Staging" --project-id <project-id>

The update subcommand

The update subcommand updates an existing environment. You must specify the unique identifier for the environment and the information to update.

You can use the following options with the update subcommand:

For example:

dotnet sitecore cloud environment update --environment-id <env-id> --name "Updated Name"

The delete subcommand

The delete subcommand removes an environment. You must specify the unique identifier for the environment.

You can use the following options with the delete subcommand:

For example:

dotnet sitecore cloud environment delete --environment-id <environment-id>

The connect subcommand

You can connect your Sitecore solution to an existing environment using the connect subcommand.

You can use the following options with the connect subcommand:

For example:

dotnet sitecore cloud environment connect --environment-id <environment-id>

The disconnect subcommand

You can disconnect your Sitecore solution from an existing environment using the disconnect subcommand.

You can use the following options with the disconnect subcommand:

For example:

sitecore cloud environment disconnect --environment-id <environment-id>

The promote subcommand

You can use the promote subcommand to promote an existing deployment into a specific environment.

You can use the following options with the promote subcommand:

For example:

sitecore cloud environment promote --environment-id <environment-id> --source-id <deployment-id>

The log list subcommand

The log list subcommand lists the log file names from the deployment of the specified environment.

You can use the following options with the log list subcommand:

For example:

dotnet sitecore cloud environment log list --environment-id <env-id>

The log download subcommand

The log download subcommand downloads and saves the content of the specified log file.

You can use the following options with the log download subcommand:

For example:

dotnet sitecore cloud environment log download --environment-id <env-id> --logfile <filename>

The log view subcommand

The log view subcommand downloads and prints the content of the specified log file to the console.

You can use the following options with the log view subcommand:

For example:

dotnet sitecore cloud environment log view --environment-id <env-id> --logfile <filename>

The health subcommand

The health subcommand displays the health status of an environment's resources.

You can use the following options with the health subcommand:

The variable list subcommand

The variable list subcommand lists all the environment variables for an environment.

You can use the following options with the variable list subcommand:

For example:

dotnet sitecore cloud environment variable list --environment-id env1
Found 3 variable(s)
LOG_LEVEL_VALUE Environment variable detailed information:
LOG_LEVEL_VALUE Environment variable detailed information:
Name   : LOG_LEVEL_VALUE
Secret : False
Value  : INFO
Target : CM

Sitecore_GraphQL_ExposePlayground Environment variable detailed information:
Name   : Sitecore_GraphQL_ExposePlayground
Secret : False
Value  : false
Target : \*

SITECORE_SPE_ELEVATION Environment variable detailed information:
Name   : SITECORE_SPE_ELEVATION
Secret : False
Value  : BLOCK
Target : Default

SECRET_VARIABLE Environment variable detailed information:
Name   : SECRET_VARIABLE
Secret : True
Value  : \*\*\*\*\*
Target : CM

The variable upsert subcommand

The variable upsert subcommand creates or updates environment variables for an environment.

You can use the following options with the variable upsert subcommand:

For example:

dotnet sitecore cloud environment variable upsert --environment-id env1 --name testvar --value testval --target CM
'testvar' Environment variable was accepted for upsert within 'env1' Environment.

The variable delete subcommand

The variable delete subcommand deletes the specified environment variable from an environment.

You can use the following options with the variable delete subcommand:

For example:

dotnet sitecore cloud environment variable delete --environment-id env1 --name testvar
'testvar' Environment variable was deleted within 'env1' Environment.

The restart subcommand

The restart subcommand restarts the authoring environment without downtime. The subcommand is available in the Sitecore CLI XM Cloud plugin version 1.1.73 or later.

You can use the following options with the subcommand: