@contentstack/cli 1.35.5 → 1.37.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 +24 -57
- package/oclif.manifest.json +1 -1
- package/package.json +17 -19
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.37.0 linux-x64 node-v22.14.0
|
|
22
22
|
$ csdx --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ csdx COMMAND
|
|
@@ -119,7 +119,6 @@ USAGE
|
|
|
119
119
|
* [`csdx plugins:unlink [PLUGIN]`](#csdx-pluginsunlink-plugin)
|
|
120
120
|
* [`csdx plugins:update`](#csdx-pluginsupdate)
|
|
121
121
|
* [`csdx tokens`](#csdx-tokens)
|
|
122
|
-
* [`csdx tsgen`](#csdx-tsgen)
|
|
123
122
|
* [`csdx whoami`](#csdx-whoami)
|
|
124
123
|
|
|
125
124
|
## `csdx audit`
|
|
@@ -129,12 +128,12 @@ Perform audits and find possible errors in the exported Contentstack data
|
|
|
129
128
|
```
|
|
130
129
|
USAGE
|
|
131
130
|
$ csdx audit [--report-path <value>] [--modules
|
|
132
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles...] [--columns <value> | ] [--sort
|
|
133
|
-
[--filter <value>] [--csv | --no-truncate]
|
|
131
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets...] [--columns <value> | ] [--sort
|
|
132
|
+
<value>] [--filter <value>] [--csv | --no-truncate]
|
|
134
133
|
|
|
135
134
|
FLAGS
|
|
136
135
|
--modules=<option>... Provide the list of modules to be audited
|
|
137
|
-
<options: content-types|global-fields|entries|extensions|workflows|custom-roles>
|
|
136
|
+
<options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
|
|
138
137
|
--report-path=<value> Path to store the audit reports
|
|
139
138
|
|
|
140
139
|
TABLE FLAGS
|
|
@@ -170,7 +169,7 @@ Perform audits and fix possible errors in the exported Contentstack data.
|
|
|
170
169
|
```
|
|
171
170
|
USAGE
|
|
172
171
|
$ csdx audit:fix [--report-path <value>] [--modules
|
|
173
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles...] [--copy-path <value> --copy-dir]
|
|
172
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets...] [--copy-path <value> --copy-dir]
|
|
174
173
|
[--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns <value> | ]
|
|
175
174
|
[--sort <value>] [--filter <value>] [--csv | --no-truncate]
|
|
176
175
|
|
|
@@ -180,7 +179,7 @@ FLAGS
|
|
|
180
179
|
--fix-only=<option>... Provide the list of fix options
|
|
181
180
|
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
182
181
|
--modules=<option>... Provide the list of modules to be audited
|
|
183
|
-
<options: content-types|global-fields|entries|extensions|workflows|custom-roles>
|
|
182
|
+
<options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
|
|
184
183
|
--report-path=<value> Path to store the audit reports
|
|
185
184
|
|
|
186
185
|
TABLE FLAGS
|
|
@@ -2346,7 +2345,9 @@ FLAGS
|
|
|
2346
2345
|
--personalize-project-name=<value> (optional) Provide a unique name for the Personalize project.
|
|
2347
2346
|
--replace-existing Replaces the existing module in the target stack.
|
|
2348
2347
|
--skip-app-recreation (optional) Skips the recreation of private apps if they already exist.
|
|
2348
|
+
--skip-assets-publish Skips asset publishing during the import process.
|
|
2349
2349
|
--skip-audit Skips the audit fix that occurs during an import operation.
|
|
2350
|
+
--skip-entries-publish Skips entry publishing during the import process
|
|
2350
2351
|
--skip-existing Skips the module exists warning messages.
|
|
2351
2352
|
|
|
2352
2353
|
DESCRIPTION
|
|
@@ -2608,12 +2609,12 @@ Perform audits and find possible errors in the exported Contentstack data
|
|
|
2608
2609
|
```
|
|
2609
2610
|
USAGE
|
|
2610
2611
|
$ csdx cm:stacks:audit [--report-path <value>] [--modules
|
|
2611
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles...] [--columns <value> | ] [--sort
|
|
2612
|
-
[--filter <value>] [--csv | --no-truncate]
|
|
2612
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets...] [--columns <value> | ] [--sort
|
|
2613
|
+
<value>] [--filter <value>] [--csv | --no-truncate]
|
|
2613
2614
|
|
|
2614
2615
|
FLAGS
|
|
2615
2616
|
--modules=<option>... Provide the list of modules to be audited
|
|
2616
|
-
<options: content-types|global-fields|entries|extensions|workflows|custom-roles>
|
|
2617
|
+
<options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
|
|
2617
2618
|
--report-path=<value> Path to store the audit reports
|
|
2618
2619
|
|
|
2619
2620
|
TABLE FLAGS
|
|
@@ -2651,7 +2652,7 @@ Perform audits and fix possible errors in the exported Contentstack data.
|
|
|
2651
2652
|
```
|
|
2652
2653
|
USAGE
|
|
2653
2654
|
$ csdx cm:stacks:audit:fix [--report-path <value>] [--modules
|
|
2654
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles...] [--copy-path <value> --copy-dir]
|
|
2655
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets...] [--copy-path <value> --copy-dir]
|
|
2655
2656
|
[--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns <value> | ]
|
|
2656
2657
|
[--sort <value>] [--filter <value>] [--csv | --no-truncate]
|
|
2657
2658
|
|
|
@@ -2661,7 +2662,7 @@ FLAGS
|
|
|
2661
2662
|
--fix-only=<option>... Provide the list of fix options
|
|
2662
2663
|
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
2663
2664
|
--modules=<option>... Provide the list of modules to be audited
|
|
2664
|
-
<options: content-types|global-fields|entries|extensions|workflows|custom-roles>
|
|
2665
|
+
<options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
|
|
2665
2666
|
--report-path=<value> Path to store the audit reports
|
|
2666
2667
|
|
|
2667
2668
|
TABLE FLAGS
|
|
@@ -2837,7 +2838,9 @@ FLAGS
|
|
|
2837
2838
|
--personalize-project-name=<value> (optional) Provide a unique name for the Personalize project.
|
|
2838
2839
|
--replace-existing Replaces the existing module in the target stack.
|
|
2839
2840
|
--skip-app-recreation (optional) Skips the recreation of private apps if they already exist.
|
|
2841
|
+
--skip-assets-publish Skips asset publishing during the import process.
|
|
2840
2842
|
--skip-audit Skips the audit fix that occurs during an import operation.
|
|
2843
|
+
--skip-entries-publish Skips entry publishing during the import process
|
|
2841
2844
|
--skip-existing Skips the module exists warning messages.
|
|
2842
2845
|
|
|
2843
2846
|
DESCRIPTION
|
|
@@ -3560,6 +3563,8 @@ EXAMPLES
|
|
|
3560
3563
|
|
|
3561
3564
|
$ csdx config:set:region GCP-NA
|
|
3562
3565
|
|
|
3566
|
+
$ csdx config:set:region GCP-EU
|
|
3567
|
+
|
|
3563
3568
|
$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India"
|
|
3564
3569
|
|
|
3565
3570
|
$ 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>
|
|
@@ -3897,7 +3902,7 @@ EXAMPLES
|
|
|
3897
3902
|
$ csdx plugins
|
|
3898
3903
|
```
|
|
3899
3904
|
|
|
3900
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3905
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/index.ts)_
|
|
3901
3906
|
|
|
3902
3907
|
## `csdx plugins:add PLUGIN`
|
|
3903
3908
|
|
|
@@ -3971,7 +3976,7 @@ EXAMPLES
|
|
|
3971
3976
|
$ csdx plugins:inspect myplugin
|
|
3972
3977
|
```
|
|
3973
3978
|
|
|
3974
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3979
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/inspect.ts)_
|
|
3975
3980
|
|
|
3976
3981
|
## `csdx plugins:install PLUGIN`
|
|
3977
3982
|
|
|
@@ -4020,7 +4025,7 @@ EXAMPLES
|
|
|
4020
4025
|
$ csdx plugins:install someuser/someplugin
|
|
4021
4026
|
```
|
|
4022
4027
|
|
|
4023
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
4028
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/install.ts)_
|
|
4024
4029
|
|
|
4025
4030
|
## `csdx plugins:link PATH`
|
|
4026
4031
|
|
|
@@ -4051,7 +4056,7 @@ EXAMPLES
|
|
|
4051
4056
|
$ csdx plugins:link myplugin
|
|
4052
4057
|
```
|
|
4053
4058
|
|
|
4054
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
4059
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/link.ts)_
|
|
4055
4060
|
|
|
4056
4061
|
## `csdx plugins:remove [PLUGIN]`
|
|
4057
4062
|
|
|
@@ -4092,7 +4097,7 @@ FLAGS
|
|
|
4092
4097
|
--reinstall Reinstall all plugins after uninstalling.
|
|
4093
4098
|
```
|
|
4094
4099
|
|
|
4095
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
4100
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/reset.ts)_
|
|
4096
4101
|
|
|
4097
4102
|
## `csdx plugins:uninstall [PLUGIN]`
|
|
4098
4103
|
|
|
@@ -4120,7 +4125,7 @@ EXAMPLES
|
|
|
4120
4125
|
$ csdx plugins:uninstall myplugin
|
|
4121
4126
|
```
|
|
4122
4127
|
|
|
4123
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
4128
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/uninstall.ts)_
|
|
4124
4129
|
|
|
4125
4130
|
## `csdx plugins:unlink [PLUGIN]`
|
|
4126
4131
|
|
|
@@ -4164,7 +4169,7 @@ DESCRIPTION
|
|
|
4164
4169
|
Update installed plugins.
|
|
4165
4170
|
```
|
|
4166
4171
|
|
|
4167
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
4172
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.36/src/commands/plugins/update.ts)_
|
|
4168
4173
|
|
|
4169
4174
|
## `csdx tokens`
|
|
4170
4175
|
|
|
@@ -4196,44 +4201,6 @@ EXAMPLES
|
|
|
4196
4201
|
$ csdx auth:tokens
|
|
4197
4202
|
```
|
|
4198
4203
|
|
|
4199
|
-
## `csdx tsgen`
|
|
4200
|
-
|
|
4201
|
-
Generate TypeScript typings from a Stack
|
|
4202
|
-
|
|
4203
|
-
```
|
|
4204
|
-
USAGE
|
|
4205
|
-
$ csdx tsgen -a <value> -o <value> [-p <value>] [-d] [--branch <value>] [--include-system-fields]
|
|
4206
|
-
[--api-type rest|graphql] [--namespace <value>]
|
|
4207
|
-
|
|
4208
|
-
FLAGS
|
|
4209
|
-
-a, --token-alias=<value> (required) delivery token alias
|
|
4210
|
-
-d, --[no-]doc include documentation comments
|
|
4211
|
-
-o, --output=<value> (required) full path to output
|
|
4212
|
-
-p, --prefix=<value> interface prefix, e.g. "I"
|
|
4213
|
-
--api-type=<option> [default: rest] [Optional] Please enter an API type to generate the type definitions.
|
|
4214
|
-
<options: rest|graphql>
|
|
4215
|
-
--branch=<value> branch
|
|
4216
|
-
--include-system-fields include system fields in generated types
|
|
4217
|
-
--namespace=<value> [Optional]Please enter a namespace for the GraphQL API type to organize the generated
|
|
4218
|
-
types.
|
|
4219
|
-
|
|
4220
|
-
DESCRIPTION
|
|
4221
|
-
Generate TypeScript typings from a Stack
|
|
4222
|
-
|
|
4223
|
-
EXAMPLES
|
|
4224
|
-
$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts"
|
|
4225
|
-
|
|
4226
|
-
$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" -p "I"
|
|
4227
|
-
|
|
4228
|
-
$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --no-doc
|
|
4229
|
-
|
|
4230
|
-
$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --api-type graphql
|
|
4231
|
-
|
|
4232
|
-
$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --api-type graphql --namespace "GraphQL"
|
|
4233
|
-
```
|
|
4234
|
-
|
|
4235
|
-
_See code: [contentstack-cli-tsgen](https://github.com/Contentstack-Solutions/contentstack-cli-tsgen/blob/v3.3.0/src/commands/tsgen.ts)_
|
|
4236
|
-
|
|
4237
4204
|
## `csdx whoami`
|
|
4238
4205
|
|
|
4239
4206
|
Display current users email address
|
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.37.0",
|
|
5
5
|
"author": "Contentstack",
|
|
6
6
|
"bin": {
|
|
7
7
|
"csdx": "./bin/run.js"
|
|
@@ -22,23 +22,23 @@
|
|
|
22
22
|
"prepack": "pnpm compile && oclif manifest && oclif readme"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@contentstack/cli-audit": "~1.
|
|
25
|
+
"@contentstack/cli-audit": "~1.9.0",
|
|
26
26
|
"@contentstack/cli-auth": "~1.3.24",
|
|
27
|
-
"@contentstack/cli-cm-bootstrap": "~1.13.
|
|
28
|
-
"@contentstack/cli-cm-branches": "~1.
|
|
29
|
-
"@contentstack/cli-cm-bulk-publish": "~1.7.
|
|
30
|
-
"@contentstack/cli-cm-clone": "~1.13.
|
|
31
|
-
"@contentstack/cli-cm-export": "~1.
|
|
27
|
+
"@contentstack/cli-cm-bootstrap": "~1.13.2",
|
|
28
|
+
"@contentstack/cli-cm-branches": "~1.3.0",
|
|
29
|
+
"@contentstack/cli-cm-bulk-publish": "~1.7.3",
|
|
30
|
+
"@contentstack/cli-cm-clone": "~1.13.2",
|
|
31
|
+
"@contentstack/cli-cm-export": "~1.15.0",
|
|
32
32
|
"@contentstack/cli-cm-export-to-csv": "~1.7.3",
|
|
33
|
-
"@contentstack/cli-cm-import": "~1.
|
|
34
|
-
"@contentstack/cli-cm-import-setup": "1.0
|
|
33
|
+
"@contentstack/cli-cm-import": "~1.20.0",
|
|
34
|
+
"@contentstack/cli-cm-import-setup": "1.1.0",
|
|
35
35
|
"@contentstack/cli-cm-migrate-rte": "~1.4.21",
|
|
36
|
-
"@contentstack/cli-cm-seed": "~1.10.
|
|
36
|
+
"@contentstack/cli-cm-seed": "~1.10.2",
|
|
37
37
|
"@contentstack/cli-command": "~1.3.3",
|
|
38
|
-
"@contentstack/cli-config": "~1.
|
|
39
|
-
"@contentstack/cli-launch": "^1.
|
|
38
|
+
"@contentstack/cli-config": "~1.10.0",
|
|
39
|
+
"@contentstack/cli-launch": "^1.6.0",
|
|
40
40
|
"@contentstack/cli-migration": "~1.6.5",
|
|
41
|
-
"@contentstack/cli-utilities": "~1.8.
|
|
41
|
+
"@contentstack/cli-utilities": "~1.8.4",
|
|
42
42
|
"@contentstack/cli-variants": "~1.1.5",
|
|
43
43
|
"@contentstack/management": "~1.18.4",
|
|
44
44
|
"@oclif/core": "^3.27.0",
|
|
@@ -46,19 +46,18 @@
|
|
|
46
46
|
"@oclif/plugin-not-found": "^2.4.3",
|
|
47
47
|
"@oclif/plugin-plugins": "^5.4.24",
|
|
48
48
|
"chalk": "^4.1.2",
|
|
49
|
-
"contentstack-cli-tsgen": "^3.0.1",
|
|
50
49
|
"debug": "^4.4.0",
|
|
51
50
|
"figlet": "^1.8.0",
|
|
52
51
|
"inquirer": "8.2.6",
|
|
53
52
|
"node-machine-id": "^1.1.12",
|
|
54
53
|
"open": "^8.4.2",
|
|
55
|
-
"semver": "^7.
|
|
54
|
+
"semver": "^7.7.1",
|
|
56
55
|
"short-uuid": "^4.2.2",
|
|
57
56
|
"uuid": "^9.0.1",
|
|
58
57
|
"winston": "^3.17.0"
|
|
59
58
|
},
|
|
60
59
|
"devDependencies": {
|
|
61
|
-
"@oclif/test": "^4.1.
|
|
60
|
+
"@oclif/test": "^4.1.12",
|
|
62
61
|
"@types/chai": "^4.3.20",
|
|
63
62
|
"@types/inquirer": "^9.0.7",
|
|
64
63
|
"@types/mkdirp": "^1.0.2",
|
|
@@ -69,7 +68,7 @@
|
|
|
69
68
|
"chai": "^4.5.0",
|
|
70
69
|
"eslint": "^8.57.1",
|
|
71
70
|
"eslint-config-oclif": "^4.0.0",
|
|
72
|
-
"eslint-config-oclif-typescript": "^3.1.
|
|
71
|
+
"eslint-config-oclif-typescript": "^3.1.14",
|
|
73
72
|
"globby": "^10.0.2",
|
|
74
73
|
"mocha": "10.8.2",
|
|
75
74
|
"nock": "^13.5.6",
|
|
@@ -153,8 +152,7 @@
|
|
|
153
152
|
"@contentstack/cli-cm-branches",
|
|
154
153
|
"@contentstack/cli-launch",
|
|
155
154
|
"@contentstack/cli-audit",
|
|
156
|
-
"@contentstack/cli-cm-import-setup"
|
|
157
|
-
"contentstack-cli-tsgen"
|
|
155
|
+
"@contentstack/cli-cm-import-setup"
|
|
158
156
|
],
|
|
159
157
|
"hooks": {
|
|
160
158
|
"prerun": [
|