@contentstack/cli 1.9.1 → 1.10.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.
Files changed (3) hide show
  1. package/README.md +125 -38
  2. package/oclif.manifest.json +1 -1
  3. package/package.json +18 -18
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.9.1 linux-x64 node-v18.18.0
21
+ @contentstack/cli/1.10.0 linux-x64 node-v18.18.2
22
22
  $ csdx --help [COMMAND]
23
23
  USAGE
24
24
  $ csdx COMMAND
@@ -29,13 +29,14 @@ USAGE
29
29
  # Commands
30
30
 
31
31
  <!-- commands -->
32
+ * [`csdx audit`](#csdx-audit)
33
+ * [`csdx audit:fix`](#csdx-auditfix)
32
34
  * [`csdx auth:login`](#csdx-authlogin)
33
35
  * [`csdx auth:logout`](#csdx-authlogout)
34
36
  * [`csdx auth:tokens`](#csdx-authtokens)
35
37
  * [`csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]`](#csdx-authtokensadd--a-value---delivery---management--e-value--k-value--y---token-value)
36
38
  * [`csdx auth:tokens:remove`](#csdx-authtokensremove)
37
39
  * [`csdx auth:whoami`](#csdx-authwhoami)
38
- * [`csdx cm::stacks:audit:fix`](#csdx-cmstacksauditfix)
39
40
  * [`csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`](#csdx-cmassetspublish--a-value---retry-failed-value--e-value---folder-uid-value---bulk-publish-value--c-value--y---locales-value---branch-value---delivery-token-value---source-env-value)
40
41
  * [`csdx cm:assets:unpublish`](#csdx-cmassetsunpublish)
41
42
  * [`csdx cm:bootstrap`](#csdx-cmbootstrap)
@@ -71,7 +72,7 @@ USAGE
71
72
  * [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]`](#csdx-cmstacksseed---repo-value---org-value--k-value--n-value--y-value--s-value)
72
73
  * [`csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent)
73
74
  * [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
74
- * [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix-1)
75
+ * [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
75
76
  * [`csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent-1)
76
77
  * [`csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets-1)
77
78
  * [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent-1)
@@ -108,6 +109,90 @@ USAGE
108
109
  * [`csdx tokens`](#csdx-tokens)
109
110
  * [`csdx whoami`](#csdx-whoami)
110
111
 
112
+ ## `csdx audit`
113
+
114
+ Perform audits and find possible errors in the exported Contentstack data
115
+
116
+ ```
117
+ USAGE
118
+ $ csdx audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
119
+ content-types|global-fields|entries] [--columns <value> | ] [--sort <value>] [--filter <value>] [--csv |
120
+ --no-truncate]
121
+
122
+ FLAGS
123
+ -c, --config=<value> Path of the external config
124
+ -d, --data-dir=<value> Path where the data is stored
125
+ --columns=<value> only show provided columns (comma-separated)
126
+ --csv output is csv format [alias: --output=csv]
127
+ --filter=<value> filter property by partial string matching, ex: name=foo
128
+ --modules=<option>... Provide the list of modules to be audited
129
+ <options: content-types|global-fields|entries>
130
+ --no-truncate do not truncate output to fit screen
131
+ --report-path=<value> Path to store the audit reports
132
+ --sort=<value> property to sort by (prepend '-' for descending)
133
+
134
+ DESCRIPTION
135
+ Perform audits and find possible errors in the exported Contentstack data
136
+
137
+ ALIASES
138
+ $ csdx audit
139
+ $ csdx cm:stacks:audit
140
+
141
+ EXAMPLES
142
+ $ csdx audit
143
+
144
+ $ csdx audit --report-path=<path>
145
+
146
+ $ csdx audit --report-path=<path> --csv
147
+
148
+ $ csdx audit --report-path=<path> --filter="name=<filter-value>"
149
+
150
+ $ csdx audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
151
+ ```
152
+
153
+ ## `csdx audit:fix`
154
+
155
+ Perform audits and fix possible errors in the exported Contentstack data.
156
+
157
+ ```
158
+ USAGE
159
+ $ csdx audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
160
+ content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--columns <value> | ] [--sort <value>]
161
+ [--filter <value>] [--csv | --no-truncate]
162
+
163
+ FLAGS
164
+ -c, --config=<value> Path of the external config
165
+ -d, --data-dir=<value> Path where the data is stored
166
+ --columns=<value> only show provided columns (comma-separated)
167
+ --copy-dir Create backup from the original data.
168
+ --copy-path=<value> Provide the path to backup the copied data
169
+ --csv output is csv format [alias: --output=csv]
170
+ --filter=<value> filter property by partial string matching, ex: name=foo
171
+ --modules=<option>... Provide the list of modules to be audited
172
+ <options: content-types|global-fields|entries>
173
+ --no-truncate do not truncate output to fit screen
174
+ --report-path=<value> Path to store the audit reports
175
+ --sort=<value> property to sort by (prepend '-' for descending)
176
+
177
+ DESCRIPTION
178
+ Perform audits and fix possible errors in the exported Contentstack data.
179
+
180
+ ALIASES
181
+ $ csdx audit:fix
182
+ $ csdx cm:stacks:audit:fix
183
+
184
+ EXAMPLES
185
+ $ csdx audit:fix --copy-dir
186
+
187
+ $ csdx audit:fix --report-path=<path> --copy-dir
188
+
189
+ $ csdx audit:fix --report-path=<path> --copy-dir --csv
190
+
191
+ $ csdx audit:fix --report-path=<path> --filter="name=<filter-value>"
192
+
193
+ $ csdx audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
194
+ ```
195
+
111
196
  ## `csdx auth:login`
112
197
 
113
198
  User sessions login
@@ -289,30 +374,6 @@ EXAMPLES
289
374
 
290
375
  _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/main/packages/contentstack-auth/src/commands/auth/whoami.ts)_
291
376
 
292
- ## `csdx cm::stacks:audit:fix`
293
-
294
- Audit fix command
295
-
296
- ```
297
- USAGE
298
- $ csdx cm::stacks:audit:fix [-c <value>] [-d <value>]
299
-
300
- FLAGS
301
- -c, --config=<value> Path of the external config.
302
- -d, --data-dir=<value> Path where the data is stored.
303
-
304
- DESCRIPTION
305
- Audit fix command
306
-
307
- ALIASES
308
- $ csdx cm::stacks:audit:fix
309
-
310
- EXAMPLES
311
- $ csdx cm::stacks:audit:fix
312
- ```
313
-
314
- _See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
315
-
316
377
  ## `csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`
317
378
 
318
379
  Publish assets to the specified environments
@@ -2025,6 +2086,8 @@ FLAGS
2025
2086
  -y, --yes [optional] Override marketplace prompts
2026
2087
  --import-webhook-status=<option> [default: disable] [optional] Webhook state
2027
2088
  <options: disable|current>
2089
+ --replace-existing Replaces the existing module in the target stack.
2090
+ --skip-existing Skips the module exists warning messages.
2028
2091
 
2029
2092
  DESCRIPTION
2030
2093
  Import content from a stack
@@ -2243,21 +2306,22 @@ USAGE
2243
2306
  --no-truncate]
2244
2307
 
2245
2308
  FLAGS
2246
- -c, --config=<value> Path of the external config.
2247
- -d, --data-dir=<value> Path where the data is stored.
2309
+ -c, --config=<value> Path of the external config
2310
+ -d, --data-dir=<value> Path where the data is stored
2248
2311
  --columns=<value> only show provided columns (comma-separated)
2249
2312
  --csv output is csv format [alias: --output=csv]
2250
2313
  --filter=<value> filter property by partial string matching, ex: name=foo
2251
- --modules=<option>... Provide the list of modules to be audited.
2314
+ --modules=<option>... Provide the list of modules to be audited
2252
2315
  <options: content-types|global-fields|entries>
2253
2316
  --no-truncate do not truncate output to fit screen
2254
- --report-path=<value> Path to store the audit reports.
2317
+ --report-path=<value> Path to store the audit reports
2255
2318
  --sort=<value> property to sort by (prepend '-' for descending)
2256
2319
 
2257
2320
  DESCRIPTION
2258
2321
  Perform audits and find possible errors in the exported Contentstack data
2259
2322
 
2260
2323
  ALIASES
2324
+ $ csdx audit
2261
2325
  $ csdx cm:stacks:audit
2262
2326
 
2263
2327
  EXAMPLES
@@ -2276,24 +2340,45 @@ _See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/
2276
2340
 
2277
2341
  ## `csdx cm:stacks:audit:fix`
2278
2342
 
2279
- Audit fix command
2343
+ Perform audits and fix possible errors in the exported Contentstack data.
2280
2344
 
2281
2345
  ```
2282
2346
  USAGE
2283
- $ csdx cm:stacks:audit:fix [-c <value>] [-d <value>]
2347
+ $ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
2348
+ content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--columns <value> | ] [--sort <value>]
2349
+ [--filter <value>] [--csv | --no-truncate]
2284
2350
 
2285
2351
  FLAGS
2286
- -c, --config=<value> Path of the external config.
2287
- -d, --data-dir=<value> Path where the data is stored.
2352
+ -c, --config=<value> Path of the external config
2353
+ -d, --data-dir=<value> Path where the data is stored
2354
+ --columns=<value> only show provided columns (comma-separated)
2355
+ --copy-dir Create backup from the original data.
2356
+ --copy-path=<value> Provide the path to backup the copied data
2357
+ --csv output is csv format [alias: --output=csv]
2358
+ --filter=<value> filter property by partial string matching, ex: name=foo
2359
+ --modules=<option>... Provide the list of modules to be audited
2360
+ <options: content-types|global-fields|entries>
2361
+ --no-truncate do not truncate output to fit screen
2362
+ --report-path=<value> Path to store the audit reports
2363
+ --sort=<value> property to sort by (prepend '-' for descending)
2288
2364
 
2289
2365
  DESCRIPTION
2290
- Audit fix command
2366
+ Perform audits and fix possible errors in the exported Contentstack data.
2291
2367
 
2292
2368
  ALIASES
2293
- $ csdx cm::stacks:audit:fix
2369
+ $ csdx audit:fix
2370
+ $ csdx cm:stacks:audit:fix
2294
2371
 
2295
2372
  EXAMPLES
2296
- $ csdx cm:stacks:audit:fix
2373
+ $ csdx cm:stacks:audit:fix --copy-dir
2374
+
2375
+ $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir
2376
+
2377
+ $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
2378
+
2379
+ $ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
2380
+
2381
+ $ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
2297
2382
  ```
2298
2383
 
2299
2384
  _See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
@@ -2413,6 +2498,8 @@ FLAGS
2413
2498
  -y, --yes [optional] Override marketplace prompts
2414
2499
  --import-webhook-status=<option> [default: disable] [optional] Webhook state
2415
2500
  <options: disable|current>
2501
+ --replace-existing Replaces the existing module in the target stack.
2502
+ --skip-existing Skips the module exists warning messages.
2416
2503
 
2417
2504
  DESCRIPTION
2418
2505
  Import content from a stack
package/oclif.manifest.json CHANGED
@@ -1,4 +1,4 @@
1
1
  {
2
- "version": "1.9.1",
2
+ "version": "1.10.0",
3
3
  "commands": {}
4
4
  }
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.9.1",
4
+ "version": "1.10.0",
5
5
  "author": "Contentstack",
6
6
  "bin": {
7
7
  "csdx": "./bin/run"
@@ -22,22 +22,22 @@
22
22
  "prepack": "pnpm compile && oclif manifest && oclif readme"
23
23
  },
24
24
  "dependencies": {
25
- "@contentstack/cli-audit": "~1.0.0",
26
- "@contentstack/cli-auth": "~1.3.14",
27
- "@contentstack/cli-cm-bootstrap": "~1.5.1",
28
- "@contentstack/cli-cm-branches": "~1.0.14",
29
- "@contentstack/cli-cm-bulk-publish": "~1.3.12",
30
- "@contentstack/cli-cm-clone": "~1.5.1",
31
- "@contentstack/cli-cm-export": "~1.9.1",
32
- "@contentstack/cli-cm-export-to-csv": "~1.4.3",
33
- "@contentstack/cli-cm-import": "~1.9.1",
34
- "@contentstack/cli-cm-migrate-rte": "~1.4.12",
35
- "@contentstack/cli-cm-seed": "~1.5.1",
36
- "@contentstack/cli-command": "~1.2.13",
37
- "@contentstack/cli-config": "~1.4.12",
38
- "@contentstack/cli-launch": "~1.0.12",
39
- "@contentstack/cli-migration": "~1.3.13",
40
- "@contentstack/cli-utilities": "~1.5.3",
25
+ "@contentstack/cli-audit": "~1.2.0",
26
+ "@contentstack/cli-auth": "~1.3.15",
27
+ "@contentstack/cli-cm-bootstrap": "~1.6.0",
28
+ "@contentstack/cli-cm-branches": "~1.0.15",
29
+ "@contentstack/cli-cm-bulk-publish": "~1.3.13",
30
+ "@contentstack/cli-cm-clone": "~1.6.0",
31
+ "@contentstack/cli-cm-export": "~1.9.2",
32
+ "@contentstack/cli-cm-export-to-csv": "~1.4.4",
33
+ "@contentstack/cli-cm-import": "~1.10.0",
34
+ "@contentstack/cli-cm-migrate-rte": "~1.4.13",
35
+ "@contentstack/cli-cm-seed": "~1.6.0",
36
+ "@contentstack/cli-command": "~1.2.14",
37
+ "@contentstack/cli-config": "~1.4.13",
38
+ "@contentstack/cli-launch": "~1.0.13",
39
+ "@contentstack/cli-migration": "~1.3.14",
40
+ "@contentstack/cli-utilities": "~1.5.4",
41
41
  "@contentstack/management": "~1.10.0",
42
42
  "@oclif/core": "^2.9.3",
43
43
  "@oclif/plugin-help": "^5",
@@ -160,4 +160,4 @@
160
160
  }
161
161
  },
162
162
  "repository": "https://github.com/contentstack/cli"
163
- }
163
+ }