Contentstack CLI plugin for configuration
npm install @contentstack/cli-configThe 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

* @contentstack/cli-config
* Usage
* Commands
``sh-session`
$ npm install -g @contentstack/cli-config
$ csdx COMMAND
running command...
$ csdx (--version)
@contentstack/cli-config/1.18.0 linux-x64 node-v22.22.0
$ 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:log
* csdx config:get:proxy
* 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:proxy
* csdx config:remove:rate-limit
* csdx config:set:base-branch
* csdx config:set:ea-header
* csdx config:set:early-access-header
* csdx config:set:log
* csdx config:set:proxy
* csdx config:set:rate-limit
* [csdx config:set:region [REGION]](#csdx-configsetregion-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 logging configuration for CLI
`
USAGE
$ csdx config:get:log
DESCRIPTION
Get logging configuration for CLI
EXAMPLES
$ csdx config:get:log
`
_See code: src/commands/config/get/log.ts_
Get proxy configuration for CLI
`
USAGE
$ csdx config:get:proxy
DESCRIPTION
Get proxy configuration for CLI
EXAMPLES
$ csdx config:get:proxy
`
_See code: src/commands/config/get/proxy.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
FLAGS
-k, --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
`
_See code: src/commands/config/remove/base-branch.ts_
Remove Early Access header
`
USAGE
$ csdx config:remove:ea-header [--header-alias
FLAGS
-y, --yes (optional) Force the removal of Early Access header configuration by skipping the
confirmation.
--header-alias=
DESCRIPTION
Remove Early Access header
ALIASES
$ csdx config:remove:ea-header
EXAMPLES
$ csdx config:remove:ea-header
$ csdx config:remove:ea-header --header-alias
`
Remove Early Access header
`
USAGE
$ csdx config:remove:early-access-header [--header-alias
FLAGS
-y, --yes (optional) Force the removal of Early Access header configuration by skipping the
confirmation.
--header-alias=
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
`
_See code: src/commands/config/remove/early-access-header.ts_
Remove proxy configuration from global config
`
USAGE
$ csdx config:remove:proxy
DESCRIPTION
Remove proxy configuration from global config
EXAMPLES
$ csdx config:remove:proxy
`
_See code: src/commands/config/remove/proxy.ts_
Remove rate-limit of the organization
`
USAGE
$ csdx config:remove:rate-limit [--org
FLAGS
--org=
DESCRIPTION
Remove rate-limit of the organization
EXAMPLES
$ csdx config:remove:rate-limit --org <
`
_See code: src/commands/config/remove/rate-limit.ts_
Set branch for CLI
`
USAGE
$ csdx config:set:base-branch [-k
FLAGS
-k, --stack-api-key=
--base-branch=
DESCRIPTION
Set branch for CLI
EXAMPLES
$ csdx config:set:base-branch
$ csdx config:set:base-branch --stack-api-key
`
_See code: src/commands/config/set/base-branch.ts_
Set Early Access header
`
USAGE
$ csdx config:set:ea-header [--header-alias
FLAGS
--header=
--header-alias=
DESCRIPTION
Set Early Access header
ALIASES
$ csdx config:set:ea-header
EXAMPLES
$ csdx config:set:ea-header
$ csdx config:set:ea-header --header
`
Set Early Access header
`
USAGE
$ csdx config:set:early-access-header [--header-alias
FLAGS
--header=
--header-alias=
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
`
_See code: src/commands/config/set/early-access-header.ts_
Set logging configuration for CLI
`
USAGE
$ csdx config:set:log [--level debug|info|warn|error] [--path
FLAGS
--level=
DESCRIPTION
Set logging configuration for CLI
EXAMPLES
$ csdx config:set:log
$ csdx config:set:log --level debug
$ csdx config:set:log --path ./logs
$ csdx config:set:log --level debug --path ./logs --show-console-logs
$ csdx config:set:log --no-show-console-logs
$ csdx config:set:log --level warn --show-console-logs
$ csdx config:set:log --path ~/custom/logs
$ csdx config:set:log --path /var/log/contentstack
`
_See code: src/commands/config/set/log.ts_
Set proxy configuration for CLI
`
USAGE
$ csdx config:set:proxy --host
FLAGS
--host=
--port=
--protocol=
DESCRIPTION
Set proxy configuration for CLI
EXAMPLES
$ csdx config:set:proxy --host 127.0.0.1 --port 3128
$ csdx config:set:proxy --host proxy.example.com --port 8080 --protocol https
$ csdx config:set:proxy --host proxy.example.com --port 8080 --username user
`
_See code: src/commands/config/set/proxy.ts_
Set rate-limit for CLI
`
USAGE
$ csdx config:set:rate-limit [--org
FLAGS
--default Reset to default rate limit
--limit-name=
--org=
--utilize=
DESCRIPTION
Set rate-limit for CLI
EXAMPLES
$ csdx config:set:rate-limit --org <
$ csdx config:set:rate-limit --org <
$ csdx config:set:rate-limit --org <
`
_See code: src/commands/config/set/rate-limit.ts_
Set region for CLI
`
USAGE
$ csdx config:set:region [REGION] [-d
[--personalize
ARGUMENTS
[REGION] Name for the region
FLAGS
-d, --cda=
name flags are required
-m, --cma=
and name flags are required
-n, --name=
--developer-hub=
--launch=
--personalize=
--studio=
--ui-host=
required
DESCRIPTION
Set region for CLI
EXAMPLES
$ csdx config:set:region
$ csdx config:set:region AWS-NA
$ csdx config:set:region AWS-EU
$ csdx config:set:region AWS-AU
$ csdx config:set:region AZURE-NA
$ csdx config:set:region AZURE-EU
$ csdx config:set:region GCP-NA
$ csdx config:set:region GCP-EU
$ csdx config:set:region --cma
$ csdx config:set:region --cma
$ csdx config:set:region --cma
$ csdx config:set:region --cma
$ csdx config:set:region --cma
$ csdx config:set:region --cda
``
_See code: src/commands/config/set/region.ts_