@contentstack/cli-cm-export

It is Contentstack’s CLI plugin to export content from the stack. To learn how to export and import content in Contentstack, refer to the Migration guide.

• @contentstack/cli-cm-export
• Usage
• Commands

Use csdx config:set:region to set your region. Run csdx config:set:region --help for available regions.

Usage

$ npm install -g @contentstack/cli-cm-export
$ csdx COMMAND
running command...
$ csdx (--version)
@contentstack/cli-cm-export/2.0.2 linux-x64 node-v22.23.3
$ csdx --help [COMMAND]
USAGE
  $ csdx COMMAND
...

Commands

• csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]

csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]

Export content from a stack

USAGE
  $ csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>]
    [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]

FLAGS
  -a, --alias=<value>
      The management token alias of the source stack from which you will export content.

  -c, --config=<value>
      [optional] Path of the config

  -d, --data-dir=<value>
      The path or the location in your file system to store the exported content. For e.g., ./content

  -k, --stack-api-key=<value>
      API Key of the source stack

  -y, --yes
      [optional] Force override all Marketplace prompts.

  --branch=<value>
      [optional] The name of the branch where you want to export your content. If you don't mention the branch name, then
      by default the content will be exported from all the branches of your stack.

  --branch-alias=<value>
      (Optional) The alias of the branch from which you want to export content.

  --content-types=<value>...
      [optional]  The UID of the content type(s) whose content you want to export. In case of multiple content types,
      specify the IDs separated by spaces.

  --module=<option>
      [optional] Specific module name. If not specified, the export command will export all the modules from the stack.
      The available modules are stack, assets, locales, environments, extensions, webhooks, global-fields, entries,
      content-types, custom-roles, workflows, publishing-rules, labels, marketplace-apps, taxonomies, personalize, and
      composable-studio.
      <options: stack|assets|locales|environments|extensions|webhooks|global-fields|entries|content-types|custom-roles|wor
      kflows|publishing-rules|labels|marketplace-apps|taxonomies|personalize|composable-studio>

  --secured-assets
      [optional] Use this flag for assets that are secured.

DESCRIPTION
  Export content from a stack

EXAMPLES
  $ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>

  $ csdx cm:stacks:export --config <path/to/config/dir>

  $ csdx cm:stacks:export --alias <management_token_alias>

  $ csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>

  $ csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>

  $ csdx cm:stacks:export --module <single module name>

  $ csdx cm:stacks:export --branch [optional] branch name

See code: src/commands/cm/stacks/export.ts