@contentstack/cli-cm-bulk-publish 1.3.9 → 1.3.11

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 (14) hide show
  1. package/README.md +145 -50
  2. package/package.json +3 -3
  3. package/src/commands/cm/entries/publish-modified.js +26 -13
  4. package/src/commands/cm/entries/publish-non-localized-fields.js +26 -9
  5. package/src/commands/cm/entries/publish-only-unpublished.js +7 -0
  6. package/src/commands/cm/entries/publish.js +22 -13
  7. package/src/commands/cm/entries/unpublish.js +26 -17
  8. package/src/commands/cm/entries/update-and-publish.js +26 -15
  9. package/src/commands/cm/stacks/publish-configure.js +14 -9
  10. package/src/commands/cm/stacks/publish.js +2 -3
  11. package/src/commands/cm/stacks/unpublish.js +29 -16
  12. package/src/services/publish-only-unpublished.js +16 -14
  13. package/src/util/command-helper.js +1 -1
  14. package/oclif.manifest.json +0 -1581
package/oclif.manifest.json DELETED
@@ -1,1581 +0,0 @@
1
- {
2
- "version": "1.3.9",
3
- "commands": {
4
- "cm:assets:publish": {
5
- "id": "cm:assets:publish",
6
- "description": "Publish assets to the specified environments\nThe assets command is used to publish assets from the specified stack, to the specified environments\n\nNote: Environment(s) and Locale(s) are required to execute the command successfully\nBut, if retryFailed flag is set, then only a logfile is required\n",
7
- "strict": true,
8
- "usage": "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>]",
9
- "pluginName": "@contentstack/cli-cm-bulk-publish",
10
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
11
- "pluginType": "core",
12
- "aliases": [
13
- "cm:bulk-publish:assets"
14
- ],
15
- "examples": [
16
- "General Usage",
17
- "csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]",
18
- "",
19
- "Using --config or -c flag",
20
- "Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
21
- "csdx cm:assets:publish --config [PATH TO CONFIG FILE]",
22
- "csdx cm:assets:publish -c [PATH TO CONFIG FILE]",
23
- "",
24
- "Using --retry-failed flag",
25
- "csdx cm:assets:publish --retry-failed [LOG FILE NAME]",
26
- "",
27
- "Using --branch flag",
28
- "csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]",
29
- "",
30
- "Using --source-env",
31
- "csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]",
32
- "",
33
- "Using --stack-api-key flag",
34
- "csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --stack-api-key [STACK API KEY]"
35
- ],
36
- "flags": {
37
- "alias": {
38
- "name": "alias",
39
- "type": "option",
40
- "char": "a",
41
- "description": "Alias(name) for the management token",
42
- "multiple": false
43
- },
44
- "stack-api-key": {
45
- "name": "stack-api-key",
46
- "type": "option",
47
- "char": "k",
48
- "description": "Stack api key to be used",
49
- "required": false,
50
- "multiple": false
51
- },
52
- "retry-failed": {
53
- "name": "retry-failed",
54
- "type": "option",
55
- "description": "Retry publishing failed assets from the logfile (optional, will override all other flags)",
56
- "multiple": false
57
- },
58
- "environments": {
59
- "name": "environments",
60
- "type": "option",
61
- "char": "e",
62
- "description": "Environments where assets will be published",
63
- "multiple": true
64
- },
65
- "folder-uid": {
66
- "name": "folder-uid",
67
- "type": "option",
68
- "description": "[default: cs_root] Folder-uid from where the assets will be published",
69
- "multiple": false,
70
- "exclusive": [
71
- "source-env"
72
- ]
73
- },
74
- "bulk-publish": {
75
- "name": "bulk-publish",
76
- "type": "option",
77
- "description": "By default this flag is set as true. It indicates that contentstack's bulkpublish API will be used to publish the assets",
78
- "multiple": false,
79
- "default": "true"
80
- },
81
- "config": {
82
- "name": "config",
83
- "type": "option",
84
- "char": "c",
85
- "description": "Path to the config file",
86
- "multiple": false
87
- },
88
- "yes": {
89
- "name": "yes",
90
- "type": "boolean",
91
- "char": "y",
92
- "description": "Agree to process the command with the current configuration",
93
- "allowNo": false
94
- },
95
- "locales": {
96
- "name": "locales",
97
- "type": "option",
98
- "char": "l",
99
- "description": "Locales to where assets will be published",
100
- "multiple": true
101
- },
102
- "branch": {
103
- "name": "branch",
104
- "type": "option",
105
- "char": "B",
106
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
107
- "multiple": false,
108
- "default": "main"
109
- },
110
- "retryFailed": {
111
- "name": "retryFailed",
112
- "type": "option",
113
- "char": "r",
114
- "description": "Retry publishing failed assets from the logfile (optional, will override all other flags)",
115
- "hidden": true,
116
- "multiple": false
117
- },
118
- "folderUid": {
119
- "name": "folderUid",
120
- "type": "option",
121
- "char": "u",
122
- "description": "[default: cs_root] Folder-uid from where the assets will be published",
123
- "hidden": true,
124
- "multiple": false,
125
- "exclusive": [
126
- "source-env"
127
- ]
128
- },
129
- "bulkPublish": {
130
- "name": "bulkPublish",
131
- "type": "option",
132
- "char": "b",
133
- "description": "By default this flag is set as true. It indicates that contentstack's bulkpublish API will be used to publish the entries",
134
- "hidden": true,
135
- "multiple": false,
136
- "default": "true"
137
- },
138
- "api-version": {
139
- "name": "api-version",
140
- "type": "option",
141
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
142
- "multiple": false
143
- },
144
- "delivery-token": {
145
- "name": "delivery-token",
146
- "type": "option",
147
- "description": "Delivery token for source environment",
148
- "multiple": false
149
- },
150
- "source-env": {
151
- "name": "source-env",
152
- "type": "option",
153
- "description": "Source environment",
154
- "multiple": false
155
- },
156
- "content-types": {
157
- "name": "content-types",
158
- "type": "option",
159
- "description": "Content types",
160
- "hidden": true,
161
- "multiple": true
162
- }
163
- },
164
- "args": {}
165
- },
166
- "cm:assets:unpublish": {
167
- "id": "cm:assets:unpublish",
168
- "description": "Unpublish assets from given environment\nThe unpublish command is used for unpublishing assets from the given environment\n\nNote: Environment (Source Environment) and Locale are required to execute the command successfully\nBut, if retry-failed flag is set, then only a logfile is required",
169
- "strict": true,
170
- "pluginName": "@contentstack/cli-cm-bulk-publish",
171
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
172
- "pluginType": "core",
173
- "aliases": [],
174
- "examples": [
175
- "General Usage",
176
- "csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]",
177
- "",
178
- "Using --config or -c flag",
179
- "Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`",
180
- "csdx cm:assets:unpublish --config [PATH TO CONFIG FILE]",
181
- "csdx cm:assets:unpublish -c [PATH TO CONFIG FILE]",
182
- "",
183
- "Using --retry-failed flag",
184
- "csdx cm:assets:unpublish --retry-failed [LOG FILE NAME]",
185
- "",
186
- "Using --branch flag",
187
- "csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]",
188
- "",
189
- "Using --stack-api-key flag",
190
- "csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]"
191
- ],
192
- "flags": {
193
- "alias": {
194
- "name": "alias",
195
- "type": "option",
196
- "char": "a",
197
- "description": "Alias(name) for the management token",
198
- "multiple": false
199
- },
200
- "stack-api-key": {
201
- "name": "stack-api-key",
202
- "type": "option",
203
- "char": "k",
204
- "description": "Stack api key to be used",
205
- "required": false,
206
- "multiple": false
207
- },
208
- "environment": {
209
- "name": "environment",
210
- "type": "option",
211
- "char": "e",
212
- "description": "Source Environment",
213
- "multiple": false
214
- },
215
- "config": {
216
- "name": "config",
217
- "type": "option",
218
- "char": "c",
219
- "description": "Path to the config file",
220
- "multiple": false
221
- },
222
- "yes": {
223
- "name": "yes",
224
- "type": "boolean",
225
- "char": "y",
226
- "description": "Agree to process the command with the current configuration",
227
- "allowNo": false
228
- },
229
- "locale": {
230
- "name": "locale",
231
- "type": "option",
232
- "description": "Locale filter",
233
- "multiple": false
234
- },
235
- "branch": {
236
- "name": "branch",
237
- "type": "option",
238
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
239
- "multiple": false,
240
- "default": "main"
241
- },
242
- "retry-failed": {
243
- "name": "retry-failed",
244
- "type": "option",
245
- "description": "Retry unpublishing failed assets from the logfile",
246
- "multiple": false
247
- },
248
- "bulk-unpublish": {
249
- "name": "bulk-unpublish",
250
- "type": "option",
251
- "description": "By default this flag is set as true. It indicates that contentstack's bulkpublish API will be used to unpublish the assets",
252
- "multiple": false,
253
- "default": "true"
254
- },
255
- "api-version": {
256
- "name": "api-version",
257
- "type": "option",
258
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
259
- "multiple": false
260
- },
261
- "delivery-token": {
262
- "name": "delivery-token",
263
- "type": "option",
264
- "description": "Delivery Token for source environment",
265
- "multiple": false
266
- }
267
- },
268
- "args": {}
269
- },
270
- "cm:bulk-publish:cross-publish": {
271
- "id": "cm:bulk-publish:cross-publish",
272
- "description": "Publish entries and assets from one environment to other environments\nThe cross-publish command is used to publish entries and assets from one environment to other environments\n\nNote: Content Type, Environment, Destination Environment(s) and Locale are required to execute the command successfully\nBut, if retryFailed flag is set, then only a logfile is required\n",
273
- "strict": true,
274
- "usage": "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]",
275
- "pluginName": "@contentstack/cli-cm-bulk-publish",
276
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
277
- "pluginType": "core",
278
- "aliases": [],
279
- "examples": [
280
- "General Usage",
281
- "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]",
282
- "",
283
- "Using --config or -c flag",
284
- "Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`",
285
- "csdx cm:bulk-publish:cross-publish --config [PATH TO CONFIG FILE]",
286
- "csdx cm:bulk-publish:cross-publish -c [PATH TO CONFIG FILE]",
287
- "",
288
- "Using --retry-failed flag",
289
- "csdx cm:bulk-publish:cross-publish --retry-failed [LOG FILE NAME]",
290
- "csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]",
291
- "",
292
- "Using --branch flag",
293
- "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]",
294
- "",
295
- "Using --stack-api-key flag",
296
- "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]",
297
- ""
298
- ],
299
- "flags": {
300
- "alias": {
301
- "name": "alias",
302
- "type": "option",
303
- "char": "a",
304
- "description": "Alias(name) for the management token",
305
- "multiple": false
306
- },
307
- "stack-api-key": {
308
- "name": "stack-api-key",
309
- "type": "option",
310
- "char": "k",
311
- "description": "Stack api key to be used",
312
- "required": false,
313
- "multiple": false
314
- },
315
- "retryFailed": {
316
- "name": "retryFailed",
317
- "type": "option",
318
- "char": "r",
319
- "description": "(optional) Retry publishing failed entries from the logfile (this flag overrides all other flags)",
320
- "hidden": true,
321
- "multiple": false
322
- },
323
- "retry-failed": {
324
- "name": "retry-failed",
325
- "type": "option",
326
- "description": "(optional) Retry publishing failed entries from the logfile (this flag overrides all other flags)",
327
- "multiple": false
328
- },
329
- "bulkPublish": {
330
- "name": "bulkPublish",
331
- "type": "option",
332
- "char": "b",
333
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
334
- "hidden": true,
335
- "multiple": false,
336
- "default": "true"
337
- },
338
- "bulk-publish": {
339
- "name": "bulk-publish",
340
- "type": "option",
341
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
342
- "multiple": false,
343
- "default": "true"
344
- },
345
- "api-version": {
346
- "name": "api-version",
347
- "type": "option",
348
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
349
- "multiple": false
350
- },
351
- "contentType": {
352
- "name": "contentType",
353
- "type": "option",
354
- "char": "t",
355
- "description": "The Content-Types from which entries need to be published",
356
- "hidden": true,
357
- "multiple": true
358
- },
359
- "content-type": {
360
- "name": "content-type",
361
- "type": "option",
362
- "description": "The Contenttypes from which entries will be published",
363
- "multiple": true
364
- },
365
- "locale": {
366
- "name": "locale",
367
- "type": "option",
368
- "char": "l",
369
- "description": "Source locale",
370
- "hidden": true,
371
- "multiple": false
372
- },
373
- "locales": {
374
- "name": "locales",
375
- "type": "option",
376
- "description": "Source locale",
377
- "multiple": false
378
- },
379
- "environment": {
380
- "name": "environment",
381
- "type": "option",
382
- "char": "e",
383
- "description": "Source Environment",
384
- "hidden": true,
385
- "multiple": false
386
- },
387
- "source-env": {
388
- "name": "source-env",
389
- "type": "option",
390
- "description": "Source Env",
391
- "multiple": false
392
- },
393
- "destEnv": {
394
- "name": "destEnv",
395
- "type": "option",
396
- "char": "d",
397
- "description": "Destination Environments",
398
- "hidden": true,
399
- "multiple": true
400
- },
401
- "environments": {
402
- "name": "environments",
403
- "type": "option",
404
- "description": "Destination Environments",
405
- "multiple": true
406
- },
407
- "deliveryToken": {
408
- "name": "deliveryToken",
409
- "type": "option",
410
- "char": "x",
411
- "description": "Delivery token for source environment",
412
- "hidden": true,
413
- "multiple": false
414
- },
415
- "delivery-token": {
416
- "name": "delivery-token",
417
- "type": "option",
418
- "description": "Delivery token for source environment",
419
- "multiple": false
420
- },
421
- "config": {
422
- "name": "config",
423
- "type": "option",
424
- "char": "c",
425
- "description": "Path to the config file",
426
- "multiple": false
427
- },
428
- "yes": {
429
- "name": "yes",
430
- "type": "boolean",
431
- "char": "y",
432
- "description": "Agree to process the command with the current configuration",
433
- "allowNo": false
434
- },
435
- "branch": {
436
- "name": "branch",
437
- "type": "option",
438
- "char": "B",
439
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
440
- "multiple": false,
441
- "default": "main"
442
- },
443
- "onlyAssets": {
444
- "name": "onlyAssets",
445
- "type": "boolean",
446
- "description": "Unpublish only assets",
447
- "allowNo": false
448
- },
449
- "onlyEntries": {
450
- "name": "onlyEntries",
451
- "type": "boolean",
452
- "description": "Unpublish only entries",
453
- "allowNo": false
454
- }
455
- },
456
- "args": {}
457
- },
458
- "cm:bulk-publish": {
459
- "id": "cm:bulk-publish",
460
- "description": "Bulk Publish script for managing entries and assets\n",
461
- "strict": true,
462
- "pluginName": "@contentstack/cli-cm-bulk-publish",
463
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
464
- "pluginType": "core",
465
- "aliases": [],
466
- "flags": {},
467
- "args": {}
468
- },
469
- "cm:entries:publish-modified": {
470
- "id": "cm:entries:publish-modified",
471
- "description": "Publish edited entries from a specified content type to the given locales and environments\nThe publish-modified command is used to publish entries from the specified content types, to the\nspecified environments and locales\n\nNote: Content type(s), Source Environment, Destination Environment(s) and Locale(s) are required to execute the command successfully\nBut, if retry-failed flag is set, then only a logfile is required\n",
472
- "strict": true,
473
- "usage": "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>]",
474
- "pluginName": "@contentstack/cli-cm-bulk-publish",
475
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
476
- "pluginType": "core",
477
- "aliases": [
478
- "cm:bulk-publish:entry-edits"
479
- ],
480
- "examples": [
481
- "General Usage",
482
- "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]",
483
- "",
484
- "Using --config or -c flag",
485
- "Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
486
- "csdx cm:entries:publish-modified --config [PATH TO CONFIG FILE]",
487
- "csdx cm:entries:publish-modified -c [PATH TO CONFIG FILE]",
488
- "",
489
- "Using --retry-failed",
490
- "csdx cm:entries:publish-modified --retry-failed [LOG FILE NAME]",
491
- "csdx cm:entries:publish-modified -r [LOG FILE NAME]",
492
- "",
493
- "Using --branch",
494
- "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]"
495
- ],
496
- "flags": {
497
- "alias": {
498
- "name": "alias",
499
- "type": "option",
500
- "char": "a",
501
- "description": "Alias(name) for the management token",
502
- "multiple": false
503
- },
504
- "retryFailed": {
505
- "name": "retryFailed",
506
- "type": "option",
507
- "char": "r",
508
- "description": "Retry publishing failed entries from the logfile (optional, overrides all other flags)",
509
- "hidden": true,
510
- "multiple": false
511
- },
512
- "retry-failed": {
513
- "name": "retry-failed",
514
- "type": "option",
515
- "description": "Retry publishing failed entries from the logfile (optional, overrides all other flags)",
516
- "multiple": false
517
- },
518
- "bulkPublish": {
519
- "name": "bulkPublish",
520
- "type": "option",
521
- "char": "b",
522
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
523
- "hidden": true,
524
- "multiple": false
525
- },
526
- "bulk-publish": {
527
- "name": "bulk-publish",
528
- "type": "option",
529
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
530
- "multiple": false,
531
- "default": "true"
532
- },
533
- "api-version": {
534
- "name": "api-version",
535
- "type": "option",
536
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
537
- "multiple": false
538
- },
539
- "sourceEnv": {
540
- "name": "sourceEnv",
541
- "type": "option",
542
- "char": "s",
543
- "description": "Environment from which edited entries will be published",
544
- "hidden": true,
545
- "multiple": false
546
- },
547
- "source-env": {
548
- "name": "source-env",
549
- "type": "option",
550
- "description": "Environment from which edited entries will be published",
551
- "multiple": false
552
- },
553
- "contentTypes": {
554
- "name": "contentTypes",
555
- "type": "option",
556
- "char": "t",
557
- "description": "The Content-Types which will be checked for edited entries",
558
- "hidden": true,
559
- "multiple": true
560
- },
561
- "content-types": {
562
- "name": "content-types",
563
- "type": "option",
564
- "description": "The Contenttypes which will be checked for edited entries",
565
- "multiple": true
566
- },
567
- "locales": {
568
- "name": "locales",
569
- "type": "option",
570
- "char": "l",
571
- "description": "Locales where edited entries will be published",
572
- "multiple": true
573
- },
574
- "environments": {
575
- "name": "environments",
576
- "type": "option",
577
- "char": "e",
578
- "description": "Destination environments",
579
- "multiple": true
580
- },
581
- "config": {
582
- "name": "config",
583
- "type": "option",
584
- "char": "c",
585
- "description": "Path to the config file",
586
- "multiple": false
587
- },
588
- "yes": {
589
- "name": "yes",
590
- "type": "boolean",
591
- "char": "y",
592
- "description": "Agree to process the command with the current configuration",
593
- "allowNo": false
594
- },
595
- "branch": {
596
- "name": "branch",
597
- "type": "option",
598
- "char": "B",
599
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
600
- "multiple": false,
601
- "default": "main"
602
- }
603
- },
604
- "args": {}
605
- },
606
- "cm:entries:publish-non-localized-fields": {
607
- "id": "cm:entries:publish-non-localized-fields",
608
- "description": "Publish non-localized fields for the given content types, from a particular source environment to the specified environments\nThe non-localized field changes command is used to publish non-localized field changes from the given content types to the specified environments\n\nNote: Content types, Environments and Source Environment are required to execute this command successfully.\nBut, if retryFailed flag is set, then only a logfile is required",
609
- "strict": true,
610
- "usage": "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>]",
611
- "pluginName": "@contentstack/cli-cm-bulk-publish",
612
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
613
- "pluginType": "core",
614
- "aliases": [
615
- "cm:bulk-publish:nonlocalized-field-changes"
616
- ],
617
- "examples": [
618
- "General Usage",
619
- "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]",
620
- "",
621
- "Using --config or -c flag",
622
- "Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`",
623
- "csdx cm:entries:publish-non-localized-fields --config [PATH TO CONFIG FILE]",
624
- "csdx cm:entries:publish-non-localized-fields -c [PATH TO CONFIG FILE]",
625
- "",
626
- "Using --retry-failed flag",
627
- "csdx cm:entries:publish-non-localized-fields --retry-failed [LOG FILE NAME]",
628
- "",
629
- "Using --branch flag",
630
- "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]"
631
- ],
632
- "flags": {
633
- "alias": {
634
- "name": "alias",
635
- "type": "option",
636
- "char": "a",
637
- "description": "Alias(name) for the management token",
638
- "multiple": false
639
- },
640
- "retry-failed": {
641
- "name": "retry-failed",
642
- "type": "option",
643
- "description": "Retry publishing failed entries from the logfile",
644
- "multiple": false
645
- },
646
- "bulk-publish": {
647
- "name": "bulk-publish",
648
- "type": "option",
649
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
650
- "multiple": false,
651
- "default": "true"
652
- },
653
- "source-env": {
654
- "name": "source-env",
655
- "type": "option",
656
- "description": "Source Environment",
657
- "multiple": false
658
- },
659
- "content-types": {
660
- "name": "content-types",
661
- "type": "option",
662
- "description": "The Contenttypes from which entries will be published",
663
- "multiple": true
664
- },
665
- "environments": {
666
- "name": "environments",
667
- "type": "option",
668
- "char": "e",
669
- "description": "Destination environments",
670
- "multiple": true
671
- },
672
- "config": {
673
- "name": "config",
674
- "type": "option",
675
- "char": "c",
676
- "description": "Path to the config file",
677
- "multiple": false
678
- },
679
- "yes": {
680
- "name": "yes",
681
- "type": "boolean",
682
- "char": "y",
683
- "description": "Agree to process the command with the current configuration",
684
- "allowNo": false
685
- },
686
- "branch": {
687
- "name": "branch",
688
- "type": "option",
689
- "char": "B",
690
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
691
- "multiple": false,
692
- "default": "main"
693
- },
694
- "retryFailed": {
695
- "name": "retryFailed",
696
- "type": "option",
697
- "char": "r",
698
- "description": "Retry publishing failed entries from the logfile",
699
- "hidden": true,
700
- "multiple": false
701
- },
702
- "bulkPublish": {
703
- "name": "bulkPublish",
704
- "type": "option",
705
- "char": "b",
706
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
707
- "hidden": true,
708
- "multiple": false,
709
- "default": "true"
710
- },
711
- "api-version": {
712
- "name": "api-version",
713
- "type": "option",
714
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
715
- "multiple": false
716
- },
717
- "sourceEnv": {
718
- "name": "sourceEnv",
719
- "type": "option",
720
- "char": "s",
721
- "description": "Source Environment",
722
- "hidden": true,
723
- "multiple": false
724
- },
725
- "contentTypes": {
726
- "name": "contentTypes",
727
- "type": "option",
728
- "char": "t",
729
- "description": "The contenttypes from which entries will be published",
730
- "hidden": true,
731
- "multiple": true
732
- }
733
- },
734
- "args": {}
735
- },
736
- "cm:entries:publish-only-unpublished": {
737
- "id": "cm:entries:publish-only-unpublished",
738
- "description": "Publish unpublished entries from the source environment, to other environments and locales\nThe publish-only-unpublished command is used to publish unpublished entries from the source environment, to other environments and locales\n\nNote: Content type(s), Source Environment, Destination Environment(s) and Source Locale are required to execute the command successfully\nBut, if retry-failed flag is set, then only a logfile is required\n",
739
- "strict": true,
740
- "usage": "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>]",
741
- "pluginName": "@contentstack/cli-cm-bulk-publish",
742
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
743
- "pluginType": "core",
744
- "aliases": [
745
- "cm:bulk-publish:unpublished-entries"
746
- ],
747
- "examples": [
748
- "General Usage",
749
- "csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] -source-env [SOURCE ENV]",
750
- "",
751
- "Using --config or -c flag",
752
- "Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`",
753
- "csdx cm:entries:publish-only-unpublished --config [PATH TO CONFIG FILE]",
754
- "csdx cm:entries:publish-only-unpublished -c [PATH TO CONFIG FILE]",
755
- "",
756
- "Using --retry-failed",
757
- "csdx cm:entries:publish-only-unpublished --retry-failed [LOG FILE NAME]",
758
- "",
759
- "Using --branch",
760
- "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]"
761
- ],
762
- "flags": {
763
- "alias": {
764
- "name": "alias",
765
- "type": "option",
766
- "char": "a",
767
- "description": "Alias(name) for the management token",
768
- "multiple": false
769
- },
770
- "retryFailed": {
771
- "name": "retryFailed",
772
- "type": "option",
773
- "char": "r",
774
- "description": "Retry publishing failed entries from the logfile",
775
- "hidden": true,
776
- "multiple": false
777
- },
778
- "retry-failed": {
779
- "name": "retry-failed",
780
- "type": "option",
781
- "description": "Retry publishing failed entries from the logfile",
782
- "multiple": false
783
- },
784
- "bulkPublish": {
785
- "name": "bulkPublish",
786
- "type": "option",
787
- "char": "b",
788
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
789
- "hidden": true,
790
- "multiple": false,
791
- "default": "true"
792
- },
793
- "bulk-publish": {
794
- "name": "bulk-publish",
795
- "type": "option",
796
- "char": "b",
797
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
798
- "multiple": false,
799
- "default": "true"
800
- },
801
- "api-version": {
802
- "name": "api-version",
803
- "type": "option",
804
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
805
- "multiple": false
806
- },
807
- "sourceEnv": {
808
- "name": "sourceEnv",
809
- "type": "option",
810
- "char": "s",
811
- "description": "Source Env",
812
- "hidden": true,
813
- "multiple": false
814
- },
815
- "source-env": {
816
- "name": "source-env",
817
- "type": "option",
818
- "description": "Source Env",
819
- "multiple": false
820
- },
821
- "contentTypes": {
822
- "name": "contentTypes",
823
- "type": "option",
824
- "char": "t",
825
- "description": "The Content-Types from which entries need to be published",
826
- "hidden": true,
827
- "multiple": true
828
- },
829
- "content-types": {
830
- "name": "content-types",
831
- "type": "option",
832
- "description": "The Contenttypes from which entries will be published",
833
- "multiple": true
834
- },
835
- "locale": {
836
- "name": "locale",
837
- "type": "option",
838
- "char": "l",
839
- "description": "Source locale",
840
- "hidden": true,
841
- "multiple": false
842
- },
843
- "locales": {
844
- "name": "locales",
845
- "type": "option",
846
- "description": "Source locale",
847
- "multiple": false
848
- },
849
- "environments": {
850
- "name": "environments",
851
- "type": "option",
852
- "char": "e",
853
- "description": "Destination environments",
854
- "multiple": true
855
- },
856
- "config": {
857
- "name": "config",
858
- "type": "option",
859
- "char": "c",
860
- "description": "Path to the config file",
861
- "multiple": false
862
- },
863
- "yes": {
864
- "name": "yes",
865
- "type": "boolean",
866
- "char": "y",
867
- "description": "Agree to process the command with the current configuration",
868
- "allowNo": false
869
- },
870
- "branch": {
871
- "name": "branch",
872
- "type": "option",
873
- "char": "B",
874
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
875
- "multiple": false,
876
- "default": "main"
877
- }
878
- },
879
- "args": {}
880
- },
881
- "cm:entries:publish": {
882
- "id": "cm:entries:publish",
883
- "description": "Publish entries from multiple contenttypes to multiple environments and locales\nThe publish command is used to publish entries from the specified content types, to the\nspecified environments and locales\n\nNote: Content Types, Environments and Locales are required to execute the command successfully\nBut, if retry-failed flag is set, then only a logfile is required\n",
884
- "strict": true,
885
- "usage": "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>]",
886
- "pluginName": "@contentstack/cli-cm-bulk-publish",
887
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
888
- "pluginType": "core",
889
- "aliases": [
890
- "cm:bulk-publish:entries"
891
- ],
892
- "examples": [
893
- "General Usage",
894
- "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]",
895
- "",
896
- "Using --config or -c flag",
897
- "Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
898
- "csdx cm:entries:publish --config [PATH TO CONFIG FILE]",
899
- "csdx cm:entries:publish -c [PATH TO CONFIG FILE]",
900
- "",
901
- "Using --retry-failed",
902
- "csdx cm:entries:publish --retry-failed [LOG FILE NAME]",
903
- "csdx cm:entries:publish -r [LOG FILE NAME]",
904
- "",
905
- "Using --branch",
906
- "csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]",
907
- "",
908
- "Using --source-env",
909
- "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]"
910
- ],
911
- "flags": {
912
- "alias": {
913
- "name": "alias",
914
- "type": "option",
915
- "char": "a",
916
- "description": "Alias(name) for the management token",
917
- "multiple": false
918
- },
919
- "retryFailed": {
920
- "name": "retryFailed",
921
- "type": "option",
922
- "char": "r",
923
- "description": "Retry failed entries from the logfile (optional, overrides all other flags) This flag is used to retry publishing entries that failed to publish in a previous attempt. A log file for the previous session will be required for processing the failed entries",
924
- "hidden": true,
925
- "multiple": false
926
- },
927
- "retry-failed": {
928
- "name": "retry-failed",
929
- "type": "option",
930
- "description": "(optional) Retry failed entries from the logfile (overrides all other flags) This flag is used to retry publishing entries that failed to publish in a previous attempt. A log file for the previous session will be required for processing the failed entries",
931
- "multiple": false
932
- },
933
- "bulkPublish": {
934
- "name": "bulkPublish",
935
- "type": "option",
936
- "char": "b",
937
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
938
- "hidden": true,
939
- "multiple": false
940
- },
941
- "bulk-publish": {
942
- "name": "bulk-publish",
943
- "type": "option",
944
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
945
- "multiple": false,
946
- "default": "true"
947
- },
948
- "api-version": {
949
- "name": "api-version",
950
- "type": "option",
951
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
952
- "multiple": false
953
- },
954
- "publish-all-content-types": {
955
- "name": "publish-all-content-types",
956
- "type": "boolean",
957
- "description": "(optional) Publish all contenttypes (cannot be set when contentTypes flag is set)",
958
- "allowNo": false
959
- },
960
- "publishAllContentTypes": {
961
- "name": "publishAllContentTypes",
962
- "type": "boolean",
963
- "char": "o",
964
- "description": "Publish all content-types (optional, cannot be set when contentTypes flag is set)",
965
- "hidden": true,
966
- "allowNo": false
967
- },
968
- "content-types": {
969
- "name": "content-types",
970
- "type": "option",
971
- "description": "The Contenttypes from which entries need to be published",
972
- "multiple": true
973
- },
974
- "contentTypes": {
975
- "name": "contentTypes",
976
- "type": "option",
977
- "char": "t",
978
- "description": "The Contenttypes from which entries will be published",
979
- "hidden": true,
980
- "multiple": true
981
- },
982
- "locales": {
983
- "name": "locales",
984
- "type": "option",
985
- "char": "l",
986
- "description": "Locales where entries will be published",
987
- "multiple": true
988
- },
989
- "environments": {
990
- "name": "environments",
991
- "type": "option",
992
- "char": "e",
993
- "description": "Environments where entries will be published",
994
- "multiple": true
995
- },
996
- "config": {
997
- "name": "config",
998
- "type": "option",
999
- "char": "c",
1000
- "description": "Path for the external config file (A new config file can be generated at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)",
1001
- "multiple": false
1002
- },
1003
- "yes": {
1004
- "name": "yes",
1005
- "type": "boolean",
1006
- "char": "y",
1007
- "description": "Agree to process the command with the current configuration",
1008
- "allowNo": false
1009
- },
1010
- "branch": {
1011
- "name": "branch",
1012
- "type": "option",
1013
- "char": "B",
1014
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
1015
- "multiple": false,
1016
- "default": "main"
1017
- },
1018
- "delivery-token": {
1019
- "name": "delivery-token",
1020
- "type": "option",
1021
- "description": "Delivery token for source environment",
1022
- "multiple": false
1023
- },
1024
- "source-env": {
1025
- "name": "source-env",
1026
- "type": "option",
1027
- "description": "Source environment",
1028
- "multiple": false
1029
- }
1030
- },
1031
- "args": {}
1032
- },
1033
- "cm:entries:unpublish": {
1034
- "id": "cm:entries:unpublish",
1035
- "description": "Unpublish entries from the given environment\nThe unpublish command is used to unpublish entries from the given environment\n\nNote: Environment (Source Environment) and Locale are required to execute the command successfully\nBut, if retry-failed flag is set, then only a logfile is required",
1036
- "strict": true,
1037
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1038
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1039
- "pluginType": "core",
1040
- "aliases": [],
1041
- "examples": [
1042
- "General Usage",
1043
- "csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]",
1044
- "",
1045
- "Using --config or -c flag",
1046
- "Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`",
1047
- "csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]",
1048
- "csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]",
1049
- "",
1050
- "Using --retry-failed flag",
1051
- "csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]",
1052
- "",
1053
- "",
1054
- "Using --branch flag",
1055
- "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]"
1056
- ],
1057
- "flags": {
1058
- "alias": {
1059
- "name": "alias",
1060
- "type": "option",
1061
- "char": "a",
1062
- "description": "Alias(name) for the management token",
1063
- "multiple": false
1064
- },
1065
- "environment": {
1066
- "name": "environment",
1067
- "type": "option",
1068
- "char": "e",
1069
- "description": "Source Environment",
1070
- "multiple": false
1071
- },
1072
- "config": {
1073
- "name": "config",
1074
- "type": "option",
1075
- "char": "c",
1076
- "description": "Path to the config file",
1077
- "multiple": false
1078
- },
1079
- "yes": {
1080
- "name": "yes",
1081
- "type": "boolean",
1082
- "char": "y",
1083
- "description": "Agree to process the command with the current configuration",
1084
- "allowNo": false
1085
- },
1086
- "locale": {
1087
- "name": "locale",
1088
- "type": "option",
1089
- "description": "Locale filter",
1090
- "multiple": false
1091
- },
1092
- "branch": {
1093
- "name": "branch",
1094
- "type": "option",
1095
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
1096
- "multiple": false,
1097
- "default": "main"
1098
- },
1099
- "retry-failed": {
1100
- "name": "retry-failed",
1101
- "type": "option",
1102
- "description": "Retry publishing failed entries from the logfile",
1103
- "multiple": false
1104
- },
1105
- "bulk-unpublish": {
1106
- "name": "bulk-unpublish",
1107
- "type": "option",
1108
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to unpublish the entries",
1109
- "multiple": false,
1110
- "default": "true"
1111
- },
1112
- "api-version": {
1113
- "name": "api-version",
1114
- "type": "option",
1115
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
1116
- "multiple": false
1117
- },
1118
- "content-type": {
1119
- "name": "content-type",
1120
- "type": "option",
1121
- "description": "Content type filter",
1122
- "multiple": false
1123
- },
1124
- "delivery-token": {
1125
- "name": "delivery-token",
1126
- "type": "option",
1127
- "description": "Delivery token for source environment",
1128
- "multiple": false
1129
- }
1130
- },
1131
- "args": {}
1132
- },
1133
- "cm:entries:update-and-publish": {
1134
- "id": "cm:entries:update-and-publish",
1135
- "description": "Add fields from updated content types to their respective entries\nThe update-and-publish command is used to update existing entries with the updated schema of the respective content type\n\nNote: Content types, Environments and Locales are required to execute the command successfully\nBut, if retry-failed flag is set, then only a logfile is required\n",
1136
- "strict": true,
1137
- "usage": "cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]",
1138
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1139
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1140
- "pluginType": "core",
1141
- "aliases": [
1142
- "cm:bulk-publish:add-fields"
1143
- ],
1144
- "examples": [
1145
- "General Usage",
1146
- "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]",
1147
- "",
1148
- "Using --config or -c flag",
1149
- "Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
1150
- "csdx cm:entries:update-and-publish --config [PATH TO CONFIG FILE]",
1151
- "csdx cm:entries:update-and-publish -c [PATH TO CONFIG FILE]",
1152
- "",
1153
- "Using --retry-failed",
1154
- "csdx cm:entries:update-and-publish --retry-failed [LOG FILE NAME]",
1155
- "",
1156
- "Using --branch",
1157
- "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]"
1158
- ],
1159
- "flags": {
1160
- "alias": {
1161
- "name": "alias",
1162
- "type": "option",
1163
- "char": "a",
1164
- "description": "Alias(name) for the management token",
1165
- "multiple": false
1166
- },
1167
- "retry-failed": {
1168
- "name": "retry-failed",
1169
- "type": "option",
1170
- "description": "Retry publishing failed entries from the logfile (optional, overrides all other flags)",
1171
- "multiple": false
1172
- },
1173
- "bulk-publish": {
1174
- "name": "bulk-publish",
1175
- "type": "option",
1176
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
1177
- "multiple": false,
1178
- "default": "true"
1179
- },
1180
- "api-version": {
1181
- "name": "api-version",
1182
- "type": "option",
1183
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
1184
- "multiple": false
1185
- },
1186
- "content-types": {
1187
- "name": "content-types",
1188
- "type": "option",
1189
- "description": "The Contenttypes from which entries will be published",
1190
- "multiple": true
1191
- },
1192
- "environments": {
1193
- "name": "environments",
1194
- "type": "option",
1195
- "char": "e",
1196
- "description": "Environments where entries will be published",
1197
- "multiple": true
1198
- },
1199
- "config": {
1200
- "name": "config",
1201
- "type": "option",
1202
- "char": "c",
1203
- "description": "Path to the config file",
1204
- "multiple": false
1205
- },
1206
- "yes": {
1207
- "name": "yes",
1208
- "type": "boolean",
1209
- "char": "y",
1210
- "description": "Agree to process the command with the current configuration",
1211
- "allowNo": false
1212
- },
1213
- "locales": {
1214
- "name": "locales",
1215
- "type": "option",
1216
- "char": "l",
1217
- "description": "Locales where entries will be published",
1218
- "multiple": true
1219
- },
1220
- "branch": {
1221
- "name": "branch",
1222
- "type": "option",
1223
- "char": "B",
1224
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
1225
- "multiple": false,
1226
- "default": "main"
1227
- },
1228
- "force": {
1229
- "name": "force",
1230
- "type": "boolean",
1231
- "description": "Update and publish all entries even if no fields have been added",
1232
- "allowNo": false
1233
- },
1234
- "retryFailed": {
1235
- "name": "retryFailed",
1236
- "type": "option",
1237
- "char": "r",
1238
- "description": "Retry publishing failed entries from the logfile (optional, overrides all other flags)",
1239
- "hidden": true,
1240
- "multiple": false
1241
- },
1242
- "bulkPublish": {
1243
- "name": "bulkPublish",
1244
- "type": "option",
1245
- "char": "b",
1246
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
1247
- "hidden": true,
1248
- "multiple": false
1249
- },
1250
- "contentTypes": {
1251
- "name": "contentTypes",
1252
- "type": "option",
1253
- "char": "t",
1254
- "description": "The Contenttypes from which entries will be published",
1255
- "multiple": true
1256
- }
1257
- },
1258
- "args": {}
1259
- },
1260
- "cm:stacks:publish-clear-logs": {
1261
- "id": "cm:stacks:publish-clear-logs",
1262
- "description": "Clear the log folder",
1263
- "strict": true,
1264
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1265
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1266
- "pluginType": "core",
1267
- "aliases": [
1268
- "cm:bulk-publish:clear"
1269
- ],
1270
- "examples": [
1271
- "csdx cm:stacks:publish-clear-logs",
1272
- "csdx cm:stacks:publish-clear-logs --log-files-count",
1273
- "csdx cm:stacks:publish-clear-logs --yes",
1274
- "csdx cm:stacks:publish-clear-logs -y"
1275
- ],
1276
- "flags": {
1277
- "log-files-count": {
1278
- "name": "log-files-count",
1279
- "type": "boolean",
1280
- "description": "List number of log files",
1281
- "allowNo": false
1282
- },
1283
- "yes": {
1284
- "name": "yes",
1285
- "type": "boolean",
1286
- "char": "y",
1287
- "description": "Delete all files without asking for confirmation",
1288
- "allowNo": false
1289
- },
1290
- "list": {
1291
- "name": "list",
1292
- "type": "boolean",
1293
- "char": "l",
1294
- "description": "List number of log files",
1295
- "hidden": true,
1296
- "allowNo": false
1297
- }
1298
- },
1299
- "args": {}
1300
- },
1301
- "cm:stacks:publish-configure": {
1302
- "id": "cm:stacks:publish-configure",
1303
- "description": "The configure command is used to generate a configuration file for publish scripts.",
1304
- "strict": true,
1305
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1306
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1307
- "pluginType": "core",
1308
- "aliases": [
1309
- "cm:bulk-publish:configure"
1310
- ],
1311
- "examples": [
1312
- "csdx cm:stacks:publish-configure",
1313
- "csdx cm:stacks:publish-configure -a <management_token_alias>",
1314
- "csdx cm:stacks:publish-configure --alias <management_token_alias>"
1315
- ],
1316
- "flags": {
1317
- "alias": {
1318
- "name": "alias",
1319
- "type": "option",
1320
- "char": "a",
1321
- "description": "Alias(name) for the management token",
1322
- "multiple": false
1323
- }
1324
- },
1325
- "args": {}
1326
- },
1327
- "cm:stacks:publish-revert": {
1328
- "id": "cm:stacks:publish-revert",
1329
- "description": "Revert publish operations by using a log file\nThe revert command is used to revert all publish operations performed using bulk-publish script.\nA log file name is required to execute revert command\n",
1330
- "strict": true,
1331
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1332
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1333
- "pluginType": "core",
1334
- "aliases": [
1335
- "cm:bulk-publish:revert"
1336
- ],
1337
- "examples": [
1338
- "Using --log-file",
1339
- "cm:bulk-publish:revert --log-file [LOG FILE NAME]",
1340
- "",
1341
- "Using --retry-failed",
1342
- "cm:bulk-publish:revert --retry-failed [LOG FILE NAME]"
1343
- ],
1344
- "flags": {
1345
- "retry-failed": {
1346
- "name": "retry-failed",
1347
- "type": "option",
1348
- "description": "retry publishing failed entries from the logfile",
1349
- "multiple": false
1350
- },
1351
- "log-file": {
1352
- "name": "log-file",
1353
- "type": "option",
1354
- "description": "logfile to be used to revert",
1355
- "multiple": false
1356
- },
1357
- "retryFailed": {
1358
- "name": "retryFailed",
1359
- "type": "option",
1360
- "char": "r",
1361
- "description": "retry publishing failed entries from the logfile",
1362
- "hidden": true,
1363
- "multiple": false
1364
- },
1365
- "logFile": {
1366
- "name": "logFile",
1367
- "type": "option",
1368
- "char": "l",
1369
- "description": "logfile to be used to revert",
1370
- "hidden": true,
1371
- "multiple": false
1372
- }
1373
- },
1374
- "args": {}
1375
- },
1376
- "cm:stacks:publish": {
1377
- "id": "cm:stacks:publish",
1378
- "description": "Publish entries and assets to multiple environments and locales\nThe publish command is used to publish entries and assets, to the specified environments and locales.\n\nNote: Content types, Environments and Locales are required to execute the publish entries command successfully.\nNote: Environments and Locales are required to execute the publish assets command successfully.\nBut, if retry-failed flag is set, then only a logfile is required",
1379
- "strict": true,
1380
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1381
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1382
- "pluginType": "core",
1383
- "aliases": [],
1384
- "examples": [
1385
- "General Usage",
1386
- "csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]",
1387
- "",
1388
- "Using --config or -c flag",
1389
- "Generate a config file in the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
1390
- "csdx cm:stacks:publish --config [PATH TO CONFIG FILE]",
1391
- "csdx cm:stacks:publish -c [PATH TO CONFIG FILE]",
1392
- "",
1393
- "Using --retry-failed flag",
1394
- "csdx cm:stacks:publish --retry-failed [LOG FILE NAME]",
1395
- "",
1396
- "Using --branch flag",
1397
- "csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]",
1398
- "",
1399
- "Using --api-version flag",
1400
- "csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --api-version [API VERSION]"
1401
- ],
1402
- "flags": {},
1403
- "args": {}
1404
- },
1405
- "cm:stacks:unpublish": {
1406
- "id": "cm:stacks:unpublish",
1407
- "description": "Unpublish entries or assets of given content types from the specified environment\nThe unpublish command is used to unpublish entries or assets from given environment\n\nEnvironment (Source Environment) and Locale are required to execute the command successfully\nBut, if retry-failed flag is set, then only a logfile is required\n\nA content type can be specified for unpublishing entries, but if no content-type(s) is/are specified and --only-assets is not used,\nthen all entries from all content types will be unpublished from the source environment\n\nNote: --only-assets can be used to unpublish only assets and --only-entries can be used to unpublish only entries.\n(--only-assets and --only-entries cannot be used together at the same time)\n",
1408
- "strict": true,
1409
- "usage": "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]",
1410
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1411
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1412
- "pluginType": "core",
1413
- "aliases": [
1414
- "cm:bulk-publish:unpublish"
1415
- ],
1416
- "examples": [
1417
- "General Usage",
1418
- "csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] ----delivery-token [DELIVERY TOKEN]",
1419
- "",
1420
- "Using --config or -c flag",
1421
- "Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`",
1422
- "csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]",
1423
- "csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]",
1424
- "",
1425
- "Using --retry-failed flag",
1426
- "csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]",
1427
- "",
1428
- "No content type",
1429
- "csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all content types and assets from the source environment)",
1430
- "",
1431
- "Using --only-assets",
1432
- "csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-assets (Will unpublish only assets from the source environment)",
1433
- "",
1434
- "Using --only-entries",
1435
- "csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, all entries, from the source environment)",
1436
- "csdx cm:stacks:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, (from CONTENT TYPE) from the source environment)",
1437
- "",
1438
- "Using --branch flag",
1439
- "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]"
1440
- ],
1441
- "flags": {
1442
- "alias": {
1443
- "name": "alias",
1444
- "type": "option",
1445
- "char": "a",
1446
- "description": "Alias(name) for the management token",
1447
- "multiple": false
1448
- },
1449
- "environment": {
1450
- "name": "environment",
1451
- "type": "option",
1452
- "char": "e",
1453
- "description": "Source Environment",
1454
- "multiple": false
1455
- },
1456
- "config": {
1457
- "name": "config",
1458
- "type": "option",
1459
- "char": "c",
1460
- "description": "Path to the config file",
1461
- "multiple": false
1462
- },
1463
- "yes": {
1464
- "name": "yes",
1465
- "type": "boolean",
1466
- "char": "y",
1467
- "description": "Agree to process the command with the current configuration",
1468
- "allowNo": false
1469
- },
1470
- "locale": {
1471
- "name": "locale",
1472
- "type": "option",
1473
- "char": "l",
1474
- "description": "Locale filter",
1475
- "multiple": false
1476
- },
1477
- "branch": {
1478
- "name": "branch",
1479
- "type": "option",
1480
- "char": "B",
1481
- "description": "Specify the branch to fetch the content from (default is main branch)",
1482
- "multiple": false,
1483
- "default": "main"
1484
- },
1485
- "retry-failed": {
1486
- "name": "retry-failed",
1487
- "type": "option",
1488
- "description": "Retry publishing failed entries from the logfile (optional, overrides all other flags)",
1489
- "multiple": false
1490
- },
1491
- "bulk-unpublish": {
1492
- "name": "bulk-unpublish",
1493
- "type": "option",
1494
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to unpublish the entries and assets",
1495
- "multiple": false,
1496
- "default": "true"
1497
- },
1498
- "api-version": {
1499
- "name": "api-version",
1500
- "type": "option",
1501
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
1502
- "multiple": false
1503
- },
1504
- "content-type": {
1505
- "name": "content-type",
1506
- "type": "option",
1507
- "description": "Content type filter",
1508
- "multiple": false
1509
- },
1510
- "delivery-token": {
1511
- "name": "delivery-token",
1512
- "type": "option",
1513
- "description": "Delivery token for source environment",
1514
- "multiple": false
1515
- },
1516
- "only-assets": {
1517
- "name": "only-assets",
1518
- "type": "boolean",
1519
- "description": "Unpublish only assets",
1520
- "hidden": true,
1521
- "allowNo": false
1522
- },
1523
- "only-entries": {
1524
- "name": "only-entries",
1525
- "type": "boolean",
1526
- "description": "Unpublish only entries",
1527
- "hidden": true,
1528
- "allowNo": false
1529
- },
1530
- "retryFailed": {
1531
- "name": "retryFailed",
1532
- "type": "option",
1533
- "char": "r",
1534
- "description": "Retry publishing failed entries from the logfile",
1535
- "hidden": true,
1536
- "multiple": false
1537
- },
1538
- "bulkUnpublish": {
1539
- "name": "bulkUnpublish",
1540
- "type": "option",
1541
- "char": "b",
1542
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used for publishing the entries",
1543
- "hidden": true,
1544
- "multiple": false,
1545
- "default": "true"
1546
- },
1547
- "contentType": {
1548
- "name": "contentType",
1549
- "type": "option",
1550
- "char": "t",
1551
- "description": "Content Type filter",
1552
- "hidden": true,
1553
- "multiple": false
1554
- },
1555
- "deliveryToken": {
1556
- "name": "deliveryToken",
1557
- "type": "option",
1558
- "char": "x",
1559
- "description": "Delivery Token for source environment",
1560
- "hidden": true,
1561
- "multiple": false
1562
- },
1563
- "onlyAssets": {
1564
- "name": "onlyAssets",
1565
- "type": "boolean",
1566
- "description": "Unpublish only assets",
1567
- "hidden": true,
1568
- "allowNo": false
1569
- },
1570
- "onlyEntries": {
1571
- "name": "onlyEntries",
1572
- "type": "boolean",
1573
- "description": "Unpublish only entries",
1574
- "hidden": true,
1575
- "allowNo": false
1576
- }
1577
- },
1578
- "args": {}
1579
- }
1580
- }
1581
- }