@contentstack/cli-cm-bulk-publish 1.3.8 → 1.3.10

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.
Files changed (19) hide show
  1. package/README.md +204 -81
  2. package/oclif.manifest.json +127 -14
  3. package/package.json +6 -4
  4. package/src/commands/cm/assets/publish.js +32 -18
  5. package/src/commands/cm/assets/unpublish.js +32 -18
  6. package/src/commands/cm/bulk-publish/cross-publish.js +33 -18
  7. package/src/commands/cm/entries/publish-modified.js +26 -13
  8. package/src/commands/cm/entries/publish-non-localized-fields.js +26 -9
  9. package/src/commands/cm/entries/publish-only-unpublished.js +7 -0
  10. package/src/commands/cm/entries/publish.js +25 -13
  11. package/src/commands/cm/entries/unpublish.js +29 -17
  12. package/src/commands/cm/entries/update-and-publish.js +26 -15
  13. package/src/commands/cm/stacks/publish-configure.js +14 -9
  14. package/src/commands/cm/stacks/publish.js +2 -3
  15. package/src/commands/cm/stacks/unpublish.js +26 -16
  16. package/src/producer/cross-publish.js +6 -1
  17. package/src/producer/unpublish.js +6 -1
  18. package/src/services/publish-only-unpublished.js +16 -14
  19. package/src/util/client.js +19 -4
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.3.8 linux-x64 node-v16.20.0
21
+ @contentstack/cli-cm-bulk-publish/1.3.10 linux-x64 node-v18.17.0
22
22
  $ csdx --help [COMMAND]
23
23
  USAGE
24
24
  $ csdx COMMAND
@@ -70,6 +70,7 @@ FLAGS
70
70
  -a, --alias=<value> Alias(name) for the management token
71
71
  -c, --config=<value> Path to the config file
72
72
  -e, --environments=<value>... Environments where assets will be published
73
+ -k, --stack-api-key=<value> Stack api key to be used
73
74
  -l, --locales=<value>... Locales to where assets will be published
74
75
  -y, --yes Agree to process the command with the current configuration
75
76
  --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
@@ -124,6 +125,12 @@ EXAMPLES
124
125
  Using --source-env
125
126
 
126
127
  $ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
128
+
129
+
130
+
131
+ Using --stack-api-key flag
132
+
133
+ $ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --stack-api-key [STACK API KEY]
127
134
  ```
128
135
 
129
136
  _See code: [src/commands/cm/assets/publish.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/assets/publish.js)_
@@ -134,22 +141,23 @@ Unpublish assets from given environment
134
141
 
135
142
  ```
136
143
  USAGE
137
- $ csdx cm:assets:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>]
138
- [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--delivery-token <value>]
144
+ $ csdx cm:assets:unpublish [-a <value>] [-k <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch
145
+ <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--delivery-token <value>]
139
146
 
140
147
  FLAGS
141
- -a, --alias=<value> Alias(name) for the management token
142
- -c, --config=<value> Path to the config file
143
- -e, --environment=<value> Source Environment
144
- -y, --yes Agree to process the command with the current configuration
145
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
146
- --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
147
- selected)
148
- --bulk-unpublish=<value> [default: true] By default this flag is set as true. It indicates that contentstack's
149
- bulkpublish API will be used to unpublish the assets
150
- --delivery-token=<value> Delivery Token for source environment
151
- --locale=<value> Locale filter
152
- --retry-failed=<value> Retry unpublishing failed assets from the logfile
148
+ -a, --alias=<value> Alias(name) for the management token
149
+ -c, --config=<value> Path to the config file
150
+ -e, --environment=<value> Source Environment
151
+ -k, --stack-api-key=<value> Stack api key to be used
152
+ -y, --yes Agree to process the command with the current configuration
153
+ --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
154
+ --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
155
+ selected)
156
+ --bulk-unpublish=<value> [default: true] By default this flag is set as true. It indicates that contentstack's
157
+ bulkpublish API will be used to unpublish the assets
158
+ --delivery-token=<value> Delivery Token for source environment
159
+ --locale=<value> Locale filter
160
+ --retry-failed=<value> Retry unpublishing failed assets from the logfile
153
161
 
