@contentstack/cli
Advanced tools
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 documentation.
$ npm install -g @contentstack/cli
$ csdx COMMAND
running command...
$ csdx (-v|--version|version)
@contentstack/cli/0.1.1-beta.17 linux-x64 node-v12.22.1
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
csdx auth:logincsdx auth:logoutcsdx auth:tokenscsdx auth:tokens:addcsdx auth:tokens:removecsdx auth:whoamicsdx cm:bootstrapcsdx cm:bulk-publishcsdx cm:bulk-publish:add-fieldscsdx cm:bulk-publish:assetscsdx cm:bulk-publish:clearcsdx cm:bulk-publish:configurecsdx cm:bulk-publish:cross-publishcsdx cm:bulk-publish:entriescsdx cm:bulk-publish:entry-editscsdx cm:bulk-publish:nonlocalized-field-changescsdx cm:bulk-publish:revertcsdx cm:bulk-publish:unpublishcsdx cm:bulk-publish:unpublished-entriescsdx cm:exportcsdx cm:export-to-csvcsdx cm:importcsdx cm:migrate-rtecsdx cm:seedcsdx cm:stack-clonecsdx config:get:regioncsdx config:set:region [REGION]csdx help [COMMAND]csdx pluginscsdx plugins:createcsdx plugins:inspect PLUGIN...csdx plugins:install PLUGIN...csdx plugins:link PLUGINcsdx plugins:uninstall PLUGIN...csdx plugins:updatecsdx auth:loginLogin to Contentstack and save the session for further use
Login to Contentstack and save the session for further use
USAGE
$ csdx auth:login
OPTIONS
-u, --username=username Email address of your Contentstack account
ALIASES
$ csdx login
See code: @contentstack/cli-auth
csdx auth:logoutLog out from Contentstack and clear the session
Log out from Contentstack and clear the session
USAGE
$ csdx auth:logout
OPTIONS
-f, --force Exclude confirmation to logout
ALIASES
$ csdx logout
See code: @contentstack/cli-auth
csdx auth:tokensLists all existing tokens added to the session
Lists all existing tokens added to the session
USAGE
$ csdx auth:tokens
OPTIONS
-x, --extended show extra columns
--columns=columns only show provided columns (comma-separated)
--csv output is csv format [alias: --output=csv]
--filter=filter 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=csv|json|yaml output in a more machine friendly format
--sort=sort property to sort by (prepend '-' for descending)
ALIASES
$ csdx tokens
See code: @contentstack/cli-auth
csdx auth:tokens:addAdds management/delivery tokens to your session to use it with further CLI command
Adds management/delivery tokens to your session to use it with further CLI command
by default it adds management token if either of management or delivery flags are not set
USAGE
$ csdx auth:tokens:add
OPTIONS
-a, --alias=alias
-d, --delivery Set this while saving delivery token
-e, --environment=environment Environment name for delivery token
-f, --force Exclude confirmation to replace existing alias
-k, --api-key=api-key Stack API key for the token
-m, --management Set this while saving management token
-t, --token=token Sets token. Can be set via environment variable 'TOKEN'. We recommend to use env
variable
DESCRIPTION
by default it adds management token if either of management or delivery flags are not set
ALIASES
$ csdx tokens:add
See code: @contentstack/cli-auth
csdx auth:tokens:removeRemoves stored tokens
Removes stored tokens
USAGE
$ csdx auth:tokens:remove
OPTIONS
-a, --alias=alias Alias (name) of the token to remove
-i, --ignore Ignores if token not present. Command shows show list of available aliases with multi select option
to delete tokens from that list.
ALIASES
$ csdx tokens:remove
See code: @contentstack/cli-auth
csdx auth:whoamiDisplay current users email address
Display current users email address
USAGE
$ csdx auth:whoami
ALIASES
$ csdx whoami
See code: @contentstack/cli-auth
csdx cm:bootstrapBootstrap contentstack apps
Bootstrap contentstack apps
USAGE
$ csdx cm:bootstrap
OPTIONS
-a, --appName=appName App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter,
nuxt-starter
-d, --directory=directory 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
-t, --accessToken=accessToken Access token for private github repo
EXAMPLES
$ csdx cm:bootstrap
$ csdx cm:bootstrap -d <path/to/setup/the/app>
$ csdx cm:bootstrap -t <github access token>
See code: @contentstack/cli-cm-bootstrap
csdx cm:bulk-publishBulk Publish script for managing entries and assets
Bulk Publish script for managing entries and assets
USAGE
$ csdx cm:bulk-publish
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bulk-publish:add-fieldsAdd fields from updated content types to their respective entries
Add fields from updated content types to their respective entries
The add-fields command is used for updating already existing entries with the updated schema of their respective Content Type
Content Types, Environments and Locales are required for executing the command successfully
But, if retryFailed flag is set, then only a logfile is required
USAGE
$ csdx cm:bulk-publish:add-fields
OPTIONS
-a, --alias=alias Alias for the management token to be used
-b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used for publishing the entries
-c, --config=config Path to config file to be used
-e, --environments=environments Environments to which entries need to be published
-l, --locales=locales Locales to which entries need to be published
-r, --retryFailed=retryFailed Retry publishing failed entries from the logfile (optional, overrides all other
flags)
-t, --contentTypes=contentTypes The Content-Types from which entries need to be published
-y, --yes Agree to process the command with the current configuration
DESCRIPTION
The add-fields command is used for updating already existing entries with the updated schema of their respective
Content Type
Content Types, Environments and Locales are required for executing the command successfully
But, if retryFailed flag is set, then only a logfile is required
EXAMPLES
General Usage
csdx cm:bulk-publish:add-fields -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [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:bulk-publish:configure -a [ALIAS]`
csdx cm:bulk-publish:add-fields --config [PATH TO CONFIG FILE]
csdx cm:bulk-publish:add-fields -c [PATH TO CONFIG FILE]
Using --retryFailed or -r flag
csdx cm:bulk-publish:add-fields --retryFailed [LOG FILE NAME]
csdx cm:bulk-publish:add-fields -r [LOG FILE NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bulk-publish:assetsPublish assets to specified environments
Publish assets to specified environments
The assets command is used for publishing assets from the specified stack, to the specified environments
Environment(s) and Locale(s) are required for executing the command successfully
But, if retryFailed flag is set, then only a logfile is required
USAGE
$ csdx cm:bulk-publish:assets
OPTIONS
-a, --alias=alias Alias for the management token to be used
-b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used for publishing the entries
-c, --config=config Path to config file to be used
-e, --environments=environments Environments to which assets need to be published
-l, --locales=locales Locales to which assets need to be published
-r, --retryFailed=retryFailed Retry publishing failed assets from the logfile (optional, will override all other
flags)
-u, --folderUid=folderUid [default: cs_root] Folder-uid from which the assets need to be published
-y, --yes Agree to process the command with the current configuration
DESCRIPTION
The assets command is used for publishing assets from the specified stack, to the specified environments
Environment(s) and Locale(s) are required for executing the command successfully
But, if retryFailed flag is set, then only a logfile is required
EXAMPLES
General Usage
csdx cm:bulk-publish:assets -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE] -a [MANAGEMENT TOKEN ALIAS]
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:assets --config [PATH TO CONFIG FILE]
csdx cm:bulk-publish:assets -c [PATH TO CONFIG FILE]
Using --retryFailed or -r flag
csdx cm:bulk-publish:assets --retryFailed [LOG FILE NAME]
csdx cm:bulk-publish:assets -r [LOG FILE NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bulk-publish:clearClear the log folder
Clear the log folder
USAGE
$ csdx cm:bulk-publish:clear
OPTIONS
-l, --list List number of log files
-y, --yes Delete all files without asking for confirmation
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bulk-publish:configureGenerate configuration template
Generate configuration template
The configure command is used for generating a configuration file for bulk-publish script.
Here is a detailed description for all the available flags
-----------------------------------------------------------------------------------------------------------
--alias or -a : Management token Alias for the stack in use.
EXAMPLE : cm:bulk-publish:configure --alias [MANAGEMENT TOKEN Alias]
EXAMPLE : cm:bulk-publish:configure -a [MANAGEMENT TOKEN Alias]
USAGE
$ csdx cm:bulk-publish:configure
OPTIONS
-a, --alias=alias Management token alias for the stack
DESCRIPTION
The configure command is used for generating a configuration file for bulk-publish script.
Here is a detailed description for all the available flags
-----------------------------------------------------------------------------------------------------------
--alias or -a : Management token Alias for the stack in use.
EXAMPLE : cm:bulk-publish:configure --alias [MANAGEMENT TOKEN Alias]
EXAMPLE : cm:bulk-publish:configure -a [MANAGEMENT TOKEN Alias]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bulk-publish:cross-publishPublish entries and assets from one environment to other environments
Publish entries and assets from one environment to other environments
The cross-publish command is used for publishing entries and assets from one evironment to other environments
Content Type, Environment, Destination Environment(s) and Locale are required for executing the command successfully
But, if retryFailed flag is set, then only a logfile is required
USAGE
$ csdx cm:bulk-publish:cross-publish
OPTIONS
-a, --alias=alias Alias for the management token to be used
-b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that
contentstack's bulkpublish API will be used for publishing the entries
-c, --config=config Path to config file to be used
-d, --destEnv=destEnv Destination Environments
-e, --environment=environment Source Environment
-l, --locale=locale Locale filter
-r, --retryFailed=retryFailed Retry publishing failed entries from the logfile (optional, overrides all other
flags)
-t, --contentType=contentType Content-Type filter
-x, --deliveryToken=deliveryToken Delivery Token for source environment
-y, --yes Agree to process the command with the current configuration
--onlyAssets Unpublish only assets
--onlyEntries Unpublish only entries
DESCRIPTION
The cross-publish command is used for publishing entries and assets from one evironment to other environments
Content Type, Environment, Destination Environment(s) and Locale are required for executing the command successfully
But, if retryFailed flag is set, then only a logfile is required
EXAMPLES
General Usage
csdx cm:bulk-publish:cross-publish -t [CONTENT TYPE] -e [SOURCE ENV] -d [DESTINATION ENVIRONMENT] -l [LOCALE] -a
[MANAGEMENT TOKEN ALIAS] -x [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 --retryFailed or -r flag
csdx cm:bulk-publish:cross-publish --retryFailed [LOG FILE NAME]
csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bulk-publish:entriesPublish entries from multiple content-types to multiple environments and locales
Publish entries from multiple content-types to multiple environments and locales
The entries command is used for publishing entries from the specified content types, to the
specified environments and locales
Content Types, Environments and Locales are required for executing the command successfully
But, if retryFailed flag is set, then only a logfile is required
USAGE
$ csdx cm:bulk-publish:entries
OPTIONS
-a, --alias=alias Alias for the management token to be used
-b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used for publishing the entries
-c, --config=config Path for the external config file to be used (A new config file can be generated at
the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
-e, --environments=environments Environments to which entries need to be published
-l, --locales=locales Locales to which entries need to be published
-o, --publishAllContentTypes Publish all content-types (optional, cannot be set when contentTypes flag is set)
-r, --retryFailed=retryFailed Retry failed entries from the logfile (optional, 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
-t, --contentTypes=contentTypes The Content-types from which entries need to be published
-y, --yes Agree to process the command with the current configuration
DESCRIPTION
The entries command is used for publishing entries from the specified content types, to the
specified environments and locales
Content Types, Environments and Locales are required for executing the command successfully
But, if retryFailed flag is set, then only a logfile is required
EXAMPLES
General Usage
csdx cm:bulk-publish:entries -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [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:bulk-publish:configure -a [ALIAS]`
csdx cm:bulk-publish:entries --config [PATH TO CONFIG FILE]
csdx cm:bulk-publish:entries -c [PATH TO CONFIG FILE]
Using --retryFailed or -r flag
csdx cm:bulk-publish:entries --retryFailed [LOG FILE NAME]
csdx cm:bulk-publish:entries -r [LOG FILE NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bulk-publish:entry-editsPublish edited entries from a specified Content Type to given locales and environments
Publish edited entries from a specified Content Type to given locales and environments
The entry-edits command is used for publishing entries from the specified content types, to the
specified environments and locales
Content Type(s), Source Environment, Destination Environment(s) and Locale(s) are required for executing the command successfully
But, if retryFailed flag is set, then only a logfile is required
USAGE
$ csdx cm:bulk-publish:entry-edits
OPTIONS
-a, --alias=alias Alias for the management token to be used
-b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used for publishing the entries
-c, --config=config Path to config file to be used
-e, --environments=environments Destination environments
-l, --locales=locales Locales to which edited entries need to be published
-r, --retryFailed=retryFailed Retry publishing failed entries from the logfile (optional, overrides all other
flags)
-s, --sourceEnv=sourceEnv Environment from which edited entries will be published
-t, --contentTypes=contentTypes The Content-Types which will be checked for edited entries
-y, --yes Agree to process the command with the current configuration
DESCRIPTION
The entry-edits command is used for publishing entries from the specified content types, to the
specified environments and locales
Content Type(s), Source Environment, Destination Environment(s) and Locale(s) are required for executing the command
successfully
But, if retryFailed flag is set, then only a logfile is required
EXAMPLES
General Usage
csdx cm:bulk-publish:entry-edits -t [CONTENT TYPE 1] [CONTENT TYPE 2] -s [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT
2] -l [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:bulk-publish:configure -a [ALIAS]`
csdx cm:bulk-publish:entry-edits --config [PATH TO CONFIG FILE]
csdx cm:bulk-publish:entry-edits -c [PATH TO CONFIG FILE]
Using --retryFailed or -r flag
csdx cm:bulk-publish:entry-edits --retryFailed [LOG FILE NAME]
csdx cm:bulk-publish:entry-edits -r [LOG FILE NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bulk-publish:nonlocalized-field-changesPublish non-localized-fields for given Content Types, from a particular source environment to specified environments
Publish non-localized-fields for given Content Types, from a particular source environment to specified environments
The nonlocalized-field-changes command is used for publishing nonlocalized field changes from the given Content Types to
the specified Environments
Content Types, Environments and Source Environment are required for executing this command successfully.
But, if retryFailed flag is set, then only a logfile is required
USAGE
$ csdx cm:bulk-publish:nonlocalized-field-changes
OPTIONS
-a, --alias=alias Alias for the management token to be used
-b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used for publishing the entries
-c, --config=config Path to config file to be used
-e, --environments=environments Destination environments
-r, --retryFailed=retryFailed Retry publishing failed entries from the logfile
-s, --sourceEnv=sourceEnv Source Environment
-t, --contentTypes=contentTypes The Content-Types from which entries need to be published
-y, --yes Agree to process the command with the current configuration
DESCRIPTION
The nonlocalized-field-changes command is used for publishing nonlocalized field changes from the given Content Types
to
the specified Environments
Content Types, Environments and Source Environment are required for executing this command successfully.
But, if retryFailed flag is set, then only a logfile is required
EXAMPLES
General Usage
csdx cm:bulk-publish:nonlocalized-field-changes -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT
2] -l [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:bulk-publish:configure -a [ALIAS]`
csdx cm:bulk-publish:nonlocalized-field-changes --config [PATH TO CONFIG FILE]
csdx cm:bulk-publish:nonlocalized-field-changes -c [PATH TO CONFIG FILE]
Using --retryFailed or -r flag
csdx cm:bulk-publish:nonlocalized-field-changes --retryFailed [LOG FILE NAME]
csdx cm:bulk-publish:nonlocalized-field-changes -r [LOG FILE NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bulk-publish:revertRevert publish operations by using a log file
Revert publish operations by using a log file
The revert command is used for reverting all publish operations performed using bulk-publish script.
A log file name is required to execute revert command
USAGE
$ csdx cm:bulk-publish:revert
OPTIONS
-l, --logFile=logFile logfile to be used to revert
-r, --retryFailed=retryFailed retry publishing failed entries from the logfile
DESCRIPTION
The revert command is used for reverting all publish operations performed using bulk-publish script.
A log file name is required to execute revert command
EXAMPLES
Using --logFile
cm:bulk-publish:revert --logFile [LOG FILE NAME]
cm:bulk-publish:revert -l [LOG FILE NAME]
Using --retryFailed
cm:bulk-publish:revert --retryFailed [LOG FILE NAME]
cm:bulk-publish:revert -r [LOG FILE NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bulk-publish:unpublishUnpublish entries of given Content Types from given environment
Unpublish entries of given Content Types from given environment
The unpublish command is used for unpublishing entries from given environment
Environment (Source Environment) and Locale are required for executing the command successfully
But, if retryFailed flag is set, then only a logfile is required
A Content Type can be specified for publishing entries, but if no content-type(s) is/are specified and --onlyAssets is not used,
then all entries from all content types will be unpublished from the source environment
--onlyAssets can be used to unpublish only assets and --onlyEntries can be used to unpublish only entries.
(--onlyAssets and --onlyEntries cannot be used together at the same time)
USAGE
$ csdx cm:bulk-publish:unpublish
OPTIONS
-a, --alias=alias Alias for the management token to be used
-b, --bulkUnpublish=bulkUnpublish [default: true] This flag is set to true by default. It indicates that
contentstack's bulkpublish API will be used for publishing the entries
-c, --config=config Path to config file to be used
-e, --environment=environment Source Environment
-l, --locale=locale Locale filter
-r, --retryFailed=retryFailed Retry publishing failed entries from the logfile
-t, --contentType=contentType Content Type filter
-x, --deliveryToken=deliveryToken Delivery Token for source environment
-y, --yes Agree to process the command with the current configuration
--onlyAssets Unpublish only assets
--onlyEntries Unpublish only entries
DESCRIPTION
The unpublish command is used for unpublishing entries from given environment
Environment (Source Environment) and Locale are required for executing the command successfully
But, if retryFailed flag is set, then only a logfile is required
A Content Type can be specified for publishing entries, but if no content-type(s) is/are specified and --onlyAssets is
not used,
then all entries from all content types will be unpublished from the source environment
--onlyAssets can be used to unpublish only assets and --onlyEntries can be used to unpublish only entries.
(--onlyAssets and --onlyEntries cannot be used together at the same time)
EXAMPLES
General Usage
csdx cm:bulk-publish:unpublish -b -t [CONTENT TYPE] -e [SOURCE ENV] -l [LOCALE] -a [MANAGEMENT TOKEN ALIAS] -x
[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:unpublish --config [PATH TO CONFIG FILE]
csdx cm:bulk-publish:unpublish -c [PATH TO CONFIG FILE]
Using --retryFailed or -r flag
csdx cm:bulk-publish:unpublish --retryFailed [LOG FILE NAME]
csdx cm:bulk-publish:unpublish -r [LOG FILE NAME]
No content type
csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all
content types and assets from the source environment)
Using --onlyAssets
csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] --onlyAssets (Will unpublish only assets
from the source environment)
Using --onlyEntries
csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries (Will unpublish only
entries, all entries, from the source environment)
csdx cm:bulk-publish:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries
(Will unpublish only entries, (from CONTENT TYPE) from the source environment)
See code: @contentstack/cli-cm-bulk-publish
csdx cm:bulk-publish:unpublished-entriesPublish unpublished entries from the source environment, to other environments and locales
Publish unpublished entries from the source environment, to other environments and locales
The unpublished-entries command is used for publishing unpublished entries from the source environment, to other environments and locales
Content Type(s), Source Environment, Destination Environment(s) and Source Locale are required for executing the command successfully
But, if retryFailed flag is set, then only a logfile is required
USAGE
$ csdx cm:bulk-publish:unpublished-entries
OPTIONS
-a, --alias=alias Alias for the management token to be used
-b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
bulkpublish API will be used for publishing the entries
-c, --config=config Path to config file to be used
-e, --environments=environments Destination environments
-l, --locale=locale Source locale
-r, --retryFailed=retryFailed Retry publishing failed entries from the logfile
-s, --sourceEnv=sourceEnv Source Env
-t, --contentTypes=contentTypes The Content-Types from which entries need to be published
-y, --yes Agree to process the command with the current configuration
DESCRIPTION
The unpublished-entries command is used for publishing unpublished entries from the source environment, to other
environments and locales
Content Type(s), Source Environment, Destination Environment(s) and Source Locale are required for executing the
command successfully
But, if retryFailed flag is set, then only a logfile is required
EXAMPLES
General Usage
csdx cm:bulk-publish:unpublished-entries -b -t [CONTENT TYPES] -e [ENVIRONMENTS] -l LOCALE -a [MANAGEMENT TOKEN ALIAS]
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:unpublished-entries --config [PATH TO CONFIG FILE]
csdx cm:bulk-publish:unpublished-entries -c [PATH TO CONFIG FILE]
Using --retryFailed or -r flag
csdx cm:bulk-publish:unpublished-entries --retryFailed [LOG FILE NAME]
csdx cm:bulk-publish:unpublished-entries -r [LOG FILE NAME]
See code: @contentstack/cli-cm-bulk-publish
csdx cm:exportExport content from a stack
Export content from a stack
...
Export content from one stack to another
USAGE
$ csdx cm:export
OPTIONS
-A, --auth-token to use auth token
-a, --management-token-alias=management-token-alias alias of the management token
-c, --config=config [optional] path of the config
-d, --data=data path or location to store the data
-m, --module=module [optional] specific module name
-s, --stack-uid=stack-uid API key of the source stack
--secured-assets [optional] use when assets are secured
DESCRIPTION
...
Export content from one stack to another
EXAMPLES
csdx cm:export -A
csdx cm:export -A -s <stack_ApiKey> -d <path/of/export/destination/dir>
csdx cm:export -A -c <path/to/config/dir>
csdx cm:export -A -m <single module name>
csdx cm:export -A --secured-assets
csdx cm:export -a <management_token_alias>
csdx cm:export -a <management_token_alias> -d <path/to/export/destination/dir>
csdx cm:export -a <management_token_alias> -c <path/to/config/file>
See code: @contentstack/cli-cm-export
csdx cm:export-to-csvExport entries or organization users to csv using this command
Export entries or organization users to csv using this command
USAGE
$ csdx cm:export-to-csv
See code: @contentstack/cli-cm-export-to-csv
csdx cm:importImport script for importing the content into new stack
Import script for importing the content into new stack
...
Once you export content from the source stack, import it to your destination stack by using the cm:import command.
USAGE
$ csdx cm:import
OPTIONS
-A, --auth-token to use auth token
-a, --management-token-alias=management-token-alias alias of the management token
-b, --backup-dir=backup-dir [optional] backup directory name when using specific module
-c, --config=config [optional] path of config file
-d, --data=data path and location where data is stored
-m, --module=module [optional] specific module name
-s, --stack-uid=stack-uid API key of the target stack
DESCRIPTION
...
Once you export content from the source stack, import it to your destination stack by using the cm:import command.
EXAMPLES
csdx cm:import -A
csdx cm:import -A -s <stack_ApiKey> -d <path/of/export/destination/dir>
csdx cm:import -A -c <path/of/config/dir>
csdx cm:import -A -m <single module name>
csdx cm:import -A -m <single module name> -b <backup dir>
csdx cm:import -a <management_token_alias>
csdx cm:import -a <management_token_alias> -d <path/of/export/destination/dir>
csdx cm:import -a <management_token_alias> -c <path/of/config/file>
See code: @contentstack/cli-cm-import
csdx cm:migrate-rteMigration script for migrating HTML RTE to JSON RTE
Migration script for migrating HTML RTE to JSON RTE
USAGE
$ csdx cm:migrate-rte
OPTIONS
-a, --alias=alias Alias for the management token to be used
-c, --content_type=content_type The content-type from which entries need to be migrated
-d, --delay=delay [default: 1000] Provide delay in ms between two entry update
-g, --isGlobalField This flag is set to false by default. It indicates that current content-type is
global-field
-h, --htmlPath=htmlPath Provide path of Html RTE to migrate
-j, --jsonPath=jsonPath Provide path of JSON RTE to migrate
-p, --configPath=configPath Path to config file to be used
-y, --yes Agree to process the command with the current configuration
EXAMPLES
General Usage
csdx cm:migrate-rte -p path/to/config.json
Using Flags
csdx cm:migrate-rte -a alias -c content_type_uid -h htmlPath -j jsonPath
Nested RTE
csdx cm:migrate-rte -a alias -c content_type_uid -h modular_block_uid.block_uid.html_rte_uid -j
modular_block_uid.block_uid.json_rte_uid
csdx cm:migrate-rte -a alias -c content_type_uid -h group_uid.html_rte_uid -j group_uid.json_rte_uid
Global Field
csdx cm:migrate-rte -a alias -c global_field_uid -g -h htmlPath -j jsonPath
See code: @contentstack/cli-cm-migrate-rte
csdx cm:seedCreate a Stack from existing content types, entries, assets, etc
Create a Stack from existing content types, entries, assets, etc
USAGE
$ csdx cm:seed
OPTIONS
-n, --stack-name=stack-name Name of a new stack that needs to be created.
-o, --org=org Provide Organization UID to create a new stack
-r, --repo=repo GitHub account or GitHub account/repository
-s, --stack=stack Provide stack UID to seed content to
EXAMPLES
$ csdx cm:seed
$ csdx cm:seed -r "account"
$ csdx cm:seed -r "account/repository"
$ csdx cm:seed -r "account/repository" -s "stack-uid" //seed content into specific stack
$ csdx cm:seed -r "account/repository" -o "your-org-uid" -n "stack-name" //create a new stack in given org uid
See code: @contentstack/cli-cm-seed
csdx cm:stack-cloneClone data (structure or content or both) of a stack into another stack
Clone data (structure or content or both) of a stack into another stack
Use this plugin to automate the process of cloning a stack in a few steps.
USAGE
$ csdx cm:stack-clone
DESCRIPTION
Use this plugin to automate the process of cloning a stack in a few steps.
EXAMPLE
csdx cm:stack-clone
See code: @contentstack/cli-cm-clone
csdx config:get:regionGet current region set for CLI
Get current region set for CLI
USAGE
$ csdx config:get:region
See code: src/commands/config/get/region.js
csdx config:set:region [REGION]Set region for CLI
Set region for CLI
USAGE
$ csdx config:set:region [REGION]
ARGUMENTS
REGION (EU|NA) North America(NA), Europe (EU)
OPTIONS
-d, --cda=cda Custom host to set for content delivery API, if this flag is added then cma and name flags are
required
-m, --cma=cma Custom host to set for content management API, , if this flag is added then cda and name flags are
required
-n, --name=name Name for the region, if this flag is added then cda and cma flags are required
EXAMPLES
$ csdx config:set:region EU
$ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --name "India"
$ csdx config:set:region --cma="https://in-api.contentstack.com" --cda="https://in-cda.contentstack.com"
--name="India"
See code: src/commands/config/set/region.js
csdx help [COMMAND]display help for csdx
display help for <%= config.bin %>
USAGE
$ csdx help [COMMAND]
ARGUMENTS
COMMAND command to show help for
OPTIONS
--all see all commands in CLI
See code: @oclif/plugin-help
csdx pluginslist installed plugins
list installed plugins
USAGE
$ csdx plugins
OPTIONS
--core show core plugins
EXAMPLE
$ csdx plugins
See code: @oclif/plugin-plugins
csdx plugins:creategenerate plugin starter code
generate plugin starter code
USAGE
$ csdx plugins:create
See code: @contentstack/cli-plugins-plugin
csdx plugins:inspect PLUGIN...displays installation properties of a plugin
displays installation properties of a plugin
USAGE
$ csdx plugins:inspect PLUGIN...
ARGUMENTS
PLUGIN [default: .] plugin to inspect
OPTIONS
-h, --help show CLI help
-v, --verbose
EXAMPLE
$ csdx plugins:inspect myplugin
See code: @oclif/plugin-plugins
csdx plugins:install PLUGIN...installs a plugin into the CLI
installs a plugin into the CLI
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI.
USAGE
$ csdx plugins:install PLUGIN...
ARGUMENTS
PLUGIN plugin to install
OPTIONS
-f, --force yarn install with force flag
-h, --help show CLI help
-v, --verbose
DESCRIPTION
Can be installed from npm or a git url.
Installation of a user-installed plugin will override a core plugin.
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
the CLI without the need to patch and update the whole CLI.
ALIASES
$ csdx plugins:add
EXAMPLES
$ csdx plugins:install myplugin
$ csdx plugins:install https://github.com/someuser/someplugin
$ csdx plugins:install someuser/someplugin
See code: @oclif/plugin-plugins
csdx plugins:link PLUGINlinks a plugin into the CLI for development
links a plugin into the CLI for development
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. This is useful for development work.
USAGE
$ csdx plugins:link PLUGIN
ARGUMENTS
PATH [default: .] path to plugin
OPTIONS
-h, --help show CLI help
-v, --verbose
DESCRIPTION
Installation of a linked plugin will override a user-installed or core plugin.
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
command will override the user-installed or core plugin implementation. This is useful for development work.
EXAMPLE
$ csdx plugins:link myplugin
See code: @oclif/plugin-plugins
csdx plugins:uninstall PLUGIN...removes a plugin from the CLI
removes a plugin from the CLI
USAGE
$ csdx plugins:uninstall PLUGIN...
ARGUMENTS
PLUGIN plugin to uninstall
OPTIONS
-h, --help show CLI help
-v, --verbose
ALIASES
$ csdx plugins:unlink
$ csdx plugins:remove
See code: @oclif/plugin-plugins
csdx plugins:updateupdate installed plugins
update installed plugins
USAGE
$ csdx plugins:update
OPTIONS
-h, --help show CLI help
-v, --verbose
See code: @oclif/plugin-plugins
FAQs
Command-line tool (CLI) to interact with Contentstack
The npm package @contentstack/cli receives a total of 5,182 weekly downloads. As such, @contentstack/cli popularity was classified as popular.
We found that @contentstack/cli demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Bybit's $1.46B hack by North Korea's Lazarus Group pushes 2025 crypto losses to $1.6B in just two months, already surpassing all of 2024's $1.49B total.
Security News
OpenSSF has published OSPS Baseline, an initiative designed to establish a minimum set of security-related best practices for open source software projects.
Security News
Michigan TypeScript founder Dimitri Mitropoulos implements WebAssembly runtime in TypeScript types, enabling Doom to run after processing 177 terabytes of type definitions.