@contentstack/cli-config

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


* @contentstack/cli-config
* Usage
* Commands

Usage

``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
...
`


Commands


* 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)

csdx config:get:base-branch

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_

csdx config:get:ea-header

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
`

csdx config:get:early-access-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_

csdx config:get:log

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_

csdx config:get:proxy

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_

csdx config:get:rate-limit

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_

csdx config:get:region

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_

csdx config:remove:base-branch

Remove branch config for CLI

`
USAGE
$ csdx config:remove:base-branch [-k ] [-y]

FLAGS
-k, --stack-api-key= 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_

csdx config:remove:ea-header

Remove Early Access header

`
USAGE
$ csdx config:remove:ea-header [--header-alias ] [-y]

FLAGS
-y, --yes (optional) Force the removal of Early Access header configuration by skipping the
confirmation.
--header-alias= (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
`

csdx config:remove:early-access-header

Remove Early Access header

`
USAGE
$ csdx config:remove:early-access-header [--header-alias ] [-y]

FLAGS
-y, --yes (optional) Force the removal of Early Access header configuration by skipping the
confirmation.
--header-alias= (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
`

_See code: src/commands/config/remove/early-access-header.ts_

csdx config:remove:proxy

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_

csdx config:remove:rate-limit

Remove rate-limit of the organization

`
USAGE
$ csdx config:remove:rate-limit [--org ]

FLAGS
--org= Provide the organization UID

DESCRIPTION
Remove rate-limit of the organization

EXAMPLES
$ csdx config:remove:rate-limit --org <>
`

_See code: src/commands/config/remove/rate-limit.ts_

csdx config:set:base-branch

Set branch for CLI

`
USAGE
$ csdx config:set:base-branch [-k ] [--base-branch ]

FLAGS
-k, --stack-api-key= Stack API key
--base-branch= Base branch (Target branch).

DESCRIPTION
Set branch for CLI

EXAMPLES
$ csdx config:set:base-branch

$ csdx config:set:base-branch --stack-api-key --base-branch
`

_See code: src/commands/config/set/base-branch.ts_

csdx config:set:ea-header

Set Early Access header

`
USAGE
$ csdx config:set:ea-header [--header-alias ] [--header ]

FLAGS
--header= (optional) Provide the Early Access header alias name.
--header-alias= (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 --header-alias
`

csdx config:set:early-access-header

Set Early Access header

`
USAGE
$ csdx config:set:early-access-header [--header-alias ] [--header ]

FLAGS
--header= (optional) Provide the Early Access header alias name.
--header-alias= (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 --header-alias
`

_See code: src/commands/config/set/early-access-header.ts_

csdx config:set:log

Set logging configuration for CLI

`
USAGE
$ csdx config:set:log [--level debug|info|warn|error] [--path ] [--show-console-logs]

FLAGS
--level= Set the log level for the CLI. Defaults to "info" if not specified.

--path= Specify the directory path where logs should be saved. Supports both relative and absolute
paths. Defaults to ~/.contentstack/logs if not specified.
--[no-]show-console-logs Enable console logging.

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_

csdx config:set:proxy

Set proxy configuration for CLI

`
USAGE
$ csdx config:set:proxy --host --port --protocol http|https [--username ]

FLAGS
--host= (required) Proxy host address
--port= (required) Proxy port number
--protocol= (required) [default: http] Proxy protocol (http or https)

--username= Proxy username (optional)

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_

csdx config:set:rate-limit

Set rate-limit for CLI

`
USAGE
$ csdx config:set:rate-limit [--org ] [--utilize ] [--limit-name ...] [--default]

FLAGS
--default Reset to default rate limit
--limit-name=... [Optional] Provide the limit names separated by commas ['limit', 'getLimit', 'bulkLimit']
--org= Provide the organization UID
--utilize= [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 <>

$ csdx config:set:rate-limit --org <> --utilize 70,80 --limit-name getLimit,limit

$ csdx config:set:rate-limit --org <> --default
`

_See code: src/commands/config/set/rate-limit.ts_

csdx config:set:region [REGION]

Set region for CLI

`
USAGE
$ csdx config:set:region [REGION] [-d -m --ui-host -n ] [--developer-hub ]
[--personalize ] [--launch ] [--studio ]

ARGUMENTS
[REGION] Name for the region

FLAGS
-d, --cda= Custom host to set for content delivery API, if this flag is added then cma, ui-host and
name flags are required
-m, --cma= Custom host to set for content management API, , if this flag is added then cda, ui-host
and name flags are required
-n, --name= Name for the region, if this flag is added then cda, cma and ui-host flags are required
--developer-hub= Custom host to set for Developer hub API
--launch= Custom host to set for Launch API
--personalize= Custom host to set for Personalize API
--studio= Custom host to set for Studio API
--ui-host= 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 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 --cda --ui-host --name "India"

$ csdx config:set:region --cma --cda --ui-host --name "India" --developer-hub

$ csdx config:set:region --cma --cda --ui-host --name "India" --personalize

$ csdx config:set:region --cma --cda --ui-host --name "India" --launch

$ csdx config:set:region --cma --cda --ui-host --name "India" --studio

$ csdx config:set:region --cda --cma --ui-host --name "India" --developer-hub --launch --personalize --studio
``

_See code: src/commands/config/set/region.ts_