Class PullEntityDefinitionCommand

Serializes one or more entity definitions from the connected Content Hub instance to the local file system.

Inheritance
object
Sitecore.CH.Cli.Core.Abstractions.Commands.BaseCommand<THandler>Sitecore.CH.Cli.Plugin.Serialization.CommandHandlers.PullEntityDefinitionCommandHandler
PullEntityDefinitionCommand
Namespace: SitecoreSitecore.CHSitecore.CH.CliSitecore.CH.Cli.PluginSitecore.CH.Cli.Plugin.SerializationCommands
Assembly: Sitecore.CH.Cli.Plugin.Serialization.dll
Syntax
RequestResponse

public sealed class PullEntityDefinitionCommand : BaseCommand<PullEntityDefinitionCommandHandler>
Remarks

Optional parameters

  • --endpoint -e Specifies an alternative endpoint name for the execution of this command.
  • --name -n Name of the entity definition to pull. Wildcards allowed.
  • --remove-missing -r Remove local-only entity definitions.
  • --updates -uUpdate only entity definitions modified in the last minutes (see --minutes).
  • --minutes -m Minutes to go back to look for modified entity definitions. Default is 30 minutes.
  • --folder -f Specifies the a working directory other than the current folder.

Global parameters

  • -? --help -h Show this help message and exit.
  • -v --verbosity Enables verbose logging.
Examples

Serialize an entity definition that matches the specified name:

RequestResponse

ch-cli serialization pull entity-definition -name "<entity definition name>"

Serialize all entity definitions, using the specified working directory:

RequestResponse

ch-cli serialization pull entity-definition --folder "<local path>"

Serialize all entity definitions that match the specific name to a specific folder:

RequestResponse

ch-cli serialization pull entity-definition --name "<name-starts*j>" --folder "<local path>"

Serialize all entity definitions that match the specified name and remove all local entity definitions that exist in the file system but not in the connected Content Hub instance:

RequestResponse

ch-cli serialization pull entity-definition -name "<entity definition name>" --remove-missing

Serialize all entity definitions that were updated recently (see --minutes):

RequestResponse

ch-cli serialization pull entity-definition --updates --minutes "<15>"

Do you have some feedback for us?

If you have suggestions for improving this article,