1. Sitecore CLI command reference

The CLI plugin command

The Sitecore CLI includes a plugin command. This command manages plugins that contain additional CLI commands.

Note

The version displayed in the terminal is the latest official release available.

Usage

You can use the command as follows:

bash
dotnet sitecore plugin [subcommand] [options]

Subcommands

You can use the following subcommands:

  • The init subcommand - initializes default plugins. Available starting with version 4.1.0
  • The add subcommand - adds or updates a plugin in your project.
  • The remove subcommand - removes a plugin from your project.
  • The list subcommand - lists all the installed plugins.

The init subcommand

The init subcommand initializes default plugins.

You can use the following options with the init subcommand:

  • -c, --config - Optional. The path to the sitecore.json configuration file. Default: current working directory.
  • --version - Optional. The version of the default plugins to install. If not specified, the CLI installs the version of the plugin matching the CLI version.
  • --overwrite - Optional. Allow overwriting or updating existing plugins. Plugins that were not installed previously are installed with the latest version or the specified version.
  • --prerelease - Optional. Allow pre-release versions for default plugins.
  • -v, --verbose - Optional. Report additional diagnostic and performance data.
  • -t, --trace - Optional. Report additional diagnostic and performance data.
  • -?, -h, --help - Optional. Help for the command.

Examples:

Initialize the default plugins

Command:

bash
dotnet sitecore plugin init

Output:

text
Successfully installed version 4.1.0 of plugin Sitecore.DevEx.Extensibility.Serialization
Successfully installed version 4.1.0 of plugin Sitecore.DevEx.Extensibility.Publishing
Successfully installed version 4.1.0 of plugin Sitecore.DevEx.Extensibility.Indexing
Successfully installed version 4.1.0 of plugin Sitecore.DevEx.Extensibility.ResourcePackage
Note

If the default plugins already exist, the CLI displays messages to inform you, for example, You have already installed Sitecore.DevEx.Extensibility.Serialization.

Initialize a specific plugin version

Command:

bash
dotnet sitecore plugin init --version 5.0.0

Output:

text
Successfully installed version 5.0.0 of plugin Sitecore.DevEx.Extensibility.Serialization
Successfully installed version 5.0.0 of plugin Sitecore.DevEx.Extensibility.Publishing
Successfully installed version 5.0.0 of plugin Sitecore.DevEx.Extensibility.Indexing
Successfully installed version 5.0.0 of plugin Sitecore.DevEx.Extensibility.ResourcePackage

Overwrite existing plugins with a newer version

Command:

bash
dotnet sitecore plugin init --version 6.0.0 --overwrite

Output:

text
Successfully updated to version 6.0.0 of plugin Sitecore.DevEx.Extensibility.Serialization
Successfully updated to version 6.0.0 of plugin Sitecore.DevEx.Extensibility.Publishing
Successfully installed version 6.0.0 of plugin Sitecore.DevEx.Extensibility.Indexing
Successfully installed version 6.0.0 of plugin Sitecore.DevEx.Extensibility.ResourcePackage

The add subcommand

You can use the following options with the add subcommand:

  • -c, --config - Optional. The path to the sitecore.json configuration file. Default: current working directory.
  • -n, --name - Required. Name of the plugin to install into the current project.
  • --version - Optional. The version of the plugin to install. If it is not specified, the CLI installs the latest version.
  • -v, --verbose - Optional. Report additional diagnostic and performance data.
  • -t, --trace - Optional. Report additional diagnostic and performance data.
  • -?, -h, --help - Optional. Help for the command.

Examples:

Add a plugin using the latest version

Command:

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

Output:

text
Successfully installed version 4.0.0 of plugin Sitecore.DevEx.Extensibility.Serialization
Note

If you do not specify the --version option, the CLI installs the latest version. If you specify a plugin version higher than the one already installed, the CLI updates it to the newer version. If the package does not exist, the CLI displays a message to inform you.

Add a specific plugin version

Command:

bash
dotnet sitecore plugin add -n Sitecore.DevEx.Extensibility.Serialization --version 4.0.0

Output:

text
Successfully installed version 4.0.0 of plugin Sitecore.DevEx.Extensibility.Serialization

The remove subcommand

You can use the following options with the remove subcommand:

  • -c, --config - Optional. The path to the sitecore.json configuration file. Default: current working directory.
  • -n, --name - Required. Name of the plugin to install into the current project.
  • -v, --verbose - Optional. Report additional diagnostic and performance data.
  • -t, --trace - Optional. Report additional diagnostic and performance data.
  • -?, -h, --help - Optional. Help for the command.

Example:

Command:

bash
dotnet sitecore plugin remove -n Sitecore.DevEx.Extensibility.Serialization

Output:

text
Successfully deleted version 4.0.0 of plugin Sitecore.DevEx.Extensibility.Serialization
Note

If the plugin does not exist, the CLI displays a message to inform you, for example, The plugin Sitecore.DevEx.Extensibility.PluginDoesNotExist does not appear to be installed.

The list subcommand

You can use the following options with the list subcommand:

  • -c, --config - Optional. The path to the sitecore.json configuration file. Default: current working directory.
  • -v, --verbose - Optional. Report additional diagnostic and performance data.
  • -t, --trace - Optional. Report additional diagnostic and performance data.
  • -?, -h, --help - Optional. Help for the command.

Example:

Command:

bash
dotnet sitecore plugin list

Output:

text
List of plugins:
Sitecore.DevEx.Extensibility.Indexing v.4.0.0
Sitecore.DevEx.Extensibility.Publishing v.4.0.0
Sitecore.DevEx.Extensibility.ResourcePackage v.4.0.0
Sitecore.DevEx.Extensibility.Serialization v.4.0.0
If you have suggestions for improving this article, let us know!