@contentstack/cli-cm-bulk-publish 1.6.0 → 1.7.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 +391 -232
- package/package.json +5 -5
- package/src/commands/cm/assets/publish.js +17 -19
- package/src/commands/cm/assets/unpublish.js +11 -12
- package/src/commands/cm/bulk-publish/cross-publish.js +18 -7
- package/src/commands/cm/entries/publish-modified.js +16 -16
- package/src/commands/cm/entries/publish-non-localized-fields.js +14 -16
- package/src/commands/cm/entries/publish-only-unpublished.js +17 -17
- package/src/commands/cm/entries/publish.js +37 -19
- package/src/commands/cm/entries/unpublish.js +21 -14
- package/src/commands/cm/entries/update-and-publish.js +24 -17
- package/src/commands/cm/stacks/publish-configure.js +2 -2
- package/src/commands/cm/stacks/publish-revert.js +4 -4
- package/src/commands/cm/stacks/unpublish.js +2 -2
- package/src/producer/cross-publish.js +84 -5
- package/src/producer/publish-entries.js +100 -7
- package/src/producer/unpublish.js +77 -10
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-cm-bulk-publish
|
|
|
18
18
|
$ csdx COMMAND
|
|
19
19
|
running command...
|
|
20
20
|
$ csdx (--version)
|
|
21
|
-
@contentstack/cli-cm-bulk-publish/1.
|
|
21
|
+
@contentstack/cli-cm-bulk-publish/1.7.0 darwin-arm64 node-v22.2.0
|
|
22
22
|
$ csdx --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ csdx COMMAND
|
|
@@ -36,14 +36,14 @@ USAGE
|
|
|
36
36
|
* [`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)
|
|
37
37
|
* [`csdx cm:bulk-publish:clear`](#csdx-cmbulk-publishclear)
|
|
38
38
|
* [`csdx cm:bulk-publish:configure`](#csdx-cmbulk-publishconfigure)
|
|
39
|
-
* [`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)
|
|
40
|
-
* [`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)
|
|
39
|
+
* [`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] [--include-variants]`](#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---include-variants)
|
|
40
|
+
* [`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>] [--entry-uid <value>] [--include-variants]`](#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---entry-uid-value---include-variants)
|
|
41
41
|
* [`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)
|
|
42
42
|
* [`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)
|
|
43
43
|
* [`csdx cm:bulk-publish:revert`](#csdx-cmbulk-publishrevert)
|
|
44
44
|
* [`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)
|
|
45
45
|
* [`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)
|
|
46
|
-
* [`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)
|
|
46
|
+
* [`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>] [--entry-uid <value>] [--include-variants]`](#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---entry-uid-value---include-variants-1)
|
|
47
47
|
* [`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)
|
|
48
48
|
* [`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)
|
|
49
49
|
* [`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)
|
|
@@ -65,21 +65,29 @@ USAGE
|
|
|
65
65
|
<value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]
|
|
66
66
|
|
|
67
67
|
FLAGS
|
|
68
|
-
-B, --branch=<value> [default: main]
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
-
|
|
72
|
-
|
|
73
|
-
-
|
|
74
|
-
|
|
75
|
-
-
|
|
76
|
-
|
|
77
|
-
--
|
|
78
|
-
|
|
79
|
-
--
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
68
|
+
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
69
|
+
operation. If you don’t mention the branch name, then by default the assets from the
|
|
70
|
+
main branch will be published.
|
|
71
|
+
-a, --alias=<value> Alias (name) for the management token. You must use either the --alias flag or the
|
|
72
|
+
--stack-api-key flag.
|
|
73
|
+
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
74
|
+
for a single run. Refer to the configure command to create a configuration file.
|
|
75
|
+
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
76
|
+
environments, specify their names separated by spaces.
|
|
77
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
78
|
+
--alias flag.
|
|
79
|
+
-l, --locales=<value>... Locales in which assets will be published, e.g., en-us. In the case of multiple
|
|
80
|
+
locales, specify the codes separated by spaces.
|
|
81
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
82
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
83
|
+
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
84
|
+
default.
|
|
85
|
+
--delivery-token=<value> The delivery token of the source environment.
|
|
86
|
+
--folder-uid=<value> (optional) The UID of the Assets’ folder from which the assets need to be published.
|
|
87
|
+
The default value is cs_root.
|
|
88
|
+
--retry-failed=<value> Use this option to retry publishing the failed assets from the logfile. Specify the
|
|
89
|
+
name of the logfile that lists failed publish calls. If this option is used, it will
|
|
90
|
+
override all other flags.
|
|
83
91
|
--source-env=<value> Source environment
|
|
84
92
|
|
|
85
93
|
DESCRIPTION
|
|
@@ -145,19 +153,25 @@ USAGE
|
|
|
145
153
|
<value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--delivery-token <value>]
|
|
146
154
|
|
|
147
155
|
FLAGS
|
|
148
|
-
-a, --alias=<value> Alias(name)
|
|
149
|
-
|
|
150
|
-
-
|
|
151
|
-
|
|
152
|
-
-
|
|
153
|
-
--api-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
--
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
--
|
|
156
|
+
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
157
|
+
--stack-api-key flag.
|
|
158
|
+
-c, --config=<value> (optional) Path of an optional configuration JSON file containing all the options for a
|
|
159
|
+
single run. Refer to the configure command to create a configuration file.
|
|
160
|
+
-e, --environment=<value> The name of the environment from where entries/assets need to be unpublished.
|
|
161
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
|
|
162
|
+
flag.
|
|
163
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
164
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
165
|
+
--branch=<value> [default: main] The name of the branch where you want to perform the bulk unpublish
|
|
166
|
+
operation. If you don’t mention the branch name, then by default the content from the
|
|
167
|
+
main branch will be unpublished.
|
|
168
|
+
--bulk-unpublish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
169
|
+
default.
|
|
170
|
+
--delivery-token=<value> The delivery token of the source environment.
|
|
171
|
+
--locale=<value> Locale from which entries/assets will be unpublished, e.g., en-us.
|
|
172
|
+
--retry-failed=<value> (optional) Use this option to retry unpublishing the failed entries from the logfile.
|
|
173
|
+
Specify the name of the logfile that lists failed unpublish calls. If this option is
|
|
174
|
+
used, it will override all other flags.
|
|
161
175
|
|
|
162
176
|
DESCRIPTION
|
|
163
177
|
Unpublish assets from given environment
|
|
@@ -226,21 +240,30 @@ USAGE
|
|
|
226
240
|
<value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
|
|
227
241
|
|
|
228
242
|
FLAGS
|
|
229
|
-
-B, --branch=<value> [default: main]
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
-
|
|
233
|
-
|
|
234
|
-
-
|
|
235
|
-
|
|
236
|
-
-
|
|
237
|
-
|
|
238
|
-
--api-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
--
|
|
243
|
-
|
|
243
|
+
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
244
|
+
operation. If you don’t mention the branch name, then by default the content from the
|
|
245
|
+
main branch will be published.
|
|
246
|
+
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
247
|
+
--stack-api-key flag.
|
|
248
|
+
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
249
|
+
for a single run. Refer to the configure command to create a configuration file.
|
|
250
|
+
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
251
|
+
environments, specify their names separated by spaces.
|
|
252
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
253
|
+
--alias flag.
|
|
254
|
+
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
|
|
255
|
+
locales, specify the codes separated by spaces.
|
|
256
|
+
-t, --contentTypes=<value>... The Contenttypes from which entries will be published.
|
|
257
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
258
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
259
|
+
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
260
|
+
default.
|
|
261
|
+
--content-types=<value>... The UID of the content type ID whose entries you want to publish in bulk. In case of
|
|
262
|
+
multiple content types, specify their IDs separated by spaces.
|
|
263
|
+
--force Update and publish all entries even if no fields have been added.
|
|
264
|
+
--retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
|
|
265
|
+
name of the logfile that lists failed publish calls. If this option is used, it will
|
|
266
|
+
override all other flags.
|
|
244
267
|
|
|
245
268
|
DESCRIPTION
|
|
246
269
|
Add fields from updated content types to their respective entries
|
|
@@ -298,21 +321,29 @@ USAGE
|
|
|
298
321
|
<value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]
|
|
299
322
|
|
|
300
323
|
FLAGS
|
|
301
|
-
-B, --branch=<value> [default: main]
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
-
|
|
305
|
-
|
|
306
|
-
-
|
|
307
|
-
|
|
308
|
-
-
|
|
309
|
-
|
|
310
|
-
--
|
|
311
|
-
|
|
312
|
-
--
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
324
|
+
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
325
|
+
operation. If you don’t mention the branch name, then by default the assets from the
|
|
326
|
+
main branch will be published.
|
|
327
|
+
-a, --alias=<value> Alias (name) for the management token. You must use either the --alias flag or the
|
|
328
|
+
--stack-api-key flag.
|
|
329
|
+
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
330
|
+
for a single run. Refer to the configure command to create a configuration file.
|
|
331
|
+
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
332
|
+
environments, specify their names separated by spaces.
|
|
333
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
334
|
+
--alias flag.
|
|
335
|
+
-l, --locales=<value>... Locales in which assets will be published, e.g., en-us. In the case of multiple
|
|
336
|
+
locales, specify the codes separated by spaces.
|
|
337
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
338
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
339
|
+
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
340
|
+
default.
|
|
341
|
+
--delivery-token=<value> The delivery token of the source environment.
|
|
342
|
+
--folder-uid=<value> (optional) The UID of the Assets’ folder from which the assets need to be published.
|
|
343
|
+
The default value is cs_root.
|
|
344
|
+
--retry-failed=<value> Use this option to retry publishing the failed assets from the logfile. Specify the
|
|
345
|
+
name of the logfile that lists failed publish calls. If this option is used, it will
|
|
346
|
+
override all other flags.
|
|
316
347
|
--source-env=<value> Source environment
|
|
317
348
|
|
|
318
349
|
DESCRIPTION
|
|
@@ -403,8 +434,10 @@ USAGE
|
|
|
403
434
|
$ csdx cm:bulk-publish:configure [-a <value>] [-k <value>]
|
|
404
435
|
|
|
405
436
|
FLAGS
|
|
406
|
-
-a, --alias=<value>
|
|
407
|
-
|
|
437
|
+
-a, --alias=<value> Name (alias) of the management token you want to use. You must use either the --alias
|
|
438
|
+
flag or the --stack-api-key flag.
|
|
439
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
|
|
440
|
+
flag.
|
|
408
441
|
|
|
409
442
|
DESCRIPTION
|
|
410
443
|
The configure command is used to generate a configuration file for publish scripts.
|
|
@@ -422,7 +455,7 @@ EXAMPLES
|
|
|
422
455
|
$ csdx cm:stacks:publish-configure --stack-api-key <stack_api_key>
|
|
423
456
|
```
|
|
424
457
|
|
|
425
|
-
## `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]`
|
|
458
|
+
## `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] [--include-variants]`
|
|
426
459
|
|
|
427
460
|
Publish entries and assets from one environment to other environments
|
|
428
461
|
|
|
@@ -430,7 +463,7 @@ Publish entries and assets from one environment to other environments
|
|
|
430
463
|
USAGE
|
|
431
464
|
$ csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type
|
|
432
465
|
<value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>]
|
|
433
|
-
[-y] [--branch <value>] [--onlyAssets] [--onlyEntries]
|
|
466
|
+
[-y] [--branch <value>] [--onlyAssets] [--onlyEntries] [--include-variants]
|
|
434
467
|
|
|
435
468
|
FLAGS
|
|
436
469
|
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
@@ -439,12 +472,13 @@ FLAGS
|
|
|
439
472
|
-c, --config=<value> Path to the config file
|
|
440
473
|
-k, --stack-api-key=<value> Stack api key to be used
|
|
441
474
|
-y, --yes Agree to process the command with the current configuration
|
|
442
|
-
--api-version=<value> API
|
|
443
|
-
--bulk-publish=<value> [default: true]
|
|
444
|
-
|
|
475
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
476
|
+
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
477
|
+
default.
|
|
445
478
|
--content-type=<value>... The Contenttypes from which entries will be published
|
|
446
|
-
--delivery-token=<value>
|
|
479
|
+
--delivery-token=<value> The delivery token of the source environment.
|
|
447
480
|
--environments=<value>... Destination Environments
|
|
481
|
+
--include-variants Include Variants flag will publish all associated variant entries.
|
|
448
482
|
--locales=<value> Source locale
|
|
449
483
|
--onlyAssets Unpublish only assets
|
|
450
484
|
--onlyEntries Unpublish only entries
|
|
@@ -495,11 +529,17 @@ EXAMPLES
|
|
|
495
529
|
Using --stack-api-key flag
|
|
496
530
|
|
|
497
531
|
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
|
|
535
|
+
Using --include-variants flag
|
|
536
|
+
|
|
537
|
+
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN] [--include-variants]
|
|
498
538
|
```
|
|
499
539
|
|
|
500
540
|
_See code: [src/commands/cm/bulk-publish/cross-publish.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js)_
|
|
501
541
|
|
|
502
|
-
## `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>]`
|
|
542
|
+
## `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>] [--entry-uid <value>] [--include-variants]`
|
|
503
543
|
|
|
504
544
|
Publish entries from multiple contenttypes to multiple environments and locales
|
|
505
545
|
|
|
@@ -507,27 +547,36 @@ Publish entries from multiple contenttypes to multiple environments and locales
|
|
|
507
547
|
USAGE
|
|
508
548
|
$ csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
509
549
|
[--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
|
|
510
|
-
<value>] [--delivery-token <value>] [--source-env <value>]
|
|
550
|
+
<value>] [--delivery-token <value>] [--source-env <value>] [--entry-uid <value>] [--include-variants]
|
|
511
551
|
|
|
512
552
|
FLAGS
|
|
513
|
-
-B, --branch=<value> [default: main]
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
-
|
|
517
|
-
|
|
518
|
-
-
|
|
519
|
-
|
|
520
|
-
-
|
|
521
|
-
|
|
522
|
-
--api-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
--
|
|
528
|
-
--
|
|
529
|
-
|
|
530
|
-
|
|
553
|
+
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
554
|
+
operation. If you don’t mention the branch name, then by default the content from main
|
|
555
|
+
branch will be published.
|
|
556
|
+
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
557
|
+
--stack-api-key flag.
|
|
558
|
+
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
559
|
+
for a single run. Refer to the configure command to create a configuration file.
|
|
560
|
+
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
561
|
+
environments, specify their names separated by spaces.
|
|
562
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
563
|
+
--alias flag.
|
|
564
|
+
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
|
|
565
|
+
locales, specify the codes separated by spaces.
|
|
566
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
567
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
568
|
+
--bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. This flag is set
|
|
569
|
+
to true, by default.
|
|
570
|
+
--content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
|
|
571
|
+
multiple content types, specify the IDs separated by spaces.
|
|
572
|
+
--delivery-token=<value> The delivery token of the source environment.
|
|
573
|
+
--entry-uid=<value> Entry Uid for publish all associated variant entries.
|
|
574
|
+
--include-variants Include Variants flag will publish all associated variant entries with base entry.
|
|
575
|
+
--publish-all-content-types (optional) Set it to true to bulk publish entries from all content types. If the
|
|
576
|
+
--content-types option is already used, then you cannot use this option.
|
|
577
|
+
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/ assets from the
|
|
578
|
+
logfile. Specify the name of the logfile that lists failed publish calls. If this
|
|
579
|
+
option is used, it will override all other flags.
|
|
531
580
|
--source-env=<value> Source environment
|
|
532
581
|
|
|
533
582
|
DESCRIPTION
|
|
@@ -582,6 +631,18 @@ EXAMPLES
|
|
|
582
631
|
Using --stack-api-key
|
|
583
632
|
|
|
584
633
|
$ csdx cm:entries:publish -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
Using --include-variants
|
|
638
|
+
|
|
639
|
+
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] [--include-variants]
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
|
|
643
|
+
Using --entry-uid and --include-variants
|
|
644
|
+
|
|
645
|
+
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] --entry-uid [ENTRY UID] [--include-variants]
|
|
585
646
|
```
|
|
586
647
|
|
|
587
648
|
## `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>]`
|
|
@@ -594,20 +655,29 @@ USAGE
|
|
|
594
655
|
<value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
595
656
|
|
|
596
657
|
FLAGS
|
|
597
|
-
-B, --branch=<value> [default: main]
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
-
|
|
601
|
-
|
|
602
|
-
-
|
|
603
|
-
|
|
604
|
-
-
|
|
605
|
-
|
|
606
|
-
--
|
|
607
|
-
|
|
608
|
-
--
|
|
609
|
-
|
|
610
|
-
|
|
658
|
+
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
659
|
+
operation. If you don't mention the branch name, then by default the entries from main
|
|
660
|
+
branch will be published.
|
|
661
|
+
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
662
|
+
--stack-api-key flag.
|
|
663
|
+
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
664
|
+
for a single run. Refer to the configure command to create a configuration file.
|
|
665
|
+
-e, --environments=<value>... The name of the environment(s) on which the entries will be published. In case of
|
|
666
|
+
multiple environments, specify their names separated by spaces.
|
|
667
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
668
|
+
--alias flag.
|
|
669
|
+
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
|
|
670
|
+
locales, specify the codes separated by spaces.
|
|
671
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
672
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
673
|
+
--bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
|
|
674
|
+
default.
|
|
675
|
+
--content-types=<value>... The UID of the content type(s) whose edited entries you want to publish in bulk. In
|
|
676
|
+
case of multiple content types, specify the IDs separated by spaces.
|
|
677
|
+
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/assets from the
|
|
678
|
+
logfile. Specify the name of the logfile that lists failed publish calls. If this
|
|
679
|
+
option is used, it will override all other flags
|
|
680
|
+
--source-env=<value> The name of the source environment where the entries were initially published.
|
|
611
681
|
|
|
612
682
|
DESCRIPTION
|
|
613
683
|
Publish edited entries from a specified content type to the given locales and environments
|
|
@@ -668,19 +738,27 @@ USAGE
|
|
|
668
738
|
[--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
669
739
|
|
|
670
740
|
FLAGS
|
|
671
|
-
-B, --branch=<value> [default: main]
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
-
|
|
675
|
-
|
|
676
|
-
-
|
|
677
|
-
|
|
678
|
-
--
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
|
|
683
|
-
--
|
|
741
|
+
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
742
|
+
operation. If you don’t mention the branch name, then by default the content from the
|
|
743
|
+
main branch will be published.
|
|
744
|
+
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
745
|
+
--stack-api-key flag.
|
|
746
|
+
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
747
|
+
for a single run. Refer to the configure command to create a configuration file.
|
|
748
|
+
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
749
|
+
environments, specify their names separated by spaces.
|
|
750
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
751
|
+
--alias flag.
|
|
752
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
753
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
754
|
+
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
755
|
+
default.
|
|
756
|
+
--content-types=<value>... The UID of the content type whose entries you want to publish in bulk. In case of
|
|
757
|
+
multiple content types, specify their IDs separated by spaces.
|
|
758
|
+
--retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
|
|
759
|
+
name of the logfile that lists failed publish calls. If this option is used, it will
|
|
760
|
+
override all other flags.
|
|
761
|
+
--source-env=<value> The name of the source environment.
|
|
684
762
|
|
|
685
763
|
DESCRIPTION
|
|
686
764
|
Publish non-localized fields for the given content types, from a particular source environment to the specified
|
|
@@ -737,8 +815,10 @@ USAGE
|
|
|
737
815
|
$ csdx cm:bulk-publish:revert [--retry-failed <value>] [--log-file <value>]
|
|
738
816
|
|
|
739
817
|
FLAGS
|
|
740
|
-
--log-file=<value> logfile
|
|
741
|
-
--retry-failed=<value> retry publishing failed entries from the logfile
|
|
818
|
+
--log-file=<value> Path of the success logfile of a particular publish action.
|
|
819
|
+
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. Specify
|
|
820
|
+
the name of the logfile that lists failed publish calls. If this option is used, it will
|
|
821
|
+
override all other flags.
|
|
742
822
|
|
|
743
823
|
DESCRIPTION
|
|
744
824
|
Revert publish operations by using a log file
|
|
@@ -779,11 +859,11 @@ FLAGS
|
|
|
779
859
|
-k, --stack-api-key=<value> Stack api key to be used
|
|
780
860
|
-l, --locale=<value> Locale filter
|
|
781
861
|
-y, --yes Agree to process the command with the current configuration
|
|
782
|
-
--api-version=<value> API
|
|
862
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
783
863
|
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
784
864
|
bulkpublish API will be used to unpublish the entries and assets
|
|
785
865
|
--content-type=<value> Content type filter
|
|
786
|
-
--delivery-token=<value>
|
|
866
|
+
--delivery-token=<value> The delivery token of the source environment.
|
|
787
867
|
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
788
868
|
|
|
789
869
|
DESCRIPTION
|
|
@@ -869,20 +949,28 @@ USAGE
|
|
|
869
949
|
<value>]
|
|
870
950
|
|
|
871
951
|
FLAGS
|
|
872
|
-
-B, --branch=<value> [default: main]
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
-
|
|
876
|
-
|
|
877
|
-
-
|
|
878
|
-
|
|
879
|
-
-
|
|
880
|
-
|
|
881
|
-
--
|
|
882
|
-
|
|
883
|
-
--
|
|
884
|
-
|
|
885
|
-
|
|
952
|
+
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
953
|
+
operation. If you don't mention the branch name, then by default the entries from main
|
|
954
|
+
branch will be published.
|
|
955
|
+
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
956
|
+
--stack-api-key flag.
|
|
957
|
+
-b, --bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
|
|
958
|
+
default.
|
|
959
|
+
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
960
|
+
for a single run. Refer to the configure command to create a configuration file.
|
|
961
|
+
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
962
|
+
environments, specify their names separated by spaces.
|
|
963
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
964
|
+
--alias flag.
|
|
965
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
966
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]..
|
|
967
|
+
--content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
|
|
968
|
+
multiple content types, specify their IDs separated by spaces.
|
|
969
|
+
--locales=<value> Locale in which entries will be published, e.g., en-us
|
|
970
|
+
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. It
|
|
971
|
+
is optional. Specify the name of the logfile that lists failed publish calls. If this
|
|
972
|
+
option is used, it will override all other flags.
|
|
973
|
+
--source-env=<value> The name of the source environment where the entries were initially published.
|
|
886
974
|
|
|
887
975
|
DESCRIPTION
|
|
888
976
|
Publish unpublished entries from the source environment, to other environments and locales
|
|
@@ -931,7 +1019,7 @@ EXAMPLES
|
|
|
931
1019
|
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --stack-api-key [STACK API KEY] -source-env [SOURCE ENV]
|
|
932
1020
|
```
|
|
933
1021
|
|
|
934
|
-
## `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>]`
|
|
1022
|
+
## `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>] [--entry-uid <value>] [--include-variants]`
|
|
935
1023
|
|
|
936
1024
|
Publish entries from multiple contenttypes to multiple environments and locales
|
|
937
1025
|
|
|
@@ -939,27 +1027,36 @@ Publish entries from multiple contenttypes to multiple environments and locales
|
|
|
939
1027
|
USAGE
|
|
940
1028
|
$ csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
941
1029
|
[--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
|
|
942
|
-
<value>] [--delivery-token <value>] [--source-env <value>]
|
|
1030
|
+
<value>] [--delivery-token <value>] [--source-env <value>] [--entry-uid <value>] [--include-variants]
|
|
943
1031
|
|
|
944
1032
|
FLAGS
|
|
945
|
-
-B, --branch=<value> [default: main]
|
|
946
|
-
|
|
947
|
-
|
|
948
|
-
-
|
|
949
|
-
|
|
950
|
-
-
|
|
951
|
-
|
|
952
|
-
-
|
|
953
|
-
|
|
954
|
-
--api-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
--
|
|
960
|
-
--
|
|
961
|
-
|
|
962
|
-
|
|
1033
|
+
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1034
|
+
operation. If you don’t mention the branch name, then by default the content from main
|
|
1035
|
+
branch will be published.
|
|
1036
|
+
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1037
|
+
--stack-api-key flag.
|
|
1038
|
+
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
1039
|
+
for a single run. Refer to the configure command to create a configuration file.
|
|
1040
|
+
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
1041
|
+
environments, specify their names separated by spaces.
|
|
1042
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1043
|
+
--alias flag.
|
|
1044
|
+
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
|
|
1045
|
+
locales, specify the codes separated by spaces.
|
|
1046
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
1047
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1048
|
+
--bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. This flag is set
|
|
1049
|
+
to true, by default.
|
|
1050
|
+
--content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
|
|
1051
|
+
multiple content types, specify the IDs separated by spaces.
|
|
1052
|
+
--delivery-token=<value> The delivery token of the source environment.
|
|
1053
|
+
--entry-uid=<value> Entry Uid for publish all associated variant entries.
|
|
1054
|
+
--include-variants Include Variants flag will publish all associated variant entries with base entry.
|
|
1055
|
+
--publish-all-content-types (optional) Set it to true to bulk publish entries from all content types. If the
|
|
1056
|
+
--content-types option is already used, then you cannot use this option.
|
|
1057
|
+
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/ assets from the
|
|
1058
|
+
logfile. Specify the name of the logfile that lists failed publish calls. If this
|
|
1059
|
+
option is used, it will override all other flags.
|
|
963
1060
|
--source-env=<value> Source environment
|
|
964
1061
|
|
|
965
1062
|
DESCRIPTION
|
|
@@ -1014,6 +1111,18 @@ EXAMPLES
|
|
|
1014
1111
|
Using --stack-api-key
|
|
1015
1112
|
|
|
1016
1113
|
$ csdx cm:entries:publish -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
Using --include-variants
|
|
1118
|
+
|
|
1119
|
+
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] [--include-variants]
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
Using --entry-uid and --include-variants
|
|
1124
|
+
|
|
1125
|
+
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] --entry-uid [ENTRY UID] [--include-variants]
|
|
1017
1126
|
```
|
|
1018
1127
|
|
|
1019
1128
|
_See code: [src/commands/cm/entries/publish.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js)_
|
|
@@ -1028,20 +1137,29 @@ USAGE
|
|
|
1028
1137
|
<value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
1029
1138
|
|
|
1030
1139
|
FLAGS
|
|
1031
|
-
-B, --branch=<value> [default: main]
|
|
1032
|
-
|
|
1033
|
-
|
|
1034
|
-
-
|
|
1035
|
-
|
|
1036
|
-
-
|
|
1037
|
-
|
|
1038
|
-
-
|
|
1039
|
-
|
|
1040
|
-
--
|
|
1041
|
-
|
|
1042
|
-
--
|
|
1043
|
-
|
|
1044
|
-
|
|
1140
|
+
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1141
|
+
operation. If you don't mention the branch name, then by default the entries from main
|
|
1142
|
+
branch will be published.
|
|
1143
|
+
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1144
|
+
--stack-api-key flag.
|
|
1145
|
+
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
1146
|
+
for a single run. Refer to the configure command to create a configuration file.
|
|
1147
|
+
-e, --environments=<value>... The name of the environment(s) on which the entries will be published. In case of
|
|
1148
|
+
multiple environments, specify their names separated by spaces.
|
|
1149
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1150
|
+
--alias flag.
|
|
1151
|
+
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
|
|
1152
|
+
locales, specify the codes separated by spaces.
|
|
1153
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
1154
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1155
|
+
--bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
|
|
1156
|
+
default.
|
|
1157
|
+
--content-types=<value>... The UID of the content type(s) whose edited entries you want to publish in bulk. In
|
|
1158
|
+
case of multiple content types, specify the IDs separated by spaces.
|
|
1159
|
+
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/assets from the
|
|
1160
|
+
logfile. Specify the name of the logfile that lists failed publish calls. If this
|
|
1161
|
+
option is used, it will override all other flags
|
|
1162
|
+
--source-env=<value> The name of the source environment where the entries were initially published.
|
|
1045
1163
|
|
|
1046
1164
|
DESCRIPTION
|
|
1047
1165
|
Publish edited entries from a specified content type to the given locales and environments
|
|
@@ -1104,19 +1222,27 @@ USAGE
|
|
|
1104
1222
|
[--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
1105
1223
|
|
|
1106
1224
|
FLAGS
|
|
1107
|
-
-B, --branch=<value> [default: main]
|
|
1108
|
-
|
|
1109
|
-
|
|
1110
|
-
-
|
|
1111
|
-
|
|
1112
|
-
-
|
|
1113
|
-
|
|
1114
|
-
--
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
|
-
|
|
1118
|
-
|
|
1119
|
-
--
|
|
1225
|
+
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1226
|
+
operation. If you don’t mention the branch name, then by default the content from the
|
|
1227
|
+
main branch will be published.
|
|
1228
|
+
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1229
|
+
--stack-api-key flag.
|
|
1230
|
+
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
1231
|
+
for a single run. Refer to the configure command to create a configuration file.
|
|
1232
|
+
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
1233
|
+
environments, specify their names separated by spaces.
|
|
1234
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1235
|
+
--alias flag.
|
|
1236
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
1237
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1238
|
+
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
1239
|
+
default.
|
|
1240
|
+
--content-types=<value>... The UID of the content type whose entries you want to publish in bulk. In case of
|
|
1241
|
+
multiple content types, specify their IDs separated by spaces.
|
|
1242
|
+
--retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
|
|
1243
|
+
name of the logfile that lists failed publish calls. If this option is used, it will
|
|
1244
|
+
override all other flags.
|
|
1245
|
+
--source-env=<value> The name of the source environment.
|
|
1120
1246
|
|
|
1121
1247
|
DESCRIPTION
|
|
1122
1248
|
Publish non-localized fields for the given content types, from a particular source environment to the specified
|
|
@@ -1177,20 +1303,28 @@ USAGE
|
|
|
1177
1303
|
<value>]
|
|
1178
1304
|
|
|
1179
1305
|
FLAGS
|
|
1180
|
-
-B, --branch=<value> [default: main]
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
-
|
|
1184
|
-
|
|
1185
|
-
-
|
|
1186
|
-
|
|
1187
|
-
-
|
|
1188
|
-
|
|
1189
|
-
--
|
|
1190
|
-
|
|
1191
|
-
--
|
|
1192
|
-
|
|
1193
|
-
|
|
1306
|
+
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1307
|
+
operation. If you don't mention the branch name, then by default the entries from main
|
|
1308
|
+
branch will be published.
|
|
1309
|
+
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1310
|
+
--stack-api-key flag.
|
|
1311
|
+
-b, --bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
|
|
1312
|
+
default.
|
|
1313
|
+
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
1314
|
+
for a single run. Refer to the configure command to create a configuration file.
|
|
1315
|
+
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
1316
|
+
environments, specify their names separated by spaces.
|
|
1317
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1318
|
+
--alias flag.
|
|
1319
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
1320
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]..
|
|
1321
|
+
--content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
|
|
1322
|
+
multiple content types, specify their IDs separated by spaces.
|
|
1323
|
+
--locales=<value> Locale in which entries will be published, e.g., en-us
|
|
1324
|
+
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. It
|
|
1325
|
+
is optional. Specify the name of the logfile that lists failed publish calls. If this
|
|
1326
|
+
option is used, it will override all other flags.
|
|
1327
|
+
--source-env=<value> The name of the source environment where the entries were initially published.
|
|
1194
1328
|
|
|
1195
1329
|
DESCRIPTION
|
|
1196
1330
|
Publish unpublished entries from the source environment, to other environments and locales
|
|
@@ -1249,23 +1383,29 @@ Unpublish entries from the given environment
|
|
|
1249
1383
|
USAGE
|
|
1250
1384
|
$ csdx cm:entries:unpublish [-a <value>] [-k <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch
|
|
1251
1385
|
<value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--content-type <value>]
|
|
1252
|
-
[--delivery-token <value>]
|
|
1386
|
+
[--delivery-token <value>] [--include-variants]
|
|
1253
1387
|
|
|
1254
1388
|
FLAGS
|
|
1255
|
-
-a, --alias=<value> Alias(name) for the management token
|
|
1256
|
-
|
|
1257
|
-
-
|
|
1258
|
-
|
|
1259
|
-
-
|
|
1260
|
-
--api-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
--
|
|
1264
|
-
|
|
1265
|
-
|
|
1266
|
-
--
|
|
1267
|
-
|
|
1268
|
-
--
|
|
1389
|
+
-a, --alias=<value> Alias (name) for the management token. You must use either the --alias flag or the
|
|
1390
|
+
--stack-api-key flag.
|
|
1391
|
+
-c, --config=<value> (optional) Path to the configuration JSON file containing all options for a single run.
|
|
1392
|
+
Refer to the configure command to create a configuration file.
|
|
1393
|
+
-e, --environment=<value> The name of the environment from where entries/assets need to be unpublished.
|
|
1394
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
|
|
1395
|
+
flag.
|
|
1396
|
+
-y, --yes Set to true to process the command with the current configuration.
|
|
1397
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1398
|
+
--branch=<value> [default: main] Specify the branch to fetch the content. If not mentioned, the main
|
|
1399
|
+
branch will be used by default.
|
|
1400
|
+
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that Contentstack's
|
|
1401
|
+
Bulk Publish APIs will be used to unpublish the entries.
|
|
1402
|
+
--content-type=<value> The UID of the content type whose entries you want to unpublish in bulk.
|
|
1403
|
+
--delivery-token=<value> The delivery token of the source environment.
|
|
1404
|
+
--include-variants Include Variants flag will unpublish all associated variant entries.
|
|
1405
|
+
--locale=<value> Locale from which entries/assets will be unpublished, e.g., en-us.
|
|
1406
|
+
--retry-failed=<value> (optional) Use this option to retry unpublishing the failed entries from the logfile.
|
|
1407
|
+
Specify the name of the logfile that lists failed unpublish calls. If used, this option
|
|
1408
|
+
will override all other flags.
|
|
1269
1409
|
|
|
1270
1410
|
DESCRIPTION
|
|
1271
1411
|
Unpublish entries from the given environment
|
|
@@ -1306,6 +1446,12 @@ EXAMPLES
|
|
|
1306
1446
|
Using --stack-api-key flag
|
|
1307
1447
|
|
|
1308
1448
|
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
Using --include-variants flag
|
|
1453
|
+
|
|
1454
|
+
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN] --include-variants
|
|
1309
1455
|
```
|
|
1310
1456
|
|
|
1311
1457
|
_See code: [src/commands/cm/entries/unpublish.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/unpublish.js)_
|
|
@@ -1320,21 +1466,30 @@ USAGE
|
|
|
1320
1466
|
<value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
|
|
1321
1467
|
|
|
1322
1468
|
FLAGS
|
|
1323
|
-
-B, --branch=<value> [default: main]
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
-
|
|
1327
|
-
|
|
1328
|
-
-
|
|
1329
|
-
|
|
1330
|
-
-
|
|
1331
|
-
|
|
1332
|
-
--api-
|
|
1333
|
-
|
|
1334
|
-
|
|
1335
|
-
|
|
1336
|
-
--
|
|
1337
|
-
|
|
1469
|
+
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1470
|
+
operation. If you don’t mention the branch name, then by default the content from the
|
|
1471
|
+
main branch will be published.
|
|
1472
|
+
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1473
|
+
--stack-api-key flag.
|
|
1474
|
+
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
1475
|
+
for a single run. Refer to the configure command to create a configuration file.
|
|
1476
|
+
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
1477
|
+
environments, specify their names separated by spaces.
|
|
1478
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1479
|
+
--alias flag.
|
|
1480
|
+
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
|
|
1481
|
+
locales, specify the codes separated by spaces.
|
|
1482
|
+
-t, --contentTypes=<value>... The Contenttypes from which entries will be published.
|
|
1483
|
+
-y, --yes Set it to true to process the command with the current configuration.
|
|
1484
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1485
|
+
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
1486
|
+
default.
|
|
1487
|
+
--content-types=<value>... The UID of the content type ID whose entries you want to publish in bulk. In case of
|
|
1488
|
+
multiple content types, specify their IDs separated by spaces.
|
|
1489
|
+
--force Update and publish all entries even if no fields have been added.
|
|
1490
|
+
--retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
|
|
1491
|
+
name of the logfile that lists failed publish calls. If this option is used, it will
|
|
1492
|
+
override all other flags.
|
|
1338
1493
|
|
|
1339
1494
|
DESCRIPTION
|
|
1340
1495
|
Add fields from updated content types to their respective entries
|
|
@@ -1475,8 +1630,10 @@ USAGE
|
|
|
1475
1630
|
$ csdx cm:stacks:publish-configure [-a <value>] [-k <value>]
|
|
1476
1631
|
|
|
1477
1632
|
FLAGS
|
|
1478
|
-
-a, --alias=<value>
|
|
1479
|
-
|
|
1633
|
+
-a, --alias=<value> Name (alias) of the management token you want to use. You must use either the --alias
|
|
1634
|
+
flag or the --stack-api-key flag.
|
|
1635
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
|
|
1636
|
+
flag.
|
|
1480
1637
|
|
|
1481
1638
|
DESCRIPTION
|
|
1482
1639
|
The configure command is used to generate a configuration file for publish scripts.
|
|
@@ -1505,8 +1662,10 @@ USAGE
|
|
|
1505
1662
|
$ csdx cm:stacks:publish-revert [--retry-failed <value>] [--log-file <value>]
|
|
1506
1663
|
|
|
1507
1664
|
FLAGS
|
|
1508
|
-
--log-file=<value> logfile
|
|
1509
|
-
--retry-failed=<value> retry publishing failed entries from the logfile
|
|
1665
|
+
--log-file=<value> Path of the success logfile of a particular publish action.
|
|
1666
|
+
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. Specify
|
|
1667
|
+
the name of the logfile that lists failed publish calls. If this option is used, it will
|
|
1668
|
+
override all other flags.
|
|
1510
1669
|
|
|
1511
1670
|
DESCRIPTION
|
|
1512
1671
|
Revert publish operations by using a log file
|
|
@@ -1549,11 +1708,11 @@ FLAGS
|
|
|
1549
1708
|
-k, --stack-api-key=<value> Stack api key to be used
|
|
1550
1709
|
-l, --locale=<value> Locale filter
|
|
1551
1710
|
-y, --yes Agree to process the command with the current configuration
|
|
1552
|
-
--api-version=<value> API
|
|
1711
|
+
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1553
1712
|
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
1554
1713
|
bulkpublish API will be used to unpublish the entries and assets
|
|
1555
1714
|
--content-type=<value> Content type filter
|
|
1556
|
-
--delivery-token=<value>
|
|
1715
|
+
--delivery-token=<value> The delivery token of the source environment.
|
|
1557
1716
|
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
1558
1717
|
|
|
1559
1718
|
DESCRIPTION
|