The config namespace contains all the commands that you will need to configure the CLI as per your requirements. Contentstack currently supports four regions: North America, Europe, Azure North America and Azure Europe. Configure the CLI documentation
$ npm install -g @contentstack/cli-config
$ csdx COMMAND
running command...
$ csdx (--version)
@contentstack/cli-config/1.9.0 linux-x64 node-v18.20.4
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
csdx config:get:base-branch
csdx config:get:ea-header
csdx config:get:early-access-header
csdx config:get:rate-limit
csdx config:get:region
csdx config:remove:base-branch
csdx config:remove:ea-header
csdx config:remove:early-access-header
csdx config:remove:rate-limit
csdx config:set:base-branch
csdx config:set:ea-header
csdx config:set:early-access-header
csdx config:set:rate-limit
csdx config:set:region [REGION]
Get current branch set for CLI
USAGE
$ csdx config:get:base-branch
DESCRIPTION
Get current branch set for CLI
EXAMPLES
$ csdx config:get:base-branch
See code: src/commands/config/get/base-branch.ts
Display Early Access headers
USAGE
$ csdx config:get:ea-header
DESCRIPTION
Display Early Access headers
ALIASES
$ csdx config:get:ea-header
EXAMPLES
$ csdx config:get:ea-header
Display Early Access headers
USAGE
$ csdx config:get:early-access-header
DESCRIPTION
Display Early Access headers
ALIASES
$ csdx config:get:ea-header
EXAMPLES
$ csdx config:get:early-access-header
See code: src/commands/config/get/early-access-header.ts
Get rate-limit of organizations
USAGE
$ csdx config:get:rate-limit
DESCRIPTION
Get rate-limit of organizations
EXAMPLES
$ csdx config:get:rate-limit
See code: src/commands/config/get/rate-limit.ts
Get current region set for CLI
USAGE
$ csdx config:get:region
DESCRIPTION
Get current region set for CLI
EXAMPLES
$ csdx config:get:region
See code: src/commands/config/get/region.ts
Remove branch config for CLI
USAGE
$ csdx config:remove:base-branch [-k <value>] [-y]
FLAGS
-k, --stack-api-key=<value> Stack API key.
-y, --yes Force remove.
DESCRIPTION
Remove branch config for CLI
EXAMPLES
$ csdx config:remove:base-branch
$ csdx config:remove:base-branch --stack-api-key <value>
See code: src/commands/config/remove/base-branch.ts
Remove Early Access header
USAGE
$ csdx config:remove:ea-header [--header-alias <value>] [-y]
FLAGS
-y, --yes (optional) Force the removal of Early Access header configuration by skipping the
confirmation.
--header-alias=<value> (optional) Provide the Early Access header alias name.
DESCRIPTION
Remove Early Access header
ALIASES
$ csdx config:remove:ea-header
EXAMPLES
$ csdx config:remove:ea-header
$ csdx config:remove:ea-header --header-alias <value>
Remove Early Access header
USAGE
$ csdx config:remove:early-access-header [--header-alias <value>] [-y]
FLAGS
-y, --yes (optional) Force the removal of Early Access header configuration by skipping the
confirmation.
--header-alias=<value> (optional) Provide the Early Access header alias name.
DESCRIPTION
Remove Early Access header
ALIASES
$ csdx config:remove:ea-header
EXAMPLES
$ csdx config:remove:early-access-header
$ csdx config:remove:early-access-header --header-alias <value>
See code: src/commands/config/remove/early-access-header.ts
Remove rate-limit of the organization
USAGE
$ csdx config:remove:rate-limit [--org <value>]
FLAGS
--org=<value> Provide the organization UID
DESCRIPTION
Remove rate-limit of the organization
EXAMPLES
$ csdx config:remove:rate-limit --org <<org_uid>>
See code: src/commands/config/remove/rate-limit.ts
Set branch for CLI
USAGE
$ csdx config:set:base-branch [-k <value>] [--base-branch <value>]
FLAGS
-k, --stack-api-key=<value> Stack API key
--base-branch=<value> Base branch (Target branch).
DESCRIPTION
Set branch for CLI
EXAMPLES
$ csdx config:set:base-branch
$ csdx config:set:base-branch --stack-api-key <value> --base-branch <value>
See code: src/commands/config/set/base-branch.ts
Set Early Access header
USAGE
$ csdx config:set:ea-header [--header-alias <value>] [--header <value>]
FLAGS
--header=<value> (optional) Provide the Early Access header alias name.
--header-alias=<value> (optional) Provide the Early Access header value.
DESCRIPTION
Set Early Access header
ALIASES
$ csdx config:set:ea-header
EXAMPLES
$ csdx config:set:ea-header
$ csdx config:set:ea-header --header <value> --header-alias <value>
Set Early Access header
USAGE
$ csdx config:set:early-access-header [--header-alias <value>] [--header <value>]
FLAGS
--header=<value> (optional) Provide the Early Access header alias name.
--header-alias=<value> (optional) Provide the Early Access header value.
DESCRIPTION
Set Early Access header
ALIASES
$ csdx config:set:ea-header
EXAMPLES
$ csdx config:set:early-access-header
$ csdx config:set:early-access-header --header <value> --header-alias <value>
See code: src/commands/config/set/early-access-header.ts
Set rate-limit for CLI
USAGE
$ csdx config:set:rate-limit [--org <value>] [--utilize <value>] [--limit-name <value>] [--default]
FLAGS
--default Reset to default rate limit
--limit-name=<value>... [Optional] Provide the limit names separated by commas ['limit', 'getLimit', 'bulkLimit']
--org=<value> Provide the organization UID
--utilize=<value> [default: 50] Provide the utilization percentages for rate limit, separated by commas
DESCRIPTION
Set rate-limit for CLI
EXAMPLES
$ csdx config:set:rate-limit --org <<org_uid>>
$ csdx config:set:rate-limit --org <<org_uid>> --utilize 70,80 --limit-name getLimit,limit
$ csdx config:set:rate-limit --org <<org_uid>> --default
See code: src/commands/config/set/rate-limit.ts
Set region for CLI
USAGE
$ csdx config:set:region [REGION] [-d <value> -m <value> --ui-host <value> -n <value>] [--developer-hub <value>]
[--personalize <value>] [--launch <value>]
ARGUMENTS
REGION Name for the region
FLAGS
-d, --cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host and name
flags are required
-m, --cma=<value> Custom host to set for content management API, , if this flag is added then cda, ui-host and
name flags are required
-n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are required
--developer-hub=<value> Custom host to set for Developer hub API
--launch=<value> Custom host to set for Launch API
--personalize=<value> Custom host to set for Personalize API
--ui-host=<value> Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
required
DESCRIPTION
Set region for CLI
EXAMPLES
$ csdx config:set:region
$ csdx config:set:region NA
$ csdx config:set:region EU
$ csdx config:set:region AZURE-NA
$ csdx config:set:region AZURE-EU
$ csdx config:set:region GCP-NA
$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India"
$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url>
$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --personalize <custom_personalize_url>
$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --launch <custom_launch_url>
$ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url>
See code: src/commands/config/set/region.ts