Contentstack CLI plugin for bulk publish actions
npm install @contentstack/cli-cm-bulk-publishIt 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.

* @contentstack/cli-cm-bulk-publish
* Usage
* Commands
``sh-session`
$ npm install -g @contentstack/cli-cm-bulk-publish
$ csdx COMMAND
running command...
$ csdx (--version)
@contentstack/cli-cm-bulk-publish/1.10.6 darwin-arm64 node-v24.13.0
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
* [csdx cm:assets:publish [-a ](#csdx-cmassetspublish--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:unpublish
* csdx cm:bulk-publish
* csdx cm:entries:update-and-publish [-a
* [](#csdx-cmentriesupdate-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
* [](#csdx-cmassetspublish--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:clear
* csdx cm:bulk-publish:configure
* csdx cm:bulk-publish:cross-publish [-a
* [](#csdx-cmbulk-publishcross-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
* [](#csdx-cmentriespublish--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
* [](#csdx-cmentriespublish-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
* [](#csdx-cmentriespublish-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:revert
* csdx csdx cm:stacks:unpublish [-a
* [](#csdx-csdx-cmstacksunpublish--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
* [](#csdx-cmentriespublish-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
* [](#csdx-cmentriespublish--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
* [](#csdx-cmentriespublish-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
* [](#csdx-cmentriespublish-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
* [](#csdx-cmentriespublish-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:unpublish
* csdx cm:entries:update-and-publish [-a
* [](#csdx-cmentriesupdate-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:publish
* csdx cm:stacks:publish-clear-logs
* csdx cm:stacks:publish-configure
* csdx cm:stacks:publish-revert
* csdx csdx cm:stacks:unpublish [-a
* [](#csdx-csdx-cmstacksunpublish--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)
Publish assets to the specified environments
`
USAGE
$ csdx cm:assets:publish [-a
FLAGS
-B, --branch=
operation. If you don’t mention the branch name, then by default the assets from the
main branch will be published.
-a, --alias=
--stack-api-key flag.
-c, --config=
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=
environments, specify their names separated by spaces.
-k, --stack-api-key=
--alias flag.
-l, --locales=
locales, specify the codes separated by spaces.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=
--bulk-publish=
default.
--delivery-token=
--folder-uid=
The default value is cs_root.
--retry-failed=
name of the logfile that lists failed publish calls. If this option is used, it will
override all other flags.
--source-env=
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_
Unpublish assets from given environment
`
USAGE
$ csdx cm:assets:unpublish [-a
FLAGS
-a, --alias=
--stack-api-key flag.
-c, --config=
single run. Refer to the configure command to create a configuration file.
-e, --environment=
-k, --stack-api-key=
flag.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=
--branch=
operation. If you don’t mention the branch name, then by default the content from the
main branch will be unpublished.
--bulk-unpublish=
default.
--delivery-token=
--locale=
--retry-failed=
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_
Bulk 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_
Add fields from updated content types to their respective entries
`
USAGE
$ csdx cm:bulk-publish:add-fields cm:entries:update-and-publish [-a
[--content-types
FLAGS
-B, --branch=
operation. If you don’t mention the branch name, then by default the content from the
main branch will be published.
-a, --alias=
--stack-api-key flag.
-c, --config=
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=
environments, specify their names separated by spaces.
-k, --stack-api-key=
--alias flag.
-l, --locales=
locales, specify the codes separated by spaces.
-t, --contentTypes=
-y, --yes Set it to true to process the command with the current configuration.
--api-version=
--bulk-publish=
default.
--content-types=
multiple content types, specify their IDs separated by spaces.
--force Update and publish all entries even if no fields have been added.
--retry-failed=
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]
`
Publish assets to the specified environments
`
USAGE
$ csdx cm:bulk-publish:assets cm:assets:publish [-a
[--bulk-publish
[--source-env
FLAGS
-B, --branch=
operation. If you don’t mention the branch name, then by default the assets from the
main branch will be published.
-a, --alias=
--stack-api-key flag.
-c, --config=
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=
environments, specify their names separated by spaces.
-k, --stack-api-key=
--alias flag.
-l, --locales=
locales, specify the codes separated by spaces.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=
--bulk-publish=
default.
--delivery-token=
--folder-uid=
The default value is cs_root.
--retry-failed=
name of the logfile that lists failed publish calls. If this option is used, it will
override all other flags.
--source-env=
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]
`
Clear 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
`
The configure command is used to generate a configuration file for publish scripts.
`
USAGE
$ csdx cm:bulk-publish:configure [-a
FLAGS
-a, --alias=
flag or the --stack-api-key flag.
-k, --stack-api-key=
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
$ csdx cm:stacks:publish-configure --alias
$ csdx cm:stacks:publish-configure --stack-api-key
`
Publish entries and assets from one environment to other environments
`
USAGE
$ csdx cm:bulk-publish:cross-publish [-a
[--locales
[--branch
FLAGS
-B, --branch=
selected)
-a, --alias=
-c, --config=
-k, --stack-api-key=
-y, --yes Agree to process the command with the current configuration
--api-version=
--bulk-publish=
default.
--content-type=
--delivery-token=
--environments=
--include-variants Include Variants flag will publish all associated variant entries.
--locales=
--onlyAssets Unpublish only assets
--onlyEntries Unpublish only entries
--retry-failed=
other flags)
--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_
Publish entries from multiple contenttypes to multiple environments and locales
`
USAGE
$ csdx cm:bulk-publish:entries cm:entries:publish [-a
[--publish-all-content-types] [--content-types
FLAGS
-B, --branch=
operation. If you don’t mention the branch name, then by default the content from
main branch will be published.
-a, --alias=
--stack-api-key flag.
-c, --config=
options for a single run. Refer to the configure command to create a configuration
file.
-e, --environments=
environments, specify their names separated by spaces.
-k, --stack-api-key=
--alias flag.
-l, --locales=
locales, specify the codes separated by spaces.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=
--bulk-publish=
set to true, by default.
--content-types=
multiple content types, specify the IDs separated by spaces.
--delivery-token=
--entry-uid=
--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=
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=
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]
`
Publish edited entries from a specified content type to the given locales and environments
`
USAGE
$ csdx cm:bulk-publish:entry-edits cm:entries:publish-modified [-a
[--source-env
FLAGS
-B, --branch=
operation. If you don't mention the branch name, then by default the entries from main
branch will be published.
-a, --alias=
--stack-api-key flag.
-c, --config=
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=
multiple environments, specify their names separated by spaces.
-k, --stack-api-key=
--alias flag.
-l, --locales=
locales, specify the codes separated by spaces.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=
--bulk-publish=
default.
--content-types=
case of multiple content types, specify the IDs separated by spaces.
--retry-failed=
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=
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]
`
Publish non-localized fields for the given content types, from a particular source environment to the specified environments
`
USAGE
$ csdx cm:bulk-publish:nonlocalized-field-changes cm:entries:publish-non-localized-fields [-a
[--bulk-publish
FLAGS
-B, --branch=
operation. If you don’t mention the branch name, then by default the content from the
main branch will be published.
-a, --alias=
--stack-api-key flag.
-c, --config=
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=
environments, specify their names separated by spaces.
-k, --stack-api-key=
--alias flag.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=
--bulk-publish=
default.
--content-types=
multiple content types, specify their IDs separated by spaces.
--retry-failed=
name of the logfile that lists failed publish calls. If this option is used, it will
override all other flags.
--source-env=
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]
`
Revert publish operations by using a log file
`
USAGE
$ csdx cm:bulk-publish:revert [--retry-failed
FLAGS
--log-file=
--retry-failed=
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]
`
Unpublish entries or assets of given content types from the specified environment
`
USAGE
$ csdx cm:bulk-publish:unpublish csdx cm:stacks:unpublish [-a
[--branch
FLAGS
-B, --branch=
-a, --alias=
-c, --config=
-e, --environment=
-k, --stack-api-key=
-l, --locale=
-y, --yes Agree to process the command with the current configuration
--api-version=
--bulk-unpublish=
bulkpublish API will be used to unpublish the entries and assets
--content-type=
--delivery-token=
--retry-failed=
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]
`
Publish unpublished entries from the source environment, to other environments and locales
`
USAGE
$ csdx cm:bulk-publish:unpublished-entries cm:entries:publish-only-unpublished [-a
[--branch
FLAGS
-B, --branch=
operation. If you don't mention the branch name, then by default the entries from main
branch will be published.
-a, --alias=
--stack-api-key flag.
-b, --bulk-publish=
default.
-c, --config=
options for a single run. Refer to the configure command to create a configuration
file.
-e, --environments=
environments, specify their names separated by spaces.
-k, --stack-api-key=
--alias flag.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=
--content-types=
multiple content types, specify their IDs separated by spaces.
--locales=
--retry-failed=
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=
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]
`
Publish entries from multiple contenttypes to multiple environments and locales
`
USAGE
$ csdx cm:entries:publish [-a
[--content-types
FLAGS
-B, --branch=
operation. If you don’t mention the branch name, then by default the content from
main branch will be published.
-a, --alias=
--stack-api-key flag.
-c, --config=
options for a single run. Refer to the configure command to create a configuration
file.
-e, --environments=
environments, specify their names separated by spaces.
-k, --stack-api-key=
--alias flag.
-l, --locales=
locales, specify the codes separated by spaces.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=
--bulk-publish=
set to true, by default.
--content-types=
multiple content types, specify the IDs separated by spaces.
--delivery-token=
--entry-uid=
--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=
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=
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_
Publish edited entries from a specified content type to the given locales and environments
`
USAGE
$ csdx cm:entries:publish-modified [-a
[--content-types
FLAGS
-B, --branch=
operation. If you don't mention the branch name, then by default the entries from main
branch will be published.
-a, --alias=
--stack-api-key flag.
-c, --config=
for a single run. Refer to the configure command to create a configuration file.
-e, --environments=
multiple environments, specify their names separated by spaces.
-k, --stack-api-key=
--alias flag.
-l, --locales=
locales, specify the codes separated by spaces.
-y, --yes Set it to true to process the command with the current configuration.
--api-version=
--bulk-publish=
default.
--content-types=
case of multiple content types, specify the IDs separated by spaces.
--retry-failed=
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=
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 --conte