@contentstack/cli 1.9.1 → 1.10.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 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.1 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
@@ -1957,20 +2018,21 @@ Export entries or organization users to csv using this command
1957
2018
 
1958
2019
  ```
1959
2020
  USAGE
1960
- $ csdx cm:export-to-csv [--action entries|users] [-a <value>] [--org <value>] [-n <value>] [-k <value>] [--org-name
1961
- <value>] [--locale <value>] [--content-type <value>] [--branch <value>]
2021
+ $ csdx cm:export-to-csv [--action entries|users|teams] [-a <value>] [--org <value>] [-n <value>] [-k <value>]
2022
+ [--org-name <value>] [--locale <value>] [--content-type <value>] [--branch <value>] [--team-uid <value>]
1962
2023
 
1963
2024
  FLAGS
1964
2025
  -a, --alias=<value> Alias of the management token
1965
2026
  -k, --stack-api-key=<value> API key of the source stack
1966
2027
  -n, --stack-name=<value> Name of the stack that needs to be created as csv filename.
1967
- --action=<option> Option to export data (entries, users)
1968
- <options: entries|users>
2028
+ --action=<option> Option to export data (entries, users, teams)
2029
+ <options: entries|users|teams>
1969
2030
  --branch=<value> Branch from which entries need to be exported
1970
2031
  --content-type=<value> Content type for which entries needs to be exported
1971
2032
  --locale=<value> Locale for which entries need to be exported
1972
2033
  --org=<value> Provide organization UID to clone org users
1973
2034
  --org-name=<value> Name of the organization that needs to be created as csv filename.
2035
+ --team-uid=<value> Uid of the team whose user data and stack roles are required
1974
2036
 
1975
2037
  DESCRIPTION
1976
2038
  Export entries or organization users to csv using this command
@@ -2001,6 +2063,36 @@ EXAMPLES
2001
2063
  Exporting organization users to csv with organization name provided
2002
2064
 
2003
2065
  $ csdx cm:export-to-csv --action <users> --org <org-uid> --org-name <org-name>
2066
+
2067
+
2068
+
2069
+ Exporting Organizations Teams to CSV
2070
+
2071
+ $ csdx cm:export-to-csv --action <teams>
2072
+
2073
+
2074
+
2075
+ Exporting Organizations Teams to CSV with org-uid
2076
+
2077
+ $ csdx cm:export-to-csv --action <teams> --org <org-uid>
2078
+
2079
+
2080
+
2081
+ Exporting Organizations Teams to CSV with team uid
2082
+
2083
+ $ csdx cm:export-to-csv --action <teams> --team-uid <team-uid>
2084
+
2085
+
2086
+
2087
+ Exporting Organizations Teams to CSV with org-uid and team uid
2088
+
2089
+ $ csdx cm:export-to-csv --action <teams> --org <org-uid> --team-uid <team-uid>
2090
+
2091
+
2092
+
2093
+ Exporting Organizations Teams to CSV with org-uid and team uid
2094
+
2095
+ $ csdx cm:export-to-csv --action <teams> --org <org-uid> --team-uid <team-uid> --org-name <org-name>
2004
2096
  ```
2005
2097
 
2006
2098
  _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)_
@@ -2025,6 +2117,8 @@ FLAGS
2025
2117
  -y, --yes [optional] Override marketplace prompts
2026
2118
  --import-webhook-status=<option> [default: disable] [optional] Webhook state
2027
2119
  <options: disable|current>
2120
+ --replace-existing Replaces the existing module in the target stack.
2121
+ --skip-existing Skips the module exists warning messages.
2028
2122
 
2029
2123
  DESCRIPTION
2030
2124
  Import content from a stack
@@ -2243,21 +2337,22 @@ USAGE
2243
2337
  --no-truncate]
2244
2338
 
2245
2339
  FLAGS
2246
- -c, --config=<value> Path of the external config.
2247
- -d, --data-dir=<value> Path where the data is stored.
2340
+ -c, --config=<value> Path of the external config
2341
+ -d, --data-dir=<value> Path where the data is stored
2248
2342
  --columns=<value> only show provided columns (comma-separated)
2249
2343
  --csv output is csv format [alias: --output=csv]
2250
2344
  --filter=<value> filter property by partial string matching, ex: name=foo
2251
- --modules=<option>... Provide the list of modules to be audited.
2345
+ --modules=<option>... Provide the list of modules to be audited
2252
2346
  <options: content-types|global-fields|entries>
2253
2347
  --no-truncate do not truncate output to fit screen
2254
- --report-path=<value> Path to store the audit reports.
2348
+ --report-path=<value> Path to store the audit reports
2255
2349
  --sort=<value> property to sort by (prepend '-' for descending)
