Skip to content

Latest commit

 

History

History

contentstack-export

README.md

@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.

License

For switching to EU region update the hosts at config/default.js

{
  host:'https://eu-api.contentstack.com/v3',
  cdn: 'https://eu-cdn.contentstack.com/v3',
 ...
}

For switching to AZURE-NA region update the hosts at config/default.js

{
  host:'https://azure-na-api.contentstack.com/v3',
  cdn: 'https://azure-na-cdn.contentstack.com/v3',
 ...
}

For switching to AZURE-EU region update the hosts at config/default.js

{
  host:'https://azure-eu-api.contentstack.com/v3',
  cdn: 'https://azure-eu-cdn.contentstack.com/v3',
 ...
}

Usage

$ npm install -g @contentstack/cli-cm-export
$ csdx COMMAND
running command...
$ csdx (--version)
@contentstack/cli-cm-export/1.14.1 darwin-arm64 node-v22.2.0
$ csdx --help [COMMAND]
USAGE
  $ csdx COMMAND
...

Commands

csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]

Export content from a stack

USAGE
  $ csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types
    <value>] [--branch <value>] [--secured-assets]

FLAGS
  -B, --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.
  -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
  -m, --module=<value>            [optional] Specific module name. If not specified, the export command will export all
                                  the modules to the stack. The available modules are assets, content-types, entries,
                                  environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
                                  workflows, custom-roles, and taxonomies.
  -t, --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.
  -y, --yes                       [optional] Force override all Marketplace prompts.
  --secured-assets                [optional] Use this flag for assets that are secured.

DESCRIPTION
  Export content from a stack

ALIASES
  $ csdx cm:export

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

csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]

Export content from a stack

USAGE
  $ csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types
    <value>] [--branch <value>] [--secured-assets]

FLAGS
  -B, --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.
  -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
  -m, --module=<value>            [optional] Specific module name. If not specified, the export command will export all
                                  the modules to the stack. The available modules are assets, content-types, entries,
                                  environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
                                  workflows, custom-roles, and taxonomies.
  -t, --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.
  -y, --yes                       [optional] Force override all Marketplace prompts.
  --secured-assets                [optional] Use this flag for assets that are secured.

DESCRIPTION
  Export content from a stack

ALIASES
  $ csdx cm:export

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