Upgrade the Sitecore Command Line Interface to version 5
Sitecore Command Line Interface (CLI) is a tool that you install in PowerShell.
If you do not have a previous installation of the CLI in your project, follow the steps to install Sitecore Command Line Interface instead.
To upgrade an existing CLI installation:
-
Update the Sitecore Management Services module.
ImportantThis is an important step because starting with version 5.1.25 the CLI has a version compatibility feature that prevents you from running CLI commands with an outdated version of Sitecore Management Services.
-
Update the CLI version:
RequestResponsedotnet tool update sitecore.cli --version {version}
NoteTo update to the latest available version, you can use the command without providing a version:
dotnet tool update sitecore.cli
. -
Update the default plugins:
RequestResponsedotnet sitecore plugin init
Alternatively, update or add each plugin manually:
RequestResponsedotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Serialization --version {version} dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Publishing --version {version} dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Indexing --version {version} dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.ResourcePackage --version {version}
-
If you want to install the Database plugin, run the following command:
RequestResponsedotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.database --version {version}
-
If you want to install the XM Cloud plugin, run the following command:
RequestResponsedotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.XMCloud
-
Check the Sitecore CLI version using the following command:
RequestResponsedotnet sitecore --version
If your CLI is updated successfully, it returns the version you specified. For example
5.1.25
. -
To update the JSON schema, run the following command in your project folder:
RequestResponsedotnet sitecore init
-
Check the installed plugins using the following command:
RequestResponsedotnet sitecore plugin list
If your CLI plugins are updated successfully, it returns the following message:
RequestResponseSitecore.DevEx.Extensibility.Database v.{version} Sitecore.DevEx.Extensibility.Indexing v.{version} Sitecore.DevEx.Extensibility.Publishing v.{version} Sitecore.DevEx.Extensibility.ResourcePackage v.{version} Sitecore.DevEx.Extensibility.Serialization v.{version}