cs-cli-1
v1.18.1
Published
Command-line tool (CLI) to interact with Contentstack
Downloads
3
Readme
cs-cli-1
Use Contentstack Command-line Interface to command Contentstack for executing a set of operations from the terminal. To get started with CLI, refer to the CLI’s documentation
Usage
$ npm install -g cs-cli-1
$ csdx COMMAND
running command...
$ csdx (--version|-v)
cs-cli-1/1.18.1 linux-x64 node-v18.20.2
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
Commands
csdx audit
csdx audit:fix
csdx auth:login
csdx auth:logout
csdx auth:tokens
csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]
csdx auth:tokens:remove
csdx auth:whoami
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:bootstrap
csdx cm:branches
csdx cm:branches:create
csdx cm:branches:delete [-uid <value>] [-k <value>]
csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]
csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>] [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]
csdx cm:bulk-publish
csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
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:clear
csdx cm:bulk-publish:configure
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:bulk-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: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:migrate-html-rte
csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>]
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:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]
csdx cm:export-to-csv
csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
csdx cm:migrate-rte
csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]
csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]
csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]
csdx cm:stacks:audit
csdx cm:stacks:audit:fix
csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]
csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]
csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]
csdx cm:stacks:publish
csdx cm:stacks:publish-clear-logs
csdx cm:stacks:publish-configure
csdx cm:stacks:publish-revert
csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]
csdx csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>] [--only-assets] [--only-entries]
csdx config:get:base-branch
csdx config:get:ea-header
csdx config:get:early-access-header
csdx config:get:region
csdx config:remove:base-branch
csdx config:remove:ea-header
csdx config:remove:early-access-header
csdx config:set:base-branch
csdx config:set:ea-header
csdx config:set:early-access-header
csdx config:set:region [REGION]
csdx help [COMMANDS]
csdx launch
csdx launch:deployments
csdx launch:environments
csdx launch:functions
csdx launch:logs
csdx launch:open
csdx login
csdx logout
csdx plugins
csdx plugins:add PLUGIN
csdx plugins:inspect PLUGIN...
csdx plugins:install PLUGIN
csdx plugins:link PATH
csdx plugins:remove [PLUGIN]
csdx plugins:reset
csdx plugins:uninstall [PLUGIN]
csdx plugins:unlink [PLUGIN]
csdx plugins:update
csdx tokens
csdx whoami
csdx audit
Perform audits and find possible errors in the exported Contentstack data
USAGE
$ csdx audit [--report-path <value>] [--modules content-types|global-fields|entries|extensions|workflows]
[--columns <value> | ] [--sort <value>] [--filter <value>] [--csv | --no-truncate]
FLAGS
--modules=<option>... Provide the list of modules to be audited
<options: content-types|global-fields|entries|extensions|workflows>
--report-path=<value> Path to store the audit reports
TABLE FLAGS
--columns=<value> Show only the specified columns (comma-separated)
--csv The output is in the CSV format [alias: --output=csv]
--filter=<value> Filter property by partial string matching. For example: name=foo
--no-truncate The output is not truncated to fit the screen
--sort=<value> Property to sort by (prepend '-' for descending)
DESCRIPTION
Perform audits and find possible errors in the exported Contentstack data
ALIASES
$ csdx audit
$ csdx cm:stacks:audit
EXAMPLES
$ csdx audit
$ csdx audit --report-path=<path>
$ csdx audit --report-path=<path> --csv
$ csdx audit --report-path=<path> --filter="name=<filter-value>"
$ csdx audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
csdx audit:fix
Perform audits and fix possible errors in the exported Contentstack data.
USAGE
$ csdx audit:fix [--report-path <value>] [--modules content-types|global-fields|entries|extensions|workflows]
[--copy-path <value> --copy-dir] [--fix-only
reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ] [--sort <value>]
[--filter <value>] [--csv | --no-truncate]
FLAGS
--copy-dir Create backup from the original data.
--copy-path=<value> Provide the path to backup the copied data
--fix-only=<option>... Provide the list of fix options
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
--modules=<option>... Provide the list of modules to be audited
<options: content-types|global-fields|entries|extensions|workflows>
--report-path=<value> Path to store the audit reports
TABLE FLAGS
--columns=<value> Show only the specified columns (comma-separated)
--csv The output is in the CSV format [alias: --output=csv]
--filter=<value> Filter property by partial string matching. For example: name=foo
--no-truncate The output is not truncated to fit the screen
--sort=<value> Property to sort by (prepend '-' for descending)
DESCRIPTION
Perform audits and fix possible errors in the exported Contentstack data.
ALIASES
$ csdx audit:fix
$ csdx cm:stacks:audit:fix
EXAMPLES
$ csdx audit:fix --copy-dir
$ csdx audit:fix --report-path=<path> --copy-dir
$ csdx audit:fix --report-path=<path> --copy-dir --csv
$ csdx audit:fix --fix-only=reference,global_field --copy-dir
$ csdx audit:fix --report-path=<path> --filter="name=<filter-value>"
$ csdx audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
csdx auth:login
User sessions login
USAGE
$ csdx auth:login [-u <value> | --oauth] [-p <value> | ]
FLAGS
-p, --password=<value> Password
-u, --username=<value> User name
--oauth Enables single sign-on (SSO) in Contentstack CLI
DESCRIPTION
User sessions login
ALIASES
$ csdx login
EXAMPLES
$ csdx auth:login
$ csdx auth:login -u <username>
$ csdx auth:login -u <username> -p <password>
$ csdx auth:login --username <username>
$ csdx auth:login --username <username> --password <password>
See code: cs-cli-1-auth
csdx auth:logout
User session logout
USAGE
$ csdx auth:logout [-y]
FLAGS
-y, --yes Force log out by skipping the confirmation
DESCRIPTION
User session logout
ALIASES
$ csdx logout
EXAMPLES
$ csdx auth:logout
$ csdx auth:logout -y
$ csdx auth:logout --yes
See code: cs-cli-1-auth
csdx auth:tokens
Lists all existing tokens added to the session
USAGE
$ csdx auth:tokens [--columns <value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]]
[--output csv|json|yaml | | ] [--sort <value>]
FLAGS
-x, --extended show extra columns
--columns=<value> only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=<value> filter property by partial string matching, ex: name=foo
--no-header hide table header from output
--no-truncate do not truncate output to fit screen
--output=<option> output in a more machine friendly format
<options: csv|json|yaml>
--sort=<value> property to sort by (prepend '-' for descending)
DESCRIPTION
Lists all existing tokens added to the session
ALIASES
$ csdx tokens
EXAMPLES
$ csdx auth:tokens
See code: cs-cli-1-auth
csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]
Adds management/delivery tokens to your session to use it with other CLI commands
USAGE
$ csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]
FLAGS
-a, --alias=<value> Name of the token alias
-d, --delivery Set this flag to save delivery token
-e, --environment=<value> Environment name for delivery token
-k, --stack-api-key=<value> Stack API Key
-m, --management Set this flag to save management token
-t, --token=<value> Add the token name
-y, --yes Use this flag to skip confirmation
DESCRIPTION
Adds management/delivery tokens to your session to use it with other CLI commands
EXAMPLES
$ csdx auth:tokens:add
$ csdx auth:tokens:add -a <alias>
$ csdx auth:tokens:add -k <stack api key>
$ csdx auth:tokens:add --delivery
$ csdx auth:tokens:add --management
$ csdx auth:tokens:add -e <environment>
$ csdx auth:tokens:add --token <token>
$ csdx auth:tokens:add -a <alias> -k <stack api key> --management --token <management token>
$ csdx auth:tokens:add -a <alias> -k <stack api key> --delivery -e <environment> --token <delivery token>
$ csdx auth:tokens:add --alias <alias> --stack-api-key <stack api key> --management --token <management token>
$ csdx auth:tokens:add --alias <alias> --stack-api-key <stack api key> --delivery -e <environment> --token <delivery token>
See code: cs-cli-1-auth
csdx auth:tokens:remove
Removes selected tokens
USAGE
$ csdx auth:tokens:remove [-a <value>] [-i]
FLAGS
-a, --alias=<value> Token alias
-i, --ignore Ignore
DESCRIPTION
Removes selected tokens
EXAMPLES
$ csdx auth:tokens:remove
$ csdx auth:tokens:remove -a <alias>
See code: cs-cli-1-auth
csdx auth:whoami
Display current users email address
USAGE
$ csdx auth:whoami
DESCRIPTION
Display current users email address
ALIASES
$ csdx whoami
EXAMPLES
$ csdx auth:whoami
See code: cs-cli-1-auth
csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]
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] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-e, --environments=<value>... Environments where assets will be published
-k, --stack-api-key=<value> Stack api key to be used
-l, --locales=<value>... Locales to where assets will be published
-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] By default this flag is set as true. It indicates that contentstack's
bulkpublish API will be used to publish the assets
--delivery-token=<value> Delivery token for source environment
--folder-uid=<value> [default: cs_root] Folder-uid from where the assets will be published
--retry-failed=<value> Retry publishing failed assets from the logfile (optional, will override all other
flags)
--source-env=<value> Source environment
DESCRIPTION
Publish assets to the specified environments
The assets command is used to publish assets from the specified stack, to the specified environments
Note: Environment(s) and Locale(s) are required to execute the command successfully
But, if retryFailed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:assets
EXAMPLES
General Usage
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
$ csdx cm:assets:publish --config [PATH TO CONFIG FILE]
$ csdx cm:assets:publish -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:assets:publish --retry-failed [LOG FILE NAME]
Using --branch flag
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
Using --source-env
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
Using --stack-api-key flag
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --stack-api-key [STACK API KEY]
See code: cs-cli-1-cm-bulk-publish
csdx cm:assets:unpublish
Unpublish 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) 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
-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].
--branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
--bulk-unpublish=<value> [default: true] By default this flag is set as true. It indicates that contentstack's
bulkpublish API will be used to unpublish the assets
--delivery-token=<value> Delivery Token for source environment
--locale=<value> Locale filter
--retry-failed=<value> Retry unpublishing failed assets from the logfile
DESCRIPTION
Unpublish assets from given environment
The unpublish command is used for unpublishing assets from the given environment
Note: Environment (Source Environment) and Locale are required to execute the command successfully
But, if retry-failed flag is set, then only a logfile is required
EXAMPLES
General Usage
$ csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
$ csdx cm:assets:unpublish --config [PATH TO CONFIG FILE]
$ csdx cm:assets:unpublish -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:assets:unpublish --retry-failed [LOG FILE NAME]
Using --branch flag
$ csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
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: cs-cli-1-cm-bulk-publish
csdx cm:bootstrap
Bootstrap contentstack apps
USAGE
$ csdx cm:bootstrap [--app-name <value>] [--project-dir <value>] [-k <value> | --org <value> | -n <value>] [-y
<value>] [-a <value>]
FLAGS
-a, --alias=<value> Alias of the management token
-k, --stack-api-key=<value> Provide stack API key to seed content
-n, --stack-name=<value> Name of a new stack that will be created.
-y, --yes=<value> [Optional] Skip stack confirmation
--app-name=<value> App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter, nuxt-starter,
vue-starter, stencil-starter
--org=<value> Provide organization UID to create a new stack
--project-dir=<value> Directory to setup the project. If directory name has a space then provide the path as a
string or escap the space using back slash eg: "../../test space" or ../../test\ space
DESCRIPTION
Bootstrap contentstack apps
EXAMPLES
$ csdx cm:bootstrap
$ csdx cm:bootstrap --project-dir <path/to/setup/the/app>
$ csdx cm:bootstrap --app-name "reactjs-starter" --project-dir <path/to/setup/the/app>
$ csdx cm:bootstrap --app-name "reactjs-starter" --project-dir <path/to/setup/the/app> --stack-api-key "stack-api-key"
$ csdx cm:bootstrap --app-name "reactjs-starter" --project-dir <path/to/setup/the/app> --org "your-org-uid" --stack-name "stack-name"
See code: cs-cli-1-cm-bootstrap
csdx cm:branches
List the branches
USAGE
$ csdx cm:branches
FLAGS
-k, --stack-api-key=<value> Stack API Key
--verbose Verbose
DESCRIPTION
List the branches
EXAMPLES
$ csdx cm:branches
$ csdx cm:branches --verbose
$ csdx cm:branches -k <stack api key>
See code: cs-cli-1-cm-branches
csdx cm:branches:create
Create a new branch
USAGE
$ csdx cm:branches:create
$ csdx cm:branches:create [--source <value>] [--uid <value>] [-k <value>]
$ csdx cm:branches:create [--source <value>] [--uid <value>] [--stack-api-key <value>]
FLAGS
-k, --stack-api-key=<value> Stack API key
--source=<value> Source branch from which new branch to be created
--uid=<value> Branch UID to be created
DESCRIPTION
Create a new branch
EXAMPLES
$ csdx cm:branches:create
$ csdx cm:branches:create --source main -uid new_branch -k bltxxxxxxxx
$ csdx cm:branches:create --source main --uid new_branch --stack-api-key bltxxxxxxxx
See code: cs-cli-1-cm-branches
csdx cm:branches:delete [-uid <value>] [-k <value>]
Delete a branch
USAGE
$ csdx cm:branches:delete [-uid <value>] [-k <value>]
$ csdx cm:branches:delete [--uid <value>] [--stack-api-key <value>]
FLAGS
-k, --stack-api-key=<value> Stack API key
-y, --yes Force the deletion of the branch by skipping the confirmation
--uid=<value> Branch UID to be deleted
DESCRIPTION
Delete a branch
EXAMPLES
$ csdx cm:branches:delete
$ csdx cm:branches:delete --uid main -k bltxxxxxxxx
$ csdx cm:branches:delete --uid main --stack-api-key bltxxxxxxxx
$ csdx cm:branches:delete --uid main --stack-api-key bltxxxxxxxx --yes
See code: cs-cli-1-cm-branches
csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]
Differences between two branches
USAGE
$ csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]
FLAGS
-k, --stack-api-key=<value> Provide Stack API key to show difference between branches
--base-branch=<value> Base branch
--compare-branch=<value> Compare branch
--format=<option> [default: compact-text] [Optional] Type of flags to show branches differences
<options: compact-text|detailed-text>
--module=<option> Module
<options: content-types|global-fields|all>
DESCRIPTION
Differences between two branches
EXAMPLES
$ csdx cm:branches:diff
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx"
$ csdx cm:branches:diff --compare-branch "develop"
$ csdx cm:branches:diff --compare-branch "develop" --stack-api-key "bltxxxxxxxx"
$ csdx cm:branches:diff --compare-branch "develop" --module "content-types"
$ csdx cm:branches:diff --module "content-types" --format "detailed-text"
$ csdx cm:branches:diff --compare-branch "develop" --format "detailed-text"
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main"
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop"
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --module "content-types"
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types"
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text"
See code: cs-cli-1-cm-branches
csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>] [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]
Merge changes from a branch
USAGE
$ csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>]
[--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]
FLAGS
-k, --stack-api-key=<value> Provide Stack API key to show difference between branches
--base-branch=<value> Base branch
--comment=<value> Merge comment
--compare-branch=<value> Compare branch name
--export-summary-path=<value> Export summary file path
--no-revert If passed, will not create the new revert branch
--use-merge-summary=<value> Path of merge summary file
DESCRIPTION
Merge changes from a branch
EXAMPLES
$ csdx cm:branches:merge --stack-api-key bltxxxxxxxx --compare-branch feature-branch
$ csdx cm:branches:merge --stack-api-key bltxxxxxxxx --comment "merge comment"
$ csdx cm:branches:merge -k bltxxxxxxxx --base-branch base-branch
$ csdx cm:branches:merge --export-summary-path file/path
$ csdx cm:branches:merge --use-merge-summary file-path
$ csdx cm:branches:merge -k bltxxxxxxxx --no-revert
$ csdx cm:branches:merge -k bltxxxxxxxx --compare-branch feature-branch --no-revert
See code: cs-cli-1-cm-branches
csdx cm:bulk-publish
Bulk Publish script for managing entries and assets
USAGE
$ csdx cm:bulk-publish
DESCRIPTION
Bulk Publish script for managing entries and assets
See code: cs-cli-1-cm-bulk-publish
csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
Add fields from updated content types to their respective entries
USAGE
$ csdx cm:bulk-publish:add-fields cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
[--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-e, --environments=<value>... Environments where entries will be published
-k, --stack-api-key=<value> Stack api key to be used
-l, --locales=<value>... Locales where entries will be published
-t, --contentTypes=<value>... The Contenttypes from which entries will be published
-y, --yes Agree to process the command with the current configuration
--api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-types=<value>... The Contenttypes from which entries will be published
--force Update and publish all entries even if no fields have been added
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
DESCRIPTION
Add fields from updated content types to their respective entries
The update-and-publish command is used to update existing entries with the updated schema of the respective content
type
Note: Content types, Environments and Locales are required to execute the command successfully
But, if retry-failed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:add-fields
EXAMPLES
General Usage
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --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:bulk-publish:assets 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] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-e, --environments=<value>... Environments where assets will be published
-k, --stack-api-key=<value> Stack api key to be used
-l, --locales=<value>... Locales to where assets will be published
-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] By default this flag is set as true. It indicates that contentstack's
bulkpublish API will be used to publish the assets
--delivery-token=<value> Delivery token for source environment
--folder-uid=<value> [default: cs_root] Folder-uid from where the assets will be published
--retry-failed=<value> Retry publishing failed assets from the logfile (optional, will override all other
flags)
--source-env=<value> Source environment
DESCRIPTION
Publish assets to the specified environments
The assets command is used to publish assets from the specified stack, to the specified environments
Note: Environment(s) and Locale(s) are required to execute the command successfully
But, if retryFailed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:assets
EXAMPLES
General Usage
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
$ csdx cm:assets:publish --config [PATH TO CONFIG FILE]
$ csdx cm:assets:publish -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:assets:publish --retry-failed [LOG FILE NAME]
Using --branch flag
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
Using --source-env
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
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:clear
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
csdx cm:bulk-publish:configure
The 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> Alias(name) for the management token
-k, --stack-api-key=<value> Stack api key to be used
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]
Publish entries and assets from one environment to other environments
USAGE
$ csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>]
[--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y]
[--branch <value>] [--onlyAssets] [--onlyEntries]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-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] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-type=<value>... The Contenttypes from which entries will be published
--delivery-token=<value> Delivery token for source environment
--environments=<value>... Destination Environments
--locales=<value> Source locale
--onlyAssets Unpublish only assets
--onlyEntries Unpublish only entries
--retry-failed=<value> (optional) Retry publishing failed entries from the logfile (this flag overrides all
other flags)
--source-env=<value> Source Env
DESCRIPTION
Publish entries and assets from one environment to other environments
The cross-publish command is used to publish entries and assets from one environment to other environments
Note: Content Type, Environment, Destination Environment(s) and Locale are required to execute the command
successfully
But, if retryFailed flag is set, then only a logfile is required
EXAMPLES
General Usage
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] -a [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
$ csdx cm:bulk-publish:cross-publish --config [PATH TO CONFIG FILE]
$ csdx cm:bulk-publish:cross-publish -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:bulk-publish:cross-publish --retry-failed [LOG FILE NAME]
$ csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]
Using --branch flag
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] -a [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
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]
See code: cs-cli-1-cm-bulk-publish
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:bulk-publish:entries cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
[--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
<value>] [--delivery-token <value>] [--source-env <value>]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch
is selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path for the external config file (A new config file can be generated at the current
working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
-e, --environments=<value>... Environments where entries will be published
-k, --stack-api-key=<value> Stack api key to be used
-l, --locales=<value>... Locales where entries will be published
-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] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-types=<value>... The Contenttypes from which entries need to be published
--delivery-token=<value> Delivery token for source environment
--publish-all-content-types (optional) Publish all contenttypes (cannot be set when contentTypes flag is set)
--retry-failed=<value> (optional) Retry failed entries from the logfile (overrides all other flags) This
flag is used to retry publishing entries that failed to publish in a previous
attempt. A log file for the previous session will be required for processing the
failed entries
--source-env=<value> Source environment
DESCRIPTION
Publish entries from multiple contenttypes to multiple environments and locales
The publish command is used to publish entries from the specified content types, to the
specified environments and locales
Note: Content Types, Environments and Locales are required to execute the command successfully
But, if retry-failed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:entries
EXAMPLES
General Usage
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
$ csdx cm:entries:publish --config [PATH TO CONFIG FILE]
$ csdx cm:entries:publish -c [PATH TO CONFIG FILE]
Using --retry-failed
$ csdx cm:entries:publish --retry-failed [LOG FILE NAME]
$ csdx cm:entries:publish -r [LOG FILE NAME]
Using --branch
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
Using --source-env
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
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]
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:bulk-publish:entry-edits cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
[--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
<value>]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-e, --environments=<value>... Destination environments
-k, --stack-api-key=<value> Stack api key to be used
-l, --locales=<value>... Locales where edited entries will be published
-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] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-types=<value>... The Contenttypes which will be checked for edited entries
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
--source-env=<value> Environment from which edited entries will be published
DESCRIPTION
Publish edited entries from a specified content type to the given locales and environments
The publish-modified command is used to publish entries from the specified content types, to the
specified environments and locales
Note: Content type(s), Source Environment, Destination Environment(s) and Locale(s) are required to execute the
command successfully
But, if retry-failed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:entry-edits
EXAMPLES
General Usage
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
$ csdx cm:entries:publish-modified --config [PATH TO CONFIG FILE]
$ csdx cm:entries:publish-modified -c [PATH TO CONFIG FILE]
Using --retry-failed
$ csdx cm:entries:publish-modified --retry-failed [LOG FILE NAME]
$ csdx cm:entries:publish-modified -r [LOG FILE NAME]
Using --branch
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
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:bulk-publish:nonlocalized-field-changes cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>]
[--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch
<value>]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-c, --config=<value> Path to the config file
-e, --environments=<value>... Destination environments
-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] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
--content-types=<value>... The Contenttypes from which entries will be published
--retry-failed=<value> Retry publishing failed entries from the logfile
--source-env=<value> Source Environment
DESCRIPTION
Publish non-localized fields for the given content types, from a particular source environment to the specified
environments
The non-localized field changes command is used to publish non-localized field changes from the given content types to
the specified environments
Note: Content types, Environments and Source Environment are required to execute this command successfully.
But, if retryFailed flag is set, then only a logfile is required
ALIASES
$ csdx cm:bulk-publish:nonlocalized-field-changes
EXAMPLES
General Usage
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
$ csdx cm:entries:publish-non-localized-fields --config [PATH TO CONFIG FILE]
$ csdx cm:entries:publish-non-localized-fields -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:entries:publish-non-localized-fields --retry-failed [LOG FILE NAME]
Using --branch flag
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV] --branch [BRANCH NAME]
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:revert
Revert publish operations by using a log file
USAGE
$ csdx cm:bulk-publish:revert [--retry-failed <value>] [--log-file <value>]
FLAGS
--log-file=<value> logfile to be used to revert
--retry-failed=<value> retry publishing failed entries from the logfile
DESCRIPTION
Revert publish operations by using a log file
The revert command is used to revert all publish operations performed using bulk-publish script.
A log file name is required to execute revert command
ALIASES
$ csdx cm:bulk-publish:revert
EXAMPLES
Using --log-file
cm:bulk-publish:revert --log-file [LOG FILE NAME]
Using --retry-failed
cm:bulk-publish:revert --retry-failed [LOG FILE NAME]
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 cm:bulk-publish:unpublish 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> Delivery token for source environment
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
DESCRIPTION
Unpublish entries or assets of given content types from the specified environment
The unpublish command is used to unpublish entries or assets from given environment
Environment (Source Environment) and Locale are required to execute the command successfully
But, if retry-failed flag is set, then only a logfile is required
A content type can be specified for unpublishing entries, but if no content-type(s) is/are specified and --only-assets
is not used,
then all entries from all content types will be unpublished from the source environment
Note: --only-assets can be used to unpublish only assets and --only-entries can be used to unpublish only entries.
(--only-assets and --only-entries cannot be used together at the same time)
ALIASES
$ csdx cm:bulk-publish:unpublish
EXAMPLES
General Usage
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] ----delivery-token [DELIVERY TOKEN]
Using --config or -c flag
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
$ csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]
$ csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]
Using --retry-failed flag
$ csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]
No content type
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all content types and assets from the source environment)
Using --only-assets
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-assets (Will unpublish only assets from the source environment)
Using --only-entries
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, all entries, from the source environment)
$ csdx cm:stacks:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, (from CONTENT TYPE) from the source environment)
Using --branch flag
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
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:bulk-publish:unpublished-entries cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish
<value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y]
[--branch <value>]
FLAGS
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
selected)
-a, --alias=<value> Alias(name) for the management token
-b, --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used to publish the entries
-c, --config=<value> Path to the config file
-e, --environments=<value>... Destination environments
-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].
--content-types=<value>... The Contenttypes from which entries will be published
--locales=<value> Source locale
--retry-failed=<value> Retry publishing failed entries from the logfile
--source-env=<value> Source Env
DESCRIPTION
Publish unpublished entries from the source environment, to other environments and locales
The publish-only-unpublished command is used to publish