154
162
  DESCRIPTION
155
163
  Unpublish assets from given environment
@@ -184,6 +192,12 @@ EXAMPLES
184
192
  Using --branch flag
185
193
 
186
194
  $ csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
195
+
196
+
197
+
198
+ Using --stack-api-key flag
199
+
200
+ $ csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
187
201
  ```
188
202
 
189
203
  _See code: [src/commands/cm/assets/unpublish.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/assets/unpublish.js)_
@@ -217,6 +231,7 @@ FLAGS
217
231
  -a, --alias=<value> Alias(name) for the management token
218
232
  -c, --config=<value> Path to the config file
219
233
  -e, --environments=<value>... Environments where entries will be published
234
+ -k, --stack-api-key=<value> Stack api key to be used
220
235
  -l, --locales=<value>... Locales where entries will be published
221
236
  -t, --contentTypes=<value>... The Contenttypes from which entries will be published
222
237
  -y, --yes Agree to process the command with the current configuration
@@ -242,7 +257,7 @@ ALIASES
242
257
  EXAMPLES
243
258
  General Usage
244
259
 
245
- $ 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]
260
+ $ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
246
261
 
247
262
 
248
263
 
@@ -264,7 +279,13 @@ EXAMPLES
264
279
 
265
280
  Using --branch
266
281
 
267
- $ 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]
282
+ $ csdx cm:entries:update-and-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]
283
+
284
+
285
+
286
+ Using --stack-api-key
287
+
288
+ $ csdx cm:entries:update-and-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]
268
289
  ```
269
290
 
270
291
  ## `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>]`
@@ -282,6 +303,7 @@ FLAGS
282
303
  -a, --alias=<value> Alias(name) for the management token
283
304
  -c, --config=<value> Path to the config file
284
305
  -e, --environments=<value>... Environments where assets will be published
306
+ -k, --stack-api-key=<value> Stack api key to be used
285
307
  -l, --locales=<value>... Locales to where assets will be published
286
308
  -y, --yes Agree to process the command with the current configuration
287
309
  --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
@@ -336,6 +358,12 @@ EXAMPLES
336
358
  Using --source-env
337
359
 
338
360
  $ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
361
+
362
+
363
+
364
+ Using --stack-api-key flag
365
+
366
+ $ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --stack-api-key [STACK API KEY]
339
367
  ```
340
368
 
341
369
  ## `csdx cm:bulk-publish:clear`
@@ -372,10 +400,11 @@ The configure command is used to generate a configuration file for publish scrip
372
400
 
373
401
  ```
374
402
  USAGE
375
- $ csdx cm:bulk-publish:configure [-a <value>]
403
+ $ csdx cm:bulk-publish:configure [-a <value>] [-k <value>]
376
404
 
377
405
  FLAGS
378
- -a, --alias=<value> Alias(name) for the management token
406
+ -a, --alias=<value> Alias(name) for the management token
407
+ -k, --stack-api-key=<value> Stack api key to be used
379
408
 
380
409
  DESCRIPTION
381
410
  The configure command is used to generate a configuration file for publish scripts.
@@ -389,6 +418,8 @@ EXAMPLES
389
418
  $ csdx cm:stacks:publish-configure -a <management_token_alias>
390
419
 
391
420
  $ csdx cm:stacks:publish-configure --alias <management_token_alias>
421
+
422
+ $ csdx cm:stacks:publish-configure --stack-api-key <stack_api_key>
392
423
  ```
393
424
 
394
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]`
@@ -402,23 +433,24 @@ USAGE
402
433
  [-y] [--branch <value>] [--onlyAssets] [--onlyEntries]
403
434
 
404
435
  FLAGS
