The CLI serialization command

The info command provides information about how the solution is set up and configured for use as it relates to content serialization.

The information returned by the command includes a list of all serialization module configurations. For every serialization module configuration, the information includes:

• Module name.
• Module description.
• Item subtrees with name and path.

You can use the following options with the info subcommand:

The following is an example of using the info subcommand:

• Command: Result
• dotnet sitecore ser info:

> sitecore ser info

Maximum subtree-relative item path allowed: 100

Feature.BasicContent
  Subtrees:
    templates: /sitecore/templates/Feature/BasicContent
    renderings: /sitecore/layout/Renderings/Feature/BasicContent
    buttons: core:/sitecore/content/Applications/WebEdit/Custom Experience Buttons/BasicContent
      FieldsFilter Excludes: 0
  Roles: 0

# ...

Project.DemoContent
An example of separating content into a separate module, so it can be excluded from deploy.
  Subtrees:
    content: /sitecore/content/Basic Company
    media: /sitecore/media library/Basic Company
      FieldsFilter Excludes: 1
  Roles: 0

Excluded Fields From Default Serialization Config:
      FieldsFilter Excludes: 1

You can use the explain to provide detailed serialization-related information on a given Sitecore item path and an optional database.

The subcommand provides the following:

• Item path is within the scope of any serialization modules.
• Related allowed operations for the given item path.
• Path to the serialization Module.json set up for the given path.

You can use the following options with the explain subcommand:

The following are examples of using the explain subcommand:

• Command: Result
• Explain a path not included in any module configuration
  sitecore ser explain --path "NOT_INCLUDED_PATH":

Path master:NOT_INCLUDED_PATH is not included in any module configuration.

• Explain a path included in a module configuration
  sitecore ser explain --path "INCLUDED_PATH":

[MODULE_NAME] [INCLUDED_PATH] Item path matches subtree scope ItemAndDescendants.
[MODULE_NAME] [INCLUDED_PATH] Subtree set allowed push operations CreateUpdateAndDelete
[MODULE_NAME] [INCLUDED_PATH] Path master:INCLUDED_PATH is included!
Physical path:PATH_TO_YAML_FILE

The pull subcommand takes items from Sitecore, serializes them, and stores them as .yml files on a given file system path. The subcommand uses Module.json files to determine what items are included in the serialization process. During the pull operation, the serialization engine evaluates existing serialized items on disk and performs a deep comparison of the same items in the source Sitecore instance.

This command requires elevated permissions.

You can use the following options with the pull subcommand:

The following are examples of using the pull subcommand:

• Command: Result
• dotnet sitecore ser pull: All Sitecore items from the configurations are serialized on disk.
• dotnet sitecore ser pull -i ModuleA ModuleB: All Sitecore items from the ModuleA and ModuleB configurations are serialized on disk.
• dotnet sitecore ser pull -i tags:[tagA,tagB]: All Sitecore items from the modules tagged as tagA and tagB configurations are serialized on disk.
• dotnet sitecore ser pull -i tags:[tagA,tagB] ModuleA: All Sitecore items from the modules tagged as tagA, tagB, and ModuleA configurations are serialized on disk.

The push command takes items serialized as .yml files on disk and pushes them to a destination Sitecore instance. The push operation uses serialization Module.json files to determine the items included in the serialization process. During the push operation, the serialization engine evaluates existing serialized items on the file system and performs a deep comparison of the same Items in the source Sitecore instance.

This command requires elevated permissions.

You can use the following options with the push subcommand:

The following are examples of using the push subcommand:

• Command: Result
• dotnet sitecore ser push: All Sitecore items from the configurations are pushed to the Sitecore instance.
• dotnet sitecore ser push -i ModuleA ModuleB: All Sitecore items from the ModuleA and ModuleB configurations are pushed to the Sitecore instance.
• dotnet sitecore ser push -i tags:[tagA,tagB]: All Sitecore items from the modules tagged as tagA and tagB configurations are pushed to the Sitecore instance.
• dotnet sitecore ser push -i tags:[tagA,tagB] ModuleA: All Sitecore items from the modules tagged as tagA, tagB, and ModuleA configurations are pushed to the Sitecore instance.

The diff subcommand compares serialization items between a source Sitecore instance and a destination Sitecore instance. The operation uses serialization Module.json files to determine the items included in the comparison process. During the diff command, the serialization engine performs a deep comparison of paths and items in the source Sitecore instance and the destination Sitecore instance.

This command requires elevated permissions in both source and target environments.

You can use the following options with the diff subcommand:

The following is an example of using the diff subcommand:

• Command: Result
• dotnet sitecore ser diff -s SOURCE -d DESTINATION:

[DBNAME] Discovered CHANGES_COUNT changes after evaluating ITEMS_COUNT total items.

The validate subcommand ensures file system integrity of serialized items and paths. Additionally, by using the --fix (-f) argument option flag, the command can attempt to auto-correct identified issues. The subcommand evaluates all serialized paths and subtrees on the file system configured in serialization Module.json files and performs the following checks on the file system:

• Invalid physical path.
• Orphaned parent ID.
• Non-included item.
• Empty folder.
• Duplicate item ID.
• Non-unique path.

You can use the following options with the validate subcommand:

The following is an example of using the validate subcommand:

• Command: Result
• dotnet sitecore ser validate:

Read-only validation is active. No fixes will be made.
No errors were detected.

• dotnet sitecore ser validate --fix:

DUPLICATE ID: 5c069416-660c-4028-b5c8-c9f3ce3cb277 found in ...
[D] ~\FILE_DUPLICATE.yml
...
No errors were detected.

The watch subcommand monitors changes to content items in a Sitecore instance and automatically serializes the changes to your file system.

This command requires elevated permissions.

You can use the following options with the watch subcommand:

The following is an example of using the watch subcommand:

• Command: Result
• dotnet sitecore ser watch:

Watcher is online! Changes made to serialized items will be automatically pulled.

The package subcommand (short form pkg) provides additional subcommands for package specific operations, as follows:

You can use the following options with the package subcommand:

The package create subcommand creates a new serialized item package.

You can use the following options with the package create subcommand:

The following is an example of using the package create subcommand:

• Command: Result
• dotnet sitecore ser pkg create -o FILE_PATH: A package was created at the specified FILE_PATH.
• Serializing a module with roles:{ "namespace": "Feature.Products", "roles": [ { "domain": "DevEx", "pattern": "Product" } ] }dotnet sitecore ser info --include Feature.Products -v: Output:

[role] [A] Role DevEx\Product Admin is created successfully.
[role] [A] Role DevEx\Product Merchandiser is created successfully.
[roles] Synced 2 roles completed.

The package install subcommand installs an existing item package to Sitecore.

This command requires elevated permissions.

You can use the following options with the package install subcommand:

The following is an example of using the package install subcommand:

• Command: Result
• dotnet sitecore ser pkg install -f FILE_PATH: The package FILE_PATH was installed to the Sitecore instance.