testsha-cm-bulk-publish
v1.0.4
Published
Contentstack CLI plugin for bulk publish actions
Downloads
2
Readme
testsha-cm-bulk-publish
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.
Usage
$ npm install -g testsha-cm-bulk-publish
$ csdx COMMAND
running command...
$ csdx (-v|--version|version)
testsha-cm-bulk-publish/1.0.4 linux-x64 node-v16.18.1
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
Commands
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:unpublish
csdx cm:bulk-publish
csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries]
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>]
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:unpublish
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>]
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 <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>]
OPTIONS
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
is selected)
-a, --alias=alias Alias(name) for the management token
-c, --config=config Path to the config file
-e, --environments=environments Environments where assets will be published
-l, --locales=locales Locales to where assets will be published
-y, --yes Agree to process the command with the current configuration
--bulk-publish=bulk-publish [default: true] By default this flag is set as true. It indicates that contentstack's
bulkpublish API will be used to publish the assets
--delivery-token=delivery-token Delivery token for source environment
--folder-uid=folder-uid [default: cs_root] Folder-uid from where the assets will be published
--retry-failed=retry-failed Retry publishing failed assets from the logfile (optional, will override all other
flags)
--source-env=source-env Source environment
DESCRIPTION
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]
csdx cm:assets:unpublish
Unpublish assets from given environment
USAGE
$ csdx cm:assets:unpublish
OPTIONS
-a, --alias=alias Alias(name) for the management token
-c, --config=config Path to the config file
-e, --environment=environment Source Environment
-y, --yes Agree to process the command with the current configuration
--branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
is selected)
--bulk-unpublish=bulk-unpublish [default: true] By default this flag is set as true. It indicates that contentstack's
bulkpublish API will be used to unpublish the assets
--delivery-token=delivery-token Delivery Token for source environment
--locale=locale Locale filter
--retry-failed=retry-failed Retry unpublishing failed assets from the logfile
DESCRIPTION
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]
csdx cm:bulk-publish
Bulk Publish script for managing entries and assets
USAGE
$ csdx cm:bulk-publish
csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries]
Publish entries and assets from one environment to other environments
USAGE
$ csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type
<value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>]
[-y] [--branch <value>] [--onlyAssets] [--onlyEntries]
OPTIONS
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
is selected)
-a, --alias=alias Alias(name) for the management token
-c, --config=config Path to the config file
-y, --yes Agree to process the command with the current configuration
--bulk-publish=bulk-publish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-type=content-type The Contenttypes from which entries will be published
--delivery-token=delivery-token Delivery token for source environment
--environments=environments Destination Environments
--locales=locales Source locale
--onlyAssets Unpublish only assets
--onlyEntries Unpublish only entries
--retry-failed=retry-failed (optional) Retry publishing failed entries from the logfile (this flag overrides all
other flags)
--source-env=source-env Source Env
DESCRIPTION
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]
csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>]
Publish entries from multiple contenttypes to multiple environments and locales
USAGE
$ csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types]
[--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token
<value>] [--source-env <value>]
OPTIONS
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
is selected)
-a, --alias=alias Alias(name) for the management token
-c, --config=config Path for the external config file (A new config file can be generated at the current
working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
-e, --environments=environments Environments where entries will be published
-l, --locales=locales Locales where entries will be published
-y, --yes Agree to process the command with the current configuration
--bulk-publish=bulk-publish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-types=content-types The Contenttypes from which entries need to be published
--delivery-token=delivery-token Delivery token for source environment
--publish-all-content-types (optional) Publish all contenttypes (cannot be set when contentTypes flag is set)
--retry-failed=retry-failed (optional) Retry failed entries from the logfile (overrides all other flags) This
flag is used to retry publishing entries that failed to publish in a previous
attempt. A log file for the previous session will be required for processing the
failed entries
--source-env=source-env Source environment
DESCRIPTION
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]
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>]
OPTIONS
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
is selected)
-a, --alias=alias Alias(name) for the management token
-c, --config=config Path to the config file
-e, --environments=environments Destination environments
-l, --locales=locales Locales where edited entries will be published
-y, --yes Agree to process the command with the current configuration
--bulk-publish=bulk-publish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-types=content-types The Contenttypes which will be checked for edited entries
--retry-failed=retry-failed Retry publishing failed entries from the logfile (optional, overrides all other
flags)
--source-env=source-env Environment from which edited entries will be published
DESCRIPTION
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]
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>]
OPTIONS
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
is selected)
-a, --alias=alias Alias(name) for the management token
-c, --config=config Path to the config file
-e, --environments=environments Destination environments
-y, --yes Agree to process the command with the current configuration
--bulk-publish=bulk-publish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-types=content-types The Contenttypes from which entries will be published
--retry-failed=retry-failed Retry publishing failed entries from the logfile
--source-env=source-env Source Environment
DESCRIPTION
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]
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>]
OPTIONS
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
is selected)
-a, --alias=alias Alias(name) for the management token
-b, --bulk-publish=bulk-publish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
-c, --config=config Path to the config file
-e, --environments=environments Destination environments
-y, --yes Agree to process the command with the current configuration
--content-types=content-types The Contenttypes from which entries will be published
--locales=locales Source locale
--retry-failed=retry-failed Retry publishing failed entries from the logfile
--source-env=source-env Source Env
DESCRIPTION
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]
csdx cm:entries:unpublish
Unpublish entries from the given environment
USAGE
$ csdx cm:entries:unpublish
OPTIONS
-a, --alias=alias Alias(name) for the management token
-c, --config=config Path to the config file
-e, --environment=environment Source Environment
-y, --yes Agree to process the command with the current configuration
--branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
is selected)
--bulk-unpublish=bulk-unpublish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to unpublish the entries
--content-type=content-type Content type filter
--delivery-token=delivery-token Delivery token for source environment
--locale=locale Locale filter
--retry-failed=retry-failed Retry publishing failed entries from the logfile
DESCRIPTION
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]
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>]
OPTIONS
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
is selected)
-a, --alias=alias Alias(name) for the management token
-c, --config=config Path to the config file
-e, --environments=environments Environments where entries will be published
-l, --locales=locales Locales where entries will be published
-t, --contentTypes=contentTypes The Contenttypes from which entries will be published
-y, --yes Agree to process the command with the current configuration
--bulk-publish=bulk-publish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-types=content-types The Contenttypes from which entries will be published
--force Update and publish all entries even if no fields have been added
--retry-failed=retry-failed Retry publishing failed entries from the logfile (optional, overrides all other
flags)
DESCRIPTION
The update-and-publish command is used to update existing entries with the updated schema of the respective content
type
Note: Content types, Environments and Locales are required to execute the command successfully
But, if retry-failed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:add-fields
EXAMPLES
General Usage
csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT
2] --locale [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
csdx cm:entries:update-and-publish --config [PATH TO CONFIG FILE]
csdx cm:entries:update-and-publish -c [PATH TO CONFIG FILE]
Using --retry-failed
csdx cm:entries:update-and-publish --retry-failed [LOG FILE NAME]
Using --branch
csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT
2] --locale [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
csdx cm:stacks:publish
Publish entries and assets to multiple environments and locales
USAGE
$ csdx cm:stacks:publish
DESCRIPTION
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]
csdx cm:stacks:publish-clear-logs
Clear the log folder
USAGE
$ csdx cm:stacks:publish-clear-logs
OPTIONS
-y, --yes Delete all files without asking for confirmation
--log-files-count List number of log files
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:stacks:publish-configure
The configure command is used to generate a configuration file for publish scripts.
USAGE
$ csdx cm:stacks:publish-configure
OPTIONS
-a, --alias=alias Alias(name) for the management token
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-revert
Revert publish operations by using a log file
USAGE
$ csdx cm:stacks:publish-revert
OPTIONS
--log-file=log-file logfile to be used to revert
--retry-failed=retry-failed retry publishing failed entries from the logfile
DESCRIPTION
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]
OPTIONS
-B, --branch=branch [default: main] Specify the branch to fetch the content from (default is main branch)
-a, --alias=alias Alias(name) for the management token
-c, --config=config Path to the config file
-e, --environment=environment Source Environment
-l, --locale=locale Locale filter
-y, --yes Agree to process the command with the current configuration
--bulk-unpublish=bulk-unpublish [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=content-type Content type filter
--delivery-token=delivery-token Delivery token for source environment
--retry-failed=retry-failed Retry publishing failed entries from the logfile (optional, overrides all other
flags)
DESCRIPTION
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]