405
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
406
- selected)
407
- -a, --alias=<value> Alias(name) for the management token
408
- -c, --config=<value> Path to the config file
409
- -y, --yes Agree to process the command with the current configuration
410
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
411
- --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
412
- bulkpublish API will be used to publish the entries
413
- --content-type=<value>... The Contenttypes from which entries will be published
414
- --delivery-token=<value> Delivery token for source environment
415
- --environments=<value>... Destination Environments
416
- --locales=<value> Source locale
417
- --onlyAssets Unpublish only assets
418
- --onlyEntries Unpublish only entries
419
- --retry-failed=<value> (optional) Retry publishing failed entries from the logfile (this flag overrides all other
420
- flags)
421
- --source-env=<value> Source Env
436
+ -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
437
+ selected)
438
+ -a, --alias=<value> Alias(name) for the management token
439
+ -c, --config=<value> Path to the config file
440
+ -k, --stack-api-key=<value> Stack api key to be used
441
+ -y, --yes Agree to process the command with the current configuration
442
+ --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
443
+ --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
444
+ bulkpublish API will be used to publish the entries
445
+ --content-type=<value>... The Contenttypes from which entries will be published
446
+ --delivery-token=<value> Delivery token for source environment
447
+ --environments=<value>... Destination Environments
448
+ --locales=<value> Source locale
449
+ --onlyAssets Unpublish only assets
450
+ --onlyEntries Unpublish only entries
451
+ --retry-failed=<value> (optional) Retry publishing failed entries from the logfile (this flag overrides all
452
+ other flags)
453
+ --source-env=<value> Source Env
422
454
 
423
455
  DESCRIPTION
424
456
  Publish entries and assets from one environment to other environments
@@ -457,6 +489,12 @@ EXAMPLES
457
489
  Using --branch flag
458
490
 
459
491
  $ 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]
492
+
493
+
494
+
495
+ Using --stack-api-key flag
496
+
497
+ $ 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]
460
498
  ```
461
499
 
462
500
  _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)_
@@ -478,6 +516,7 @@ FLAGS
478
516
  -c, --config=<value> Path for the external config file (A new config file can be generated at the current
479
517
  working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
480
518
  -e, --environments=<value>... Environments where entries will be published
519
+ -k, --stack-api-key=<value> Stack api key to be used
481
520
  -l, --locales=<value>... Locales where entries will be published
482
521
  -y, --yes Agree to process the command with the current configuration
483
522
  --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
@@ -537,6 +576,12 @@ EXAMPLES
537
576
  Using --source-env
538
577
 
539
578
  $ 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]
579
+
580
+
581
+
582
+ Using --stack-api-key
583
+
584
+ $ 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]
540
585
  ```
541
586
 
542
587
  ## `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>]`
@@ -554,6 +599,7 @@ FLAGS
554
599
  -a, --alias=<value> Alias(name) for the management token
555
600
  -c, --config=<value> Path to the config file
556
601
  -e, --environments=<value>... Destination environments
602
+ -k, --stack-api-key=<value> Stack api key to be used
557
603
  -l, --locales=<value>... Locales where edited entries will be published
558
604
  -y, --yes Agree to process the command with the current configuration
559
605
  --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
@@ -604,6 +650,12 @@ EXAMPLES
604
650
  Using --branch
605
651
 
606
652
  $ 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]
653
+
654
+
655
+
656
+ Using --stack-api-key
657
+
658
+ $ 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] -stack-api-key [STACK API KEY]
607
659
  ```
608
660
 
609
661
  ## `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>]`
@@ -621,6 +673,7 @@ FLAGS
621
673
  -a, --alias=<value> Alias(name) for the management token
622
674
  -c, --config=<value> Path to the config file
623
675
  -e, --environments=<value>... Destination environments
676
+ -k, --stack-api-key=<value> Stack api key to be used
624
677
  -y, --yes Agree to process the command with the current configuration
625
678
  --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
626
679
  --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
@@ -667,6 +720,12 @@ EXAMPLES
667
720
  Using --branch flag
668
721
 
669
722
  $ 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]
723
+
724
+
725
+
726
+ Using --stack-api-key flag
727
+
728
+ $ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENV]
670
729
  ```
671
730
 
672
731
  ## `csdx cm:bulk-publish:revert`
@@ -713,18 +772,19 @@ USAGE
713
772
  [--only-assets] [--only-entries]
714
773
 
715
774
  FLAGS
