Skip to main content

Sitecore Command Line Interface reference

Abstract

Command reference for Sitecore Command Line Interface (CLI).

As the name suggests, Sitecore Command Line Interface (CLI) is a command-line tool named sitecore, and you add subcommands and options to accomplish different tasks.

To discover additional options for each of the commands listed in the following table, you add the --help option at the end. For example, dotnet sitecore login --help or dotnet sitecore ser package create --help.

Subcommand

Versions

Description

index

4.0 or later

Automates indexing operations. Install the indexing plugin to access this command.

For more information, see The CLI index command.

init

All

Initializes a project configuration in the current folder.

For more information, see Install Sitecore Command Line Interface.

itemres

4.0 or later

Creates an item package in a resource file with configurable options. Install the Items as Resources plugin to access this command.

For more information, see The CLI itemres command.

login

All

Logs in to a Sitecore instance.

For more information, see Log in to a Sitecore instance with Sitecore Command Line Interface.

plugin

3.0 or later

Manages plugins for the CLI that contain additional commands.

For more information, see The CLI plugin command and Extend the Command Line Interface with NuGet.

publish

All

Publishes all content from the Master database to the Web database. Install the publishing plugin to access this command.

For more information, see The CLI publish command.

ser, serialization

All

Handles the serialization of items. Install the serialization plugin to access this command.

For more information, see The CLI serialization command.

connect

5.0 or later

Connect your environment to a different existing environment and use its login information.

For more information, see The CLI connect command.

cloud

5.0 or later

Allows you to interact with XM Cloud.

For more information, see The CLI cloud command.

dbcleanup

5.0 or later

Performs database cleanup according to the provided tasks.

For more information, see The CLI dbcleanup command.