Sitecore Command Line Interface reference

The CLI index command

Version:

The Sitecore indexing plugin includes an index command. This command automates indexing operations. To install the indexing plugin, run the following code:

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

Note

This command is available from CLI 4.0 or later.

Usage

You can use the command as follows:

dotnet sitecore index [subcommand] [options]

Subcommands

You can use the following subcommands:

Subcommand	Description
`list`	Provides the list of available indexes from the environment
`schema-populate`	Populates the managed schema
`rebuild`	Rebuilds all the indexes
`statistic`	Statistics of all the indexes

All the subcommands require elevated permissions.

Options

You can use the following options with the list subcommand:

Option	Required?	Description
`-n, --environment-name <environment-name>`	Optional	The Sitecore environment to use. Default: `default`.
`-c, --config <CONFIG>`	Optional	Path to root `sitecore.config` directory (default: cwd).
`-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.

You can use the following options with the schema-populate subcommand:

Option	Required?	Description
`-i, --indexes <list-of-indexes>`	Optional	Populate the schema for specified indexes.
`-n, --environment-name <environment-name>`	Optional	The Sitecore environment to use. Default: `default`.
`-c, --config <CONFIG>`	Optional	Path to root sitecore.config directory (default: cwd).
`-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.

You can use the following options with the rebuild subcommand:

Option	Required?	Description
`-i, --indexes <list-of-indexes>`	Optional	Rebuild the specified indexes.
`-n, --environment-name <environment-name>`	Optional	The Sitecore environment to use. Default: `default`.
`-c, --config <CONFIG>`	Optional	Path to root sitecore.config directory (default: cwd).
`-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.

You can use the following options with the statistic subcommand:

Option	Required?	Description
`-n, --environment-name <environment-name>`	Optional	The Sitecore environment to use. Default: `default`.
`-c, --config <CONFIG>`	Optional	Path to root sitecore.config directory (default: cwd).
`-t, --trace`	Optional	Report additional diagnostic and performance data.
`-?, -h, --help`	Optional	Help for the command.

Examples

The following are examples of the index command use:

Command: Result
dotnet sitecore index list:


List of Indexes:
sitecore_master_index
sitecore_core_index

dotnet sitecore index schema-populate:


The search indexes have been populated.

Result:
sitecore_core_index   [job ended]
sitecore_master_index [job ended]
sitecore_web_index    [job ended]

dotnet sitecore index schema-populate -i sitecore_master_index:


The search indexes have been populated.

Result:
sitecore_master_index [job ended]

dotnet sitecore index rebuild:


The search indexes have been rebuilt.

Result:
sitecore_core_index   [job ended] [units processsed: 13596]
sitecore_master_index [job ended] [units processsed: 16620]
sitecore_web_index    [job ended] [units processsed: 13596]

dotnet sitecore index rebuild -i sitecore_master_index:


The search indexes have been rebuilt.

Result:
sitecore_master_index [job ended] [units processsed: 16620]

dotnet sitecore index statistic:


Index statistics:
 sitecore_core_index
  Rebuild Time: Never Run
  Last Updated: 08/13/2021 - `08:45` (UTC)
  Approximate Throughput: items per second
  Has Deletions: False
  Out of Date: False
  Document Count: 0
  Number of Fields: -1
  Number of Terms: -1

If you have suggestions for improving this article, let us know!