716
- -B, --branch=<value> [default: main] Specify the branch to fetch the content from (default is main branch)
717
- -a, --alias=<value> Alias(name) for the management token
718
- -c, --config=<value> Path to the config file
719
- -e, --environment=<value> Source Environment
720
- -l, --locale=<value> Locale filter
721
- -y, --yes Agree to process the command with the current configuration
722
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
723
- --bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
724
- bulkpublish API will be used to unpublish the entries and assets
725
- --content-type=<value> Content type filter
726
- --delivery-token=<value> Delivery token for source environment
727
- --retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
775
+ -B, --branch=<value> [default: main] Specify the branch to fetch the content from (default is main branch)
776
+ -a, --alias=<value> Alias(name) for the management token
777
+ -c, --config=<value> Path to the config file
778
+ -e, --environment=<value> Source Environment
779
+ -k, --stack-api-key=<value> Stack api key to be used
780
+ -l, --locale=<value> Locale filter
781
+ -y, --yes Agree to process the command with the current configuration
782
+ --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
783
+ --bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
784
+ bulkpublish API will be used to unpublish the entries and assets
785
+ --content-type=<value> Content type filter
786
+ --delivery-token=<value> Delivery token for source environment
787
+ --retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
728
788
 
729
789
  DESCRIPTION
730
790
  Unpublish entries or assets of given content types from the specified environment
@@ -790,6 +850,12 @@ EXAMPLES
790
850
  Using --branch flag
791
851
 
792
852
  $ 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]
853
+
854
+
855
+
856
+ Using --stack-api-key flag
857
+
858
+ $ 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]
793
859
  ```
794
860
 
795
861
  ## `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>]`
@@ -810,6 +876,7 @@ FLAGS
810
876
  bulkpublish API will be used to publish the entries
811
877
  -c, --config=<value> Path to the config file
812
878
  -e, --environments=<value>... Destination environments
879
+ -k, --stack-api-key=<value> Stack api key to be used
813
880
  -y, --yes Agree to process the command with the current configuration
814
881
  --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
815
882
  --content-types=<value>... The Contenttypes from which entries will be published
@@ -856,6 +923,12 @@ EXAMPLES
856
923
  Using --branch
857
924
 
858
925
  $ 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]
926
+
927
+
928
+
929
+ Using --stack-api-key
930
+
931
+ $ 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]
859
932
  ```
860
933
 
861
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>]`
@@ -875,6 +948,7 @@ FLAGS
875
948
  -c, --config=<value> Path for the external config file (A new config file can be generated at the current
876
949
  working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
877
950
  -e, --environments=<value>... Environments where entries will be published
951
+ -k, --stack-api-key=<value> Stack api key to be used
878
952
  -l, --locales=<value>... Locales where entries will be published
879
953
  -y, --yes Agree to process the command with the current configuration
880
954
  --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
@@ -934,6 +1008,12 @@ EXAMPLES
934
1008
  Using --source-env
935
1009
 
936
1010
  $ 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]
1011
+
1012
+
1013
+
1014
+ Using --stack-api-key
1015
+
1016
+ $ 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]
937
1017
  ```
938
1018
 
939
1019
  _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)_
@@ -953,6 +1033,7 @@ FLAGS
953
1033
  -a, --alias=<value> Alias(name) for the management token
954
1034
  -c, --config=<value> Path to the config file
955
1035
  -e, --environments=<value>... Destination environments
1036
+ -k, --stack-api-key=<value> Stack api key to be used
956
1037
  -l, --locales=<value>... Locales where edited entries will be published
957
1038
  -y, --yes Agree to process the command with the current configuration
958
1039
  --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
@@ -1003,6 +1084,12 @@ EXAMPLES
1003
1084
  Using --branch
1004
1085
 
1005
1086
  $ 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]
1087
+
1088
+
1089
+
1090
+ Using --stack-api-key
1091
+
1092
+ $ 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] -stack-api-key [STACK API KEY]
1006
1093
  ```
1007
1094
 
1008
1095
  _See code: [src/commands/cm/entries/publish-modified.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-modified.js)_
@@ -1022,6 +1109,7 @@ FLAGS
1022
1109
  -a, --alias=<value> Alias(name) for the management token
1023
1110
  -c, --config=<value> Path to the config file
1024
1111
  -e, --environments=<value>... Destination environments
1112
+ -k, --stack-api-key=<value> Stack api key to be used
1025
1113
  -y, --yes Agree to process the command with the current configuration
1026
1114
  --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1027
1115
  --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
@@ -1068,6 +1156,12 @@ EXAMPLES
1068
1156
  Using --branch flag
1069
1157
 
1070
1158
  $ 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]
1159
+
1160
+
1161
+
1162
+ Using --stack-api-key flag
1163
+
1164
+ $ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENV]
1071
1165
  ```
