@contentstack/cli 1.10.1 → 1.11.1
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 +89 -41
- package/oclif.manifest.json +1 -1
- 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.
|
|
21
|
+
@contentstack/cli/1.11.1 linux-x64 node-v18.18.2
|
|
22
22
|
$ csdx --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ csdx COMMAND
|
|
@@ -120,16 +120,20 @@ USAGE
|
|
|
120
120
|
--no-truncate]
|
|
121
121
|
|
|
122
122
|
FLAGS
|
|
123
|
+
--modules=<option>... Provide the list of modules to be audited
|
|
124
|
+
<options: content-types|global-fields|entries>
|
|
125
|
+
--report-path=<value> Path to store the audit reports
|
|
126
|
+
|
|
127
|
+
COMMON FLAGS
|
|
123
128
|
-c, --config=<value> Path of the external config
|
|
124
129
|
-d, --data-dir=<value> Path where the data is stored
|
|
125
|
-
|
|
126
|
-
|
|
127
|
-
--
|
|
128
|
-
--
|
|
129
|
-
|
|
130
|
-
--no-truncate
|
|
131
|
-
--
|
|
132
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
130
|
+
|
|
131
|
+
TABLE FLAGS
|
|
132
|
+
--columns=<value> Show only the specified columns (comma-separated)
|
|
133
|
+
--csv The output is in the CSV format [alias: --output=csv]
|
|
134
|
+
--filter=<value> Filter property by partial string matching. For example: name=foo
|
|
135
|
+
--no-truncate The output is not truncated to fit the screen
|
|
136
|
+
--sort=<value> Property to sort by (prepend '-' for descending)
|
|
133
137
|
|
|
134
138
|
DESCRIPTION
|
|
135
139
|
Perform audits and find possible errors in the exported Contentstack data
|
|
@@ -157,22 +161,29 @@ Perform audits and fix possible errors in the exported Contentstack data.
|
|
|
157
161
|
```
|
|
158
162
|
USAGE
|
|
159
163
|
$ csdx audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
|
|
160
|
-
content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--
|
|
161
|
-
[--
|
|
164
|
+
content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--fix-only
|
|
165
|
+
reference|global_field|json:rte|json:custom-field|blocks|group] [--columns <value> | ] [--sort <value>] [--filter
|
|
166
|
+
<value>] [--csv | --no-truncate]
|
|
162
167
|
|
|
163
168
|
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
169
|
--copy-dir Create backup from the original data.
|
|
168
170
|
--copy-path=<value> Provide the path to backup the copied data
|
|
169
|
-
--
|
|
170
|
-
|
|
171
|
+
--fix-only=<option>... Provide the list of fix options
|
|
172
|
+
<options: reference|global_field|json:rte|json:custom-field|blocks|group>
|
|
171
173
|
--modules=<option>... Provide the list of modules to be audited
|
|
172
174
|
<options: content-types|global-fields|entries>
|
|
173
|
-
--no-truncate do not truncate output to fit screen
|
|
174
175
|
--report-path=<value> Path to store the audit reports
|
|
175
|
-
|
|
176
|
+
|
|
177
|
+
COMMON FLAGS
|
|
178
|
+
-c, --config=<value> Path of the external config
|
|
179
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
180
|
+
|
|
181
|
+
TABLE FLAGS
|
|
182
|
+
--columns=<value> Show only the specified columns (comma-separated)
|
|
183
|
+
--csv The output is in the CSV format [alias: --output=csv]
|
|
184
|
+
--filter=<value> Filter property by partial string matching. For example: name=foo
|
|
185
|
+
--no-truncate The output is not truncated to fit the screen
|
|
186
|
+
--sort=<value> Property to sort by (prepend '-' for descending)
|
|
176
187
|
|
|
177
188
|
DESCRIPTION
|
|
178
189
|
Perform audits and fix possible errors in the exported Contentstack data.
|
|
@@ -188,6 +199,8 @@ EXAMPLES
|
|
|
188
199
|
|
|
189
200
|
$ csdx audit:fix --report-path=<path> --copy-dir --csv
|
|
190
201
|
|
|
202
|
+
$ csdx audit:fix --fix-only=reference,global_field --copy-dir
|
|
203
|
+
|
|
191
204
|
$ csdx audit:fix --report-path=<path> --filter="name=<filter-value>"
|
|
192
205
|
|
|
193
206
|
$ csdx audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
|
|
@@ -2014,28 +2027,32 @@ EXAMPLES
|
|
|
2014
2027
|
|
|
2015
2028
|
## `csdx cm:export-to-csv`
|
|
2016
2029
|
|
|
2017
|
-
Export entries or organization users to csv using this command
|
|
2030
|
+
Export entries, taxonomies, terms or organization users to csv using this command
|
|
2018
2031
|
|
|
2019
2032
|
```
|
|
2020
2033
|
USAGE
|
|
2021
|
-
$ csdx cm:export-to-csv [--action entries|users|teams] [-a <value>] [--org <value>] [-n <value>] [-k
|
|
2022
|
-
[--org-name <value>] [--locale <value>] [--content-type <value>] [--branch <value>] [--team-uid <value>]
|
|
2034
|
+
$ csdx cm:export-to-csv [--action entries|users|teams|taxonomies] [-a <value>] [--org <value>] [-n <value>] [-k
|
|
2035
|
+
<value>] [--org-name <value>] [--locale <value>] [--content-type <value>] [--branch <value>] [--team-uid <value>]
|
|
2036
|
+
[--taxonomy-uid <value>] [--delimiter <value>]
|
|
2023
2037
|
|
|
2024
2038
|
FLAGS
|
|
2025
2039
|
-a, --alias=<value> Alias of the management token
|
|
2026
2040
|
-k, --stack-api-key=<value> API key of the source stack
|
|
2027
2041
|
-n, --stack-name=<value> Name of the stack that needs to be created as csv filename.
|
|
2028
|
-
--action=<option> Option to export data (entries, users, teams)
|
|
2029
|
-
<options: entries|users|teams>
|
|
2042
|
+
--action=<option> Option to export data (entries, users, teams, taxonomies)
|
|
2043
|
+
<options: entries|users|teams|taxonomies>
|
|
2030
2044
|
--branch=<value> Branch from which entries need to be exported
|
|
2031
2045
|
--content-type=<value> Content type for which entries needs to be exported
|
|
2046
|
+
--delimiter=<value> [default: ,] [optional] Provide a delimiter to separate individual data fields within the
|
|
2047
|
+
CSV file.
|
|
2032
2048
|
--locale=<value> Locale for which entries need to be exported
|
|
2033
2049
|
--org=<value> Provide organization UID to clone org users
|
|
2034
2050
|
--org-name=<value> Name of the organization that needs to be created as csv filename.
|
|
2051
|
+
--taxonomy-uid=<value> Provide the taxonomy UID of the related terms you want to export
|
|
2035
2052
|
--team-uid=<value> Uid of the team whose user data and stack roles are required
|
|
2036
2053
|
|
|
2037
2054
|
DESCRIPTION
|
|
2038
|
-
Export entries or organization users to csv using this command
|
|
2055
|
+
Export entries, taxonomies, terms or organization users to csv using this command
|
|
2039
2056
|
|
|
2040
2057
|
EXAMPLES
|
|
2041
2058
|
$ csdx cm:export-to-csv
|
|
@@ -2093,6 +2110,24 @@ EXAMPLES
|
|
|
2093
2110
|
Exporting Organizations Teams to CSV with org-uid and team uid
|
|
2094
2111
|
|
|
2095
2112
|
$ csdx cm:export-to-csv --action <teams> --org <org-uid> --team-uid <team-uid> --org-name <org-name>
|
|
2113
|
+
|
|
2114
|
+
|
|
2115
|
+
|
|
2116
|
+
Exporting taxonomies and related terms to a .CSV file with the provided taxonomy UID
|
|
2117
|
+
|
|
2118
|
+
$ csdx cm:export-to-csv --action <taxonomies> --alias <management-token-alias> --taxonomy-uid <taxonomy-uid>
|
|
2119
|
+
|
|
2120
|
+
|
|
2121
|
+
|
|
2122
|
+
Exporting taxonomies and respective terms to a .CSV file
|
|
2123
|
+
|
|
2124
|
+
$ csdx cm:export-to-csv --action <taxonomies> --alias <management-token-alias>
|
|
2125
|
+
|
|
2126
|
+
|
|
2127
|
+
|
|
2128
|
+
Exporting taxonomies and respective terms to a .CSV file with a delimiter
|
|
2129
|
+
|
|
2130
|
+
$ csdx cm:export-to-csv --action <taxonomies> --alias <management-token-alias> --delimiter <delimiter>
|
|
2096
2131
|
```
|
|
2097
2132
|
|
|
2098
2133
|
_See code: [@contentstack/cli-cm-export-to-csv](https://github.com/contentstack/cli/blob/main/packages/contentstack-export-to-csv/src/commands/cm/export-to-csv.js)_
|
|
@@ -2337,16 +2372,20 @@ USAGE
|
|
|
2337
2372
|
--no-truncate]
|
|
2338
2373
|
|
|
2339
2374
|
FLAGS
|
|
2375
|
+
--modules=<option>... Provide the list of modules to be audited
|
|
2376
|
+
<options: content-types|global-fields|entries>
|
|
2377
|
+
--report-path=<value> Path to store the audit reports
|
|
2378
|
+
|
|
2379
|
+
COMMON FLAGS
|
|
2340
2380
|
-c, --config=<value> Path of the external config
|
|
2341
2381
|
-d, --data-dir=<value> Path where the data is stored
|
|
2342
|
-
|
|
2343
|
-
|
|
2344
|
-
--
|
|
2345
|
-
--
|
|
2346
|
-
|
|
2347
|
-
--no-truncate
|
|
2348
|
-
--
|
|
2349
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2382
|
+
|
|
2383
|
+
TABLE FLAGS
|
|
2384
|
+
--columns=<value> Show only the specified columns (comma-separated)
|
|
2385
|
+
--csv The output is in the CSV format [alias: --output=csv]
|
|
2386
|
+
--filter=<value> Filter property by partial string matching. For example: name=foo
|
|
2387
|
+
--no-truncate The output is not truncated to fit the screen
|
|
2388
|
+
--sort=<value> Property to sort by (prepend '-' for descending)
|
|
2350
2389
|
|
|
2351
2390
|
DESCRIPTION
|
|
2352
2391
|
Perform audits and find possible errors in the exported Contentstack data
|
|
@@ -2376,22 +2415,29 @@ Perform audits and fix possible errors in the exported Contentstack data.
|
|
|
2376
2415
|
```
|
|
2377
2416
|
USAGE
|
|
2378
2417
|
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
|
|
2379
|
-
content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--
|
|
2380
|
-
[--
|
|
2418
|
+
content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--fix-only
|
|
2419
|
+
reference|global_field|json:rte|json:custom-field|blocks|group] [--columns <value> | ] [--sort <value>] [--filter
|
|
2420
|
+
<value>] [--csv | --no-truncate]
|
|
2381
2421
|
|
|
2382
2422
|
FLAGS
|
|
2383
|
-
-c, --config=<value> Path of the external config
|
|
2384
|
-
-d, --data-dir=<value> Path where the data is stored
|
|
2385
|
-
--columns=<value> only show provided columns (comma-separated)
|
|
2386
2423
|
--copy-dir Create backup from the original data.
|
|
2387
2424
|
--copy-path=<value> Provide the path to backup the copied data
|
|
2388
|
-
--
|
|
2389
|
-
|
|
2425
|
+
--fix-only=<option>... Provide the list of fix options
|
|
2426
|
+
<options: reference|global_field|json:rte|json:custom-field|blocks|group>
|
|
2390
2427
|
--modules=<option>... Provide the list of modules to be audited
|
|
2391
2428
|
<options: content-types|global-fields|entries>
|
|
2392
|
-
--no-truncate do not truncate output to fit screen
|
|
2393
2429
|
--report-path=<value> Path to store the audit reports
|
|
2394
|
-
|
|
2430
|
+
|
|
2431
|
+
COMMON FLAGS
|
|
2432
|
+
-c, --config=<value> Path of the external config
|
|
2433
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
2434
|
+
|
|
2435
|
+
TABLE FLAGS
|
|
2436
|
+
--columns=<value> Show only the specified columns (comma-separated)
|
|
2437
|
+
--csv The output is in the CSV format [alias: --output=csv]
|
|
2438
|
+
--filter=<value> Filter property by partial string matching. For example: name=foo
|
|
2439
|
+
--no-truncate The output is not truncated to fit the screen
|
|
2440
|
+
--sort=<value> Property to sort by (prepend '-' for descending)
|
|
2395
2441
|
|
|
2396
2442
|
DESCRIPTION
|
|
2397
2443
|
Perform audits and fix possible errors in the exported Contentstack data.
|
|
@@ -2407,6 +2453,8 @@ EXAMPLES
|
|
|
2407
2453
|
|
|
2408
2454
|
$ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
|
|
2409
2455
|
|
|
2456
|
+
$ csdx cm:stacks:audit:fix --fix-only=reference,global_field --copy-dir
|
|
2457
|
+
|
|
2410
2458
|
$ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
|
|
2411
2459
|
|
|
2412
2460
|
$ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
|
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.11.1",
|
|
5
5
|
"author": "Contentstack",
|
|
6
6
|
"bin": {
|
|
7
7
|
"csdx": "./bin/run"
|
|
@@ -22,23 +22,23 @@
|
|
|
22
22
|
"prepack": "pnpm compile && oclif manifest && oclif readme"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@contentstack/cli-audit": "~1.
|
|
26
|
-
"@contentstack/cli-auth": "~1.3.
|
|
27
|
-
"@contentstack/cli-cm-bootstrap": "~1.6.
|
|
28
|
-
"@contentstack/cli-cm-branches": "~1.0.
|
|
29
|
-
"@contentstack/cli-cm-bulk-publish": "~1.3.
|
|
30
|
-
"@contentstack/cli-cm-clone": "~1.
|
|
31
|
-
"@contentstack/cli-cm-export": "~1.
|
|
32
|
-
"@contentstack/cli-cm-export-to-csv": "~1.
|
|
33
|
-
"@contentstack/cli-cm-import": "~1.
|
|
34
|
-
"@contentstack/cli-cm-migrate-rte": "~1.4.
|
|
35
|
-
"@contentstack/cli-cm-seed": "~1.6.
|
|
36
|
-
"@contentstack/cli-command": "~1.2.
|
|
37
|
-
"@contentstack/cli-config": "~1.4.
|
|
38
|
-
"@contentstack/cli-launch": "~1.0.
|
|
39
|
-
"@contentstack/cli-migration": "~1.
|
|
40
|
-
"@contentstack/cli-utilities": "~1.5.
|
|
41
|
-
"@contentstack/management": "~1.
|
|
25
|
+
"@contentstack/cli-audit": "~1.3.0",
|
|
26
|
+
"@contentstack/cli-auth": "~1.3.17",
|
|
27
|
+
"@contentstack/cli-cm-bootstrap": "~1.6.3",
|
|
28
|
+
"@contentstack/cli-cm-branches": "~1.0.17",
|
|
29
|
+
"@contentstack/cli-cm-bulk-publish": "~1.3.15",
|
|
30
|
+
"@contentstack/cli-cm-clone": "~1.7.1",
|
|
31
|
+
"@contentstack/cli-cm-export": "~1.10.1",
|
|
32
|
+
"@contentstack/cli-cm-export-to-csv": "~1.6.1",
|
|
33
|
+
"@contentstack/cli-cm-import": "~1.11.1",
|
|
34
|
+
"@contentstack/cli-cm-migrate-rte": "~1.4.15",
|
|
35
|
+
"@contentstack/cli-cm-seed": "~1.6.3",
|
|
36
|
+
"@contentstack/cli-command": "~1.2.16",
|
|
37
|
+
"@contentstack/cli-config": "~1.4.15",
|
|
38
|
+
"@contentstack/cli-launch": "~1.0.15",
|
|
39
|
+
"@contentstack/cli-migration": "~1.4.1",
|
|
40
|
+
"@contentstack/cli-utilities": "~1.5.7",
|
|
41
|
+
"@contentstack/management": "~1.12.0",
|
|
42
42
|
"@oclif/core": "^2.9.3",
|
|
43
43
|
"@oclif/plugin-help": "^5",
|
|
44
44
|
"@oclif/plugin-not-found": "^2.4.0",
|