Sitecore CM Cloud CLI Commands List. To contribute, please reach out. https://www.linkedin.com/in/nehemiahj/
|
Create/Navigate Project Folder
|
cd <project folder>
|
|
Create DotNet Tool Manifest
|
dotnet new tool-manifest
|
|
Add Nuget Source
|
dotnet nuget add source -n Sitecore https://nuget.sitecore.com/resources/v3/index.json
|
|
Install Sitecore.CLI Tool
|
dotnet tool install Sitecore.CLI
|
|
To initialize New Project
|
dotnet sitecore init
|
|
Install the XM Cloud plugin (Requires Sitecore CLI version 5.0.0 and later)
|
dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.XMCloud
|
|
To view plugins installed/initialized
|
dotnet sitecore plugin list
|
|
List of all the commands, subcommands.
|
|||
|
Login
|
interactive
|
For interactive user login using a device code authentication flow
|
dotnet sitecore cloud login
|
|
Login
|
non-interactive
|
For non-interactive client logins using client credential flows
|
dotnet sitecore cloud login --client-credentials --client-id <clientId> --client-secret <clientSecret>
|
|
Logout
|
logout
|
To log out of an XM Cloud environment
|
dotnet sitecore cloud logout
|
|
Organization
|
info
|
To show information about the current user's organization
|
dotnet sitecore cloud organization info --organization-id <id>
|
|
Organization
|
health
|
To provide information about the status of the organization's resources.
|
dotnet sitecore cloud organization health --organization-id <id>
|
|
Organization
|
license
|
To download your organization's license file using the license subcommand
|
dotnet sitecore cloud organization license --organization-id <id>
|
|
Project
|
list
|
To get the list of all XM Cloud Projects
|
dotnet sitecore cloud project list
|
|
Project
|
info
|
To get information about an XM Cloud Project
|
dotnet sitecore cloud project info --project-id <project-id>
|
|
Project
|
create
|
To create an XM Cloud Project
|
dotnet sitecore cloud project create --name "Project name"
|
|
Project
|
update
|
To update the name of the XM Cloud Project
|
dotnet sitecore cloud project update --project-id <project-id> --name "Updated Name"
|
|
Project
|
delete
|
To remove an XM Cloud project
|
dotnet sitecore cloud project delete --project-id <project-id>
|
|
Environment
|
list
|
To list all the XM Cloud environments for a project
|
dotnet sitecore cloud environment list --project-id <project ID>
|
|
Environment
|
info
|
To get information about an XM Cloud Environment
|
dotnet sitecore cloud environment info --environment-id <environment-id>
|
|
Environment
|
create
|
To create a new XM Cloud environment
|
dotnet sitecore cloud environment create --name "Staging" --project-id <project-id>
|
|
Environment
|
update
|
To update an existing XM Cloud environment
|
dotnet sitecore cloud environment update --environment-id <env-id> --name "Updated Name"
|
|
Environment
|
delete
|
To remove an XM Cloud environment
|
dotnet sitecore cloud environment delete --environment-id <environment-id>
|
|
Environment
|
connect
|
To connect your Sitecore solution to an existing environment
|
dotnet sitecore cloud environment connect --environment-id <environment-id>
|
|
Environment
|
disconnect
|
To disconnect your Sitecore solution from an existing environment
|
sitecore cloud environment disconnect --environment-id <environment-id>
|
|
Environment
|
promote
|
To promote an existing deployment into a specific environment
|
sitecore cloud environment promote --environment-id <environment-id> --source-id <deployment-id>
|
|
Environment
|
log list
|
To list the log file names from the deployment
|
dotnet sitecore cloud environment log list --environment-id <env-id>
|
|
Environment
|
log download
|
To download and save the content of the specified log file
|
dotnet sitecore cloud environment log download --environment-id <env-id> --logfile <logfile>
|
|
Environment
|
log view
|
To download and print the content of the specified log file to the console
|
dotnet sitecore cloud environment log view --environment-id <env-id> --logfile <logfile>
|
|
Environment
|
health
|
To display the health status of an environment's resources
|
dotnet sitecore cloud environment health --environment-id <environment-id>
|
|
Environment
|
variable list
|
To list all the environment variables for an XM Cloud environment
|
dotnet sitecore cloud environment variable list --environment-id <environment-id>
|
|
Environment
|
variable upsert
|
To create or update environment variables for an XM Cloud environment
|
dotnet sitecore cloud environment variable upsert --environment-id env1 --name testvar --value testval --target CM 'testvar'
|
|
Environment
|
variable delete
|
To delete the specified environment variable from an XM Cloud environment
|
dotnet sitecore cloud environment variable delete --environment-id env1 --name testvar 'testvar'
|
|
Environment
|
restart
|
To restart the authoring environment without downtime.
|
dotnet sitecore cloud environment restart --environment-id <environment-id>
|
|
Deployment
|
create
|
To create and start a deployment entity for an XM Cloud environment
|
dotnet sitecore cloud deployment create --environment-id <id> --no-start --no-watch --upload --working-dir <path>
|
|
Deployment
|
info
|
To get information about a specific XM Cloud deployment
|
dotnet sitecore cloud deployment get --deployment-id <id>
|
|
Deployment
|
list
|
To list the most recent deployments for an environment
|
dotnet sitecore cloud deployment list --environment-id <id>
|
|
Deployment
|
start
|
To start the execution of a deployment
|
dotnet sitecore cloud deployment start --deployment-id <id> --no-watch
|
|
Deployment
|
watch
|
To show information about the deployment status/progress
|
dotnet sitecore cloud deployment watch --deployment-id <id>
|
|
Deployment
|
log
|
To show or download logs about a specific deployment
|
dotnet sitecore cloud deployment log --deployment-id <id> --output <path>
|
|
Editing Host
|
create
|
To create a new editing host
|
dotnet sitecore cloud editinghost create --name <name> --cm-environment-id <cm-environment-id>
|
|
Editing Host
|
update
|
To update the name of an existing editing host
|
dotnet sitecore cloud editinghost update --environment-id <editinghost-id> --name "Staging updated"
|
|
Editing Host
|
delete
|
To permanently deletes an editing host
|
dotnet sitecore cloud editinghost delete --environment-id <editinghost-id>
|
|
Editing Host
|
deploy
|
To create and start a deployment entity for an editing host
|
dotnet sitecore cloud editinghost deploy --environment-id <editinghost-id>
|
No comments yet.
Cheatography n. The art of mapping complex subjects into clear, instantly navigable reference guides.
