@contentstack/cli 1.23.0 → 1.25.0
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.
- package/README.md +74 -59
- package/oclif.manifest.json +1 -1
- package/package.json +11 -11
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli
|
|
|
18
18
|
$ csdx COMMAND
|
|
19
19
|
running command...
|
|
20
20
|
$ csdx (--version|-v)
|
|
21
|
-
@contentstack/cli/1.
|
|
21
|
+
@contentstack/cli/1.25.0 linux-x64 node-v18.20.4
|
|
22
22
|
$ csdx --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ csdx COMMAND
|
|
@@ -123,12 +123,12 @@ Perform audits and find possible errors in the exported Contentstack data
|
|
|
123
123
|
```
|
|
124
124
|
USAGE
|
|
125
125
|
$ csdx audit [--report-path <value>] [--modules
|
|
126
|
-
content-types|global-fields|entries|extensions|workflows...] [--columns <value> | ] [--sort <value>]
|
|
127
|
-
<value>] [--csv | --no-truncate]
|
|
126
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles...] [--columns <value> | ] [--sort <value>]
|
|
127
|
+
[--filter <value>] [--csv | --no-truncate]
|
|
128
128
|
|
|
129
129
|
FLAGS
|
|
130
130
|
--modules=<option>... Provide the list of modules to be audited
|
|
131
|
-
<options: content-types|global-fields|entries|extensions|workflows>
|
|
131
|
+
<options: content-types|global-fields|entries|extensions|workflows|custom-roles>
|
|
132
132
|
--report-path=<value> Path to store the audit reports
|
|
133
133
|
|
|
134
134
|
TABLE FLAGS
|
|
@@ -164,9 +164,9 @@ Perform audits and fix possible errors in the exported Contentstack data.
|
|
|
164
164
|
```
|
|
165
165
|
USAGE
|
|
166
166
|
$ csdx audit:fix [--report-path <value>] [--modules
|
|
167
|
-
content-types|global-fields|entries|extensions|workflows...] [--copy-path <value> --copy-dir]
|
|
168
|
-
reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns <value> | ]
|
|
169
|
-
<value>] [--filter <value>] [--csv | --no-truncate]
|
|
167
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles...] [--copy-path <value> --copy-dir]
|
|
168
|
+
[--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns <value> | ]
|
|
169
|
+
[--sort <value>] [--filter <value>] [--csv | --no-truncate]
|
|
170
170
|
|
|
171
171
|
FLAGS
|
|
172
172
|
--copy-dir Create backup from the original data.
|
|
@@ -174,7 +174,7 @@ FLAGS
|
|
|
174
174
|
--fix-only=<option>... Provide the list of fix options
|
|
175
175
|
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
176
176
|
--modules=<option>... Provide the list of modules to be audited
|
|
177
|
-
<options: content-types|global-fields|entries|extensions|workflows>
|
|
177
|
+
<options: content-types|global-fields|entries|extensions|workflows|custom-roles>
|
|
178
178
|
--report-path=<value> Path to store the audit reports
|
|
179
179
|
|
|
180
180
|
TABLE FLAGS
|
|
@@ -2145,21 +2145,22 @@ USAGE
|
|
|
2145
2145
|
[--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
|
|
2146
2146
|
|
|
2147
2147
|
FLAGS
|
|
2148
|
-
-B, --branch=<value>
|
|
2149
|
-
-a, --alias=<value>
|
|
2150
|
-
-b, --backup-dir=<value>
|
|
2151
|
-
-c, --config=<value>
|
|
2152
|
-
-d, --data-dir=<value>
|
|
2153
|
-
-k, --stack-api-key=<value>
|
|
2154
|
-
-m, --module=<value>
|
|
2155
|
-
-y, --yes
|
|
2156
|
-
--exclude-global-modules
|
|
2157
|
-
--import-webhook-status=<option>
|
|
2158
|
-
|
|
2159
|
-
--
|
|
2160
|
-
--
|
|
2161
|
-
--skip-
|
|
2162
|
-
--skip-
|
|
2148
|
+
-B, --branch=<value> [optional] branch name
|
|
2149
|
+
-a, --alias=<value> alias of the management token
|
|
2150
|
+
-b, --backup-dir=<value> [optional] backup directory name when using specific module
|
|
2151
|
+
-c, --config=<value> [optional] path of config file
|
|
2152
|
+
-d, --data-dir=<value> path and location where data is stored
|
|
2153
|
+
-k, --stack-api-key=<value> API key of the target stack
|
|
2154
|
+
-m, --module=<value> [optional] specific module name
|
|
2155
|
+
-y, --yes [optional] Override marketplace prompts
|
|
2156
|
+
--exclude-global-modules Excludes the branch-independent module from the import operation
|
|
2157
|
+
--import-webhook-status=<option> [default: disable] [optional] Webhook state
|
|
2158
|
+
<options: disable|current>
|
|
2159
|
+
--personalize-project-name=<value> Personalize project name.
|
|
2160
|
+
--replace-existing Replaces the existing module in the target stack.
|
|
2161
|
+
--skip-app-recreation [optional] Skip private apps recreation if already exist
|
|
2162
|
+
--skip-audit Skips the audit fix.
|
|
2163
|
+
--skip-existing Skips the module exists warning messages.
|
|
2163
2164
|
|
|
2164
2165
|
DESCRIPTION
|
|
2165
2166
|
Import content from a stack
|
|
@@ -2377,12 +2378,12 @@ Perform audits and find possible errors in the exported Contentstack data
|
|
|
2377
2378
|
```
|
|
2378
2379
|
USAGE
|
|
2379
2380
|
$ csdx cm:stacks:audit [--report-path <value>] [--modules
|
|
2380
|
-
content-types|global-fields|entries|extensions|workflows...] [--columns <value> | ] [--sort <value>]
|
|
2381
|
-
<value>] [--csv | --no-truncate]
|
|
2381
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles...] [--columns <value> | ] [--sort <value>]
|
|
2382
|
+
[--filter <value>] [--csv | --no-truncate]
|
|
2382
2383
|
|
|
2383
2384
|
FLAGS
|
|
2384
2385
|
--modules=<option>... Provide the list of modules to be audited
|
|
2385
|
-
<options: content-types|global-fields|entries|extensions|workflows>
|
|
2386
|
+
<options: content-types|global-fields|entries|extensions|workflows|custom-roles>
|
|
2386
2387
|
--report-path=<value> Path to store the audit reports
|
|
2387
2388
|
|
|
2388
2389
|
TABLE FLAGS
|
|
@@ -2420,9 +2421,9 @@ Perform audits and fix possible errors in the exported Contentstack data.
|
|
|
2420
2421
|
```
|
|
2421
2422
|
USAGE
|
|
2422
2423
|
$ csdx cm:stacks:audit:fix [--report-path <value>] [--modules
|
|
2423
|
-
content-types|global-fields|entries|extensions|workflows...] [--copy-path <value> --copy-dir]
|
|
2424
|
-
reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns <value> | ]
|
|
2425
|
-
<value>] [--filter <value>] [--csv | --no-truncate]
|
|
2424
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles...] [--copy-path <value> --copy-dir]
|
|
2425
|
+
[--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns <value> | ]
|
|
2426
|
+
[--sort <value>] [--filter <value>] [--csv | --no-truncate]
|
|
2426
2427
|
|
|
2427
2428
|
FLAGS
|
|
2428
2429
|
--copy-dir Create backup from the original data.
|
|
@@ -2430,7 +2431,7 @@ FLAGS
|
|
|
2430
2431
|
--fix-only=<option>... Provide the list of fix options
|
|
2431
2432
|
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
2432
2433
|
--modules=<option>... Provide the list of modules to be audited
|
|
2433
|
-
<options: content-types|global-fields|entries|extensions|workflows>
|
|
2434
|
+
<options: content-types|global-fields|entries|extensions|workflows|custom-roles>
|
|
2434
2435
|
--report-path=<value> Path to store the audit reports
|
|
2435
2436
|
|
|
2436
2437
|
TABLE FLAGS
|
|
@@ -2570,21 +2571,22 @@ USAGE
|
|
|
2570
2571
|
<value>] [--branch <value>] [--import-webhook-status disable|current]
|
|
2571
2572
|
|
|
2572
2573
|
FLAGS
|
|
2573
|
-
-B, --branch=<value>
|
|
2574
|
-
-a, --alias=<value>
|
|
2575
|
-
-b, --backup-dir=<value>
|
|
2576
|
-
-c, --config=<value>
|
|
2577
|
-
-d, --data-dir=<value>
|
|
2578
|
-
-k, --stack-api-key=<value>
|
|
2579
|
-
-m, --module=<value>
|
|
2580
|
-
-y, --yes
|
|
2581
|
-
--exclude-global-modules
|
|
2582
|
-
--import-webhook-status=<option>
|
|
2583
|
-
|
|
2584
|
-
--
|
|
2585
|
-
--
|
|
2586
|
-
--skip-
|
|
2587
|
-
--skip-
|
|
2574
|
+
-B, --branch=<value> [optional] branch name
|
|
2575
|
+
-a, --alias=<value> alias of the management token
|
|
2576
|
+
-b, --backup-dir=<value> [optional] backup directory name when using specific module
|
|
2577
|
+
-c, --config=<value> [optional] path of config file
|
|
2578
|
+
-d, --data-dir=<value> path and location where data is stored
|
|
2579
|
+
-k, --stack-api-key=<value> API key of the target stack
|
|
2580
|
+
-m, --module=<value> [optional] specific module name
|
|
2581
|
+
-y, --yes [optional] Override marketplace prompts
|
|
2582
|
+
--exclude-global-modules Excludes the branch-independent module from the import operation
|
|
2583
|
+
--import-webhook-status=<option> [default: disable] [optional] Webhook state
|
|
2584
|
+
<options: disable|current>
|
|
2585
|
+
--personalize-project-name=<value> Personalize project name.
|
|
2586
|
+
--replace-existing Replaces the existing module in the target stack.
|
|
2587
|
+
--skip-app-recreation [optional] Skip private apps recreation if already exist
|
|
2588
|
+
--skip-audit Skips the audit fix.
|
|
2589
|
+
--skip-existing Skips the module exists warning messages.
|
|
2588
2590
|
|
|
2589
2591
|
DESCRIPTION
|
|
2590
2592
|
Import content from a stack
|
|
@@ -3161,18 +3163,23 @@ Set region for CLI
|
|
|
3161
3163
|
|
|
3162
3164
|
```
|
|
3163
3165
|
USAGE
|
|
3164
|
-
$ csdx config:set:region [REGION] [-d <value> -m <value> --ui-host <value> -n <value>]
|
|
3166
|
+
$ csdx config:set:region [REGION] [-d <value> -m <value> --ui-host <value> -n <value>] [--developer-hub <value>]
|
|
3167
|
+
[--personalize <value>] [--launch <value>]
|
|
3165
3168
|
|
|
3166
3169
|
ARGUMENTS
|
|
3167
3170
|
REGION Name for the region
|
|
3168
3171
|
|
|
3169
3172
|
FLAGS
|
|
3170
|
-
-d, --cda=<value>
|
|
3171
|
-
|
|
3172
|
-
-m, --cma=<value>
|
|
3173
|
-
|
|
3174
|
-
-n, --name=<value>
|
|
3175
|
-
--
|
|
3173
|
+
-d, --cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host and
|
|
3174
|
+
name flags are required
|
|
3175
|
+
-m, --cma=<value> Custom host to set for content management API, , if this flag is added then cda, ui-host
|
|
3176
|
+
and name flags are required
|
|
3177
|
+
-n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are required
|
|
3178
|
+
--developer-hub=<value> Custom host to set for Developer hub API
|
|
3179
|
+
--launch=<value> Custom host to set for Launch API
|
|
3180
|
+
--personalize=<value> Custom host to set for Personalize API
|
|
3181
|
+
--ui-host=<value> Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
|
|
3182
|
+
required
|
|
3176
3183
|
|
|
3177
3184
|
DESCRIPTION
|
|
3178
3185
|
Set region for CLI
|
|
@@ -3191,6 +3198,14 @@ EXAMPLES
|
|
|
3191
3198
|
$ csdx config:set:region GCP-NA
|
|
3192
3199
|
|
|
3193
3200
|
$ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India"
|
|
3201
|
+
|
|
3202
|
+
$ 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>
|
|
3203
|
+
|
|
3204
|
+
$ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India" --personalize <personalize_url>
|
|
3205
|
+
|
|
3206
|
+
$ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India" --launch <launch_url>
|
|
3207
|
+
|
|
3208
|
+
$ 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>
|
|
3194
3209
|
```
|
|
3195
3210
|
|
|
3196
3211
|
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/region.ts)_
|
|
@@ -3510,7 +3525,7 @@ EXAMPLES
|
|
|
3510
3525
|
$ csdx plugins
|
|
3511
3526
|
```
|
|
3512
3527
|
|
|
3513
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3528
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.6/src/commands/plugins/index.ts)_
|
|
3514
3529
|
|
|
3515
3530
|
## `csdx plugins:add PLUGIN`
|
|
3516
3531
|
|
|
@@ -3584,7 +3599,7 @@ EXAMPLES
|
|
|
3584
3599
|
$ csdx plugins:inspect myplugin
|
|
3585
3600
|
```
|
|
3586
3601
|
|
|
3587
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3602
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.6/src/commands/plugins/inspect.ts)_
|
|
3588
3603
|
|
|
3589
3604
|
## `csdx plugins:install PLUGIN`
|
|
3590
3605
|
|
|
@@ -3633,7 +3648,7 @@ EXAMPLES
|
|
|
3633
3648
|
$ csdx plugins:install someuser/someplugin
|
|
3634
3649
|
```
|
|
3635
3650
|
|
|
3636
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3651
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.6/src/commands/plugins/install.ts)_
|
|
3637
3652
|
|
|
3638
3653
|
## `csdx plugins:link PATH`
|
|
3639
3654
|
|
|
@@ -3663,7 +3678,7 @@ EXAMPLES
|
|
|
3663
3678
|
$ csdx plugins:link myplugin
|
|
3664
3679
|
```
|
|
3665
3680
|
|
|
3666
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3681
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.6/src/commands/plugins/link.ts)_
|
|
3667
3682
|
|
|
3668
3683
|
## `csdx plugins:remove [PLUGIN]`
|
|
3669
3684
|
|
|
@@ -3704,7 +3719,7 @@ FLAGS
|
|
|
3704
3719
|
--reinstall Reinstall all plugins after uninstalling.
|
|
3705
3720
|
```
|
|
3706
3721
|
|
|
3707
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3722
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.6/src/commands/plugins/reset.ts)_
|
|
3708
3723
|
|
|
3709
3724
|
## `csdx plugins:uninstall [PLUGIN]`
|
|
3710
3725
|
|
|
@@ -3732,7 +3747,7 @@ EXAMPLES
|
|
|
3732
3747
|
$ csdx plugins:uninstall myplugin
|
|
3733
3748
|
```
|
|
3734
3749
|
|
|
3735
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3750
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.6/src/commands/plugins/uninstall.ts)_
|
|
3736
3751
|
|
|
3737
3752
|
## `csdx plugins:unlink [PLUGIN]`
|
|
3738
3753
|
|
|
@@ -3776,7 +3791,7 @@ DESCRIPTION
|
|
|
3776
3791
|
Update installed plugins.
|
|
3777
3792
|
```
|
|
3778
3793
|
|
|
3779
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3794
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.6/src/commands/plugins/update.ts)_
|
|
3780
3795
|
|
|
3781
3796
|
## `csdx tokens`
|
|
3782
3797
|
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentstack/cli",
|
|
3
3
|
"description": "Command-line tool (CLI) to interact with Contentstack",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.25.0",
|
|
5
5
|
"author": "Contentstack",
|
|
6
6
|
"bin": {
|
|
7
7
|
"csdx": "./bin/run.js"
|
|
@@ -22,22 +22,22 @@
|
|
|
22
22
|
"prepack": "pnpm compile && oclif manifest && oclif readme"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@contentstack/cli-audit": "~1.
|
|
25
|
+
"@contentstack/cli-audit": "~1.7.0",
|
|
26
26
|
"@contentstack/cli-auth": "~1.3.20",
|
|
27
|
-
"@contentstack/cli-cm-bootstrap": "~1.
|
|
27
|
+
"@contentstack/cli-cm-bootstrap": "~1.11.0",
|
|
28
28
|
"@contentstack/cli-cm-branches": "~1.1.2",
|
|
29
29
|
"@contentstack/cli-cm-bulk-publish": "~1.4.8",
|
|
30
|
-
"@contentstack/cli-cm-export": "~1.
|
|
31
|
-
"@contentstack/cli-cm-clone": "~1.
|
|
30
|
+
"@contentstack/cli-cm-export": "~1.12.0",
|
|
31
|
+
"@contentstack/cli-cm-clone": "~1.11.0",
|
|
32
32
|
"@contentstack/cli-cm-export-to-csv": "~1.7.2",
|
|
33
|
-
"@contentstack/cli-cm-import": "~1.
|
|
33
|
+
"@contentstack/cli-cm-import": "~1.17.0",
|
|
34
34
|
"@contentstack/cli-cm-migrate-rte": "~1.4.18",
|
|
35
|
-
"@contentstack/cli-cm-seed": "~1.
|
|
36
|
-
"@contentstack/cli-command": "~1.
|
|
37
|
-
"@contentstack/cli-config": "~1.
|
|
38
|
-
"@contentstack/cli-launch": "~1.2.
|
|
35
|
+
"@contentstack/cli-cm-seed": "~1.8.0",
|
|
36
|
+
"@contentstack/cli-command": "~1.3.0",
|
|
37
|
+
"@contentstack/cli-config": "~1.7.0",
|
|
38
|
+
"@contentstack/cli-launch": "~1.2.1",
|
|
39
39
|
"@contentstack/cli-migration": "~1.6.1",
|
|
40
|
-
"@contentstack/cli-utilities": "~1.7.
|
|
40
|
+
"@contentstack/cli-utilities": "~1.7.2",
|
|
41
41
|
"@contentstack/management": "~1.17.0",
|
|
42
42
|
"@oclif/core": "^3.26.5",
|
|
43
43
|
"@oclif/plugin-help": "^5",
|