2256
2350
 
2257
2351
  DESCRIPTION
2258
2352
  Perform audits and find possible errors in the exported Contentstack data
2259
2353
 
2260
2354
  ALIASES
2355
+ $ csdx audit
2261
2356
  $ csdx cm:stacks:audit
2262
2357
 
2263
2358
  EXAMPLES
@@ -2276,24 +2371,45 @@ _See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/
2276
2371
 
2277
2372
  ## `csdx cm:stacks:audit:fix`
2278
2373
 
2279
- Audit fix command
2374
+ Perform audits and fix possible errors in the exported Contentstack data.
2280
2375
 
2281
2376
  ```
2282
2377
  USAGE
2283
- $ csdx cm:stacks:audit:fix [-c <value>] [-d <value>]
2378
+ $ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
2379
+ content-types|global-fields|entries] [--copy-path <value> --copy-dir] [--columns <value> | ] [--sort <value>]
2380
+ [--filter <value>] [--csv | --no-truncate]
2284
2381
 
2285
2382
  FLAGS
2286
- -c, --config=<value> Path of the external config.
2287
- -d, --data-dir=<value> Path where the data is stored.
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
+ --copy-dir Create backup from the original data.
2387
+ --copy-path=<value> Provide the path to backup the copied data
2388
+ --csv output is csv format [alias: --output=csv]
2389
+ --filter=<value> filter property by partial string matching, ex: name=foo
2390
+ --modules=<option>... Provide the list of modules to be audited
2391
+ <options: content-types|global-fields|entries>
2392
+ --no-truncate do not truncate output to fit screen
2393
+ --report-path=<value> Path to store the audit reports
2394
+ --sort=<value> property to sort by (prepend '-' for descending)
2288
2395
 
2289
2396
  DESCRIPTION
2290
- Audit fix command
2397
+ Perform audits and fix possible errors in the exported Contentstack data.
2291
2398
 
2292
2399
  ALIASES
2293
- $ csdx cm::stacks:audit:fix
2400
+ $ csdx audit:fix
2401
+ $ csdx cm:stacks:audit:fix
2294
2402
 
2295
2403
  EXAMPLES
2296
- $ csdx cm:stacks:audit:fix
2404
+ $ csdx cm:stacks:audit:fix --copy-dir
2405
+
2406
+ $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir
2407
+
2408
+ $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
2409
+
2410
+ $ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
2411
+
2412
+ $ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
2297
2413
  ```
2298
2414
 
2299
2415
  _See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
@@ -2413,6 +2529,8 @@ FLAGS
2413
2529
  -y, --yes [optional] Override marketplace prompts
2414
2530
  --import-webhook-status=<option> [default: disable] [optional] Webhook state
2415
2531
  <options: disable|current>
2532
+ --replace-existing Replaces the existing module in the target stack.
2533
+ --skip-existing Skips the module exists warning messages.
2416
2534
 
2417
2535
  DESCRIPTION
2418
2536
  Import content from a stack
@@ -1,4 +1,4 @@
1
1
  {
2
- "version": "1.9.1",
2
+ "version": "1.10.1",
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.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.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",
41
- "@contentstack/management": "~1.10.0",
25
+ "@contentstack/cli-audit": "~1.2.1",
26
+ "@contentstack/cli-auth": "~1.3.16",
27
+ "@contentstack/cli-cm-bootstrap": "~1.6.1",
28
+ "@contentstack/cli-cm-branches": "~1.0.16",
29
+ "@contentstack/cli-cm-bulk-publish": "~1.3.14",
30
+ "@contentstack/cli-cm-clone": "~1.6.1",
31
+ "@contentstack/cli-cm-export": "~1.9.3",
32
+ "@contentstack/cli-cm-export-to-csv": "~1.5.0",
33
+ "@contentstack/cli-cm-import": "~1.10.1",
34
+ "@contentstack/cli-cm-migrate-rte": "~1.4.14",
35
+ "@contentstack/cli-cm-seed": "~1.6.1",
36
+ "@contentstack/cli-command": "~1.2.15",
37
+ "@contentstack/cli-config": "~1.4.14",
38
+ "@contentstack/cli-launch": "~1.0.14",
39
+ "@contentstack/cli-migration": "~1.3.15",
40
+ "@contentstack/cli-utilities": "~1.5.5",
41
+ "@contentstack/management": "~1.11.0",
42
42
  "@oclif/core": "^2.9.3",
43
43
  "@oclif/plugin-help": "^5",
44
44
  "@oclif/plugin-not-found": "^2.4.0",
@@ -160,4 +160,4 @@
160
160
  }
161
161
  },
162
162
  "repository": "https://github.com/contentstack/cli"
163
- }
163
+ }