@contentstack/cli-cm-bulk-publish
Advanced tools
Contentstack CLI plugin for bulk publish actions
It is Contentstack’s CLI plugin to perform bulk publish/unpublish operations on entries and assets in Contentstack. Refer to the Bulk Publish and Unpublish documentation to learn more about its commands.
$ npm install -g @contentstack/cli-cm-bulk-publish
$ csdx COMMAND
running command...
$ csdx (--version)
@contentstack/cli-cm-bulk-publish/1.7.0 darwin-arm64 node-v22.2.0
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
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>]csdx cm:assets:unpublishcsdx cm:bulk-publishcsdx 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: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>]csdx cm:bulk-publish:clearcsdx cm:bulk-publish:configurecsdx 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] [--include-variants]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>] [--entry-uid <value>] [--include-variants]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:bulk-publish:revertcsdx 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 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: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>] [--entry-uid <value>] [--include-variants]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:stacks:publishcsdx cm:stacks:publish-clear-logscsdx cm:stacks:publish-configurecsdx cm:stacks:publish-revertcsdx 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 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>]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>]
FLAGS
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
operation. If you don’t mention the branch name, then by default the assets from the
main branch will be published.
-a, --alias=<value> Alias (name) for the management token. You must use either the --alias flag or the
--stack-api-key flag.
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
environments, specify their names separated by spaces.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
--alias flag.
-l, --locales=<value>... Locales in which assets will be published, e.g., en-us. In the case of multiple
locales, specify the codes separated by spaces.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
default.
--delivery-token=<value> The delivery token of the source environment.
--folder-uid=<value> (optional) The UID of the Assets’ folder from which the assets need to be published.
The default value is cs_root.
--retry-failed=<value> Use this option to retry publishing the failed assets from the logfile. Specify the
name of the logfile that lists failed publish calls. If this option is used, it 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]
Using --stack-api-key flag
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --stack-api-key [STACK API KEY]
See code: src/commands/cm/assets/publish.js
csdx cm:assets:unpublishUnpublish assets from given environment
USAGE
$ csdx cm:assets:unpublish [-a <value>] [-k <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch
<value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--delivery-token <value>]
FLAGS
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
--stack-api-key flag.
-c, --config=<value> (optional) Path of an optional configuration JSON file containing all the options for a
single run. Refer to the configure command to create a configuration file.
-e, --environment=<value> The name of the environment from where entries/assets need to be unpublished.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
flag.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--branch=<value> [default: main] The name of the branch where you want to perform the bulk unpublish
operation. If you don’t mention the branch name, then by default the content from the
main branch will be unpublished.
--bulk-unpublish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
default.
--delivery-token=<value> The delivery token of the source environment.
--locale=<value> Locale from which entries/assets will be unpublished, e.g., en-us.
--retry-failed=<value> (optional) Use this option to retry unpublishing the failed entries from the logfile.
Specify the name of the logfile that lists failed unpublish calls. If this option is
used, it will override all other flags.
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]
Using --stack-api-key flag
$ csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
See code: src/commands/cm/assets/unpublish.js
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: src/commands/cm/bulk-publish/index.js
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] The name of the branch where you want to perform the bulk publish
operation. If you don’t mention the branch name, then by default the content from the
main branch will be published.
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
--stack-api-key flag.
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
environments, specify their names separated by spaces.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
--alias flag.
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
locales, specify the codes separated by spaces.
-t, --contentTypes=<value>... The Contenttypes from which entries will be published.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
default.
--content-types=<value>... The UID of the content type ID whose entries you want to publish in bulk. In case of
multiple content types, specify their IDs separated by spaces.
--force Update and publish all entries even if no fields have been added.
--retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
name of the logfile that lists failed publish calls. If this option is used, it will
override 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] --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: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] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
Using --stack-api-key
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY]
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>]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>]
FLAGS
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
operation. If you don’t mention the branch name, then by default the assets from the
main branch will be published.
-a, --alias=<value> Alias (name) for the management token. You must use either the --alias flag or the
--stack-api-key flag.
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
environments, specify their names separated by spaces.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
--alias flag.
-l, --locales=<value>... Locales in which assets will be published, e.g., en-us. In the case of multiple
locales, specify the codes separated by spaces.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
default.
--delivery-token=<value> The delivery token of the source environment.
--folder-uid=<value> (optional) The UID of the Assets’ folder from which the assets need to be published.
The default value is cs_root.
--retry-failed=<value> Use this option to retry publishing the failed assets from the logfile. Specify the
name of the logfile that lists failed publish calls. If this option is used, it 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]
Using --stack-api-key flag
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --stack-api-key [STACK API KEY]
csdx cm:bulk-publish:clearClear the log folder
USAGE
$ csdx cm:bulk-publish:clear [--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
csdx cm:bulk-publish:configureThe configure command is used to generate a configuration file for publish scripts.
USAGE
$ csdx cm:bulk-publish:configure [-a <value>] [-k <value>]
FLAGS
-a, --alias=<value> Name (alias) of the management token you want to use. You must use either the --alias
flag or the --stack-api-key flag.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
flag.
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>
$ csdx cm:stacks:publish-configure --stack-api-key <stack_api_key>
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] [--include-variants]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] [--include-variants]
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
-k, --stack-api-key=<value> Stack api key to be used
-y, --yes Agree to process the command with the current configuration
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
default.
--content-type=<value>... The Contenttypes from which entries will be published
--delivery-token=<value> The delivery token of the source environment.
--environments=<value>... Destination Environments
--include-variants Include Variants flag will publish all associated variant entries.
--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]
Using --stack-api-key flag
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
Using --include-variants flag
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN] [--include-variants]
See code: src/commands/cm/bulk-publish/cross-publish.js
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>] [--entry-uid <value>] [--include-variants]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>] [--entry-uid <value>] [--include-variants]
FLAGS
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
operation. If you don’t mention the branch name, then by default the content from main
branch will be published.
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
--stack-api-key flag.
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
environments, specify their names separated by spaces.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
--alias flag.
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
locales, specify the codes separated by spaces.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. This flag is set
to true, by default.
--content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
multiple content types, specify the IDs separated by spaces.
--delivery-token=<value> The delivery token of the source environment.
--entry-uid=<value> Entry Uid for publish all associated variant entries.
--include-variants Include Variants flag will publish all associated variant entries with base entry.
--publish-all-content-types (optional) Set it to true to bulk publish entries from all content types. If the
--content-types option is already used, then you cannot use this option.
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/ assets from the
logfile. Specify the name of the logfile that lists failed publish calls. If this
option is used, it will override all other flags.
--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]
Using --stack-api-key
$ csdx cm:entries:publish -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
Using --include-variants
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] [--include-variants]
Using --entry-uid and --include-variants
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] --entry-uid [ENTRY UID] [--include-variants]
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] The name of the branch where you want to perform the bulk publish
operation. If you don't mention the branch name, then by default the entries from main
branch will be published.
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
--stack-api-key flag.
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=<value>... The name of the environment(s) on which the entries will be published. In case of
multiple environments, specify their names separated by spaces.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
--alias flag.
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
locales, specify the codes separated by spaces.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
default.
--content-types=<value>... The UID of the content type(s) whose edited entries you want to publish in bulk. In
case of multiple content types, specify the IDs separated by spaces.
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/assets from the
logfile. Specify the name of the logfile that lists failed publish calls. If this
option is used, it will override all other flags
--source-env=<value> The name of the source environment where the entries were initially 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]
Using --stack-api-key
$ 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] -stack-api-key [STACK API KEY]
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] The name of the branch where you want to perform the bulk publish
operation. If you don’t mention the branch name, then by default the content from the
main branch will be published.
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
--stack-api-key flag.
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
environments, specify their names separated by spaces.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
--alias flag.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
default.
--content-types=<value>... The UID of the content type whose entries you want to publish in bulk. In case of
multiple content types, specify their IDs separated by spaces.
--retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
name of the logfile that lists failed publish calls. If this option is used, it will
override all other flags.
--source-env=<value> The name of the 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]
Using --stack-api-key flag
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENV]
csdx cm:bulk-publish:revertRevert publish operations by using a log file
USAGE
$ csdx cm:bulk-publish:revert [--retry-failed <value>] [--log-file <value>]
FLAGS
--log-file=<value> Path of the success logfile of a particular publish action.
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. Specify
the name of the logfile that lists failed publish calls. If this option is used, it will
override all other flags.
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]
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
-k, --stack-api-key=<value> Stack api key to be used
-l, --locale=<value> Locale filter
-y, --yes Agree to process the command with the current configuration
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--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> The delivery token of the 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]
Using --stack-api-key flag
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
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] The name of the branch where you want to perform the bulk publish
operation. If you don't mention the branch name, then by default the entries from main
branch will be published.
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
--stack-api-key flag.
-b, --bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
default.
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
environments, specify their names separated by spaces.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
--alias flag.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]..
--content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
multiple content types, specify their IDs separated by spaces.
--locales=<value> Locale in which entries will be published, e.g., en-us
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. It
is optional. Specify the name of the logfile that lists failed publish calls. If this
option is used, it will override all other flags.
--source-env=<value> The name of the source environment where the entries were initially published.
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]
Using --stack-api-key
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --stack-api-key [STACK API KEY] -source-env [SOURCE ENV]
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>] [--entry-uid <value>] [--include-variants]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>] [--entry-uid <value>] [--include-variants]
FLAGS
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
operation. If you don’t mention the branch name, then by default the content from main
branch will be published.
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
--stack-api-key flag.
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
environments, specify their names separated by spaces.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
--alias flag.
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
locales, specify the codes separated by spaces.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. This flag is set
to true, by default.
--content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
multiple content types, specify the IDs separated by spaces.
--delivery-token=<value> The delivery token of the source environment.
--entry-uid=<value> Entry Uid for publish all associated variant entries.
--include-variants Include Variants flag will publish all associated variant entries with base entry.
--publish-all-content-types (optional) Set it to true to bulk publish entries from all content types. If the
--content-types option is already used, then you cannot use this option.
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/ assets from the
logfile. Specify the name of the logfile that lists failed publish calls. If this
option is used, it will override all other flags.
--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]
Using --stack-api-key
$ csdx cm:entries:publish -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
Using --include-variants
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] [--include-variants]
Using --entry-uid and --include-variants
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] --entry-uid [ENTRY UID] [--include-variants]
See code: src/commands/cm/entries/publish.js
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] The name of the branch where you want to perform the bulk publish
operation. If you don't mention the branch name, then by default the entries from main
branch will be published.
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
--stack-api-key flag.
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=<value>... The name of the environment(s) on which the entries will be published. In case of
multiple environments, specify their names separated by spaces.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
--alias flag.
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
locales, specify the codes separated by spaces.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
default.
--content-types=<value>... The UID of the content type(s) whose edited entries you want to publish in bulk. In
case of multiple content types, specify the IDs separated by spaces.
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/assets from the
logfile. Specify the name of the logfile that lists failed publish calls. If this
option is used, it will override all other flags
--source-env=<value> The name of the source environment where the entries were initially 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]
Using --stack-api-key
$ 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] -stack-api-key [STACK API KEY]
See code: src/commands/cm/entries/publish-modified.js
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] The name of the branch where you want to perform the bulk publish
operation. If you don’t mention the branch name, then by default the content from the
main branch will be published.
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
--stack-api-key flag.
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
environments, specify their names separated by spaces.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
--alias flag.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
default.
--content-types=<value>... The UID of the content type whose entries you want to publish in bulk. In case of
multiple content types, specify their IDs separated by spaces.
--retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
name of the logfile that lists failed publish calls. If this option is used, it will
override all other flags.
--source-env=<value> The name of the 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]
Using --stack-api-key flag
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENV]
See code: src/commands/cm/entries/publish-non-localized-fields.js
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] The name of the branch where you want to perform the bulk publish
operation. If you don't mention the branch name, then by default the entries from main
branch will be published.
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
--stack-api-key flag.
-b, --bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
default.
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
environments, specify their names separated by spaces.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
--alias flag.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]..
--content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
multiple content types, specify their IDs separated by spaces.
--locales=<value> Locale in which entries will be published, e.g., en-us
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. It
is optional. Specify the name of the logfile that lists failed publish calls. If this
option is used, it will override all other flags.
--source-env=<value> The name of the source environment where the entries were initially published.
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]
Using --stack-api-key
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --stack-api-key [STACK API KEY] -source-env [SOURCE ENV]
See code: src/commands/cm/entries/publish-only-unpublished.js
csdx cm:entries:unpublishUnpublish entries from the given environment
USAGE
$ csdx cm:entries:unpublish [-a <value>] [-k <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch
<value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--content-type <value>]
[--delivery-token <value>] [--include-variants]
FLAGS
-a, --alias=<value> Alias (name) for the management token. You must use either the --alias flag or the
--stack-api-key flag.
-c, --config=<value> (optional) Path to the configuration JSON file containing all options for a single run.
Refer to the configure command to create a configuration file.
-e, --environment=<value> The name of the environment from where entries/assets need to be unpublished.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
flag.
-y, --yes Set to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--branch=<value> [default: main] Specify the branch to fetch the content. If not mentioned, the main
branch will be used by default.
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that Contentstack's
Bulk Publish APIs will be used to unpublish the entries.
--content-type=<value> The UID of the content type whose entries you want to unpublish in bulk.
--delivery-token=<value> The delivery token of the source environment.
--include-variants Include Variants flag will unpublish all associated variant entries.
--locale=<value> Locale from which entries/assets will be unpublished, e.g., en-us.
--retry-failed=<value> (optional) Use this option to retry unpublishing the failed entries from the logfile.
Specify the name of the logfile that lists failed unpublish calls. If used, this option
will override all other flags.
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]
Using --stack-api-key flag
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
Using --include-variants flag
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN] --include-variants
See code: src/commands/cm/entries/unpublish.js
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] The name of the branch where you want to perform the bulk publish
operation. If you don’t mention the branch name, then by default the content from the
main branch will be published.
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
--stack-api-key flag.
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
environments, specify their names separated by spaces.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
--alias flag.
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
locales, specify the codes separated by spaces.
-t, --contentTypes=<value>... The Contenttypes from which entries will be published.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
default.
--content-types=<value>... The UID of the content type ID whose entries you want to publish in bulk. In case of
multiple content types, specify their IDs separated by spaces.
--force Update and publish all entries even if no fields have been added.
--retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
name of the logfile that lists failed publish calls. If this option is used, it will
override 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] --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: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] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
Using --stack-api-key
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY]
See code: src/commands/cm/entries/update-and-publish.js
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]
Using --api-version flag
$ csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --api-version [API VERSION]
See code: src/commands/cm/stacks/publish.js
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: src/commands/cm/stacks/publish-clear-logs.js
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>] [-k <value>]
FLAGS
-a, --alias=<value> Name (alias) of the management token you want to use. You must use either the --alias
flag or the --stack-api-key flag.
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
flag.
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>
$ csdx cm:stacks:publish-configure --stack-api-key <stack_api_key>
See code: src/commands/cm/stacks/publish-configure.js
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> Path of the success logfile of a particular publish action.
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. Specify
the name of the logfile that lists failed publish calls. If this option is used, it will
override all other flags.
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: src/commands/cm/stacks/publish-revert.js
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
-k, --stack-api-key=<value> Stack api key to be used
-l, --locale=<value> Locale filter
-y, --yes Agree to process the command with the current configuration
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--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> The delivery token of the 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]
Using --stack-api-key flag
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
See code: src/commands/cm/stacks/unpublish.js
FAQs
Contentstack CLI plugin for bulk publish actions
The npm package @contentstack/cli-cm-bulk-publish receives a total of 2,648 weekly downloads. As such, @contentstack/cli-cm-bulk-publish popularity was classified as popular.
We found that @contentstack/cli-cm-bulk-publish 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.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."