@contentstack/cli
Advanced tools
It is Contentstack’s CLI plugin to perform authentication-related activities. To get started with authenticating yourself with the CLI, refer to the CLI’s Authentication documentation
$ npm install -g @contentstack/cli
$ csdx COMMAND
running command...
$ csdx (-v|--version|version)
@contentstack/cli/1.0.1 linux-x64 node-v16.15.1
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
csdx auth:logincsdx auth:logoutcsdx auth:tokenscsdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]csdx auth:tokens:removecsdx auth:whoamicsdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>] [--content-types <value>]csdx cm:assets:unpublishcsdx cm:bootstrapcsdx cm:bulk-publishcsdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries]csdx cm:entries:migrate-html-rtecsdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>]csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]csdx cm:entries:unpublishcsdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]csdx cm:export-to-csvcsdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]csdx cm:stacks:publishcsdx cm:stacks:publish-clear-logscsdx cm:stacks:publish-configurecsdx cm:stacks:publish-revertcsdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]csdx csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>] [--only-assets] [--only-entries]csdx config:get:regioncsdx config:set:region [REGION]csdx pluginscsdx plugins:inspect PLUGIN...csdx plugins:install PLUGIN...csdx plugins:link PLUGINcsdx plugins:uninstall PLUGIN...csdx plugins:updatecsdx auth:loginUser sessions login
USAGE
$ csdx auth:login [-u <value>] [-p <value>]
FLAGS
-p, --password=<value> Password
-u, --username=<value> User name
DESCRIPTION
User sessions login
ALIASES
$ csdx login
EXAMPLES
$ csdx auth:login
$ csdx auth:login -u <username>
$ csdx auth:login -u <username> -p <password>
$ csdx auth:login --username <username>
$ csdx auth:login --username <username> --password <password>
See code: @contentstack/cli-auth
csdx auth:logoutUser session logout
USAGE
$ csdx auth:logout [-y]
FLAGS
-y, --yes Force log out by skipping the confirmation
DESCRIPTION
User session logout
ALIASES
$ csdx logout
EXAMPLES
$ csdx auth:logout
$ csdx auth:logout -y
$ csdx auth:logout --yes
See code: @contentstack/cli-auth
csdx auth:tokensLists all existing tokens added to the session
USAGE
$ csdx auth:tokens [--columns <value>] [--sort <value>] [--filter <value>] [--csv] [--output csv|json|yaml]
[-x] [--no-truncate] [--no-header]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Lists all existing tokens added to the session
ALIASES
$ csdx tokens
EXAMPLES
$ csdx auth:tokens
See code: @contentstack/cli-auth
csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]Adds management/delivery tokens to your session to use it with other CLI commands
USAGE
$ csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]
FLAGS
-a, --alias=<value> Name of the token alias
-d, --delivery Set this flag to save delivery token
-e, --environment=<value> Environment name for delivery token
-k, --stack-api-key=<value> Stack API Key
-m, --management Set this flag to save management token
-t, --token=<value> Add the token name
-y, --yes Use this flag to skip confirmation
DESCRIPTION
Adds management/delivery tokens to your session to use it with other CLI commands
EXAMPLES
$ csdx auth:tokens:add
$ csdx auth:tokens:add -a <alias>
$ csdx auth:tokens:add -k <stack api key>
$ csdx auth:tokens:add --delivery
$ csdx auth:tokens:add --management
$ csdx auth:tokens:add -e <environment>
$ csdx auth:tokens:add --token <token>
$ csdx auth:tokens:add -a <alias> -k <stack api key> --management --token <management token>
$ csdx auth:tokens:add -a <alias> -k <stack api key> --delivery -e <environment> --token <delivery token>
$ csdx auth:tokens:add --alias <alias> --stack-api-key <stack api key> --management --token <management token>
$ csdx auth:tokens:add --alias <alias> --stack-api-key <stack api key> --delivery -e <environment> --token <delivery token>
See code: @contentstack/cli-auth
csdx auth:tokens:removeRemoves selected tokens
USAGE
$ csdx auth:tokens:remove [-a <value>] [-i]
FLAGS
-a, --alias=<value> Token alias
-i, --ignore Ignore
DESCRIPTION
Removes selected tokens
EXAMPLES
$ csdx auth:tokens:remove
$ csdx auth:tokens:remove -a <alias>
See code: @contentstack/cli-auth
csdx auth:whoamiDisplay current users email address
USAGE
$ csdx auth:whoami
DESCRIPTION
Display current users email address
ALIASES
$ csdx whoami
EXAMPLES
$ csdx auth:whoami
See code: @contentstack/cli-auth
csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>] [--content-types <value>]Publish assets to the specified environments
USAGE
$ csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish
<value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]
[--content-types <value>]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-e, --environments=<value> Environments where assets will be published
-l, --locales=<value> Locales to where assets will be published
-y, --yes Agree to process the command with the current configuration
--bulk-publish=<value> [default: true] By default this flag is set as true. It indicates that contentstack's
bulkpublish API will be used to publish the assets
--content-types=<value> Content types
--delivery-token=<value> Delivery token for source environment
--folder-uid=<value> [default: cs_root] Folder-uid from where the assets will be published
--retry-failed=<value> Retry publishing failed assets from the logfile (optional, will override all other flags)
--source-env=<value> Source environment
DESCRIPTION
Publish assets to the specified environments
The assets command is used to publish assets from the specified stack, to the specified environments
Note: Environment(s) and Locale(s) are required to execute the command successfully
But, if retryFailed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:assets
EXAMPLES
General Usage
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
$ csdx cm:assets:publish --config [PATH TO CONFIG FILE]
$ csdx cm:assets:publish -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:assets:publish --retry-failed [LOG FILE NAME]
Using --branch flag
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
Using --source-env
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:assets:unpublishUnpublish assets from given environment
USAGE
$ csdx cm:assets:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>]
[--retry-failed <value>] [--bulk-unpublish <value>] [--delivery-token <value>]
FLAGS
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-e, --environment=<value> Source Environment
-y, --yes Agree to process the command with the current configuration
--branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
--bulk-unpublish=<value> [default: true] By default this flag is set as true. It indicates that contentstack's
bulkpublish API will be used to unpublish the assets
--delivery-token=<value> Delivery Token for source environment
--locale=<value> Locale filter
--retry-failed=<value> Retry unpublishing failed assets from the logfile
DESCRIPTION
Unpublish assets from given environment
The unpublish command is used for unpublishing assets from the given environment
Note: Environment (Source Environment) and Locale are required to execute the command successfully
But, if retry-failed flag is set, then only a logfile is required
EXAMPLES
General Usage
$ csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
$ csdx cm:assets:unpublish --config [PATH TO CONFIG FILE]
$ csdx cm:assets:unpublish -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:assets:unpublish --retry-failed [LOG FILE NAME]
Using --branch flag
$ csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bootstrapBootstrap contentstack apps
USAGE
$ csdx cm:bootstrap [--app-name <value>] [--project-dir <value>] [-k <value>] [--org <value>] [-n <value>] [-y
<value>]
FLAGS
-k, --stack-api-key=<value> Provide stack API key to seed content
-n, --stack-name=<value> Name of a new stack that will be created.
-y, --yes=<value>
--app-name=<value> App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter, nuxt-starter
--org=<value> Provide organization UID to create a new stack
--project-dir=<value> Directory to setup the project. If directory name has a space then provide the path as a
string or escap the space using back slash eg: "../../test space" or ../../test\ space
DESCRIPTION
Bootstrap contentstack apps
EXAMPLES
$ csdx cm:bootstrap
$ csdx cm:bootstrap --project-dir <path/to/setup/the/app>
$ csdx cm:bootstrap --app-name "reactjs-starter" --project-dir <path/to/setup/the/app>
$ csdx cm:bootstrap --app-name "reactjs-starter" --project-dir <path/to/setup/the/app> --stack-api-key "stack-api-key"
$ csdx cm:bootstrap --app-name "reactjs-starter" --project-dir <path/to/setup/the/app> --org "your-org-uid" --stack-name "stack-name"
See code: @contentstack/cli-cm-bootstrap
csdx cm:bulk-publishBulk Publish script for managing entries and assets
USAGE
$ csdx cm:bulk-publish
DESCRIPTION
Bulk Publish script for managing entries and assets
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries]Publish entries and assets from one environment to other environments
USAGE
$ csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type
<value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>]
[-y] [--branch <value>] [--onlyAssets] [--onlyEntries]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-y, --yes Agree to process the command with the current configuration
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-type=<value> The Contenttypes from which entries will be published
--delivery-token=<value> Delivery token for source environment
--environments=<value> Destination Environments
--locales=<value> Source locale
--onlyAssets Unpublish only assets
--onlyEntries Unpublish only entries
--retry-failed=<value> (optional) Retry publishing failed entries from the logfile (this flag overrides all other
flags)
--source-env=<value> Source Env
DESCRIPTION
Publish entries and assets from one environment to other environments
The cross-publish command is used to publish entries and assets from one environment to other environments
Note: Content Type, Environment, Destination Environment(s) and Locale are required to execute the command
successfully
But, if retryFailed flag is set, then only a logfile is required
EXAMPLES
General Usage
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] -a [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
$ csdx cm:bulk-publish:cross-publish --config [PATH TO CONFIG FILE]
$ csdx cm:bulk-publish:cross-publish -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:bulk-publish:cross-publish --retry-failed [LOG FILE NAME]
$ csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]
Using --branch flag
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] -a [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:entries:migrate-html-rteMigration script to migrate content from HTML RTE to JSON RTE
USAGE
$ csdx cm:entries:migrate-html-rte [-c <value>] [-a <value>] [--content-type <value>] [--global-field] [-y] [--html-path
<value>] [--json-path <value>] [--delay <value>] [--locale <value>] [--batch-limit <value>]
FLAGS
-a, --alias=<value> Alias(name) for the management token
-c, --config-path=<value> Path to config file
-y, --yes Agree to process the command with the current configuration
--batch-limit=<value> [default: 50] Provide batch limit for updating entries
--content-type=<value> The content type from which entries will be migrated
--delay=<value> [default: 1000] Provide delay in ms between two entry update
--global-field This flag is set to false by default. It indicates that current content type is a
globalfield
--html-path=<value> Provide path of HTML RTE to migrate
--json-path=<value> Provide path of JSON RTE to migrate
--locale=<value> The locale from which entries will be migrated
DESCRIPTION
Migration script to migrate content from HTML RTE to JSON RTE
ALIASES
$ csdx cm:migrate-rte
EXAMPLES
General Usage
$ csdx cm:entries:migrate-html-rte --config-path path/to/config.json
Using Flags
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path html-path --json-path json-path
Nested RTE
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path modular_block_uid.block_uid.html_rte_uid --json-path modular_block_uid.block_uid.json_rte_uid
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path group_uid.html_rte_uid --json-path group_uid.json_rte_uid
Global Field
$ csdx cm:entries:migrate-html-rte --alias alias --content-type global_field_uid --global-field --html-path html-path --json-path json-path
See code: @contentstack/cli-cm-migrate-rte
csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>]Publish entries from multiple contenttypes to multiple environments and locales
USAGE
$ csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
[--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
<value>] [--delivery-token <value>] [--source-env <value>]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path for the external config file (A new config file can be generated at the current
working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
-e, --environments=<value> Environments where entries will be published
-l, --locales=<value> Locales where entries will be published
-y, --yes Agree to process the command with the current configuration
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-types=<value> The Contenttypes from which entries need to be published
--delivery-token=<value> Delivery token for source environment
--publish-all-content-types (optional) Publish all contenttypes (cannot be set when contentTypes flag is set)
--retry-failed=<value> (optional) Retry failed entries from the logfile (overrides all other flags) This flag is
used to retry publishing entries that failed to publish in a previous attempt. A log file
for the previous session will be required for processing the failed entries
--source-env=<value> Source environment
DESCRIPTION
Publish entries from multiple contenttypes to multiple environments and locales
The publish command is used to publish entries from the specified content types, to the
specified environments and locales
Note: Content Types, Environments and Locales are required to execute the command successfully
But, if retry-failed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:entries
EXAMPLES
General Usage
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
$ csdx cm:entries:publish --config [PATH TO CONFIG FILE]
$ csdx cm:entries:publish -c [PATH TO CONFIG FILE]
Using --retry-failed
$ csdx cm:entries:publish --retry-failed [LOG FILE NAME]
$ csdx cm:entries:publish -r [LOG FILE NAME]
Using --branch
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
Using --source-env
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]Publish edited entries from a specified content type to the given locales and environments
USAGE
$ csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env
<value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-e, --environments=<value> Destination environments
-l, --locales=<value> Locales where edited entries will be published
-y, --yes Agree to process the command with the current configuration
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-types=<value> The Contenttypes which will be checked for edited entries
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
--source-env=<value> Environment from which edited entries will be published
DESCRIPTION
Publish edited entries from a specified content type to the given locales and environments
The publish-modified command is used to publish entries from the specified content types, to the
specified environments and locales
Note: Content type(s), Source Environment, Destination Environment(s) and Locale(s) are required to execute the
command successfully
But, if retry-failed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:entry-edits
EXAMPLES
General Usage
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
$ csdx cm:entries:publish-modified --config [PATH TO CONFIG FILE]
$ csdx cm:entries:publish-modified -c [PATH TO CONFIG FILE]
Using --retry-failed
$ csdx cm:entries:publish-modified --retry-failed [LOG FILE NAME]
$ csdx cm:entries:publish-modified -r [LOG FILE NAME]
Using --branch
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]Publish non-localized fields for the given content types, from a particular source environment to the specified environments
USAGE
$ csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
[--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-e, --environments=<value> Destination environments
-y, --yes Agree to process the command with the current configuration
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-types=<value> The Contenttypes from which entries will be published
--retry-failed=<value> Retry publishing failed entries from the logfile
--source-env=<value> Source Environment
DESCRIPTION
Publish non-localized fields for the given content types, from a particular source environment to the specified
environments
The non-localized field changes command is used to publish non-localized field changes from the given content types to
the specified environments
Note: Content types, Environments and Source Environment are required to execute this command successfully.
But, if retryFailed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:nonlocalized-field-changes
EXAMPLES
General Usage
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
$ csdx cm:entries:publish-non-localized-fields --config [PATH TO CONFIG FILE]
$ csdx cm:entries:publish-non-localized-fields -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:entries:publish-non-localized-fields --retry-failed [LOG FILE NAME]
Using --branch flag
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV] --branch [BRANCH NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]Publish unpublished entries from the source environment, to other environments and locales
USAGE
$ csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
[--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
<value>]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-b, --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
-c, --config=<value> Path to the config file
-e, --environments=<value> Destination environments
-y, --yes Agree to process the command with the current configuration
--content-types=<value> The Contenttypes from which entries will be published
--locales=<value> Source locale
--retry-failed=<value> Retry publishing failed entries from the logfile
--source-env=<value> Source Env
DESCRIPTION
Publish unpublished entries from the source environment, to other environments and locales
The publish-only-unpublished command is used to publish unpublished entries from the source environment, to other
environments and locales
Note: Content type(s), Source Environment, Destination Environment(s) and Source Locale are required to execute the
command successfully
But, if retry-failed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:unpublished-entries
EXAMPLES
General Usage
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] -source-env [SOURCE ENV]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
$ csdx cm:entries:publish-only-unpublished --config [PATH TO CONFIG FILE]
$ csdx cm:entries:publish-only-unpublished -c [PATH TO CONFIG FILE]
Using --retry-failed
$ csdx cm:entries:publish-only-unpublished --retry-failed [LOG FILE NAME]
Using --branch
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME] -source-env [SOURCE ENV]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:entries:unpublishUnpublish entries from the given environment
USAGE
$ csdx cm:entries:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>]
[--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>]
FLAGS
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-e, --environment=<value> Source Environment
-y, --yes Agree to process the command with the current configuration
--branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to unpublish the entries
--content-type=<value> Content type filter
--delivery-token=<value> Delivery token for source environment
--locale=<value> Locale filter
--retry-failed=<value> Retry publishing failed entries from the logfile
DESCRIPTION
Unpublish entries from the given environment
The unpublish command is used to unpublish entries from the given environment
Note: Environment (Source Environment) and Locale are required to execute the command successfully
But, if retry-failed flag is set, then only a logfile is required
EXAMPLES
General Usage
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
$ csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]
$ csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]
Using --branch flag
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]Add fields from updated content types to their respective entries
USAGE
$ csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types
<value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-e, --environments=<value> Environments where entries will be published
-l, --locales=<value> Locales where entries will be published
-t, --contentTypes=<value> The Contenttypes from which entries will be published
-y, --yes Agree to process the command with the current configuration
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-types=<value> The Contenttypes from which entries will be published
--force Update and publish all entries even if no fields have been added
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
DESCRIPTION
Add fields from updated content types to their respective entries
The update-and-publish command is used to update existing entries with the updated schema of the respective content
type
Note: Content types, Environments and Locales are required to execute the command successfully
But, if retry-failed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:add-fields
EXAMPLES
General Usage
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locale [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
$ csdx cm:entries:update-and-publish --config [PATH TO CONFIG FILE]
$ csdx cm:entries:update-and-publish -c [PATH TO CONFIG FILE]
Using --retry-failed
$ csdx cm:entries:update-and-publish --retry-failed [LOG FILE NAME]
Using --branch
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locale [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:export-to-csvExport entries or organization users to csv using this command
USAGE
$ csdx cm:export-to-csv [--action entries|users] [-a <value>] [--org <value>] [-n <value>] [--org-name <value>]
[--locale <value>] [--content-type <value>]
FLAGS
-a, --alias=<value> Alias of the management token
-n, --stack-name=<value> Name of the stack that needs to be created as csv filename.
--action=<option> Option to export data (entries, users)
<options: entries|users>
--content-type=<value> Content type for which entries needs to be exported
--locale=<value> Locale for which entries need to be exported
--org=<value> Provide organization UID to clone org users
--org-name=<value> Name of the organization that needs to be created as csv filename.
DESCRIPTION
Export entries or organization users to csv using this command
EXAMPLES
$ csdx cm:export-to-csv
Exporting entries to csv
$ csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type>
Exporting entries to csv with stack name provided
$ csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type> --stack-name <stack-name>
Exporting organization users to csv
$ csdx cm:export-to-csv --action <users> --org <org-uid>
Exporting organization users to csv with organization name provided
$ csdx cm:export-to-csv --action <users> --org <org-uid> --org-name <org-name>
See code: @contentstack/cli-cm-export-to-csv
csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]Clone data (structure/content or both) of a stack into another stack
USAGE
$ csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>]
[--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>]
[--destination-stack-api-key <value>] [--import-webhook-status disable|current]
FLAGS
-n, --stack-name=<value> Name for the new stack to store the cloned content.
--destination-management-token-alias=<value> Source API key of the target stack token alias.
--destination-stack-api-key=<value> Destination stack API Key
--import-webhook-status=<option> [default: disable] Webhook state
<options: disable|current>
--source-branch=<value> Branch of the source stack.
--source-management-token-alias=<value> Source API key of the target stack token alias.
--source-stack-api-key=<value> Source stack API Key
--target-branch=<value> Branch of the target stack.
--type=<option> Type of data to clone
a) Structure (all modules except entries & assets)
b) Structure with content (all modules including entries & assets)
<options: a|b>
DESCRIPTION
Clone data (structure/content or both) of a stack into another stack
Use this plugin to automate the process of cloning a stack in few steps.
ALIASES
$ csdx cm:stack-clone
EXAMPLES
$ csdx cm:stacks:clone
$ csdx cm:stacks:clone --source-branch <source-branch-name> --target-branch <target-branch-name>
$ csdx cm:stacks:clone --source-stack-api-key <apiKey> --destination-stack-api-key <apiKey>
$ csdx cm:stacks:clone --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
$ csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
$ csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias> --type <value a or b>
See code: @contentstack/cli-cm-clone
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] branch name
-a, --alias=<value> alias of the management token
-c, --config=<value> [optional] path of the config
-d, --data-dir=<value> path or location to store the data
-k, --stack-api-key=<value> API key of the source stack
-m, --module=<value> [optional] specific module name
-t, --content-types=<value> [optional] content type
--secured-assets [optional] use when assets 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: @contentstack/cli-cm-export
csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]Import script for importing the content into the new stack
USAGE
$ csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>]
[--branch <value>] [--import-webhook-status disable|current]
FLAGS
-B, --branch=<value> [optional] branch name
-a, --alias=<value> alias of the management token
-b, --backup-dir=<value> [optional] backup directory name when using specific module
-c, --config=<value> [optional] path of config file
-d, --data-dir=<value> path and location where data is stored
-k, --stack-api-key=<value> API key of the target stack
-m, --module=<value> [optional] specific module name
--import-webhook-status=<option> [default: disable] Webhook state
<options: disable|current>
DESCRIPTION
Import script for importing the content into the new stack
...
Once you export content from the source stack, import it to your destination stack by using the cm:stacks:import
command.
ALIASES
$ csdx cm:import
EXAMPLES
$ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
$ csdx cm:stacks:import --config <path/of/config/dir>
$ csdx cm:stacks:import --module <single module name>
$ csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>
$ csdx cm:stacks:import --alias <management_token_alias>
$ csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>
$ csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
$ csdx cm:stacks:import --branch <branch name>
See code: @contentstack/cli-cm-import
csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]Contentstack migration script.
USAGE
$ csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>]
[--config <value>] [--multiple]
FLAGS
-B, --branch=<value> Use this flag to add the branch name where you want to perform the migration.
-a, --alias=<value> Use this flag to add the management token alias.
-k, --stack-api-key=<value> With this flag add the API key of your stack.
--config=<value> [optional] inline configuration, <key1>:<value1>
--config-file=<value> [optional] Path of the JSON configuration file
--file-path=<value> Use this flag to provide the path of the file of the migration script provided by the
user.
--multiple This flag helps you to migrate multiple content files in a single instance.
DESCRIPTION
Contentstack migration script.
ALIASES
$ csdx cm:migration
EXAMPLES
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>
$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>
$ csdx cm:migration --config-file <path/to/json/config/file> --file-path <migration/script/file/path>
$ csdx cm:migration --multiple --file-path <migration/scripts/dir/path>
$ csdx cm:migration --alias --file-path <migration/script/file/path> -k <api-key>
See code: @contentstack/cli-migration
csdx cm:stacks:publishPublish entries and assets to multiple environments and locales
USAGE
$ csdx cm:stacks:publish
DESCRIPTION
Publish entries and assets to multiple environments and locales
The publish command is used to publish entries and assets, to the specified environments and locales.
Note: Content types, Environments and Locales are required to execute the publish entries command successfully.
Note: Environments and Locales are required to execute the publish assets command successfully.
But, if retry-failed flag is set, then only a logfile is required
EXAMPLES
General Usage
$ csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]
Using --config or -c flag
Generate a config file in the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
$ csdx cm:stacks:publish --config [PATH TO CONFIG FILE]
$ csdx cm:stacks:publish -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:stacks:publish --retry-failed [LOG FILE NAME]
Using --branch flag
$ csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:stacks:publish-clear-logsClear the log folder
USAGE
$ csdx cm:stacks:publish-clear-logs [--log-files-count] [-y]
FLAGS
-y, --yes Delete all files without asking for confirmation
--log-files-count List number of log files
DESCRIPTION
Clear the log folder
ALIASES
$ csdx cm:bulk-publish:clear
EXAMPLES
$ csdx cm:stacks:publish-clear-logs
$ csdx cm:stacks:publish-clear-logs --log-files-count
$ csdx cm:stacks:publish-clear-logs --yes
$ csdx cm:stacks:publish-clear-logs -y
See code: @contentstack/cli-cm-bulk-publish
csdx cm:stacks:publish-configureThe configure command is used to generate a configuration file for publish scripts.
USAGE
$ csdx cm:stacks:publish-configure [-a <value>]
FLAGS
-a, --alias=<value> Alias(name) for the management token
DESCRIPTION
The configure command is used to generate a configuration file for publish scripts.
ALIASES
$ csdx cm:bulk-publish:configure
EXAMPLES
$ csdx cm:stacks:publish-configure
$ csdx cm:stacks:publish-configure -a <management_token_alias>
$ csdx cm:stacks:publish-configure --alias <management_token_alias>
See code: @contentstack/cli-cm-bulk-publish
csdx cm:stacks:publish-revertRevert publish operations by using a log file
USAGE
$ csdx cm:stacks:publish-revert [--retry-failed <value>] [--log-file <value>]
FLAGS
--log-file=<value> logfile to be used to revert
--retry-failed=<value> retry publishing failed entries from the logfile
DESCRIPTION
Revert publish operations by using a log file
The revert command is used to revert all publish operations performed using bulk-publish script.
A log file name is required to execute revert command
ALIASES
$ csdx cm:bulk-publish:revert
EXAMPLES
Using --log-file
cm:bulk-publish:revert --log-file [LOG FILE NAME]
Using --retry-failed
cm:bulk-publish:revert --retry-failed [LOG FILE NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]Create a stack from existing content types, entries, assets, etc
USAGE
$ csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]
FLAGS
-k, --stack-api-key=<value> Provide stack api key to seed content to
-n, --stack-name=<value> Name of a new stack that needs to be created.
-o, --org=<value> Provide Organization UID to create a new stack
-r, --repo=<value> GitHub account or GitHub account/repository
-s, --stack=<value> Provide stack UID to seed content to
-y, --yes=<value>
DESCRIPTION
Create a stack from existing content types, entries, assets, etc
ALIASES
$ csdx cm:seed
EXAMPLES
$ csdx cm:stacks:seed
$ csdx cm:stacks:seed --repo "account"
$ csdx cm:stacks:seed --repo "account/repository"
$ csdx cm:stacks:seed --repo "account/repository" --stack-api-key "stack-api-key" //seed content into specific stack
$ csdx cm:stacks:seed --repo "account/repository" --org "your-org-uid" --stack-name "stack-name" //create a new stack in given org uid
See code: @contentstack/cli-cm-seed
csdx csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>] [--only-assets] [--only-entries]Unpublish entries or assets of given content types from the specified environment
USAGE
$ csdx csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>]
[--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>]
[--only-assets] [--only-entries]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content from (default is main branch)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-e, --environment=<value> Source Environment
-l, --locale=<value> Locale filter
-y, --yes Agree to process the command with the current configuration
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to unpublish the entries and assets
--content-type=<value> Content type filter
--delivery-token=<value> Delivery token for source environment
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
DESCRIPTION
Unpublish entries or assets of given content types from the specified environment
The unpublish command is used to unpublish entries or assets from given environment
Environment (Source Environment) and Locale are required to execute the command successfully
But, if retry-failed flag is set, then only a logfile is required
A content type can be specified for unpublishing entries, but if no content-type(s) is/are specified and --only-assets
is not used,
then all entries from all content types will be unpublished from the source environment
Note: --only-assets can be used to unpublish only assets and --only-entries can be used to unpublish only entries.
(--only-assets and --only-entries cannot be used together at the same time)
ALIASES
$ csdx cm:bulk-publish:unpublish
EXAMPLES
General Usage
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] ----delivery-token [DELIVERY TOKEN]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
$ csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]
$ csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]
No content type
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all content types and assets from the source environment)
Using --only-assets
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-assets (Will unpublish only assets from the source environment)
Using --only-entries
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, all entries, from the source environment)
$ csdx cm:stacks:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, (from CONTENT TYPE) from the source environment)
Using --branch flag
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx config:get:regionGet current region set for CLI
USAGE
$ csdx config:get:region
DESCRIPTION
Get current region set for CLI
EXAMPLES
$ csdx config:get:region
See code: @contentstack/cli-config
csdx config:set:region [REGION]Set region for CLI
USAGE
$ csdx config:set:region [REGION] [-d <value>] [-m <value>] [-n <value>]
FLAGS
-d, --cda=<value> Custom host to set for content delivery API, if this flag is added then cma and name flags are
required
-m, --cma=<value> Custom host to set for content management API, , if this flag is added then cda and name flags are
required
-n, --name=<value> Name for the region, if this flag is added then cda and cma flags are required
DESCRIPTION
Set region for CLI
EXAMPLES
$ csdx config:set:region
$ csdx config:set:region NA
$ csdx config:set:region NA
$ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --name "India"
See code: @contentstack/cli-config
csdx pluginsList installed plugins.
USAGE
$ csdx plugins [--core]
FLAGS
--core Show core plugins.
DESCRIPTION
List installed plugins.
EXAMPLES
$ csdx plugins
See code: @oclif/plugin-plugins
csdx plugins:inspect PLUGIN...Displays installation properties of a plugin.
USAGE
$ csdx plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] Plugin to inspect.
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Displays installation properties of a plugin.
EXAMPLES
$ csdx plugins:inspect myplugin
See code: @oclif/plugin-plugins
csdx plugins:install PLUGIN...Installs a plugin into the CLI.
USAGE
$ csdx plugins:install PLUGIN...
ARGUMENTS
PLUGIN Plugin to install.
FLAGS
-f, --force Run yarn install with force flag.
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Installs a plugin into the CLI.
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ csdx plugins:add
EXAMPLES
$ csdx plugins:install myplugin
$ csdx plugins:install https://github.com/someuser/someplugin
$ csdx plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
csdx plugins:link PLUGINLinks a plugin into the CLI for development.
USAGE
$ csdx plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Links a plugin into the CLI for development.
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLES
$ csdx plugins:link myplugin
See code: @oclif/plugin-plugins
csdx plugins:uninstall PLUGIN...Removes a plugin from the CLI.
USAGE
$ csdx plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Removes a plugin from the CLI.
ALIASES
$ csdx plugins:unlink
$ csdx plugins:remove
See code: @oclif/plugin-plugins
csdx plugins:updateUpdate installed plugins.
USAGE
$ csdx plugins:update [-h] [-v]
FLAGS
-h, --help Show CLI help.
-v, --verbose
DESCRIPTION
Update installed plugins.
See code: @oclif/plugin-plugins
FAQs
Command-line tool (CLI) to interact with Contentstack
The npm package @contentstack/cli receives a total of 5,182 weekly downloads. As such, @contentstack/cli popularity was classified as popular.
We found that @contentstack/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
Malicious Go packages are impersonating popular libraries to install hidden loader malware on Linux and macOS, targeting developers with obfuscated payloads.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.