The CLI plugin command
The Sitecore CLI includes a plugin
command. This command manages plugins that contain additional CLI commands.
The version displayed in the terminal is the latest official release available.
Usage
You can use the command as follows:
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:
Option |
Required? |
Description |
---|---|---|
|
No |
The path to the |
|
No |
The version of the default plugins to install. If not specified, the CLI installs the version of the plugin matching the CLI version. |
|
No |
Allow overwriting/updating existing plugins. Plugins that were not installed previously are installed with the latest version or the specified version. |
|
No |
Allow pre-release versions for default plugins. |
|
No |
Report additional diagnostic and performance data. |
|
No |
Report additional diagnostic and performance data |
|
No |
Help for the command. |
The following are examples using the init
subcommand:
Command |
Result |
---|---|
|
Output: RequestResponse
Note If the default plugins already exist, the CLI displays messages to inform you, for example, You have already installed Sitecore.DevEx.Extensibility.Serialization . |
|
Output: RequestResponse
|
|
Output: RequestResponse
|
The add subcommand
You can use the following options with the add
subcommand:
Option |
Required? |
Description |
---|---|---|
|
No |
The path to the |
|
Yes |
Name of the plugin to install into the current project. |
|
No |
The version of the plugin to install. If it is not specified, the CLI installs the latest version. |
|
No |
Report additional diagnostic and performance data. |
|
No |
Report additional diagnostic and performance data. |
|
No |
Help for the command. |
The following are examples using the add
subcommand:
Command |
Result |
---|---|
|
Output: RequestResponse
Note If you do not specify the If the package does not exist, the CLI displays a message to inform you. |
|
Output: RequestResponse
|
The remove subcommand
You can use the following options with the remove
subcommand:
Option |
Required? |
Description |
---|---|---|
|
No |
The path to the |
|
Yes |
Name of the plugin to install into the current project. |
|
No |
Report additional diagnostic and performance data. |
|
No |
Report additional diagnostic and performance data. |
|
No |
Help for the command. |
The following are examples of using the remove
subcommand:
Command |
Result |
---|---|
|
Output: RequestResponse
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:
Option |
Required? |
Description |
---|---|---|
|
No |
The path to the |
|
No |
Report additional diagnostic and performance data. |
|
No |
Report additional diagnostic and performance data. |
|
No |
Help for the command. |
The following is an example of the list
subcommand:
Command |
Result |
---|---|
|
Output: RequestResponse
|