❤
npm
Sign UpSign In

@contentstack/cli-config

1.12.0 • Public • Published

@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

License

Usage

$ npm install -g @contentstack/cli-config
$ csdx COMMAND
running command...
$ csdx (--version)
@contentstack/cli-config/1.12.0 linux-x64 node-v22.14.0
$ csdx --help [COMMAND]
USAGE
  $ csdx COMMAND
...

Commands

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: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 <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

csdx config:remove:ea-header

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>

csdx config:remove:early-access-header

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

csdx config:remove:rate-limit

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

csdx config:set:base-branch

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

csdx config:set:ea-header

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>

csdx config:set:early-access-header

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

csdx config:set:rate-limit

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

csdx config:set:region [REGION]

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 AWS-NA

  $ csdx config:set:region AWS-EU

  $ 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 <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

Versions

Current Tags

VersionDownloads (Last 7 Days)Tag
1.12.06,724latest

Version History

VersionDownloads (Last 7 Days)Published
1.12.06,724
1.11.00
1.10.17
1.10.076
1.9.130
1.9.0162
1.8.01
1.7.30
1.7.20
1.7.10
1.7.02
1.6.5153
1.6.431
1.6.324
1.6.20
1.6.131
1.6.00
1.5.10
1.5.00
1.4.150
1.4.140
1.4.130
1.4.120
1.4.1188
1.4.100
1.4.90
1.4.80
1.4.70
1.4.60
1.4.50
1.4.40
1.4.30
1.4.20
1.4.10
1.4.00
1.3.10
1.3.00
1.2.00
1.1.00
1.0.43
1.0.30
1.0.20
1.0.10
1.0.00

Package Sidebar

Install

npm i @contentstack/cli-config

Repository

github.com/contentstack/cli

Homepage

github.com/contentstack/cli

Weekly Downloads

7,332

Version

1.12.0

License

MIT

Unpacked Size

83.5 kB

Total Files

43

Last publish

Collaborators

  • mynk
  • cloudaccounts
Try on RunKit
Report malware