Version compatibility

Current version: 10.1

The Sitecore Command Line Interface(CLI) version 5.1.25 introduces a version compatibility feature that checks if the version of the Sitecore Management Services module is compatible with your version of the CLI.

The version compatibility feature is enabled by default, but it can be controlled with the help of the new settings entry in the sitecore.json file:

RequestResponse
  "settings": {
    "versionComparingEnabled": true
  }

After upgrading the CLI, any CLI operations that make calls to the Sitecore Management Services endpoint run only if the version of the module is up to date. If the versions are not compatible, running a CLI command will show the following message:

RequestResponse
The Sitecore Management Service version of the environment this 
Sitecore CLI operates with is outdated, please update the Sitecore 
Management Service to version 5.1.25.

As a short-term workaround, you can set versionComparingEnabled to false, but we strongly recommend updating the Sitecore Management Services module instead.

Important

Although disabling the version compatibility check is possible, incompatible CLI and Sitecore Management Service versions can result in inconsistent behavior and functional issues.

Do you have some feedback for us?

If you have suggestions for improving this article,