@contentstack/cli 1.2.5 → 1.3.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.
- package/README.md +1304 -221
- package/bin/run +2 -2
- package/lib/hooks/prerun/auth-guard.js +5 -4
- package/lib/index.js +1 -3
- package/oclif.manifest.json +4 -1
- package/package.json +28 -27
package/README.md
CHANGED
|
@@ -17,8 +17,8 @@ Use Contentstack Command-line Interface to command Contentstack for executing a
|
|
|
17
17
|
$ npm install -g @contentstack/cli
|
|
18
18
|
$ csdx COMMAND
|
|
19
19
|
running command...
|
|
20
|
-
$ csdx (
|
|
21
|
-
@contentstack/cli/1.
|
|
20
|
+
$ csdx (--version|-v)
|
|
21
|
+
@contentstack/cli/1.3.0 linux-x64 node-v16.19.0
|
|
22
22
|
$ csdx --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ csdx COMMAND
|
|
@@ -39,33 +39,57 @@ USAGE
|
|
|
39
39
|
* [`csdx cm:assets:unpublish`](#csdx-cmassetsunpublish)
|
|
40
40
|
* [`csdx cm:bootstrap`](#csdx-cmbootstrap)
|
|
41
41
|
* [`csdx cm:bulk-publish`](#csdx-cmbulk-publish)
|
|
42
|
+
* [`csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value)
|
|
43
|
+
* [`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-1)
|
|
44
|
+
* [`csdx cm:bulk-publish:clear`](#csdx-cmbulk-publishclear)
|
|
45
|
+
* [`csdx cm:bulk-publish:configure`](#csdx-cmbulk-publishconfigure)
|
|
42
46
|
* [`csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries]`](#csdx-cmbulk-publishcross-publish--a-value---retry-failed-value---bulk-publish-value---content-type-value---locales-value---source-env-value---environments-value---delivery-token-value--c-value--y---branch-value---onlyassets---onlyentries)
|
|
43
|
-
* [`csdx cm:entries:migrate-html-rte`](#csdx-cmentriesmigrate-html-rte)
|
|
44
47
|
* [`csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value)
|
|
45
48
|
* [`csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value)
|
|
46
49
|
* [`csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value)
|
|
50
|
+
* [`csdx cm:bulk-publish:revert`](#csdx-cmbulk-publishrevert)
|
|
51
|
+
* [`csdx csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>] [--only-assets] [--only-entries]`](#csdx-csdx-cmstacksunpublish--a-value--e-value--c-value--y---locale-value---branch-value---retry-failed-value---bulk-unpublish-value---content-type-value---delivery-token-value---only-assets---only-entries)
|
|
47
52
|
* [`csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-only-unpublished--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value)
|
|
53
|
+
* [`csdx cm:entries:migrate-html-rte`](#csdx-cmentriesmigrate-html-rte)
|
|
54
|
+
* [`csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value-1)
|
|
55
|
+
* [`csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value-1)
|
|
56
|
+
* [`csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value-1)
|
|
57
|
+
* [`csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-only-unpublished--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value-1)
|
|
48
58
|
* [`csdx cm:entries:unpublish`](#csdx-cmentriesunpublish)
|
|
49
|
-
* [`csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value)
|
|
50
|
-
* [`csdx cm:export-to-csv`](#csdx-cmexport-to-csv)
|
|
51
|
-
* [`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)
|
|
59
|
+
* [`csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value-1)
|
|
52
60
|
* [`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)
|
|
61
|
+
* [`csdx cm:export-to-csv`](#csdx-cmexport-to-csv)
|
|
53
62
|
* [`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)
|
|
63
|
+
* [`csdx cm:migrate-rte`](#csdx-cmmigrate-rte)
|
|
54
64
|
* [`csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple)
|
|
65
|
+
* [`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)
|
|
66
|
+
* [`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)
|
|
67
|
+
* [`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)
|
|
68
|
+
* [`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)
|
|
69
|
+
* [`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)
|
|
70
|
+
* [`csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple-1)
|
|
55
71
|
* [`csdx cm:stacks:publish`](#csdx-cmstackspublish)
|
|
56
72
|
* [`csdx cm:stacks:publish-clear-logs`](#csdx-cmstackspublish-clear-logs)
|
|
57
73
|
* [`csdx cm:stacks:publish-configure`](#csdx-cmstackspublish-configure)
|
|
58
74
|
* [`csdx cm:stacks:publish-revert`](#csdx-cmstackspublish-revert)
|
|
59
|
-
* [`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)
|
|
60
|
-
* [`csdx csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>] [--only-assets] [--only-entries]`](#csdx-csdx-cmstacksunpublish--a-value--e-value--c-value--y---locale-value---branch-value---retry-failed-value---bulk-unpublish-value---content-type-value---delivery-token-value---only-assets---only-entries)
|
|
75
|
+
* [`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-1)
|
|
76
|
+
* [`csdx csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>] [--only-assets] [--only-entries]`](#csdx-csdx-cmstacksunpublish--a-value--e-value--c-value--y---locale-value---branch-value---retry-failed-value---bulk-unpublish-value---content-type-value---delivery-token-value---only-assets---only-entries-1)
|
|
61
77
|
* [`csdx config:get:region`](#csdx-configgetregion)
|
|
62
78
|
* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
|
|
79
|
+
* [`csdx help [COMMANDS]`](#csdx-help-commands)
|
|
80
|
+
* [`csdx login`](#csdx-login)
|
|
81
|
+
* [`csdx logout`](#csdx-logout)
|
|
63
82
|
* [`csdx plugins`](#csdx-plugins)
|
|
64
|
-
* [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
|
|
65
83
|
* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin)
|
|
84
|
+
* [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
|
|
85
|
+
* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin-1)
|
|
66
86
|
* [`csdx plugins:link PLUGIN`](#csdx-pluginslink-plugin)
|
|
67
87
|
* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin)
|
|
88
|
+
* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-1)
|
|
89
|
+
* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-2)
|
|
68
90
|
* [`csdx plugins:update`](#csdx-pluginsupdate)
|
|
91
|
+
* [`csdx tokens`](#csdx-tokens)
|
|
92
|
+
* [`csdx whoami`](#csdx-whoami)
|
|
69
93
|
|
|
70
94
|
## `csdx auth:login`
|
|
71
95
|
|
|
@@ -132,8 +156,8 @@ Lists all existing tokens added to the session
|
|
|
132
156
|
|
|
133
157
|
```
|
|
134
158
|
USAGE
|
|
135
|
-
$ csdx auth:tokens [--columns <value>] [--sort <value>] [--filter <value>] [--
|
|
136
|
-
[
|
|
159
|
+
$ csdx auth:tokens [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
|
|
160
|
+
[--csv | --no-truncate]] [--no-header | ]
|
|
137
161
|
|
|
138
162
|
FLAGS
|
|
139
163
|
-x, --extended show extra columns
|
|
@@ -257,19 +281,20 @@ USAGE
|
|
|
257
281
|
<value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]
|
|
258
282
|
|
|
259
283
|
FLAGS
|
|
260
|
-
-B, --branch=<value>
|
|
261
|
-
|
|
262
|
-
-a, --alias=<value>
|
|
263
|
-
-c, --config=<value>
|
|
264
|
-
-e, --environments=<value
|
|
265
|
-
-l, --locales=<value
|
|
266
|
-
-y, --yes
|
|
267
|
-
--bulk-publish=<value>
|
|
268
|
-
|
|
269
|
-
--delivery-token=<value>
|
|
270
|
-
--folder-uid=<value>
|
|
271
|
-
--retry-failed=<value>
|
|
272
|
-
|
|
284
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
285
|
+
selected)
|
|
286
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
287
|
+
-c, --config=<value> Path to the config file
|
|
288
|
+
-e, --environments=<value>... Environments where assets will be published
|
|
289
|
+
-l, --locales=<value>... Locales to where assets will be published
|
|
290
|
+
-y, --yes Agree to process the command with the current configuration
|
|
291
|
+
--bulk-publish=<value> [default: true] By default this flag is set as true. It indicates that contentstack's
|
|
292
|
+
bulkpublish API will be used to publish the assets
|
|
293
|
+
--delivery-token=<value> Delivery token for source environment
|
|
294
|
+
--folder-uid=<value> [default: cs_root] Folder-uid from where the assets will be published
|
|
295
|
+
--retry-failed=<value> Retry publishing failed assets from the logfile (optional, will override all other
|
|
296
|
+
flags)
|
|
297
|
+
--source-env=<value> Source environment
|
|
273
298
|
|
|
274
299
|
DESCRIPTION
|
|
275
300
|
Publish assets to the specified environments
|
|
@@ -383,7 +408,7 @@ Bootstrap contentstack apps
|
|
|
383
408
|
|
|
384
409
|
```
|
|
385
410
|
USAGE
|
|
386
|
-
$ csdx cm:bootstrap [--app-name <value>] [--project-dir <value>] [-k <value>
|
|
411
|
+
$ csdx cm:bootstrap [--app-name <value>] [--project-dir <value>] [-k <value> | --org <value> | -n <value>] [-y
|
|
387
412
|
<value>]
|
|
388
413
|
|
|
389
414
|
FLAGS
|
|
@@ -427,132 +452,261 @@ DESCRIPTION
|
|
|
427
452
|
|
|
428
453
|
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/index.js)_
|
|
429
454
|
|
|
430
|
-
## `csdx cm:
|
|
455
|
+
## `csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]`
|
|
431
456
|
|
|
432
|
-
|
|
457
|
+
Add fields from updated content types to their respective entries
|
|
433
458
|
|
|
434
459
|
```
|
|
435
460
|
USAGE
|
|
436
|
-
$ csdx cm:
|
|
437
|
-
<value>] [
|
|
438
|
-
[-y] [--branch <value>] [--onlyAssets] [--onlyEntries]
|
|
461
|
+
$ csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types
|
|
462
|
+
<value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
|
|
439
463
|
|
|
440
464
|
FLAGS
|
|
441
|
-
-B, --branch=<value>
|
|
442
|
-
|
|
443
|
-
-a, --alias=<value>
|
|
444
|
-
-c, --config=<value>
|
|
445
|
-
-
|
|
446
|
-
--
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
--
|
|
450
|
-
|
|
451
|
-
--
|
|
452
|
-
--
|
|
453
|
-
--
|
|
454
|
-
--retry-failed=<value> (optional) Retry publishing failed entries from the logfile (this flag overrides all other
|
|
455
|
-
flags)
|
|
456
|
-
--source-env=<value> Source Env
|
|
465
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
466
|
+
selected)
|
|
467
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
468
|
+
-c, --config=<value> Path to the config file
|
|
469
|
+
-e, --environments=<value>... Environments where entries will be published
|
|
470
|
+
-l, --locales=<value>... Locales where entries will be published
|
|
471
|
+
-t, --contentTypes=<value>... The Contenttypes from which entries will be published
|
|
472
|
+
-y, --yes Agree to process the command with the current configuration
|
|
473
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
474
|
+
bulkpublish API will be used to publish the entries
|
|
475
|
+
--content-types=<value>... The Contenttypes from which entries will be published
|
|
476
|
+
--force Update and publish all entries even if no fields have been added
|
|
477
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
457
478
|
|
|
458
479
|
DESCRIPTION
|
|
459
|
-
|
|
460
|
-
The
|
|
480
|
+
Add fields from updated content types to their respective entries
|
|
481
|
+
The update-and-publish command is used to update existing entries with the updated schema of the respective content
|
|
482
|
+
type
|
|
461
483
|
|
|
462
|
-
Note: Content
|
|
463
|
-
|
|
484
|
+
Note: Content types, Environments and Locales are required to execute the command successfully
|
|
485
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
ALIASES
|
|
489
|
+
$ csdx cm:bulk-publish:add-fields
|
|
490
|
+
|
|
491
|
+
EXAMPLES
|
|
492
|
+
General Usage
|
|
493
|
+
|
|
494
|
+
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locale [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
|
|
498
|
+
Using --config or -c flag
|
|
499
|
+
|
|
500
|
+
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
501
|
+
|
|
502
|
+
$ csdx cm:entries:update-and-publish --config [PATH TO CONFIG FILE]
|
|
503
|
+
|
|
504
|
+
$ csdx cm:entries:update-and-publish -c [PATH TO CONFIG FILE]
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
Using --retry-failed
|
|
509
|
+
|
|
510
|
+
$ csdx cm:entries:update-and-publish --retry-failed [LOG FILE NAME]
|
|
511
|
+
|
|
512
|
+
|
|
513
|
+
|
|
514
|
+
Using --branch
|
|
515
|
+
|
|
516
|
+
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locale [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
517
|
+
```
|
|
518
|
+
|
|
519
|
+
## `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>]`
|
|
520
|
+
|
|
521
|
+
Publish assets to the specified environments
|
|
522
|
+
|
|
523
|
+
```
|
|
524
|
+
USAGE
|
|
525
|
+
$ csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish
|
|
526
|
+
<value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]
|
|
527
|
+
|
|
528
|
+
FLAGS
|
|
529
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
530
|
+
selected)
|
|
531
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
532
|
+
-c, --config=<value> Path to the config file
|
|
533
|
+
-e, --environments=<value>... Environments where assets will be published
|
|
534
|
+
-l, --locales=<value>... Locales to where assets will be published
|
|
535
|
+
-y, --yes Agree to process the command with the current configuration
|
|
536
|
+
--bulk-publish=<value> [default: true] By default this flag is set as true. It indicates that contentstack's
|
|
537
|
+
bulkpublish API will be used to publish the assets
|
|
538
|
+
--delivery-token=<value> Delivery token for source environment
|
|
539
|
+
--folder-uid=<value> [default: cs_root] Folder-uid from where the assets will be published
|
|
540
|
+
--retry-failed=<value> Retry publishing failed assets from the logfile (optional, will override all other
|
|
541
|
+
flags)
|
|
542
|
+
--source-env=<value> Source environment
|
|
543
|
+
|
|
544
|
+
DESCRIPTION
|
|
545
|
+
Publish assets to the specified environments
|
|
546
|
+
The assets command is used to publish assets from the specified stack, to the specified environments
|
|
547
|
+
|
|
548
|
+
Note: Environment(s) and Locale(s) are required to execute the command successfully
|
|
464
549
|
But, if retryFailed flag is set, then only a logfile is required
|
|
465
550
|
|
|
466
551
|
|
|
552
|
+
ALIASES
|
|
553
|
+
$ csdx cm:bulk-publish:assets
|
|
554
|
+
|
|
467
555
|
EXAMPLES
|
|
468
556
|
General Usage
|
|
469
557
|
|
|
470
|
-
$ csdx cm:
|
|
558
|
+
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]
|
|
471
559
|
|
|
472
560
|
|
|
473
561
|
|
|
474
562
|
Using --config or -c flag
|
|
475
563
|
|
|
476
|
-
Generate a config file at the current working directory using `csdx cm:
|
|
564
|
+
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
477
565
|
|
|
478
|
-
$ csdx cm:
|
|
566
|
+
$ csdx cm:assets:publish --config [PATH TO CONFIG FILE]
|
|
479
567
|
|
|
480
|
-
$ csdx cm:
|
|
568
|
+
$ csdx cm:assets:publish -c [PATH TO CONFIG FILE]
|
|
481
569
|
|
|
482
570
|
|
|
483
571
|
|
|
484
572
|
Using --retry-failed flag
|
|
485
573
|
|
|
486
|
-
$ csdx cm:
|
|
487
|
-
|
|
488
|
-
$ csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]
|
|
574
|
+
$ csdx cm:assets:publish --retry-failed [LOG FILE NAME]
|
|
489
575
|
|
|
490
576
|
|
|
491
577
|
|
|
492
578
|
Using --branch flag
|
|
493
579
|
|
|
494
|
-
$ csdx cm:
|
|
580
|
+
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
Using --source-env
|
|
585
|
+
|
|
586
|
+
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
495
587
|
```
|
|
496
588
|
|
|
497
|
-
|
|
589
|
+
## `csdx cm:bulk-publish:clear`
|
|
498
590
|
|
|
499
|
-
|
|
591
|
+
Clear the log folder
|
|
500
592
|
|
|
501
|
-
|
|
593
|
+
```
|
|
594
|
+
USAGE
|
|
595
|
+
$ csdx cm:bulk-publish:clear [--log-files-count] [-y]
|
|
596
|
+
|
|
597
|
+
FLAGS
|
|
598
|
+
-y, --yes Delete all files without asking for confirmation
|
|
599
|
+
--log-files-count List number of log files
|
|
600
|
+
|
|
601
|
+
DESCRIPTION
|
|
602
|
+
Clear the log folder
|
|
603
|
+
|
|
604
|
+
ALIASES
|
|
605
|
+
$ csdx cm:bulk-publish:clear
|
|
606
|
+
|
|
607
|
+
EXAMPLES
|
|
608
|
+
$ csdx cm:stacks:publish-clear-logs
|
|
609
|
+
|
|
610
|
+
$ csdx cm:stacks:publish-clear-logs --log-files-count
|
|
611
|
+
|
|
612
|
+
$ csdx cm:stacks:publish-clear-logs --yes
|
|
613
|
+
|
|
614
|
+
$ csdx cm:stacks:publish-clear-logs -y
|
|
615
|
+
```
|
|
616
|
+
|
|
617
|
+
## `csdx cm:bulk-publish:configure`
|
|
618
|
+
|
|
619
|
+
The configure command is used to generate a configuration file for publish scripts.
|
|
502
620
|
|
|
503
621
|
```
|
|
504
622
|
USAGE
|
|
505
|
-
$ csdx cm:
|
|
506
|
-
|
|
623
|
+
$ csdx cm:bulk-publish:configure [-a <value>]
|
|
624
|
+
|
|
625
|
+
FLAGS
|
|
626
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
627
|
+
|
|
628
|
+
DESCRIPTION
|
|
629
|
+
The configure command is used to generate a configuration file for publish scripts.
|
|
630
|
+
|
|
631
|
+
ALIASES
|
|
632
|
+
$ csdx cm:bulk-publish:configure
|
|
633
|
+
|
|
634
|
+
EXAMPLES
|
|
635
|
+
$ csdx cm:stacks:publish-configure
|
|
636
|
+
|
|
637
|
+
$ csdx cm:stacks:publish-configure -a <management_token_alias>
|
|
638
|
+
|
|
639
|
+
$ csdx cm:stacks:publish-configure --alias <management_token_alias>
|
|
640
|
+
```
|
|
641
|
+
|
|
642
|
+
## `csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries]`
|
|
643
|
+
|
|
644
|
+
Publish entries and assets from one environment to other environments
|
|
645
|
+
|
|
646
|
+
```
|
|
647
|
+
USAGE
|
|
648
|
+
$ csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type
|
|
649
|
+
<value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>]
|
|
650
|
+
[-y] [--branch <value>] [--onlyAssets] [--onlyEntries]
|
|
507
651
|
|
|
508
652
|
FLAGS
|
|
653
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
654
|
+
selected)
|
|
509
655
|
-a, --alias=<value> Alias(name) for the management token
|
|
510
|
-
-c, --config
|
|
656
|
+
-c, --config=<value> Path to the config file
|
|
511
657
|
-y, --yes Agree to process the command with the current configuration
|
|
512
|
-
--
|
|
513
|
-
|
|
514
|
-
--
|
|
515
|
-
--
|
|
516
|
-
|
|
517
|
-
--
|
|
518
|
-
--
|
|
519
|
-
--
|
|
658
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
659
|
+
bulkpublish API will be used to publish the entries
|
|
660
|
+
--content-type=<value>... The Contenttypes from which entries will be published
|
|
661
|
+
--delivery-token=<value> Delivery token for source environment
|
|
662
|
+
--environments=<value>... Destination Environments
|
|
663
|
+
--locales=<value> Source locale
|
|
664
|
+
--onlyAssets Unpublish only assets
|
|
665
|
+
--onlyEntries Unpublish only entries
|
|
666
|
+
--retry-failed=<value> (optional) Retry publishing failed entries from the logfile (this flag overrides all other
|
|
667
|
+
flags)
|
|
668
|
+
--source-env=<value> Source Env
|
|
520
669
|
|
|
521
670
|
DESCRIPTION
|
|
522
|
-
|
|
671
|
+
Publish entries and assets from one environment to other environments
|
|
672
|
+
The cross-publish command is used to publish entries and assets from one environment to other environments
|
|
673
|
+
|
|
674
|
+
Note: Content Type, Environment, Destination Environment(s) and Locale are required to execute the command
|
|
675
|
+
successfully
|
|
676
|
+
But, if retryFailed flag is set, then only a logfile is required
|
|
523
677
|
|
|
524
|
-
ALIASES
|
|
525
|
-
$ csdx cm:migrate-rte
|
|
526
678
|
|
|
527
679
|
EXAMPLES
|
|
528
680
|
General Usage
|
|
529
681
|
|
|
530
|
-
$ csdx cm:
|
|
682
|
+
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] -a [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
|
|
531
683
|
|
|
532
684
|
|
|
533
685
|
|
|
534
|
-
Using
|
|
686
|
+
Using --config or -c flag
|
|
535
687
|
|
|
536
|
-
|
|
688
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
537
689
|
|
|
690
|
+
$ csdx cm:bulk-publish:cross-publish --config [PATH TO CONFIG FILE]
|
|
538
691
|
|
|
692
|
+
$ csdx cm:bulk-publish:cross-publish -c [PATH TO CONFIG FILE]
|
|
539
693
|
|
|
540
|
-
Nested RTE
|
|
541
694
|
|
|
542
|
-
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path modular_block_uid.block_uid.html_rte_uid --json-path modular_block_uid.block_uid.json_rte_uid
|
|
543
695
|
|
|
696
|
+
Using --retry-failed flag
|
|
544
697
|
|
|
698
|
+
$ csdx cm:bulk-publish:cross-publish --retry-failed [LOG FILE NAME]
|
|
545
699
|
|
|
546
|
-
$ csdx cm:
|
|
700
|
+
$ csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]
|
|
547
701
|
|
|
548
702
|
|
|
549
703
|
|
|
550
|
-
|
|
704
|
+
Using --branch flag
|
|
551
705
|
|
|
552
|
-
$ csdx cm:
|
|
706
|
+
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] -a [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
553
707
|
```
|
|
554
708
|
|
|
555
|
-
_See code: [@contentstack/cli-cm-
|
|
709
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js)_
|
|
556
710
|
|
|
557
711
|
## `csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`
|
|
558
712
|
|
|
@@ -565,23 +719,23 @@ USAGE
|
|
|
565
719
|
<value>] [--delivery-token <value>] [--source-env <value>]
|
|
566
720
|
|
|
567
721
|
FLAGS
|
|
568
|
-
-B, --branch=<value>
|
|
569
|
-
|
|
570
|
-
-a, --alias=<value>
|
|
571
|
-
-c, --config=<value>
|
|
572
|
-
|
|
573
|
-
-e, --environments=<value
|
|
574
|
-
-l, --locales=<value
|
|
575
|
-
-y, --yes
|
|
576
|
-
--bulk-publish=<value>
|
|
577
|
-
|
|
578
|
-
--content-types=<value
|
|
579
|
-
--delivery-token=<value>
|
|
580
|
-
--publish-all-content-types
|
|
581
|
-
--retry-failed=<value>
|
|
582
|
-
|
|
583
|
-
|
|
584
|
-
--source-env=<value>
|
|
722
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
723
|
+
selected)
|
|
724
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
725
|
+
-c, --config=<value> Path for the external config file (A new config file can be generated at the current
|
|
726
|
+
working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
|
|
727
|
+
-e, --environments=<value>... Environments where entries will be published
|
|
728
|
+
-l, --locales=<value>... Locales where entries will be published
|
|
729
|
+
-y, --yes Agree to process the command with the current configuration
|
|
730
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
731
|
+
bulkpublish API will be used to publish the entries
|
|
732
|
+
--content-types=<value>... The Contenttypes from which entries need to be published
|
|
733
|
+
--delivery-token=<value> Delivery token for source environment
|
|
734
|
+
--publish-all-content-types (optional) Publish all contenttypes (cannot be set when contentTypes flag is set)
|
|
735
|
+
--retry-failed=<value> (optional) Retry failed entries from the logfile (overrides all other flags) This flag
|
|
736
|
+
is used to retry publishing entries that failed to publish in a previous attempt. A log
|
|
737
|
+
file for the previous session will be required for processing the failed entries
|
|
738
|
+
--source-env=<value> Source environment
|
|
585
739
|
|
|
586
740
|
DESCRIPTION
|
|
587
741
|
Publish entries from multiple contenttypes to multiple environments and locales
|
|
@@ -631,8 +785,6 @@ EXAMPLES
|
|
|
631
785
|
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
632
786
|
```
|
|
633
787
|
|
|
634
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js)_
|
|
635
|
-
|
|
636
788
|
## `csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
637
789
|
|
|
638
790
|
Publish edited entries from a specified content type to the given locales and environments
|
|
@@ -643,18 +795,18 @@ USAGE
|
|
|
643
795
|
<value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
644
796
|
|
|
645
797
|
FLAGS
|
|
646
|
-
-B, --branch=<value>
|
|
647
|
-
|
|
648
|
-
-a, --alias=<value>
|
|
649
|
-
-c, --config=<value>
|
|
650
|
-
-e, --environments=<value
|
|
651
|
-
-l, --locales=<value
|
|
652
|
-
-y, --yes
|
|
653
|
-
--bulk-publish=<value>
|
|
654
|
-
|
|
655
|
-
--content-types=<value
|
|
656
|
-
--retry-failed=<value>
|
|
657
|
-
--source-env=<value>
|
|
798
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
799
|
+
selected)
|
|
800
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
801
|
+
-c, --config=<value> Path to the config file
|
|
802
|
+
-e, --environments=<value>... Destination environments
|
|
803
|
+
-l, --locales=<value>... Locales where edited entries will be published
|
|
804
|
+
-y, --yes Agree to process the command with the current configuration
|
|
805
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
806
|
+
bulkpublish API will be used to publish the entries
|
|
807
|
+
--content-types=<value>... The Contenttypes which will be checked for edited entries
|
|
808
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
809
|
+
--source-env=<value> Environment from which edited entries will be published
|
|
658
810
|
|
|
659
811
|
DESCRIPTION
|
|
660
812
|
Publish edited entries from a specified content type to the given locales and environments
|
|
@@ -699,8 +851,6 @@ EXAMPLES
|
|
|
699
851
|
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
700
852
|
```
|
|
701
853
|
|
|
702
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-modified.js)_
|
|
703
|
-
|
|
704
854
|
## `csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
705
855
|
|
|
706
856
|
Publish non-localized fields for the given content types, from a particular source environment to the specified environments
|
|
@@ -711,17 +861,17 @@ USAGE
|
|
|
711
861
|
[--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
712
862
|
|
|
713
863
|
FLAGS
|
|
714
|
-
-B, --branch=<value>
|
|
715
|
-
|
|
716
|
-
-a, --alias=<value>
|
|
717
|
-
-c, --config=<value>
|
|
718
|
-
-e, --environments=<value
|
|
719
|
-
-y, --yes
|
|
720
|
-
--bulk-publish=<value>
|
|
721
|
-
|
|
722
|
-
--content-types=<value
|
|
723
|
-
--retry-failed=<value>
|
|
724
|
-
--source-env=<value>
|
|
864
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
865
|
+
selected)
|
|
866
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
867
|
+
-c, --config=<value> Path to the config file
|
|
868
|
+
-e, --environments=<value>... Destination environments
|
|
869
|
+
-y, --yes Agree to process the command with the current configuration
|
|
870
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
871
|
+
bulkpublish API will be used to publish the entries
|
|
872
|
+
--content-types=<value>... The Contenttypes from which entries will be published
|
|
873
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile
|
|
874
|
+
--source-env=<value> Source Environment
|
|
725
875
|
|
|
726
876
|
DESCRIPTION
|
|
727
877
|
Publish non-localized fields for the given content types, from a particular source environment to the specified
|
|
@@ -763,78 +913,532 @@ EXAMPLES
|
|
|
763
913
|
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV] --branch [BRANCH NAME]
|
|
764
914
|
```
|
|
765
915
|
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
## `csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
916
|
+
## `csdx cm:bulk-publish:revert`
|
|
769
917
|
|
|
770
|
-
|
|
918
|
+
Revert publish operations by using a log file
|
|
771
919
|
|
|
772
920
|
```
|
|
773
921
|
USAGE
|
|
774
|
-
$ csdx cm:
|
|
775
|
-
[--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
|
|
776
|
-
<value>]
|
|
922
|
+
$ csdx cm:bulk-publish:revert [--retry-failed <value>] [--log-file <value>]
|
|
777
923
|
|
|
778
924
|
FLAGS
|
|
779
|
-
-
|
|
780
|
-
|
|
781
|
-
-a, --alias=<value> Alias(name) for the management token
|
|
782
|
-
-b, --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
783
|
-
bulkpublish API will be used to publish the entries
|
|
784
|
-
-c, --config=<value> Path to the config file
|
|
785
|
-
-e, --environments=<value> Destination environments
|
|
786
|
-
-y, --yes Agree to process the command with the current configuration
|
|
787
|
-
--content-types=<value> The Contenttypes from which entries will be published
|
|
788
|
-
--locales=<value> Source locale
|
|
789
|
-
--retry-failed=<value> Retry publishing failed entries from the logfile
|
|
790
|
-
--source-env=<value> Source Env
|
|
925
|
+
--log-file=<value> logfile to be used to revert
|
|
926
|
+
--retry-failed=<value> retry publishing failed entries from the logfile
|
|
791
927
|
|
|
792
928
|
DESCRIPTION
|
|
793
|
-
|
|
794
|
-
The
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
Note: Content type(s), Source Environment, Destination Environment(s) and Source Locale are required to execute the
|
|
798
|
-
command successfully
|
|
799
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
929
|
+
Revert publish operations by using a log file
|
|
930
|
+
The revert command is used to revert all publish operations performed using bulk-publish script.
|
|
931
|
+
A log file name is required to execute revert command
|
|
800
932
|
|
|
801
933
|
|
|
802
934
|
ALIASES
|
|
803
|
-
$ csdx cm:bulk-publish:
|
|
935
|
+
$ csdx cm:bulk-publish:revert
|
|
804
936
|
|
|
805
937
|
EXAMPLES
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] -source-env [SOURCE ENV]
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
|
|
812
|
-
Using --config or -c flag
|
|
813
|
-
|
|
814
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
815
|
-
|
|
816
|
-
$ csdx cm:entries:publish-only-unpublished --config [PATH TO CONFIG FILE]
|
|
938
|
+
Using --log-file
|
|
817
939
|
|
|
818
|
-
|
|
940
|
+
cm:bulk-publish:revert --log-file [LOG FILE NAME]
|
|
819
941
|
|
|
820
942
|
|
|
821
943
|
|
|
822
944
|
Using --retry-failed
|
|
823
945
|
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
Using --branch
|
|
829
|
-
|
|
830
|
-
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME] -source-env [SOURCE ENV]
|
|
946
|
+
cm:bulk-publish:revert --retry-failed [LOG FILE NAME]
|
|
831
947
|
```
|
|
832
948
|
|
|
833
|
-
|
|
834
|
-
|
|
835
|
-
## `csdx cm:entries:unpublish`
|
|
949
|
+
## `csdx csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>] [--only-assets] [--only-entries]`
|
|
836
950
|
|
|
837
|
-
Unpublish entries from the
|
|
951
|
+
Unpublish entries or assets of given content types from the specified environment
|
|
952
|
+
|
|
953
|
+
```
|
|
954
|
+
USAGE
|
|
955
|
+
$ csdx csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>]
|
|
956
|
+
[--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>]
|
|
957
|
+
[--only-assets] [--only-entries]
|
|
958
|
+
|
|
959
|
+
FLAGS
|
|
960
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content from (default is main branch)
|
|
961
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
962
|
+
-c, --config=<value> Path to the config file
|
|
963
|
+
-e, --environment=<value> Source Environment
|
|
964
|
+
-l, --locale=<value> Locale filter
|
|
965
|
+
-y, --yes Agree to process the command with the current configuration
|
|
966
|
+
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
967
|
+
bulkpublish API will be used to unpublish the entries and assets
|
|
968
|
+
--content-type=<value> Content type filter
|
|
969
|
+
--delivery-token=<value> Delivery token for source environment
|
|
970
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
971
|
+
|
|
972
|
+
DESCRIPTION
|
|
973
|
+
Unpublish entries or assets of given content types from the specified environment
|
|
974
|
+
The unpublish command is used to unpublish entries or assets from given environment
|
|
975
|
+
|
|
976
|
+
Environment (Source Environment) and Locale are required to execute the command successfully
|
|
977
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
978
|
+
|
|
979
|
+
A content type can be specified for unpublishing entries, but if no content-type(s) is/are specified and --only-assets
|
|
980
|
+
is not used,
|
|
981
|
+
then all entries from all content types will be unpublished from the source environment
|
|
982
|
+
|
|
983
|
+
Note: --only-assets can be used to unpublish only assets and --only-entries can be used to unpublish only entries.
|
|
984
|
+
(--only-assets and --only-entries cannot be used together at the same time)
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
ALIASES
|
|
988
|
+
$ csdx cm:bulk-publish:unpublish
|
|
989
|
+
|
|
990
|
+
EXAMPLES
|
|
991
|
+
General Usage
|
|
992
|
+
|
|
993
|
+
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] ----delivery-token [DELIVERY TOKEN]
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
Using --config or -c flag
|
|
998
|
+
|
|
999
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
|
|
1000
|
+
|
|
1001
|
+
$ csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]
|
|
1002
|
+
|
|
1003
|
+
$ csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]
|
|
1004
|
+
|
|
1005
|
+
|
|
1006
|
+
|
|
1007
|
+
Using --retry-failed flag
|
|
1008
|
+
|
|
1009
|
+
$ csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
No content type
|
|
1014
|
+
|
|
1015
|
+
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all content types and assets from the source environment)
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
Using --only-assets
|
|
1020
|
+
|
|
1021
|
+
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-assets (Will unpublish only assets from the source environment)
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
|
|
1025
|
+
Using --only-entries
|
|
1026
|
+
|
|
1027
|
+
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, all entries, from the source environment)
|
|
1028
|
+
|
|
1029
|
+
$ csdx cm:stacks:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, (from CONTENT TYPE) from the source environment)
|
|
1030
|
+
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
Using --branch flag
|
|
1034
|
+
|
|
1035
|
+
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
1036
|
+
```
|
|
1037
|
+
|
|
1038
|
+
## `csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
1039
|
+
|
|
1040
|
+
Publish unpublished entries from the source environment, to other environments and locales
|
|
1041
|
+
|
|
1042
|
+
```
|
|
1043
|
+
USAGE
|
|
1044
|
+
$ csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
1045
|
+
[--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
|
|
1046
|
+
<value>]
|
|
1047
|
+
|
|
1048
|
+
FLAGS
|
|
1049
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
1050
|
+
selected)
|
|
1051
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
1052
|
+
-b, --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
1053
|
+
bulkpublish API will be used to publish the entries
|
|
1054
|
+
-c, --config=<value> Path to the config file
|
|
1055
|
+
-e, --environments=<value>... Destination environments
|
|
1056
|
+
-y, --yes Agree to process the command with the current configuration
|
|
1057
|
+
--content-types=<value>... The Contenttypes from which entries will be published
|
|
1058
|
+
--locales=<value> Source locale
|
|
1059
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile
|
|
1060
|
+
--source-env=<value> Source Env
|
|
1061
|
+
|
|
1062
|
+
DESCRIPTION
|
|
1063
|
+
Publish unpublished entries from the source environment, to other environments and locales
|
|
1064
|
+
The publish-only-unpublished command is used to publish unpublished entries from the source environment, to other
|
|
1065
|
+
environments and locales
|
|
1066
|
+
|
|
1067
|
+
Note: Content type(s), Source Environment, Destination Environment(s) and Source Locale are required to execute the
|
|
1068
|
+
command successfully
|
|
1069
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
ALIASES
|
|
1073
|
+
$ csdx cm:bulk-publish:unpublished-entries
|
|
1074
|
+
|
|
1075
|
+
EXAMPLES
|
|
1076
|
+
General Usage
|
|
1077
|
+
|
|
1078
|
+
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] -source-env [SOURCE ENV]
|
|
1079
|
+
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
Using --config or -c flag
|
|
1083
|
+
|
|
1084
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
1085
|
+
|
|
1086
|
+
$ csdx cm:entries:publish-only-unpublished --config [PATH TO CONFIG FILE]
|
|
1087
|
+
|
|
1088
|
+
$ csdx cm:entries:publish-only-unpublished -c [PATH TO CONFIG FILE]
|
|
1089
|
+
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
Using --retry-failed
|
|
1093
|
+
|
|
1094
|
+
$ csdx cm:entries:publish-only-unpublished --retry-failed [LOG FILE NAME]
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
Using --branch
|
|
1099
|
+
|
|
1100
|
+
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME] -source-env [SOURCE ENV]
|
|
1101
|
+
```
|
|
1102
|
+
|
|
1103
|
+
## `csdx cm:entries:migrate-html-rte`
|
|
1104
|
+
|
|
1105
|
+
Migration script to migrate content from HTML RTE to JSON RTE
|
|
1106
|
+
|
|
1107
|
+
```
|
|
1108
|
+
USAGE
|
|
1109
|
+
$ csdx cm:entries:migrate-html-rte [-c <value>] [-a <value>] [--content-type <value>] [--global-field] [-y] [--html-path
|
|
1110
|
+
<value> --json-path <value>] [--delay <value>] [--locale <value>] [--batch-limit <value>]
|
|
1111
|
+
|
|
1112
|
+
FLAGS
|
|
1113
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
1114
|
+
-c, --config-path=<value> Path to config file
|
|
1115
|
+
-y, --yes Agree to process the command with the current configuration
|
|
1116
|
+
--batch-limit=<value> [default: 50] Provide batch limit for updating entries
|
|
1117
|
+
--content-type=<value> The content type from which entries will be migrated
|
|
1118
|
+
--delay=<value> [default: 1000] Provide delay in ms between two entry update
|
|
1119
|
+
--global-field This flag is set to false by default. It indicates that current content type is a
|
|
1120
|
+
globalfield
|
|
1121
|
+
--html-path=<value> Provide path of HTML RTE to migrate
|
|
1122
|
+
--json-path=<value> Provide path of JSON RTE to migrate
|
|
1123
|
+
--locale=<value> The locale from which entries will be migrated
|
|
1124
|
+
|
|
1125
|
+
DESCRIPTION
|
|
1126
|
+
Migration script to migrate content from HTML RTE to JSON RTE
|
|
1127
|
+
|
|
1128
|
+
ALIASES
|
|
1129
|
+
$ csdx cm:migrate-rte
|
|
1130
|
+
|
|
1131
|
+
EXAMPLES
|
|
1132
|
+
General Usage
|
|
1133
|
+
|
|
1134
|
+
$ csdx cm:entries:migrate-html-rte --config-path path/to/config.json
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
Using Flags
|
|
1139
|
+
|
|
1140
|
+
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path html-path --json-path json-path
|
|
1141
|
+
|
|
1142
|
+
|
|
1143
|
+
|
|
1144
|
+
Nested RTE
|
|
1145
|
+
|
|
1146
|
+
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path modular_block_uid.block_uid.html_rte_uid --json-path modular_block_uid.block_uid.json_rte_uid
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path group_uid.html_rte_uid --json-path group_uid.json_rte_uid
|
|
1151
|
+
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
Global Field
|
|
1155
|
+
|
|
1156
|
+
$ csdx cm:entries:migrate-html-rte --alias alias --content-type global_field_uid --global-field --html-path html-path --json-path json-path
|
|
1157
|
+
```
|
|
1158
|
+
|
|
1159
|
+
_See code: [@contentstack/cli-cm-migrate-rte](https://github.com/contentstack/cli/blob/main/packages/contentstack-migrate-rte/src/commands/cm/entries/migrate-html-rte.js)_
|
|
1160
|
+
|
|
1161
|
+
## `csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`
|
|
1162
|
+
|
|
1163
|
+
Publish entries from multiple contenttypes to multiple environments and locales
|
|
1164
|
+
|
|
1165
|
+
```
|
|
1166
|
+
USAGE
|
|
1167
|
+
$ csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
1168
|
+
[--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
|
|
1169
|
+
<value>] [--delivery-token <value>] [--source-env <value>]
|
|
1170
|
+
|
|
1171
|
+
FLAGS
|
|
1172
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
1173
|
+
selected)
|
|
1174
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
1175
|
+
-c, --config=<value> Path for the external config file (A new config file can be generated at the current
|
|
1176
|
+
working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
|
|
1177
|
+
-e, --environments=<value>... Environments where entries will be published
|
|
1178
|
+
-l, --locales=<value>... Locales where entries will be published
|
|
1179
|
+
-y, --yes Agree to process the command with the current configuration
|
|
1180
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
1181
|
+
bulkpublish API will be used to publish the entries
|
|
1182
|
+
--content-types=<value>... The Contenttypes from which entries need to be published
|
|
1183
|
+
--delivery-token=<value> Delivery token for source environment
|
|
1184
|
+
--publish-all-content-types (optional) Publish all contenttypes (cannot be set when contentTypes flag is set)
|
|
1185
|
+
--retry-failed=<value> (optional) Retry failed entries from the logfile (overrides all other flags) This flag
|
|
1186
|
+
is used to retry publishing entries that failed to publish in a previous attempt. A log
|
|
1187
|
+
file for the previous session will be required for processing the failed entries
|
|
1188
|
+
--source-env=<value> Source environment
|
|
1189
|
+
|
|
1190
|
+
DESCRIPTION
|
|
1191
|
+
Publish entries from multiple contenttypes to multiple environments and locales
|
|
1192
|
+
The publish command is used to publish entries from the specified content types, to the
|
|
1193
|
+
specified environments and locales
|
|
1194
|
+
|
|
1195
|
+
Note: Content Types, Environments and Locales are required to execute the command successfully
|
|
1196
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
1197
|
+
|
|
1198
|
+
|
|
1199
|
+
ALIASES
|
|
1200
|
+
$ csdx cm:bulk-publish:entries
|
|
1201
|
+
|
|
1202
|
+
EXAMPLES
|
|
1203
|
+
General Usage
|
|
1204
|
+
|
|
1205
|
+
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
Using --config or -c flag
|
|
1210
|
+
|
|
1211
|
+
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
1212
|
+
|
|
1213
|
+
$ csdx cm:entries:publish --config [PATH TO CONFIG FILE]
|
|
1214
|
+
|
|
1215
|
+
$ csdx cm:entries:publish -c [PATH TO CONFIG FILE]
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
Using --retry-failed
|
|
1220
|
+
|
|
1221
|
+
$ csdx cm:entries:publish --retry-failed [LOG FILE NAME]
|
|
1222
|
+
|
|
1223
|
+
$ csdx cm:entries:publish -r [LOG FILE NAME]
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
Using --branch
|
|
1228
|
+
|
|
1229
|
+
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
Using --source-env
|
|
1234
|
+
|
|
1235
|
+
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
1236
|
+
```
|
|
1237
|
+
|
|
1238
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js)_
|
|
1239
|
+
|
|
1240
|
+
## `csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
1241
|
+
|
|
1242
|
+
Publish edited entries from a specified content type to the given locales and environments
|
|
1243
|
+
|
|
1244
|
+
```
|
|
1245
|
+
USAGE
|
|
1246
|
+
$ csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env
|
|
1247
|
+
<value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
1248
|
+
|
|
1249
|
+
FLAGS
|
|
1250
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
1251
|
+
selected)
|
|
1252
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
1253
|
+
-c, --config=<value> Path to the config file
|
|
1254
|
+
-e, --environments=<value>... Destination environments
|
|
1255
|
+
-l, --locales=<value>... Locales where edited entries will be published
|
|
1256
|
+
-y, --yes Agree to process the command with the current configuration
|
|
1257
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
1258
|
+
bulkpublish API will be used to publish the entries
|
|
1259
|
+
--content-types=<value>... The Contenttypes which will be checked for edited entries
|
|
1260
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
1261
|
+
--source-env=<value> Environment from which edited entries will be published
|
|
1262
|
+
|
|
1263
|
+
DESCRIPTION
|
|
1264
|
+
Publish edited entries from a specified content type to the given locales and environments
|
|
1265
|
+
The publish-modified command is used to publish entries from the specified content types, to the
|
|
1266
|
+
specified environments and locales
|
|
1267
|
+
|
|
1268
|
+
Note: Content type(s), Source Environment, Destination Environment(s) and Locale(s) are required to execute the
|
|
1269
|
+
command successfully
|
|
1270
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
ALIASES
|
|
1274
|
+
$ csdx cm:bulk-publish:entry-edits
|
|
1275
|
+
|
|
1276
|
+
EXAMPLES
|
|
1277
|
+
General Usage
|
|
1278
|
+
|
|
1279
|
+
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
Using --config or -c flag
|
|
1284
|
+
|
|
1285
|
+
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
1286
|
+
|
|
1287
|
+
$ csdx cm:entries:publish-modified --config [PATH TO CONFIG FILE]
|
|
1288
|
+
|
|
1289
|
+
$ csdx cm:entries:publish-modified -c [PATH TO CONFIG FILE]
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
Using --retry-failed
|
|
1294
|
+
|
|
1295
|
+
$ csdx cm:entries:publish-modified --retry-failed [LOG FILE NAME]
|
|
1296
|
+
|
|
1297
|
+
$ csdx cm:entries:publish-modified -r [LOG FILE NAME]
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
Using --branch
|
|
1302
|
+
|
|
1303
|
+
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
1304
|
+
```
|
|
1305
|
+
|
|
1306
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-modified.js)_
|
|
1307
|
+
|
|
1308
|
+
## `csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
1309
|
+
|
|
1310
|
+
Publish non-localized fields for the given content types, from a particular source environment to the specified environments
|
|
1311
|
+
|
|
1312
|
+
```
|
|
1313
|
+
USAGE
|
|
1314
|
+
$ csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
1315
|
+
[--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
1316
|
+
|
|
1317
|
+
FLAGS
|
|
1318
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
1319
|
+
selected)
|
|
1320
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
1321
|
+
-c, --config=<value> Path to the config file
|
|
1322
|
+
-e, --environments=<value>... Destination environments
|
|
1323
|
+
-y, --yes Agree to process the command with the current configuration
|
|
1324
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
1325
|
+
bulkpublish API will be used to publish the entries
|
|
1326
|
+
--content-types=<value>... The Contenttypes from which entries will be published
|
|
1327
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile
|
|
1328
|
+
--source-env=<value> Source Environment
|
|
1329
|
+
|
|
1330
|
+
DESCRIPTION
|
|
1331
|
+
Publish non-localized fields for the given content types, from a particular source environment to the specified
|
|
1332
|
+
environments
|
|
1333
|
+
The non-localized field changes command is used to publish non-localized field changes from the given content types to
|
|
1334
|
+
the specified environments
|
|
1335
|
+
|
|
1336
|
+
Note: Content types, Environments and Source Environment are required to execute this command successfully.
|
|
1337
|
+
But, if retryFailed flag is set, then only a logfile is required
|
|
1338
|
+
|
|
1339
|
+
ALIASES
|
|
1340
|
+
$ csdx cm:bulk-publish:nonlocalized-field-changes
|
|
1341
|
+
|
|
1342
|
+
EXAMPLES
|
|
1343
|
+
General Usage
|
|
1344
|
+
|
|
1345
|
+
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV]
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
Using --config or -c flag
|
|
1350
|
+
|
|
1351
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
1352
|
+
|
|
1353
|
+
$ csdx cm:entries:publish-non-localized-fields --config [PATH TO CONFIG FILE]
|
|
1354
|
+
|
|
1355
|
+
$ csdx cm:entries:publish-non-localized-fields -c [PATH TO CONFIG FILE]
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
Using --retry-failed flag
|
|
1360
|
+
|
|
1361
|
+
$ csdx cm:entries:publish-non-localized-fields --retry-failed [LOG FILE NAME]
|
|
1362
|
+
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
Using --branch flag
|
|
1366
|
+
|
|
1367
|
+
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV] --branch [BRANCH NAME]
|
|
1368
|
+
```
|
|
1369
|
+
|
|
1370
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-non-localized-fields.js)_
|
|
1371
|
+
|
|
1372
|
+
## `csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
1373
|
+
|
|
1374
|
+
Publish unpublished entries from the source environment, to other environments and locales
|
|
1375
|
+
|
|
1376
|
+
```
|
|
1377
|
+
USAGE
|
|
1378
|
+
$ csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
1379
|
+
[--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
|
|
1380
|
+
<value>]
|
|
1381
|
+
|
|
1382
|
+
FLAGS
|
|
1383
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
1384
|
+
selected)
|
|
1385
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
1386
|
+
-b, --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
1387
|
+
bulkpublish API will be used to publish the entries
|
|
1388
|
+
-c, --config=<value> Path to the config file
|
|
1389
|
+
-e, --environments=<value>... Destination environments
|
|
1390
|
+
-y, --yes Agree to process the command with the current configuration
|
|
1391
|
+
--content-types=<value>... The Contenttypes from which entries will be published
|
|
1392
|
+
--locales=<value> Source locale
|
|
1393
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile
|
|
1394
|
+
--source-env=<value> Source Env
|
|
1395
|
+
|
|
1396
|
+
DESCRIPTION
|
|
1397
|
+
Publish unpublished entries from the source environment, to other environments and locales
|
|
1398
|
+
The publish-only-unpublished command is used to publish unpublished entries from the source environment, to other
|
|
1399
|
+
environments and locales
|
|
1400
|
+
|
|
1401
|
+
Note: Content type(s), Source Environment, Destination Environment(s) and Source Locale are required to execute the
|
|
1402
|
+
command successfully
|
|
1403
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
1404
|
+
|
|
1405
|
+
|
|
1406
|
+
ALIASES
|
|
1407
|
+
$ csdx cm:bulk-publish:unpublished-entries
|
|
1408
|
+
|
|
1409
|
+
EXAMPLES
|
|
1410
|
+
General Usage
|
|
1411
|
+
|
|
1412
|
+
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] -source-env [SOURCE ENV]
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
Using --config or -c flag
|
|
1417
|
+
|
|
1418
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
1419
|
+
|
|
1420
|
+
$ csdx cm:entries:publish-only-unpublished --config [PATH TO CONFIG FILE]
|
|
1421
|
+
|
|
1422
|
+
$ csdx cm:entries:publish-only-unpublished -c [PATH TO CONFIG FILE]
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
|
|
1426
|
+
Using --retry-failed
|
|
1427
|
+
|
|
1428
|
+
$ csdx cm:entries:publish-only-unpublished --retry-failed [LOG FILE NAME]
|
|
1429
|
+
|
|
1430
|
+
|
|
1431
|
+
|
|
1432
|
+
Using --branch
|
|
1433
|
+
|
|
1434
|
+
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME] -source-env [SOURCE ENV]
|
|
1435
|
+
```
|
|
1436
|
+
|
|
1437
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-only-unpublished.js)_
|
|
1438
|
+
|
|
1439
|
+
## `csdx cm:entries:unpublish`
|
|
1440
|
+
|
|
1441
|
+
Unpublish entries from the given environment
|
|
838
1442
|
|
|
839
1443
|
```
|
|
840
1444
|
USAGE
|
|
@@ -904,19 +1508,19 @@ USAGE
|
|
|
904
1508
|
<value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
|
|
905
1509
|
|
|
906
1510
|
FLAGS
|
|
907
|
-
-B, --branch=<value>
|
|
908
|
-
|
|
909
|
-
-a, --alias=<value>
|
|
910
|
-
-c, --config=<value>
|
|
911
|
-
-e, --environments=<value
|
|
912
|
-
-l, --locales=<value
|
|
913
|
-
-t, --contentTypes=<value
|
|
914
|
-
-y, --yes
|
|
915
|
-
--bulk-publish=<value>
|
|
916
|
-
|
|
917
|
-
--content-types=<value
|
|
918
|
-
--force
|
|
919
|
-
--retry-failed=<value>
|
|
1511
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
1512
|
+
selected)
|
|
1513
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
1514
|
+
-c, --config=<value> Path to the config file
|
|
1515
|
+
-e, --environments=<value>... Environments where entries will be published
|
|
1516
|
+
-l, --locales=<value>... Locales where entries will be published
|
|
1517
|
+
-t, --contentTypes=<value>... The Contenttypes from which entries will be published
|
|
1518
|
+
-y, --yes Agree to process the command with the current configuration
|
|
1519
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
1520
|
+
bulkpublish API will be used to publish the entries
|
|
1521
|
+
--content-types=<value>... The Contenttypes from which entries will be published
|
|
1522
|
+
--force Update and publish all entries even if no fields have been added
|
|
1523
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
920
1524
|
|
|
921
1525
|
DESCRIPTION
|
|
922
1526
|
Add fields from updated content types to their respective entries
|
|
@@ -960,6 +1564,48 @@ EXAMPLES
|
|
|
960
1564
|
|
|
961
1565
|
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/update-and-publish.js)_
|
|
962
1566
|
|
|
1567
|
+
## `csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
|
|
1568
|
+
|
|
1569
|
+
Export content from a stack
|
|
1570
|
+
|
|
1571
|
+
```
|
|
1572
|
+
USAGE
|
|
1573
|
+
$ csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types
|
|
1574
|
+
<value>] [--branch <value>] [--secured-assets]
|
|
1575
|
+
|
|
1576
|
+
FLAGS
|
|
1577
|
+
-B, --branch=<value> [optional] branch name
|
|
1578
|
+
-a, --alias=<value> alias of the management token
|
|
1579
|
+
-c, --config=<value> [optional] path of the config
|
|
1580
|
+
-d, --data-dir=<value> path or location to store the data
|
|
1581
|
+
-k, --stack-api-key=<value> API key of the source stack
|
|
1582
|
+
-m, --module=<value> [optional] specific module name
|
|
1583
|
+
-t, --content-types=<value>... [optional] content type
|
|
1584
|
+
-y, --yes [optional] Override marketplace apps related prompts
|
|
1585
|
+
--secured-assets [optional] use when assets are secured
|
|
1586
|
+
|
|
1587
|
+
DESCRIPTION
|
|
1588
|
+
Export content from a stack
|
|
1589
|
+
|
|
1590
|
+
ALIASES
|
|
1591
|
+
$ csdx cm:export
|
|
1592
|
+
|
|
1593
|
+
EXAMPLES
|
|
1594
|
+
$ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
1595
|
+
|
|
1596
|
+
$ csdx cm:stacks:export --config <path/to/config/dir>
|
|
1597
|
+
|
|
1598
|
+
$ csdx cm:stacks:export --alias <management_token_alias>
|
|
1599
|
+
|
|
1600
|
+
$ csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>
|
|
1601
|
+
|
|
1602
|
+
$ csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>
|
|
1603
|
+
|
|
1604
|
+
$ csdx cm:stacks:export --module <single module name>
|
|
1605
|
+
|
|
1606
|
+
$ csdx cm:stacks:export --branch [optional] branch name
|
|
1607
|
+
```
|
|
1608
|
+
|
|
963
1609
|
## `csdx cm:export-to-csv`
|
|
964
1610
|
|
|
965
1611
|
Export entries or organization users to csv using this command
|
|
@@ -980,37 +1626,264 @@ FLAGS
|
|
|
980
1626
|
--org-name=<value> Name of the organization that needs to be created as csv filename.
|
|
981
1627
|
|
|
982
1628
|
DESCRIPTION
|
|
983
|
-
Export entries or organization users to csv using this command
|
|
1629
|
+
Export entries or organization users to csv using this command
|
|
1630
|
+
|
|
1631
|
+
EXAMPLES
|
|
1632
|
+
$ csdx cm:export-to-csv
|
|
1633
|
+
|
|
1634
|
+
|
|
1635
|
+
|
|
1636
|
+
Exporting entries to csv
|
|
1637
|
+
|
|
1638
|
+
$ csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type>
|
|
1639
|
+
|
|
1640
|
+
|
|
1641
|
+
|
|
1642
|
+
Exporting entries to csv with stack name provided
|
|
1643
|
+
|
|
1644
|
+
$ csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type> --stack-name <stack-name>
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
|
|
1648
|
+
Exporting organization users to csv
|
|
1649
|
+
|
|
1650
|
+
$ csdx cm:export-to-csv --action <users> --org <org-uid>
|
|
1651
|
+
|
|
1652
|
+
|
|
1653
|
+
|
|
1654
|
+
Exporting organization users to csv with organization name provided
|
|
1655
|
+
|
|
1656
|
+
$ csdx cm:export-to-csv --action <users> --org <org-uid> --org-name <org-name>
|
|
1657
|
+
```
|
|
1658
|
+
|
|
1659
|
+
_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)_
|
|
1660
|
+
|
|
1661
|
+
## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
|
|
1662
|
+
|
|
1663
|
+
Import script for importing the content into the new stack
|
|
1664
|
+
|
|
1665
|
+
```
|
|
1666
|
+
USAGE
|
|
1667
|
+
$ csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>]
|
|
1668
|
+
[--branch <value>] [--import-webhook-status disable|current]
|
|
1669
|
+
|
|
1670
|
+
FLAGS
|
|
1671
|
+
-B, --branch=<value> [optional] branch name
|
|
1672
|
+
-a, --alias=<value> alias of the management token
|
|
1673
|
+
-b, --backup-dir=<value> [optional] backup directory name when using specific module
|
|
1674
|
+
-c, --config=<value> [optional] path of config file
|
|
1675
|
+
-d, --data-dir=<value> path and location where data is stored
|
|
1676
|
+
-k, --stack-api-key=<value> API key of the target stack
|
|
1677
|
+
-m, --module=<value> [optional] specific module name
|
|
1678
|
+
-y, --yes [optional] Override marketplace prompts
|
|
1679
|
+
--import-webhook-status=<option> [default: disable] [optional] Webhook state
|
|
1680
|
+
<options: disable|current>
|
|
1681
|
+
|
|
1682
|
+
DESCRIPTION
|
|
1683
|
+
Import script for importing the content into the new stack
|
|
1684
|
+
...
|
|
1685
|
+
Once you export content from the source stack, import it to your destination stack by using the cm:stacks:import
|
|
1686
|
+
command.
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
ALIASES
|
|
1690
|
+
$ csdx cm:import
|
|
1691
|
+
|
|
1692
|
+
EXAMPLES
|
|
1693
|
+
$ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
1694
|
+
|
|
1695
|
+
$ csdx cm:stacks:import --config <path/of/config/dir>
|
|
1696
|
+
|
|
1697
|
+
$ csdx cm:stacks:import --module <single module name>
|
|
1698
|
+
|
|
1699
|
+
$ csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>
|
|
1700
|
+
|
|
1701
|
+
$ csdx cm:stacks:import --alias <management_token_alias>
|
|
1702
|
+
|
|
1703
|
+
$ csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>
|
|
1704
|
+
|
|
1705
|
+
$ csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
|
|
1706
|
+
|
|
1707
|
+
$ csdx cm:stacks:import --branch <branch name> --yes
|
|
1708
|
+
```
|
|
1709
|
+
|
|
1710
|
+
## `csdx cm:migrate-rte`
|
|
1711
|
+
|
|
1712
|
+
Migration script to migrate content from HTML RTE to JSON RTE
|
|
1713
|
+
|
|
1714
|
+
```
|
|
1715
|
+
USAGE
|
|
1716
|
+
$ csdx cm:migrate-rte [-c <value>] [-a <value>] [--content-type <value>] [--global-field] [-y] [--html-path
|
|
1717
|
+
<value> --json-path <value>] [--delay <value>] [--locale <value>] [--batch-limit <value>]
|
|
1718
|
+
|
|
1719
|
+
FLAGS
|
|
1720
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
1721
|
+
-c, --config-path=<value> Path to config file
|
|
1722
|
+
-y, --yes Agree to process the command with the current configuration
|
|
1723
|
+
--batch-limit=<value> [default: 50] Provide batch limit for updating entries
|
|
1724
|
+
--content-type=<value> The content type from which entries will be migrated
|
|
1725
|
+
--delay=<value> [default: 1000] Provide delay in ms between two entry update
|
|
1726
|
+
--global-field This flag is set to false by default. It indicates that current content type is a
|
|
1727
|
+
globalfield
|
|
1728
|
+
--html-path=<value> Provide path of HTML RTE to migrate
|
|
1729
|
+
--json-path=<value> Provide path of JSON RTE to migrate
|
|
1730
|
+
--locale=<value> The locale from which entries will be migrated
|
|
1731
|
+
|
|
1732
|
+
DESCRIPTION
|
|
1733
|
+
Migration script to migrate content from HTML RTE to JSON RTE
|
|
1734
|
+
|
|
1735
|
+
ALIASES
|
|
1736
|
+
$ csdx cm:migrate-rte
|
|
1737
|
+
|
|
1738
|
+
EXAMPLES
|
|
1739
|
+
General Usage
|
|
1740
|
+
|
|
1741
|
+
$ csdx cm:entries:migrate-html-rte --config-path path/to/config.json
|
|
1742
|
+
|
|
1743
|
+
|
|
1744
|
+
|
|
1745
|
+
Using Flags
|
|
1746
|
+
|
|
1747
|
+
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path html-path --json-path json-path
|
|
1748
|
+
|
|
1749
|
+
|
|
1750
|
+
|
|
1751
|
+
Nested RTE
|
|
1752
|
+
|
|
1753
|
+
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path modular_block_uid.block_uid.html_rte_uid --json-path modular_block_uid.block_uid.json_rte_uid
|
|
1754
|
+
|
|
1755
|
+
|
|
1756
|
+
|
|
1757
|
+
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path group_uid.html_rte_uid --json-path group_uid.json_rte_uid
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
|
|
1761
|
+
Global Field
|
|
1762
|
+
|
|
1763
|
+
$ csdx cm:entries:migrate-html-rte --alias alias --content-type global_field_uid --global-field --html-path html-path --json-path json-path
|
|
1764
|
+
```
|
|
1765
|
+
|
|
1766
|
+
## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
|
|
1767
|
+
|
|
1768
|
+
Contentstack migration script.
|
|
1769
|
+
|
|
1770
|
+
```
|
|
1771
|
+
USAGE
|
|
1772
|
+
$ csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>]
|
|
1773
|
+
[--config <value>] [--multiple]
|
|
1774
|
+
|
|
1775
|
+
FLAGS
|
|
1776
|
+
-B, --branch=<value> Use this flag to add the branch name where you want to perform the migration.
|
|
1777
|
+
-a, --alias=<value> Use this flag to add the management token alias.
|
|
1778
|
+
-k, --stack-api-key=<value> With this flag add the API key of your stack.
|
|
1779
|
+
--config=<value>... [optional] inline configuration, <key1>:<value1>
|
|
1780
|
+
--config-file=<value> [optional] Path of the JSON configuration file
|
|
1781
|
+
--file-path=<value> Use this flag to provide the path of the file of the migration script provided by the
|
|
1782
|
+
user.
|
|
1783
|
+
--multiple This flag helps you to migrate multiple content files in a single instance.
|
|
1784
|
+
|
|
1785
|
+
DESCRIPTION
|
|
1786
|
+
Contentstack migration script.
|
|
1787
|
+
|
|
1788
|
+
ALIASES
|
|
1789
|
+
$ csdx cm:migration
|
|
1790
|
+
|
|
1791
|
+
EXAMPLES
|
|
1792
|
+
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>
|
|
1793
|
+
|
|
1794
|
+
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>
|
|
1795
|
+
|
|
1796
|
+
$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>
|
|
1797
|
+
|
|
1798
|
+
$ csdx cm:migration --config-file <path/to/json/config/file> --file-path <migration/script/file/path>
|
|
1799
|
+
|
|
1800
|
+
$ csdx cm:migration --multiple --file-path <migration/scripts/dir/path>
|
|
1801
|
+
|
|
1802
|
+
$ csdx cm:migration --alias --file-path <migration/script/file/path> -k <api-key>
|
|
1803
|
+
```
|
|
1804
|
+
|
|
1805
|
+
## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]`
|
|
1806
|
+
|
|
1807
|
+
Create a stack from existing content types, entries, assets, etc
|
|
1808
|
+
|
|
1809
|
+
```
|
|
1810
|
+
USAGE
|
|
1811
|
+
$ csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]
|
|
1812
|
+
|
|
1813
|
+
FLAGS
|
|
1814
|
+
-k, --stack-api-key=<value> Provide stack api key to seed content to
|
|
1815
|
+
-n, --stack-name=<value> Name of a new stack that needs to be created.
|
|
1816
|
+
-o, --org=<value> Provide Organization UID to create a new stack
|
|
1817
|
+
-r, --repo=<value> GitHub account or GitHub account/repository
|
|
1818
|
+
-s, --stack=<value> Provide stack UID to seed content to
|
|
1819
|
+
-y, --yes=<value> [Optional] Skip stack confirmation
|
|
1820
|
+
|
|
1821
|
+
DESCRIPTION
|
|
1822
|
+
Create a stack from existing content types, entries, assets, etc
|
|
1823
|
+
|
|
1824
|
+
ALIASES
|
|
1825
|
+
$ csdx cm:seed
|
|
984
1826
|
|
|
985
1827
|
EXAMPLES
|
|
986
|
-
$ csdx cm:
|
|
1828
|
+
$ csdx cm:stacks:seed
|
|
987
1829
|
|
|
1830
|
+
$ csdx cm:stacks:seed --repo "account"
|
|
988
1831
|
|
|
1832
|
+
$ csdx cm:stacks:seed --repo "account/repository"
|
|
989
1833
|
|
|
990
|
-
|
|
1834
|
+
$ csdx cm:stacks:seed --repo "account/repository" --stack-api-key "stack-api-key" //seed content into specific stack
|
|
991
1835
|
|
|
992
|
-
$ csdx cm:
|
|
1836
|
+
$ csdx cm:stacks:seed --repo "account/repository" --org "your-org-uid" --stack-name "stack-name" //create a new stack in given org uid
|
|
1837
|
+
```
|
|
993
1838
|
|
|
1839
|
+
## `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]`
|
|
994
1840
|
|
|
1841
|
+
Clone data (structure/content or both) of a stack into another stack
|
|
995
1842
|
|
|
996
|
-
|
|
1843
|
+
```
|
|
1844
|
+
USAGE
|
|
1845
|
+
$ csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>]
|
|
1846
|
+
[--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>]
|
|
1847
|
+
[--destination-stack-api-key <value>] [--import-webhook-status disable|current]
|
|
997
1848
|
|
|
998
|
-
|
|
1849
|
+
FLAGS
|
|
1850
|
+
-n, --stack-name=<value> Name for the new stack to store the cloned content.
|
|
1851
|
+
-y, --yes [Optional] Override marketplace prompts
|
|
1852
|
+
--destination-management-token-alias=<value> Source API key of the target stack token alias.
|
|
1853
|
+
--destination-stack-api-key=<value> Destination stack API Key
|
|
1854
|
+
--import-webhook-status=<option> [default: disable] [Optional] Webhook state
|
|
1855
|
+
<options: disable|current>
|
|
1856
|
+
--source-branch=<value> Branch of the source stack.
|
|
1857
|
+
--source-management-token-alias=<value> Source API key of the target stack token alias.
|
|
1858
|
+
--source-stack-api-key=<value> Source stack API Key
|
|
1859
|
+
--target-branch=<value> Branch of the target stack.
|
|
1860
|
+
--type=<option> Type of data to clone
|
|
1861
|
+
a) Structure (all modules except entries & assets)
|
|
1862
|
+
b) Structure with content (all modules including entries & assets)
|
|
999
1863
|
|
|
1864
|
+
<options: a|b>
|
|
1000
1865
|
|
|
1866
|
+
DESCRIPTION
|
|
1867
|
+
Clone data (structure/content or both) of a stack into another stack
|
|
1868
|
+
Use this plugin to automate the process of cloning a stack in few steps.
|
|
1001
1869
|
|
|
1002
|
-
Exporting organization users to csv
|
|
1003
1870
|
|
|
1004
|
-
|
|
1871
|
+
ALIASES
|
|
1872
|
+
$ csdx cm:stack-clone
|
|
1005
1873
|
|
|
1874
|
+
EXAMPLES
|
|
1875
|
+
$ csdx cm:stacks:clone
|
|
1006
1876
|
|
|
1877
|
+
$ csdx cm:stacks:clone --source-branch <source-branch-name> --target-branch <target-branch-name> --yes
|
|
1007
1878
|
|
|
1008
|
-
|
|
1879
|
+
$ csdx cm:stacks:clone --source-stack-api-key <apiKey> --destination-stack-api-key <apiKey>
|
|
1009
1880
|
|
|
1010
|
-
$ csdx cm:
|
|
1011
|
-
```
|
|
1881
|
+
$ csdx cm:stacks:clone --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
|
|
1012
1882
|
|
|
1013
|
-
|
|
1883
|
+
$ csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
|
|
1884
|
+
|
|
1885
|
+
$ csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias> --type <value a or b>
|
|
1886
|
+
```
|
|
1014
1887
|
|
|
1015
1888
|
## `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]`
|
|
1016
1889
|
|
|
@@ -1073,15 +1946,15 @@ USAGE
|
|
|
1073
1946
|
<value>] [--branch <value>] [--secured-assets]
|
|
1074
1947
|
|
|
1075
1948
|
FLAGS
|
|
1076
|
-
-B, --branch=<value>
|
|
1077
|
-
-a, --alias=<value>
|
|
1078
|
-
-c, --config=<value>
|
|
1079
|
-
-d, --data-dir=<value>
|
|
1080
|
-
-k, --stack-api-key=<value>
|
|
1081
|
-
-m, --module=<value>
|
|
1082
|
-
-t, --content-types=<value
|
|
1083
|
-
-y, --yes
|
|
1084
|
-
--secured-assets
|
|
1949
|
+
-B, --branch=<value> [optional] branch name
|
|
1950
|
+
-a, --alias=<value> alias of the management token
|
|
1951
|
+
-c, --config=<value> [optional] path of the config
|
|
1952
|
+
-d, --data-dir=<value> path or location to store the data
|
|
1953
|
+
-k, --stack-api-key=<value> API key of the source stack
|
|
1954
|
+
-m, --module=<value> [optional] specific module name
|
|
1955
|
+
-t, --content-types=<value>... [optional] content type
|
|
1956
|
+
-y, --yes [optional] Override marketplace apps related prompts
|
|
1957
|
+
--secured-assets [optional] use when assets are secured
|
|
1085
1958
|
|
|
1086
1959
|
DESCRIPTION
|
|
1087
1960
|
Export content from a stack
|
|
@@ -1171,7 +2044,7 @@ FLAGS
|
|
|
1171
2044
|
-B, --branch=<value> Use this flag to add the branch name where you want to perform the migration.
|
|
1172
2045
|
-a, --alias=<value> Use this flag to add the management token alias.
|
|
1173
2046
|
-k, --stack-api-key=<value> With this flag add the API key of your stack.
|
|
1174
|
-
--config=<value
|
|
2047
|
+
--config=<value>... [optional] inline configuration, <key1>:<value1>
|
|
1175
2048
|
--config-file=<value> [optional] Path of the JSON configuration file
|
|
1176
2049
|
--file-path=<value> Use this flag to provide the path of the file of the migration script provided by the
|
|
1177
2050
|
user.
|
|
@@ -1197,7 +2070,7 @@ EXAMPLES
|
|
|
1197
2070
|
$ csdx cm:migration --alias --file-path <migration/script/file/path> -k <api-key>
|
|
1198
2071
|
```
|
|
1199
2072
|
|
|
1200
|
-
_See code: [@contentstack/cli-migration](https://github.com/contentstack/cli
|
|
2073
|
+
_See code: [@contentstack/cli-migration](https://github.com/contentstack/cli/blob/main/packages/contentstack-migration/src/commands/cm/stacks/migration.js)_
|
|
1201
2074
|
|
|
1202
2075
|
## `csdx cm:stacks:publish`
|
|
1203
2076
|
|
|
@@ -1487,7 +2360,7 @@ Set region for CLI
|
|
|
1487
2360
|
|
|
1488
2361
|
```
|
|
1489
2362
|
USAGE
|
|
1490
|
-
$ csdx config:set:region [REGION] [-d <value>
|
|
2363
|
+
$ csdx config:set:region [REGION] [-d <value> -m <value> -n <value>]
|
|
1491
2364
|
|
|
1492
2365
|
FLAGS
|
|
1493
2366
|
-d, --cda=<value> Custom host to set for content delivery API, if this flag is added then cma and name flags are
|
|
@@ -1511,6 +2384,81 @@ EXAMPLES
|
|
|
1511
2384
|
|
|
1512
2385
|
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/region.ts)_
|
|
1513
2386
|
|
|
2387
|
+
## `csdx help [COMMANDS]`
|
|
2388
|
+
|
|
2389
|
+
Display help for csdx.
|
|
2390
|
+
|
|
2391
|
+
```
|
|
2392
|
+
USAGE
|
|
2393
|
+
$ csdx help [COMMANDS] [-n]
|
|
2394
|
+
|
|
2395
|
+
ARGUMENTS
|
|
2396
|
+
COMMANDS Command to show help for.
|
|
2397
|
+
|
|
2398
|
+
FLAGS
|
|
2399
|
+
-n, --nested-commands Include all nested commands in the output.
|
|
2400
|
+
|
|
2401
|
+
DESCRIPTION
|
|
2402
|
+
Display help for csdx.
|
|
2403
|
+
```
|
|
2404
|
+
|
|
2405
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.4/src/commands/help.ts)_
|
|
2406
|
+
|
|
2407
|
+
## `csdx login`
|
|
2408
|
+
|
|
2409
|
+
User sessions login
|
|
2410
|
+
|
|
2411
|
+
```
|
|
2412
|
+
USAGE
|
|
2413
|
+
$ csdx login [-u <value>] [-p <value>]
|
|
2414
|
+
|
|
2415
|
+
FLAGS
|
|
2416
|
+
-p, --password=<value> Password
|
|
2417
|
+
-u, --username=<value> User name
|
|
2418
|
+
|
|
2419
|
+
DESCRIPTION
|
|
2420
|
+
User sessions login
|
|
2421
|
+
|
|
2422
|
+
ALIASES
|
|
2423
|
+
$ csdx login
|
|
2424
|
+
|
|
2425
|
+
EXAMPLES
|
|
2426
|
+
$ csdx auth:login
|
|
2427
|
+
|
|
2428
|
+
$ csdx auth:login -u <username>
|
|
2429
|
+
|
|
2430
|
+
$ csdx auth:login -u <username> -p <password>
|
|
2431
|
+
|
|
2432
|
+
$ csdx auth:login --username <username>
|
|
2433
|
+
|
|
2434
|
+
$ csdx auth:login --username <username> --password <password>
|
|
2435
|
+
```
|
|
2436
|
+
|
|
2437
|
+
## `csdx logout`
|
|
2438
|
+
|
|
2439
|
+
User session logout
|
|
2440
|
+
|
|
2441
|
+
```
|
|
2442
|
+
USAGE
|
|
2443
|
+
$ csdx logout [-y]
|
|
2444
|
+
|
|
2445
|
+
FLAGS
|
|
2446
|
+
-y, --yes Force log out by skipping the confirmation
|
|
2447
|
+
|
|
2448
|
+
DESCRIPTION
|
|
2449
|
+
User session logout
|
|
2450
|
+
|
|
2451
|
+
ALIASES
|
|
2452
|
+
$ csdx logout
|
|
2453
|
+
|
|
2454
|
+
EXAMPLES
|
|
2455
|
+
$ csdx auth:logout
|
|
2456
|
+
|
|
2457
|
+
$ csdx auth:logout -y
|
|
2458
|
+
|
|
2459
|
+
$ csdx auth:logout --yes
|
|
2460
|
+
```
|
|
2461
|
+
|
|
1514
2462
|
## `csdx plugins`
|
|
1515
2463
|
|
|
1516
2464
|
List installed plugins.
|
|
@@ -1529,7 +2477,45 @@ EXAMPLES
|
|
|
1529
2477
|
$ csdx plugins
|
|
1530
2478
|
```
|
|
1531
2479
|
|
|
1532
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.
|
|
2480
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.3.2/src/commands/plugins/index.ts)_
|
|
2481
|
+
|
|
2482
|
+
## `csdx plugins:install PLUGIN...`
|
|
2483
|
+
|
|
2484
|
+
Installs a plugin into the CLI.
|
|
2485
|
+
|
|
2486
|
+
```
|
|
2487
|
+
USAGE
|
|
2488
|
+
$ csdx plugins:install PLUGIN...
|
|
2489
|
+
|
|
2490
|
+
ARGUMENTS
|
|
2491
|
+
PLUGIN Plugin to install.
|
|
2492
|
+
|
|
2493
|
+
FLAGS
|
|
2494
|
+
-f, --force Run yarn install with force flag.
|
|
2495
|
+
-h, --help Show CLI help.
|
|
2496
|
+
-v, --verbose
|
|
2497
|
+
|
|
2498
|
+
DESCRIPTION
|
|
2499
|
+
Installs a plugin into the CLI.
|
|
2500
|
+
Can be installed from npm or a git url.
|
|
2501
|
+
|
|
2502
|
+
Installation of a user-installed plugin will override a core plugin.
|
|
2503
|
+
|
|
2504
|
+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
2505
|
+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
2506
|
+
the CLI without the need to patch and update the whole CLI.
|
|
2507
|
+
|
|
2508
|
+
|
|
2509
|
+
ALIASES
|
|
2510
|
+
$ csdx plugins:add
|
|
2511
|
+
|
|
2512
|
+
EXAMPLES
|
|
2513
|
+
$ csdx plugins:install myplugin
|
|
2514
|
+
|
|
2515
|
+
$ csdx plugins:install https://github.com/someuser/someplugin
|
|
2516
|
+
|
|
2517
|
+
$ csdx plugins:install someuser/someplugin
|
|
2518
|
+
```
|
|
1533
2519
|
|
|
1534
2520
|
## `csdx plugins:inspect PLUGIN...`
|
|
1535
2521
|
|
|
@@ -1546,6 +2532,9 @@ FLAGS
|
|
|
1546
2532
|
-h, --help Show CLI help.
|
|
1547
2533
|
-v, --verbose
|
|
1548
2534
|
|
|
2535
|
+
GLOBAL FLAGS
|
|
2536
|
+
--json Format output as json.
|
|
2537
|
+
|
|
1549
2538
|
DESCRIPTION
|
|
1550
2539
|
Displays installation properties of a plugin.
|
|
1551
2540
|
|
|
@@ -1553,7 +2542,7 @@ EXAMPLES
|
|
|
1553
2542
|
$ csdx plugins:inspect myplugin
|
|
1554
2543
|
```
|
|
1555
2544
|
|
|
1556
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.
|
|
2545
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.3.2/src/commands/plugins/inspect.ts)_
|
|
1557
2546
|
|
|
1558
2547
|
## `csdx plugins:install PLUGIN...`
|
|
1559
2548
|
|
|
@@ -1593,7 +2582,7 @@ EXAMPLES
|
|
|
1593
2582
|
$ csdx plugins:install someuser/someplugin
|
|
1594
2583
|
```
|
|
1595
2584
|
|
|
1596
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.
|
|
2585
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.3.2/src/commands/plugins/install.ts)_
|
|
1597
2586
|
|
|
1598
2587
|
## `csdx plugins:link PLUGIN`
|
|
1599
2588
|
|
|
@@ -1622,7 +2611,30 @@ EXAMPLES
|
|
|
1622
2611
|
$ csdx plugins:link myplugin
|
|
1623
2612
|
```
|
|
1624
2613
|
|
|
1625
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.
|
|
2614
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.3.2/src/commands/plugins/link.ts)_
|
|
2615
|
+
|
|
2616
|
+
## `csdx plugins:uninstall PLUGIN...`
|
|
2617
|
+
|
|
2618
|
+
Removes a plugin from the CLI.
|
|
2619
|
+
|
|
2620
|
+
```
|
|
2621
|
+
USAGE
|
|
2622
|
+
$ csdx plugins:uninstall PLUGIN...
|
|
2623
|
+
|
|
2624
|
+
ARGUMENTS
|
|
2625
|
+
PLUGIN plugin to uninstall
|
|
2626
|
+
|
|
2627
|
+
FLAGS
|
|
2628
|
+
-h, --help Show CLI help.
|
|
2629
|
+
-v, --verbose
|
|
2630
|
+
|
|
2631
|
+
DESCRIPTION
|
|
2632
|
+
Removes a plugin from the CLI.
|
|
2633
|
+
|
|
2634
|
+
ALIASES
|
|
2635
|
+
$ csdx plugins:unlink
|
|
2636
|
+
$ csdx plugins:remove
|
|
2637
|
+
```
|
|
1626
2638
|
|
|
1627
2639
|
## `csdx plugins:uninstall PLUGIN...`
|
|
1628
2640
|
|
|
@@ -1647,7 +2659,30 @@ ALIASES
|
|
|
1647
2659
|
$ csdx plugins:remove
|
|
1648
2660
|
```
|
|
1649
2661
|
|
|
1650
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.
|
|
2662
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.3.2/src/commands/plugins/uninstall.ts)_
|
|
2663
|
+
|
|
2664
|
+
## `csdx plugins:uninstall PLUGIN...`
|
|
2665
|
+
|
|
2666
|
+
Removes a plugin from the CLI.
|
|
2667
|
+
|
|
2668
|
+
```
|
|
2669
|
+
USAGE
|
|
2670
|
+
$ csdx plugins:uninstall PLUGIN...
|
|
2671
|
+
|
|
2672
|
+
ARGUMENTS
|
|
2673
|
+
PLUGIN plugin to uninstall
|
|
2674
|
+
|
|
2675
|
+
FLAGS
|
|
2676
|
+
-h, --help Show CLI help.
|
|
2677
|
+
-v, --verbose
|
|
2678
|
+
|
|
2679
|
+
DESCRIPTION
|
|
2680
|
+
Removes a plugin from the CLI.
|
|
2681
|
+
|
|
2682
|
+
ALIASES
|
|
2683
|
+
$ csdx plugins:unlink
|
|
2684
|
+
$ csdx plugins:remove
|
|
2685
|
+
```
|
|
1651
2686
|
|
|
1652
2687
|
## `csdx plugins:update`
|
|
1653
2688
|
|
|
@@ -1665,7 +2700,55 @@ DESCRIPTION
|
|
|
1665
2700
|
Update installed plugins.
|
|
1666
2701
|
```
|
|
1667
2702
|
|
|
1668
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.
|
|
2703
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.3.2/src/commands/plugins/update.ts)_
|
|
2704
|
+
|
|
2705
|
+
## `csdx tokens`
|
|
2706
|
+
|
|
2707
|
+
Lists all existing tokens added to the session
|
|
2708
|
+
|
|
2709
|
+
```
|
|
2710
|
+
USAGE
|
|
2711
|
+
$ csdx tokens [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output csv|json|yaml | |
|
|
2712
|
+
[--csv | --no-truncate]] [--no-header | ]
|
|
2713
|
+
|
|
2714
|
+
FLAGS
|
|
2715
|
+
-x, --extended show extra columns
|
|
2716
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
2717
|
+
--csv output is csv format [alias: --output=csv]
|
|
2718
|
+
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
2719
|
+
--no-header hide table header from output
|
|
2720
|
+
--no-truncate do not truncate output to fit screen
|
|
2721
|
+
--output=<option> output in a more machine friendly format
|
|
2722
|
+
<options: csv|json|yaml>
|
|
2723
|
+
--sort=<value> property to sort by (prepend '-' for descending)
|
|
2724
|
+
|
|
2725
|
+
DESCRIPTION
|
|
2726
|
+
Lists all existing tokens added to the session
|
|
2727
|
+
|
|
2728
|
+
ALIASES
|
|
2729
|
+
$ csdx tokens
|
|
2730
|
+
|
|
2731
|
+
EXAMPLES
|
|
2732
|
+
$ csdx auth:tokens
|
|
2733
|
+
```
|
|
2734
|
+
|
|
2735
|
+
## `csdx whoami`
|
|
2736
|
+
|
|
2737
|
+
Display current users email address
|
|
2738
|
+
|
|
2739
|
+
```
|
|
2740
|
+
USAGE
|
|
2741
|
+
$ csdx whoami
|
|
2742
|
+
|
|
2743
|
+
DESCRIPTION
|
|
2744
|
+
Display current users email address
|
|
2745
|
+
|
|
2746
|
+
ALIASES
|
|
2747
|
+
$ csdx whoami
|
|
2748
|
+
|
|
2749
|
+
EXAMPLES
|
|
2750
|
+
$ csdx auth:whoami
|
|
2751
|
+
```
|
|
1669
2752
|
<!-- commandsstop -->
|
|
1670
2753
|
|
|
1671
2754
|
```
|