Skip to main content

The CLI serialization command

Abstract

Reference of the DevEx CLI serialization command that serializes items.

The Sitecore serialization plugin includes a ser command. This command handles the serialization of items. To install the serialization plugin, run the following code:

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

Usage

You can use the command as follows:

dotnet sitecore ser [subcommand] [options]

Subcommands

You can use the following subcommands:

Subcommand

Description

diff

Compares the content items of two Sitecore instances.

explain

Explains whether a content item path is included and why.

info

Shows serialization configuration information.

package

Lists serialization package commands.

package create

Creates a package of serialized content items.

package install

Installs a package of serialized content items in a Sitecore instance.

pull

Serializes content items from a Sitecore instance to your file system.

push

Pushes serialized content items from your file system to a Sitecore instance.

validate

Checks serialized content items for validity. Can fix common issues with the --fix argument.

Note

For more information, see Validate serialized content items.

watch

Monitors changes to content items in a Sitecore instance and automatically serializes the changes to your file system.

Options

You can use the following options with the pull and push subcommands:

Options

Required?

Description

--what-if

No

Simulate what content changes you are going to make before you actually make them.

Note

For more information on the --what-if option, see the video Sitecore CLI and the 'what-if' flag.