Export Content Using the CLI | V2.x.x Beta
To migrate content from one stack to another, begin by exporting content from the source stack, then import it into the destination stack.
This guide explains how to use the cm:stacks:export command by logging in to the CLI (or using a management token), using configuration files, or using direct CLI parameters.
Prerequisites
- Contentstack account
- Contentstack CLI installed
- CLI authenticated
- Configured management token (alias) (optional)
Supported Modules
- Assets
- Locales
- Environments
- Stacks (CLI supports Stacks from v1.42.0)
- Extensions
- Marketplace Apps
- Webhooks
- Global Fields (CLI supports Nested Global Fields from v1.42.0)
- Content Types
- Entries
- Labels
- Workflow
- Custom Role
- Taxonomy
- Personalize
- Studio
Commands
The cm:stacks:export command lets you export content from one stack to another.
Usage
csdx cm:stacks:export -k <<stack_ApiKey>> -d <<file_path>>
Options
Use the following options with any applicable export command:
| Flag | Short Flag | Description |
|---|---|---|
| --stack-api-key=stack-api-key | -k | API key of the source stack. |
| --alias=alias | -a | Management token alias of the source stack. |
| --data-dir=data-dir | -d | Absolute path to the folder where exported content is stored. |
| --branch=branch | - | Name of the branch from which content is exported. Default: all branches If not specified, content from all branches is exported. |
| --branch-alias=branch-alias | Alias of the branch from which content is exported. | |
| --module=module | - | [Optional] Export a specific module from the source stack. If not specified, all modules are exported. Available modules: assets, content-types, entries, environments, stacks, extensions, marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, taxonomies, personalize, studio |
| --content-types=content-types | - | [Optional] UID of the content type(s whose content should be exported. For multiple content types, separate IDs using spaces. |
| --secured-assets=secured-assets | - | [Optional] Required if the secured assets feature is enabled for the stack. Ensure this flag is included when exporting secured assets. |
| --backup-dir=backup-dir | - | [Optional] Backup directory name for a specific module. |
| --yes | -y | Force override all Marketplace prompts. If not provided, you are prompted to enter an encryption key while exporting Marketplace app configurations. |
| --config=config | -c | Path to the configuration JSON file containing all options for a single run. |
| --query | [optional] Query object (inline JSON or file path) to filter module exports. |
Examples
- To export all modules from a stack:
csdx cm:stacks:export -d "C:\Users\Name\Desktop\cli\content" -k bltxxxxxx
- To export all modules from a specific branch (e.g., develop):
csdx cm:stacks:export -d "C:\Users\Name\Desktop\cli\content" -k bltxxxxxx --branch develop
- To export all modules from a branch using an alias:
csdx cm:stacks:export -d "C:\Users\Name\Desktop\cli\content" -k bltxxxxxx --branch-alias developAlias
- To export only content types:
csdx cm:stacks:export -d "C:\Users\Name\Desktop\cli\content" --module content-types -k bltxxxxxx
Note When exporting modules individually, follow this module sequence:
assets → environments → stacks → locales → extensions → marketplace-apps → webhooks → taxonomies → global-fields → content-types → workflows → entries → labels → custom-roles → personalize → studio
For example, before exporting entries, you must have already exported assets, environments, stacks, locales, extensions, marketplace-apps, webhooks, taxonomies, global-fields, content-types, and workflows.
Using Configuration File
You can also export content using a configuration file.
To get started, follow the steps below:
- Download the configuration file.
- Add your values.
- Note the path where the file is saved.
Usage
csdx cm:stacks:export -c <<config_file_path>>
Example
- To export content using a configuration file:
csdx cm:stacks:export -c "C:\Users\Name\Desktop\cli\config.json"
Note
- Mac OS users must use "/" for paths in a JSON file.
- Windows OS users must use "\\" for paths in a JSON file.
Configuration File Options
The following are the possible file options in the configuration file:
| Configuration File Option | Options | Description |
|---|---|---|
| versioning | true, false | Exports versioned entries. |
| host | Any valid CMA base URL | Sets the host for the export operation. |
| preserveStackVersion | true, false | Preserves the stack version while exporting data. |
| fetchConcurrency | Any natural number | Specifies the number of files to fetch per request. |
| writeConcurrency | Any natural number | Specifies the number of files to write per request. |
| source_stack | <stack_uid> | UID of the stack from which data is exported. |
| data | <path-where-data-is-stored> | File path where the exported data is stored. |
| branchName | <branch-name> | Name of the branch to export data from. |
| branchAlias | - | Alias of the branch to export data from. |
| moduleName | stack, assets, locales, environments, extensions, webhooks, global-fields, content-types, custom-roles, workflows, entries, labels, marketplace-apps | Specifies the module to export. |
| securedAssets | true, false | Fetches only secured assets. |
Export Content Using Management Token
You can also export content from your stack using a management token.
Usage
csdx cm:stacks:export -a <<alias>>
Alternatively, refer to the following command to add several parameters or options in a single line:
csdx cm:stacks:export -a <<alias>> -d <<file_path>>
You can also export content by using a management token and a configuration file that contains the parameters or options and the associated values.
By doing so, you don’t need to separately provide parameters or options in the command.
Usage
csdx cm:stacks:export -a <<alias>> -c <<config_file_path>>
Example
- To export content using a configuration file:
csdx cm:stacks:export -a mytoken -c "C:\Users\Name\Desktop\cli\config.json"
Toggle Between Console Logs and Progress Manager View (2.x.x-beta)
Contentstack CLI lets you toggle between the raw console logs and the visual Progress Manager UI during export or plugin workflows.
Default Usage:
csdx cm:stacks:export -d "./export-data" -k bltxxxxxx
Note By default, the Progress Manager UI displays when you run the export command and does not require any configuration.
Example for Progress Manager View (Default Mode):
STACK:
├─ Settings |████████████████████████████████████████| 100% | 1/1 | ✓ Complete (1/1)
├─ Locale |████████████████████████████████████████| 100% | 1/1 | ✓ Complete (1/1)
LOCALES:
└─ Locales |████████████████████████████████████████| 100% | 2/2 | ✓ Complete (2/2)
CONTENT TYPES:
└─ Content types |████████████████████████████████████████| 100% | 6/6 | ✓ Complete (6/6)
ENTRIES:
├─ Entries |████████████████████████████████████████| 100% | 12/12 | ✓ Complete (12/12)Steps to Switch to Console Logs (Optional):
- Run the following command to switch to console log mode:
csdx config:set:log --show-console-logs
- Run the export command:
csdx cm:stacks:export -d "./export-data" -k bltxxxxxx
The screen displays the console logs for the export operation.
Tip Use --show-console-logs for detailed debugging when troubleshooting export issues.
- Run the following command to switch back to default mode:
csdx config:set:log --no-show-console-logs
Options:
- --show-console-logs: Displays the console logs for the operation.
- --no-show-console-logs: Hides the console logs and displays the Progress Manager view.
Example for Console Log Mode:
[2025-08-22 16:12:23] INFO: Exporting content from branch main [2025-08-22 16:12:23] INFO: Started to export content, version is 2 [2025-08-22 16:12:23] INFO: Exporting module: stack [2025-08-22 16:12:24] INFO: Exporting stack settings [2025-08-22 16:12:25] SUCCESS: Exported stack settings successfully!
Limitations
- If multiple assets have the same UID and file name, only the first asset will be exported.
- To resolve the maxContentLength and maxBodyLength errors, include these parameters in the configuration JSON with values specified in bytes. The default limit is 100MB. For implementation details, refer to the example configuration file.
- To manage API request timing and prevent concurrency issues, add the delayMs parameter to your configuration file.
For example, use delayMs: 1000 (for a 1-second delay).
- Currently, only the latest version of entries and assets is exported.
- Currently, the following modules cannot be exported:
Additional Resource: Learn more about the CLI-supported export operations in the CLI-Supported Features for Export, Import, and Clone Operations document.