@@ -19,11 +19,7 @@ $ npm install -g @contentstack/cli-audit
1919$ csdx COMMAND
2020running command...
2121$ csdx (--version| -v)
22- <<<<<<< HEAD
2322@contentstack/cli-audit/1.11.0 darwin-arm64 node-v22.14.0
24- =======
25- @contentstack/cli-audit/1.10.0 darwin-arm64 node-v22.13.1
26- >>>>>>> main
2723$ csdx --help [COMMAND]
2824USAGE
2925 $ csdx COMMAND
3430# Commands
3531
3632<!-- commands -->
37- * [ ` csdx audit ` ] ( #csdx-audit )
38- * [ ` csdx audit:fix ` ] ( #csdx-auditfix )
39- * [ ` csdx cm:stacks:audit ` ] ( #csdx-cmstacksaudit )
40- * [ ` csdx cm:stacks:audit:fix ` ] ( #csdx-cmstacksauditfix )
4133* [ ` csdx help [COMMAND] ` ] ( #csdx-help-command )
4234* [ ` csdx plugins ` ] ( #csdx-plugins )
4335* [ ` csdx plugins:add PLUGIN ` ] ( #csdx-pluginsadd-plugin )
@@ -50,220 +42,6 @@ USAGE
5042* [ ` csdx plugins:unlink [PLUGIN] ` ] ( #csdx-pluginsunlink-plugin )
5143* [ ` csdx plugins:update ` ] ( #csdx-pluginsupdate )
5244
53- ## ` csdx audit `
54-
55- Perform audits and find possible errors in the exported Contentstack data
56-
57- ```
58- USAGE
59- $ csdx audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
60- content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
61- [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
62-
63- FLAGS
64- --modules=<option>... Provide the list of modules to be audited
65- <options:
66- content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
67- --report-path=<value> Path to store the audit reports
68-
69- COMMON FLAGS
70- -c, --config=<value> Path of the external config
71- -d, --data-dir=<value> Path where the data is stored
72-
73- TABLE FLAGS
74- --columns=<value> Specify columns to display, comma-separated.
75- --csv Output results in CSV format.
76- --filter=<value> Filter rows by a column value (e.g., name=foo).
77- --no-header Hide table headers in output.
78- --no-truncate Prevent truncation of long text in columns.
79- --output=<option> Specify output format: csv, json, or yaml.
80- <options: csv|json|yaml>
81- --sort=<value> Sort the table by a column. Use "-" for descending.
82-
83- DESCRIPTION
84- Perform audits and find possible errors in the exported Contentstack data
85-
86- ALIASES
87- $ csdx audit
88- $ csdx cm:stacks:audit
89-
90- EXAMPLES
91- $ csdx audit
92-
93- $ csdx audit --report-path=<path>
94-
95- $ csdx audit --report-path=<path> --csv
96-
97- $ csdx audit --report-path=<path> --filter="name=<filter-value>"
98-
99- $ csdx audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
100- ```
101-
102- ## ` csdx audit:fix `
103-
104- Perform audits and fix possible errors in the exported Contentstack data.
105-
106- ```
107- USAGE
108- $ csdx audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
109- content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
110- --copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
111- <value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
112-
113- FLAGS
114- --copy-dir Create backup from the original data.
115- --copy-path=<value> Provide the path to backup the copied data
116- --fix-only=<option>... Provide the list of fix options
117- <options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
118- --modules=<option>... Provide the list of modules to be audited
119- <options:
120- content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
121- --report-path=<value> Path to store the audit reports
122-
123- COMMON FLAGS
124- -c, --config=<value> Path of the external config
125- -d, --data-dir=<value> Path where the data is stored
126-
127- TABLE FLAGS
128- --columns=<value> Specify columns to display, comma-separated.
129- --csv Output results in CSV format.
130- --filter=<value> Filter rows by a column value (e.g., name=foo).
131- --no-header Hide table headers in output.
132- --no-truncate Prevent truncation of long text in columns.
133- --output=<option> Specify output format: csv, json, or yaml.
134- <options: csv|json|yaml>
135- --sort=<value> Sort the table by a column. Use "-" for descending.
136-
137- DESCRIPTION
138- Perform audits and fix possible errors in the exported Contentstack data.
139-
140- ALIASES
141- $ csdx audit:fix
142- $ csdx cm:stacks:audit:fix
143-
144- EXAMPLES
145- $ csdx audit:fix --copy-dir
146-
147- $ csdx audit:fix --report-path=<path> --copy-dir
148-
149- $ csdx audit:fix --report-path=<path> --copy-dir --csv
150-
151- $ csdx audit:fix --fix-only=reference,global_field --copy-dir
152-
153- $ csdx audit:fix --report-path=<path> --filter="name=<filter-value>"
154-
155- $ csdx audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
156- ```
157-
158- ## ` csdx cm:stacks:audit `
159-
160- Perform audits and find possible errors in the exported Contentstack data
161-
162- ```
163- USAGE
164- $ csdx cm:stacks:audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
165- content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
166- [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
167-
168- FLAGS
169- --modules=<option>... Provide the list of modules to be audited
170- <options:
171- content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
172- --report-path=<value> Path to store the audit reports
173-
174- COMMON FLAGS
175- -c, --config=<value> Path of the external config
176- -d, --data-dir=<value> Path where the data is stored
177-
178- TABLE FLAGS
179- --columns=<value> Specify columns to display, comma-separated.
180- --csv Output results in CSV format.
181- --filter=<value> Filter rows by a column value (e.g., name=foo).
182- --no-header Hide table headers in output.
183- --no-truncate Prevent truncation of long text in columns.
184- --output=<option> Specify output format: csv, json, or yaml.
185- <options: csv|json|yaml>
186- --sort=<value> Sort the table by a column. Use "-" for descending.
187-
188- DESCRIPTION
189- Perform audits and find possible errors in the exported Contentstack data
190-
191- ALIASES
192- $ csdx audit
193- $ csdx cm:stacks:audit
194-
195- EXAMPLES
196- $ csdx cm:stacks:audit
197-
198- $ csdx cm:stacks:audit --report-path=<path>
199-
200- $ csdx cm:stacks:audit --report-path=<path> --csv
201-
202- $ csdx cm:stacks:audit --report-path=<path> --filter="name=<filter-value>"
203-
204- $ csdx cm:stacks:audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
205- ```
206-
207- _ See code: [ src/commands/cm/stacks/audit/index.ts] ( https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts ) _
208-
209- ## ` csdx cm:stacks:audit:fix `
210-
211- Perform audits and fix possible errors in the exported Contentstack data.
212-
213- ```
214- USAGE
215- $ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
216- content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
217- --copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
218- <value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
219-
220- FLAGS
221- --copy-dir Create backup from the original data.
222- --copy-path=<value> Provide the path to backup the copied data
223- --fix-only=<option>... Provide the list of fix options
224- <options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
225- --modules=<option>... Provide the list of modules to be audited
226- <options:
227- content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
228- --report-path=<value> Path to store the audit reports
229-
230- COMMON FLAGS
231- -c, --config=<value> Path of the external config
232- -d, --data-dir=<value> Path where the data is stored
233-
234- TABLE FLAGS
235- --columns=<value> Specify columns to display, comma-separated.
236- --csv Output results in CSV format.
237- --filter=<value> Filter rows by a column value (e.g., name=foo).
238- --no-header Hide table headers in output.
239- --no-truncate Prevent truncation of long text in columns.
240- --output=<option> Specify output format: csv, json, or yaml.
241- <options: csv|json|yaml>
242- --sort=<value> Sort the table by a column. Use "-" for descending.
243-
244- DESCRIPTION
245- Perform audits and fix possible errors in the exported Contentstack data.
246-
247- ALIASES
248- $ csdx audit:fix
249- $ csdx cm:stacks:audit:fix
250-
251- EXAMPLES
252- $ csdx cm:stacks:audit:fix --copy-dir
253-
254- $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir
255-
256- $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
257-
258- $ csdx cm:stacks:audit:fix --fix-only=reference,global_field --copy-dir
259-
260- $ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
261-
262- $ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
263- ```
264-
265- _ 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 ) _
266-
26745## ` csdx help [COMMAND] `
26846
26947Display help for csdx.
0 commit comments