@contentstack/cli-config

@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

$ npm install -g @contentstack/cli-config
$ csdx COMMAND
running command...
$ csdx (--version)
@contentstack/cli-config/1.7.0 linux-x64 node-v18.20.4
$ 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:region
• csdx config:remove:base-branch
• csdx config:remove:ea-header
• csdx config:remove:early-access-header
• csdx config:set:base-branch
• csdx config:set:ea-header
• csdx config:set:early-access-header
• csdx config:set:region [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: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               Force Remove
  --header-alias=<value>  Early access 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 <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               Force Remove
  --header-alias=<value>  Early access 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 <value>

See code: src/commands/config/remove/early-access-header.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

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>        Early access header value
  --header-alias=<value>  Early access 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 <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>        Early access header value
  --header-alias=<value>  Early access 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 <value> --header-alias <value>

See code: src/commands/config/set/early-access-header.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 AZURE-NA

  $ csdx config:set:region AZURE-EU

  $ csdx config:set:region GCP-NA

  $ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India"

  $ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India" --developer-hub <developer_hub_url>

  $ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India" --personalize <personalize_url>

  $ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India" --launch <launch_url>

  $ csdx config:set:region --cda <contentstack_cda_endpoint> --cma <contentstack_cma_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India" --developer-hub <developer_hub_url> --personalize <personalize_url> --launch <launch_url>

See code: src/commands/config/set/region.ts