@contentstack/cli-config 2.0.0-beta.12 → 2.0.0-beta.14

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (5) hide show
  1. package/README.md +20 -20
  2. package/lib/commands/config/set/early-access-header.js +2 -2
  3. package/lib/commands/config/set/region.js +1 -2
  4. package/oclif.manifest.json +4 -5
  5. package/package.json +9 -5
package/README.md CHANGED
@@ -1,6 +1,6 @@
1
1
  # @contentstack/cli-config
2
2
 
3
- 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](https://www.contentstack.com/docs/developers/cli/configure-the-cli)
3
+ The config namespace contains all the commands that you will need to configure the CLI as per your requirements. Contentstack supports multiple regions. [Configure the CLI documentation](https://www.contentstack.com/docs/headless-cms/configure-the-cli)
4
4
 
5
5
  [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE)
6
6
 
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
18
18
  $ csdx COMMAND
19
19
  running command...
20
20
  $ csdx (--version)
21
- @contentstack/cli-config/2.0.0-beta.12 linux-x64 node-v22.23.0
21
+ @contentstack/cli-config/2.0.0-beta.14 linux-x64 node-v22.23.1
22
22
  $ csdx --help [COMMAND]
23
23
  USAGE
24
24
  $ csdx COMMAND
@@ -316,8 +316,8 @@ USAGE
316
316
  $ csdx config:set:ea-header [--header-alias <value>] [--header <value>]
317
317
 
318
318
  FLAGS
319
- --header=<value> (optional) Provide the Early Access header alias name.
320
- --header-alias=<value> (optional) Provide the Early Access header value.
319
+ --header=<value> (optional) Provide the Early Access header value.
320
+ --header-alias=<value> (optional) Provide a name (alias) for this Early Access header.
321
321
 
322
322
  DESCRIPTION
323
323
  Set Early Access header
@@ -340,8 +340,8 @@ USAGE
340
340
  $ csdx config:set:early-access-header [--header-alias <value>] [--header <value>]
341
341
 
342
342
  FLAGS
343
- --header=<value> (optional) Provide the Early Access header alias name.
344
- --header-alias=<value> (optional) Provide the Early Access header value.
343
+ --header=<value> (optional) Provide the Early Access header value.
344
+ --header-alias=<value> (optional) Provide a name (alias) for this Early Access header.
345
345
 
346
346
  DESCRIPTION
347
347
  Set Early Access header
@@ -456,25 +456,25 @@ Set region for CLI
456
456
 
457
457
  ```
458
458
  USAGE
459
- $ csdx config:set:region [REGION] [--cda <value> --cma <value> --ui-host <value> -n <value>] [--developer-hub
459
+ $ csdx config:set:region [REGION] [--cda <value> --cma <value> --ui-host <value> --name <value>] [--developer-hub
460
460
  <value>] [--personalize <value>] [--launch <value>] [--studio <value>] [--cs-assets <value>]
461
461
 
462
462
  ARGUMENTS
463
463
  [REGION] Name for the region
464
464
 
465
465
  FLAGS
466
- -n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are required
467
- --cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host and
468
- name flags are required
469
- --cma=<value> Custom host to set for content management API, , if this flag is added then cda, ui-host
470
- and name flags are required
471
- --cs-assets=<value> Custom host to set for Contentstack Assets API
472
- --developer-hub=<value> Custom host to set for Developer hub API
473
- --launch=<value> Custom host to set for Launch API
474
- --personalize=<value> Custom host to set for Personalize API
475
- --studio=<value> Custom host to set for Studio API
476
- --ui-host=<value> Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
477
- required
466
+ --cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host and name
467
+ flags are required
468
+ --cma=<value> Custom host to set for content management API, , if this flag is added then cda, ui-host and
469
+ name flags are required
470
+ --cs-assets=<value> Custom host to set for Contentstack Assets API
471
+ --developer-hub=<value> Custom host to set for Developer hub API
472
+ --launch=<value> Custom host to set for Launch API
473
+ --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are required
474
+ --personalize=<value> Custom host to set for Personalize API
475
+ --studio=<value> Custom host to set for Studio API
476
+ --ui-host=<value> Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
477
+ required
478
478
 
479
479
  DESCRIPTION
480
480
  Set region for CLI
@@ -508,7 +508,7 @@ EXAMPLES
508
508
 
509
509
  $ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --cs-assets <cs_assets_url>
510
510
 
511
- $ 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> --studio <custom_studio_url>
511
+ $ 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> --studio <custom_studio_url> --cs-assets <cs_assets_url>
512
512
  ```
513
513
 
514
514
  _See code: [src/commands/config/set/region.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/region.ts)_
package/lib/commands/config/set/early-access-header.js CHANGED
@@ -26,8 +26,8 @@ exports.default = SetEarlyAccessHeaderCommand;
26
26
  SetEarlyAccessHeaderCommand.description = 'Set Early Access header';
27
27
  SetEarlyAccessHeaderCommand.aliases = ['config:set:ea-header'];
28
28
  SetEarlyAccessHeaderCommand.flags = {
29
- 'header-alias': cli_utilities_1.flags.string({ description: '(optional) Provide the Early Access header value.' }),
30
- header: cli_utilities_1.flags.string({ description: '(optional) Provide the Early Access header alias name.' }),
29
+ 'header-alias': cli_utilities_1.flags.string({ description: '(optional) Provide a name (alias) for this Early Access header.' }),
30
+ header: cli_utilities_1.flags.string({ description: '(optional) Provide the Early Access header value.' }),
31
31
  };
32
32
  SetEarlyAccessHeaderCommand.examples = [
33
33
  '$ <%= config.bin %> <%= command.id %>',
package/lib/commands/config/set/region.js CHANGED
@@ -117,7 +117,6 @@ RegionSetCommand.flags = {
117
117
  dependsOn: ['cda', 'cma', 'name'],
118
118
  }),
119
119
  name: cli_utilities_1.flags.string({
120
- char: 'n',
121
120
  description: 'Name for the region, if this flag is added then cda, cma and ui-host flags are required',
122
121
  dependsOn: ['cda', 'cma', 'ui-host'],
123
122
  }),
@@ -152,7 +151,7 @@ RegionSetCommand.examples = [
152
151
  '$ 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>',
153
152
  '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --studio <custom_studio_url>',
154
153
  '$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --cs-assets <cs_assets_url>',
155
- '$ 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> --studio <custom_studio_url>',
154
+ '$ 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> --studio <custom_studio_url> --cs-assets <cs_assets_url>',
156
155
  ];
157
156
  RegionSetCommand.args = {
158
157
  region: cli_utilities_1.args.string({ description: 'Name for the region' }),
package/oclif.manifest.json CHANGED
@@ -338,14 +338,14 @@
338
338
  ],
339
339
  "flags": {
340
340
  "header-alias": {
341
- "description": "(optional) Provide the Early Access header value.",
341
+ "description": "(optional) Provide a name (alias) for this Early Access header.",
342
342
  "name": "header-alias",
343
343
  "hasDynamicHelp": false,
344
344
  "multiple": false,
345
345
  "type": "option"
346
346
  },
347
347
  "header": {
348
- "description": "(optional) Provide the Early Access header alias name.",
348
+ "description": "(optional) Provide the Early Access header value.",
349
349
  "name": "header",
350
350
  "hasDynamicHelp": false,
351
351
  "multiple": false,
@@ -568,7 +568,7 @@
568
568
  "$ 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>",
569
569
  "$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name \"India\" --studio <custom_studio_url>",
570
570
  "$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name \"India\" --cs-assets <cs_assets_url>",
571
- "$ 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> --studio <custom_studio_url>"
571
+ "$ 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> --studio <custom_studio_url> --cs-assets <cs_assets_url>"
572
572
  ],
573
573
  "flags": {
574
574
  "cda": {
@@ -608,7 +608,6 @@
608
608
  "type": "option"
609
609
  },
610
610
  "name": {
611
- "char": "n",
612
611
  "dependsOn": [
613
612
  "cda",
614
613
  "cma",
@@ -673,5 +672,5 @@
673
672
  ]
674
673
  }
675
674
  },
676
- "version": "2.0.0-beta.12"
675
+ "version": "2.0.0-beta.14"
677
676
  }
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@contentstack/cli-config",
3
3
  "description": "Contentstack CLI plugin for configuration",
4
- "version": "2.0.0-beta.12",
4
+ "version": "2.0.0-beta.14",
5
5
  "author": "Contentstack",
6
6
  "scripts": {
7
7
  "build": "pnpm compile && oclif manifest && oclif readme",
@@ -14,8 +14,8 @@
14
14
  "lint": "eslint src/**/*.ts"
15
15
  },
16
16
  "dependencies": {
17
- "@contentstack/cli-command": "~2.0.0-beta.9",
18
- "@contentstack/cli-utilities": "~2.0.0-beta.10",
17
+ "@contentstack/cli-command": "~2.0.0-beta.10",
18
+ "@contentstack/cli-utilities": "~2.0.0-beta.11",
19
19
  "@contentstack/utils": "~1.9.1",
20
20
  "@oclif/core": "^4.11.4"
21
21
  },
@@ -90,5 +90,9 @@
90
90
  "config:remove:rate-limit": "RLRM"
91
91
  }
92
92
  },
93
- "repository": "contentstack/cli"
94
- }
93
+ "repository": {
94
+ "type": "git",
95
+ "url": "git+https://github.com/contentstack/cli.git",
96
+ "directory": "packages/contentstack-config"
97
+ }
98
+ }