1072
1166
 
1073
1167
  _See code: [src/commands/cm/entries/publish-non-localized-fields.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-non-localized-fields.js)_
@@ -1090,6 +1184,7 @@ FLAGS
1090
1184
  bulkpublish API will be used to publish the entries
1091
1185
  -c, --config=<value> Path to the config file
1092
1186
  -e, --environments=<value>... Destination environments
1187
+ -k, --stack-api-key=<value> Stack api key to be used
1093
1188
  -y, --yes Agree to process the command with the current configuration
1094
1189
  --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1095
1190
  --content-types=<value>... The Contenttypes from which entries will be published
@@ -1136,6 +1231,12 @@ EXAMPLES
1136
1231
  Using --branch
1137
1232
 
1138
1233
  $ 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]
1234
+
1235
+
1236
+
1237
+ Using --stack-api-key
1238
+
1239
+ $ 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]
1139
1240
  ```
1140
1241
 
1141
1242
  _See code: [src/commands/cm/entries/publish-only-unpublished.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-only-unpublished.js)_
@@ -1146,24 +1247,25 @@ Unpublish entries from the given environment
1146
1247
 
1147
1248
  ```
1148
1249
  USAGE
1149
- $ csdx cm:entries:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>]
1150
- [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--content-type <value>]
1250
+ $ csdx cm:entries:unpublish [-a <value>] [-k <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch
1251
+ <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--content-type <value>]
1151
1252
  [--delivery-token <value>]
1152
1253
 
1153
1254
  FLAGS
1154
- -a, --alias=<value> Alias(name) for the management token
1155
- -c, --config=<value> Path to the config file
1156
- -e, --environment=<value> Source Environment
1157
- -y, --yes Agree to process the command with the current configuration
1158
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1159
- --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
1160
- selected)
1161
- --bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1162
- bulkpublish API will be used to unpublish the entries
1163
- --content-type=<value> Content type filter
1164
- --delivery-token=<value> Delivery token for source environment
1165
- --locale=<value> Locale filter
1166
- --retry-failed=<value> Retry publishing failed entries from the logfile
1255
+ -a, --alias=<value> Alias(name) for the management token
1256
+ -c, --config=<value> Path to the config file
1257
+ -e, --environment=<value> Source Environment
1258
+ -k, --stack-api-key=<value> Stack api key to be used
1259
+ -y, --yes Agree to process the command with the current configuration
1260
+ --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1261
+ --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
1262
+ selected)
1263
+ --bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1264
+ bulkpublish API will be used to unpublish the entries
1265
+ --content-type=<value> Content type filter
1266
+ --delivery-token=<value> Delivery token for source environment
1267
+ --locale=<value> Locale filter
1268
+ --retry-failed=<value> Retry publishing failed entries from the logfile
1167
1269
 
1168
1270
  DESCRIPTION
1169
1271
  Unpublish entries from the given environment
@@ -1195,11 +1297,15 @@ EXAMPLES
1195
1297
 
1196
1298
 
1197
1299
 
1198
-
1199
-
1200
1300
  Using --branch flag
1201
1301
 
1202
1302
  $ 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]
