@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
19
19
$ csdx COMMAND
20
20
running command...
21
21
$ csdx (--version| -v)
22
- @contentstack/cli-audit/1.10 .0 darwin-arm64 node-v22.13.1
22
+ @contentstack/cli-audit/1.11 .0 darwin-arm64 node-v22.14.0
23
23
$ csdx --help [COMMAND]
24
24
USAGE
25
25
$ csdx COMMAND
34
34
* [ ` csdx audit:fix ` ] ( #csdx-auditfix )
35
35
* [ ` csdx cm:stacks:audit ` ] ( #csdx-cmstacksaudit )
36
36
* [ ` csdx cm:stacks:audit:fix ` ] ( #csdx-cmstacksauditfix )
37
- * [ ` csdx help [COMMANDS ] ` ] ( #csdx-help-commands )
37
+ * [ ` csdx help [COMMAND ] ` ] ( #csdx-help-command )
38
38
* [ ` csdx plugins ` ] ( #csdx-plugins )
39
39
* [ ` csdx plugins:add PLUGIN ` ] ( #csdx-pluginsadd-plugin )
40
40
* [ ` csdx plugins:inspect PLUGIN... ` ] ( #csdx-pluginsinspect-plugin )
@@ -52,21 +52,29 @@ Perform audits and find possible errors in the exported Contentstack data
52
52
53
53
```
54
54
USAGE
55
- $ csdx audit [--report-path <value>] [--modules
56
- content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--columns <value> | ] [--sort
57
- <value>] [--filter <value>] [--csv | --no-truncate]
55
+ $ csdx audit [-c <value>] [-d <value>] [- -report-path <value>] [--modules
56
+ content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules... ] [--columns <value>]
57
+ [--sort <value>] [--filter <value>] [--csv] [ --no-truncate] [--no-header] [--output csv|json|yaml ]
58
58
59
59
FLAGS
60
60
--modules=<option>... Provide the list of modules to be audited
61
- <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
61
+ <options:
62
+ content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
62
63
--report-path=<value> Path to store the audit reports
63
64
65
+ COMMON FLAGS
66
+ -c, --config=<value> Path of the external config
67
+ -d, --data-dir=<value> Path where the data is stored
68
+
64
69
TABLE FLAGS
65
- --columns=<value> Show only the specified columns (comma-separated)
66
- --csv The output is in the CSV format [alias: --output=csv]
67
- --filter=<value> Filter property by partial string matching. For example: name=foo
68
- --no-truncate The output is not truncated to fit the screen
69
- --sort=<value> Property to sort by (prepend '-' for descending)
70
+ --columns=<value> Specify columns to display, comma-separated.
71
+ --csv Output results in CSV format.
72
+ --filter=<value> Filter rows by a column value (e.g., name=foo).
73
+ --no-header Hide table headers in output.
74
+ --no-truncate Prevent truncation of long text in columns.
75
+ --output=<option> Specify output format: csv, json, or yaml.
76
+ <options: csv|json|yaml>
77
+ --sort=<value> Sort the table by a column. Use "-" for descending.
70
78
71
79
DESCRIPTION
72
80
Perform audits and find possible errors in the exported Contentstack data
@@ -93,26 +101,34 @@ Perform audits and fix possible errors in the exported Contentstack data.
93
101
94
102
```
95
103
USAGE
96
- $ csdx audit:fix [--report-path <value>] [--modules
97
- content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--copy-path <value> --copy-dir]
98
- [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ]
99
- [--sort <value>] [--filter <value>] [--csv | --no-truncate]
104
+ $ csdx audit:fix [-c <value>] [-d <value>] [- -report-path <value>] [--modules
105
+ content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules... ] [--copy-path <value>
106
+ --copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types... ] [--columns
107
+ <value>] [--sort <value>] [--filter <value>] [--csv] [ --no-truncate] [--no-header] [--output csv|json|yaml ]
100
108
101
109
FLAGS
102
110
--copy-dir Create backup from the original data.
103
111
--copy-path=<value> Provide the path to backup the copied data
104
112
--fix-only=<option>... Provide the list of fix options
105
113
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
106
114
--modules=<option>... Provide the list of modules to be audited
107
- <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
115
+ <options:
116
+ content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
108
117
--report-path=<value> Path to store the audit reports
109
118
119
+ COMMON FLAGS
120
+ -c, --config=<value> Path of the external config
121
+ -d, --data-dir=<value> Path where the data is stored
122
+
110
123
TABLE FLAGS
111
- --columns=<value> Show only the specified columns (comma-separated)
112
- --csv The output is in the CSV format [alias: --output=csv]
113
- --filter=<value> Filter property by partial string matching. For example: name=foo
114
- --no-truncate The output is not truncated to fit the screen
115
- --sort=<value> Property to sort by (prepend '-' for descending)
124
+ --columns=<value> Specify columns to display, comma-separated.
125
+ --csv Output results in CSV format.
126
+ --filter=<value> Filter rows by a column value (e.g., name=foo).
127
+ --no-header Hide table headers in output.
128
+ --no-truncate Prevent truncation of long text in columns.
129
+ --output=<option> Specify output format: csv, json, or yaml.
130
+ <options: csv|json|yaml>
131
+ --sort=<value> Sort the table by a column. Use "-" for descending.
116
132
117
133
DESCRIPTION
118
134
Perform audits and fix possible errors in the exported Contentstack data.
@@ -141,21 +157,29 @@ Perform audits and find possible errors in the exported Contentstack data
141
157
142
158
```
143
159
USAGE
144
- $ csdx cm:stacks:audit [--report-path <value>] [--modules
145
- content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--columns <value> | ] [--sort
146
- <value>] [--filter <value>] [--csv | --no-truncate]
160
+ $ csdx cm:stacks:audit [-c <value>] [-d <value>] [- -report-path <value>] [--modules
161
+ content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules... ] [--columns <value>]
162
+ [--sort <value>] [--filter <value>] [--csv] [ --no-truncate] [--no-header] [--output csv|json|yaml ]
147
163
148
164
FLAGS
149
165
--modules=<option>... Provide the list of modules to be audited
150
- <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
166
+ <options:
167
+ content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
151
168
--report-path=<value> Path to store the audit reports
152
169
170
+ COMMON FLAGS
171
+ -c, --config=<value> Path of the external config
172
+ -d, --data-dir=<value> Path where the data is stored
173
+
153
174
TABLE FLAGS
154
- --columns=<value> Show only the specified columns (comma-separated)
155
- --csv The output is in the CSV format [alias: --output=csv]
156
- --filter=<value> Filter property by partial string matching. For example: name=foo
157
- --no-truncate The output is not truncated to fit the screen
158
- --sort=<value> Property to sort by (prepend '-' for descending)
175
+ --columns=<value> Specify columns to display, comma-separated.
176
+ --csv Output results in CSV format.
177
+ --filter=<value> Filter rows by a column value (e.g., name=foo).
178
+ --no-header Hide table headers in output.
179
+ --no-truncate Prevent truncation of long text in columns.
180
+ --output=<option> Specify output format: csv, json, or yaml.
181
+ <options: csv|json|yaml>
182
+ --sort=<value> Sort the table by a column. Use "-" for descending.
159
183
160
184
DESCRIPTION
161
185
Perform audits and find possible errors in the exported Contentstack data
@@ -184,26 +208,34 @@ Perform audits and fix possible errors in the exported Contentstack data.
184
208
185
209
```
186
210
USAGE
187
- $ csdx cm:stacks:audit:fix [--report-path <value>] [--modules
188
- content-types|global-fields|entries|extensions|workflows|custom-roles|assets] [--copy-path <value> --copy-dir]
189
- [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ]
190
- [--sort <value>] [--filter <value>] [--csv | --no-truncate]
211
+ $ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [- -report-path <value>] [--modules
212
+ content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules... ] [--copy-path <value>
213
+ --copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types... ] [--columns
214
+ <value>] [--sort <value>] [--filter <value>] [--csv] [ --no-truncate] [--no-header] [--output csv|json|yaml ]
191
215
192
216
FLAGS
193
217
--copy-dir Create backup from the original data.
194
218
--copy-path=<value> Provide the path to backup the copied data
195
219
--fix-only=<option>... Provide the list of fix options
196
220
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
197
221
--modules=<option>... Provide the list of modules to be audited
198
- <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets>
222
+ <options:
223
+ content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
199
224
--report-path=<value> Path to store the audit reports
200
225
226
+ COMMON FLAGS
227
+ -c, --config=<value> Path of the external config
228
+ -d, --data-dir=<value> Path where the data is stored
229
+
201
230
TABLE FLAGS
202
- --columns=<value> Show only the specified columns (comma-separated)
203
- --csv The output is in the CSV format [alias: --output=csv]
204
- --filter=<value> Filter property by partial string matching. For example: name=foo
205
- --no-truncate The output is not truncated to fit the screen
206
- --sort=<value> Property to sort by (prepend '-' for descending)
231
+ --columns=<value> Specify columns to display, comma-separated.
232
+ --csv Output results in CSV format.
233
+ --filter=<value> Filter rows by a column value (e.g., name=foo).
234
+ --no-header Hide table headers in output.
235
+ --no-truncate Prevent truncation of long text in columns.
236
+ --output=<option> Specify output format: csv, json, or yaml.
237
+ <options: csv|json|yaml>
238
+ --sort=<value> Sort the table by a column. Use "-" for descending.
207
239
208
240
DESCRIPTION
209
241
Perform audits and fix possible errors in the exported Contentstack data.
@@ -228,16 +260,16 @@ EXAMPLES
228
260
229
261
_ See code: [ src/commands/cm/stacks/audit/fix.ts] ( https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts ) _
230
262
231
- ## ` csdx help [COMMANDS ] `
263
+ ## ` csdx help [COMMAND ] `
232
264
233
265
Display help for csdx.
234
266
235
267
```
236
268
USAGE
237
- $ csdx help [COMMANDS ] [-n]
269
+ $ csdx help [COMMAND... ] [-n]
238
270
239
271
ARGUMENTS
240
- COMMANDS Command to show help for.
272
+ COMMAND... Command to show help for.
241
273
242
274
FLAGS
243
275
-n, --nested-commands Include all nested commands in the output.
@@ -246,7 +278,7 @@ DESCRIPTION
246
278
Display help for csdx.
247
279
```
248
280
249
- _ See code: [ @oclif/plugin-help ] ( https://github.com/oclif/plugin-help/blob/v5 .2.20 /src/commands/help.ts ) _
281
+ _ See code: [ @oclif/plugin-help ] ( https://github.com/oclif/plugin-help/blob/v6 .2.27 /src/commands/help.ts ) _
250
282
251
283
## ` csdx plugins `
252
284
@@ -277,10 +309,10 @@ Installs a plugin into csdx.
277
309
278
310
```
279
311
USAGE
280
- $ csdx plugins:add PLUGIN [--json] [-f] [-h] [-s | -v]
312
+ $ csdx plugins:add PLUGIN... [--json] [-f] [-h] [-s | -v]
281
313
282
314
ARGUMENTS
283
- PLUGIN Plugin to install.
315
+ PLUGIN... Plugin to install.
284
316
285
317
FLAGS
286
318
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
@@ -327,7 +359,7 @@ USAGE
327
359
$ csdx plugins:inspect PLUGIN...
328
360
329
361
ARGUMENTS
330
- PLUGIN [default: .] Plugin to inspect.
362
+ PLUGIN... [default: .] Plugin to inspect.
331
363
332
364
FLAGS
333
365
-h, --help Show CLI help.
@@ -351,10 +383,10 @@ Installs a plugin into csdx.
351
383
352
384
```
353
385
USAGE
354
- $ csdx plugins:install PLUGIN [--json] [-f] [-h] [-s | -v]
386
+ $ csdx plugins:install PLUGIN... [--json] [-f] [-h] [-s | -v]
355
387
356
388
ARGUMENTS
357
- PLUGIN Plugin to install.
389
+ PLUGIN... Plugin to install.
358
390
359
391
FLAGS
360
392
-f, --force Force npm to fetch remote resources even if a local copy exists on disk.
@@ -406,9 +438,9 @@ ARGUMENTS
406
438
PATH [default: .] path to plugin
407
439
408
440
FLAGS
409
- -h, --help Show CLI help.
441
+ -h, --help Show CLI help.
410
442
-v, --verbose
411
- --[no-]install Install dependencies after linking the plugin.
443
+ --[no-]install Install dependencies after linking the plugin.
412
444
413
445
DESCRIPTION
414
446
Links a plugin into the CLI for development.
@@ -431,10 +463,10 @@ Removes a plugin from the CLI.
431
463
432
464
```
433
465
USAGE
434
- $ csdx plugins:remove [PLUGIN] [-h] [-v]
466
+ $ csdx plugins:remove [PLUGIN... ] [-h] [-v]
435
467
436
468
ARGUMENTS
437
- PLUGIN plugin to uninstall
469
+ PLUGIN... plugin to uninstall
438
470
439
471
FLAGS
440
472
-h, --help Show CLI help.
@@ -472,10 +504,10 @@ Removes a plugin from the CLI.
472
504
473
505
```
474
506
USAGE
475
- $ csdx plugins:uninstall [PLUGIN] [-h] [-v]
507
+ $ csdx plugins:uninstall [PLUGIN... ] [-h] [-v]
476
508
477
509
ARGUMENTS
478
- PLUGIN plugin to uninstall
510
+ PLUGIN... plugin to uninstall
479
511
480
512
FLAGS
481
513
-h, --help Show CLI help.
@@ -500,10 +532,10 @@ Removes a plugin from the CLI.
500
532
501
533
```
502
534
USAGE
503
- $ csdx plugins:unlink [PLUGIN] [-h] [-v]
535
+ $ csdx plugins:unlink [PLUGIN... ] [-h] [-v]
504
536
505
537
ARGUMENTS
506
- PLUGIN plugin to uninstall
538
+ PLUGIN... plugin to uninstall
507
539
508
540
FLAGS
509
541
-h, --help Show CLI help.
0 commit comments