Upgrade the Sitecore Command Line Interface to version 3

Abstract

How to upgrade the Sitecore Command Line Interface (CLI) to version 3.0.0 in PowerShell.

Sitecore Command Line Interface (CLI) is a tool that you install in PowerShell.

Note

To install a new CLI installation, see Install Sitecore Command Line Interface.

To upgrade an existing CLI installation from version 2.0.0 to version 3.0.0:

  1. Update the NuGet source config file with the MyGet configuration:

    dotnet nuget add source https://sitecore.myget.org/F/sc-packages/api/v3/index.json -n myget
  2. Upgrade the CLI version to version 3.0.0:

    dotnet tool install Sitecore.CLI --version 3.0.0 
  3. Install the required Publishing and Serialization plugins:

    dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Serialization
    dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Publishing

    Note

    The Publishing and Serialization commands became separate plugins as part of the Sitecore CLI NuGet extensibility release.

    After you install the plugins, the ser and publish commands are available, and the updated sitecore.json config file from your solution has a new plugins section:

    {
    2  "$schema": "./.sitecore/schemas/RootConfigurationFile.schema.json",
    3  "modules": [
    4    "items/*/*.module.json"
    5  ],
    6  "plugins": [
    7    "Sitecore.DevEx.Extensibility.Publishing@3.0.0",
    8    "Sitecore.DevEx.Extensibility.Serialization@3.0.0"
    9  ],
    10  "serialization": {
    11    "defaultMaxRelativeItemPathLength": 120,
    12    "defaultModuleRelativeSerializationPath": "serialization"
    13  }
    14}
  4. You can check the Sitecore CLI version using the following command:

    dotnet sitecore --version

    If your CLI is updated successfully, It returns 3.0.0.

  5. You can check the installed plugins using the following command:

    dotnet sitecore plugin list

    If your CLI plugins are updated successfully, you will see the following message:

    List of plugins:
    Sitecore.DevEx.Extensibility.Publishing v.3.0.0
    Sitecore.DevEx.Extensibility.Serialization v.3.0.0