1303
+
1304
+
1305
+
1306
+ Using --stack-api-key flag
1307
+
1308
+ $ 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]
1203
1309
  ```
1204
1310
 
1205
1311
  _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)_
@@ -1219,6 +1325,7 @@ FLAGS
1219
1325
  -a, --alias=<value> Alias(name) for the management token
1220
1326
  -c, --config=<value> Path to the config file
1221
1327
  -e, --environments=<value>... Environments where entries will be published
1328
+ -k, --stack-api-key=<value> Stack api key to be used
1222
1329
  -l, --locales=<value>... Locales where entries will be published
1223
1330
  -t, --contentTypes=<value>... The Contenttypes from which entries will be published
1224
1331
  -y, --yes Agree to process the command with the current configuration
@@ -1244,7 +1351,7 @@ ALIASES
1244
1351
  EXAMPLES
1245
1352
  General Usage
1246
1353
 
1247
- $ 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]
1354
+ $ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
1248
1355
 
1249
1356
 
1250
1357
 
@@ -1266,7 +1373,13 @@ EXAMPLES
1266
1373
 
1267
1374
  Using --branch
1268
1375
 
1269
- $ 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]
1376
+ $ csdx cm:entries:update-and-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]
1377
+
1378
+
1379
+
1380
+ Using --stack-api-key
1381
+
1382
+ $ csdx cm:entries:update-and-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]
1270
1383
  ```
1271
1384
 
1272
1385
  _See code: [src/commands/cm/entries/update-and-publish.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/update-and-publish.js)_
@@ -1359,10 +1472,11 @@ The configure command is used to generate a configuration file for publish scrip
1359
1472
 
1360
1473
  ```
1361
1474
  USAGE
1362
- $ csdx cm:stacks:publish-configure [-a <value>]
1475
+ $ csdx cm:stacks:publish-configure [-a <value>] [-k <value>]
1363
1476
 
1364
1477
  FLAGS
1365
- -a, --alias=<value> Alias(name) for the management token
1478
+ -a, --alias=<value> Alias(name) for the management token
1479
+ -k, --stack-api-key=<value> Stack api key to be used
1366
1480
 
1367
1481
  DESCRIPTION
1368
1482
  The configure command is used to generate a configuration file for publish scripts.
@@ -1376,6 +1490,8 @@ EXAMPLES
1376
1490
  $ csdx cm:stacks:publish-configure -a <management_token_alias>
1377
1491
 
1378
1492
  $ csdx cm:stacks:publish-configure --alias <management_token_alias>
1493
+
1494
+ $ csdx cm:stacks:publish-configure --stack-api-key <stack_api_key>
1379
1495
  ```
1380
1496
 
1381
1497
  _See code: [src/commands/cm/stacks/publish-configure.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-configure.js)_
@@ -1426,18 +1542,19 @@ USAGE
1426
1542
  [--only-assets] [--only-entries]
1427
1543
 
1428
1544
  FLAGS
1429
- -B, --branch=<value> [default: main] Specify the branch to fetch the content from (default is main branch)
1430
- -a, --alias=<value> Alias(name) for the management token
1431
- -c, --config=<value> Path to the config file
1432
- -e, --environment=<value> Source Environment
1433
- -l, --locale=<value> Locale filter
1434
- -y, --yes Agree to process the command with the current configuration
1435
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1436
- --bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1437
- bulkpublish API will be used to unpublish the entries and assets
1438
- --content-type=<value> Content type filter
1439
- --delivery-token=<value> Delivery token for source environment
1440
- --retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
1545
+ -B, --branch=<value> [default: main] Specify the branch to fetch the content from (default is main branch)
1546
+ -a, --alias=<value> Alias(name) for the management token
1547
+ -c, --config=<value> Path to the config file
1548
+ -e, --environment=<value> Source Environment
1549
+ -k, --stack-api-key=<value> Stack api key to be used
1550
+ -l, --locale=<value> Locale filter
1551
+ -y, --yes Agree to process the command with the current configuration
1552
+ --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1553
+ --bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1554
+ bulkpublish API will be used to unpublish the entries and assets
1555
+ --content-type=<value> Content type filter
1556
+ --delivery-token=<value> Delivery token for source environment
1557
+ --retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
1441
1558
 
1442
1559
  DESCRIPTION
1443
1560
  Unpublish entries or assets of given content types from the specified environment
@@ -1503,6 +1620,12 @@ EXAMPLES
1503
1620
  Using --branch flag
1504
1621
 
1505
1622
  $ 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]
1623
+
1624
+
1625
+
1626
+ Using --stack-api-key flag
1627
+
1628
+ $ 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]
1506
1629
  ```
1507
1630
 
1508
1631
  _See code: [src/commands/cm/stacks/unpublish.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/stacks/unpublish.js)_