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

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 (5) hide show
  1. package/README.md +1 -1
  2. package/package.json +3 -3
  3. package/src/commands/cm/stacks/unpublish.js +3 -0
  4. package/src/util/command-helper.js +1 -1
  5. package/oclif.manifest.json +0 -1660
package/oclif.manifest.json DELETED
@@ -1,1660 +0,0 @@
1
- {
2
- "version": "1.3.10",
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
- "Using --stack-api-key",
497
- "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]"
498
- ],
499
- "flags": {
500
- "alias": {
501
- "name": "alias",
502
- "type": "option",
503
- "char": "a",
504
- "description": "Alias(name) for the management token",
505
- "multiple": false
506
- },
507
- "stack-api-key": {
508
- "name": "stack-api-key",
509
- "type": "option",
510
- "char": "k",
511
- "description": "Stack api key to be used",
512
- "required": false,
513
- "multiple": false
514
- },
515
- "retryFailed": {
516
- "name": "retryFailed",
517
- "type": "option",
518
- "char": "r",
519
- "description": "Retry publishing failed entries from the logfile (optional, overrides all other flags)",
520
- "hidden": true,
521
- "multiple": false
522
- },
523
- "retry-failed": {
524
- "name": "retry-failed",
525
- "type": "option",
526
- "description": "Retry publishing failed entries from the logfile (optional, overrides all other flags)",
527
- "multiple": false
528
- },
529
- "bulkPublish": {
530
- "name": "bulkPublish",
531
- "type": "option",
532
- "char": "b",
533
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
534
- "hidden": true,
535
- "multiple": false
536
- },
537
- "bulk-publish": {
538
- "name": "bulk-publish",
539
- "type": "option",
540
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
541
- "multiple": false,
542
- "default": "true"
543
- },
544
- "api-version": {
545
- "name": "api-version",
546
- "type": "option",
547
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
548
- "multiple": false
549
- },
550
- "sourceEnv": {
551
- "name": "sourceEnv",
552
- "type": "option",
553
- "char": "s",
554
- "description": "Environment from which edited entries will be published",
555
- "hidden": true,
556
- "multiple": false
557
- },
558
- "source-env": {
559
- "name": "source-env",
560
- "type": "option",
561
- "description": "Environment from which edited entries will be published",
562
- "multiple": false
563
- },
564
- "contentTypes": {
565
- "name": "contentTypes",
566
- "type": "option",
567
- "char": "t",
568
- "description": "The Content-Types which will be checked for edited entries",
569
- "hidden": true,
570
- "multiple": true
571
- },
572
- "content-types": {
573
- "name": "content-types",
574
- "type": "option",
575
- "description": "The Contenttypes which will be checked for edited entries",
576
- "multiple": true
577
- },
578
- "locales": {
579
- "name": "locales",
580
- "type": "option",
581
- "char": "l",
582
- "description": "Locales where edited entries will be published",
583
- "multiple": true
584
- },
585
- "environments": {
586
- "name": "environments",
587
- "type": "option",
588
- "char": "e",
589
- "description": "Destination environments",
590
- "multiple": true
591
- },
592
- "config": {
593
- "name": "config",
594
- "type": "option",
595
- "char": "c",
596
- "description": "Path to the config file",
597
- "multiple": false
598
- },
599
- "yes": {
600
- "name": "yes",
601
- "type": "boolean",
602
- "char": "y",
603
- "description": "Agree to process the command with the current configuration",
604
- "allowNo": false
605
- },
606
- "branch": {
607
- "name": "branch",
608
- "type": "option",
609
- "char": "B",
610
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
611
- "multiple": false,
612
- "default": "main"
613
- }
614
- },
615
- "args": {}
616
- },
617
- "cm:entries:publish-non-localized-fields": {
618
- "id": "cm:entries:publish-non-localized-fields",
619
- "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",
620
- "strict": true,
621
- "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>]",
622
- "pluginName": "@contentstack/cli-cm-bulk-publish",
623
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
624
- "pluginType": "core",
625
- "aliases": [
626
- "cm:bulk-publish:nonlocalized-field-changes"
627
- ],
628
- "examples": [
629
- "General Usage",
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]",
631
- "",
632
- "Using --config or -c flag",
633
- "Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`",
634
- "csdx cm:entries:publish-non-localized-fields --config [PATH TO CONFIG FILE]",
635
- "csdx cm:entries:publish-non-localized-fields -c [PATH TO CONFIG FILE]",
636
- "",
637
- "Using --retry-failed flag",
638
- "csdx cm:entries:publish-non-localized-fields --retry-failed [LOG FILE NAME]",
639
- "",
640
- "Using --branch flag",
641
- "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]",
642
- "",
643
- "Using --stack-api-key flag",
644
- "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]"
645
- ],
646
- "flags": {
647
- "alias": {
648
- "name": "alias",
649
- "type": "option",
650
- "char": "a",
651
- "description": "Alias(name) for the management token",
652
- "multiple": false
653
- },
654
- "stack-api-key": {
655
- "name": "stack-api-key",
656
- "type": "option",
657
- "char": "k",
658
- "description": "Stack api key to be used",
659
- "required": false,
660
- "multiple": false
661
- },
662
- "retry-failed": {
663
- "name": "retry-failed",
664
- "type": "option",
665
- "description": "Retry publishing failed entries from the logfile",
666
- "multiple": false
667
- },
668
- "bulk-publish": {
669
- "name": "bulk-publish",
670
- "type": "option",
671
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
672
- "multiple": false,
673
- "default": "true"
674
- },
675
- "source-env": {
676
- "name": "source-env",
677
- "type": "option",
678
- "description": "Source Environment",
679
- "multiple": false
680
- },
681
- "content-types": {
682
- "name": "content-types",
683
- "type": "option",
684
- "description": "The Contenttypes from which entries will be published",
685
- "multiple": true
686
- },
687
- "environments": {
688
- "name": "environments",
689
- "type": "option",
690
- "char": "e",
691
- "description": "Destination environments",
692
- "multiple": true
693
- },
694
- "config": {
695
- "name": "config",
696
- "type": "option",
697
- "char": "c",
698
- "description": "Path to the config file",
699
- "multiple": false
700
- },
701
- "yes": {
702
- "name": "yes",
703
- "type": "boolean",
704
- "char": "y",
705
- "description": "Agree to process the command with the current configuration",
706
- "allowNo": false
707
- },
708
- "branch": {
709
- "name": "branch",
710
- "type": "option",
711
- "char": "B",
712
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
713
- "multiple": false,
714
- "default": "main"
715
- },
716
- "retryFailed": {
717
- "name": "retryFailed",
718
- "type": "option",
719
- "char": "r",
720
- "description": "Retry publishing failed entries from the logfile",
721
- "hidden": true,
722
- "multiple": false
723
- },
724
- "bulkPublish": {
725
- "name": "bulkPublish",
726
- "type": "option",
727
- "char": "b",
728
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
729
- "hidden": true,
730
- "multiple": false,
731
- "default": "true"
732
- },
733
- "api-version": {
734
- "name": "api-version",
735
- "type": "option",
736
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
737
- "multiple": false
738
- },
739
- "sourceEnv": {
740
- "name": "sourceEnv",
741
- "type": "option",
742
- "char": "s",
743
- "description": "Source Environment",
744
- "hidden": true,
745
- "multiple": false
746
- },
747
- "contentTypes": {
748
- "name": "contentTypes",
749
- "type": "option",
750
- "char": "t",
751
- "description": "The contenttypes from which entries will be published",
752
- "hidden": true,
753
- "multiple": true
754
- }
755
- },
756
- "args": {}
757
- },
758
- "cm:entries:publish-only-unpublished": {
759
- "id": "cm:entries:publish-only-unpublished",
760
- "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",
761
- "strict": true,
762
- "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>]",
763
- "pluginName": "@contentstack/cli-cm-bulk-publish",
764
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
765
- "pluginType": "core",
766
- "aliases": [
767
- "cm:bulk-publish:unpublished-entries"
768
- ],
769
- "examples": [
770
- "General Usage",
771
- "csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] -source-env [SOURCE ENV]",
772
- "",
773
- "Using --config or -c flag",
774
- "Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`",
775
- "csdx cm:entries:publish-only-unpublished --config [PATH TO CONFIG FILE]",
776
- "csdx cm:entries:publish-only-unpublished -c [PATH TO CONFIG FILE]",
777
- "",
778
- "Using --retry-failed",
779
- "csdx cm:entries:publish-only-unpublished --retry-failed [LOG FILE NAME]",
780
- "",
781
- "Using --branch",
782
- "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]",
783
- "",
784
- "Using --stack-api-key",
785
- "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]"
786
- ],
787
- "flags": {
788
- "alias": {
789
- "name": "alias",
790
- "type": "option",
791
- "char": "a",
792
- "description": "Alias(name) for the management token",
793
- "multiple": false
794
- },
795
- "stack-api-key": {
796
- "name": "stack-api-key",
797
- "type": "option",
798
- "char": "k",
799
- "description": "Stack api key to be used",
800
- "multiple": false
801
- },
802
- "retryFailed": {
803
- "name": "retryFailed",
804
- "type": "option",
805
- "char": "r",
806
- "description": "Retry publishing failed entries from the logfile",
807
- "hidden": true,
808
- "multiple": false
809
- },
810
- "retry-failed": {
811
- "name": "retry-failed",
812
- "type": "option",
813
- "description": "Retry publishing failed entries from the logfile",
814
- "multiple": false
815
- },
816
- "bulkPublish": {
817
- "name": "bulkPublish",
818
- "type": "option",
819
- "char": "b",
820
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
821
- "hidden": true,
822
- "multiple": false,
823
- "default": "true"
824
- },
825
- "bulk-publish": {
826
- "name": "bulk-publish",
827
- "type": "option",
828
- "char": "b",
829
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
830
- "multiple": false,
831
- "default": "true"
832
- },
833
- "api-version": {
834
- "name": "api-version",
835
- "type": "option",
836
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
837
- "multiple": false
838
- },
839
- "sourceEnv": {
840
- "name": "sourceEnv",
841
- "type": "option",
842
- "char": "s",
843
- "description": "Source Env",
844
- "hidden": true,
845
- "multiple": false
846
- },
847
- "source-env": {
848
- "name": "source-env",
849
- "type": "option",
850
- "description": "Source Env",
851
- "multiple": false
852
- },
853
- "contentTypes": {
854
- "name": "contentTypes",
855
- "type": "option",
856
- "char": "t",
857
- "description": "The Content-Types from which entries need to be published",
858
- "hidden": true,
859
- "multiple": true
860
- },
861
- "content-types": {
862
- "name": "content-types",
863
- "type": "option",
864
- "description": "The Contenttypes from which entries will be published",
865
- "multiple": true
866
- },
867
- "locale": {
868
- "name": "locale",
869
- "type": "option",
870
- "char": "l",
871
- "description": "Source locale",
872
- "hidden": true,
873
- "multiple": false
874
- },
875
- "locales": {
876
- "name": "locales",
877
- "type": "option",
878
- "description": "Source locale",
879
- "multiple": false
880
- },
881
- "environments": {
882
- "name": "environments",
883
- "type": "option",
884
- "char": "e",
885
- "description": "Destination environments",
886
- "multiple": true
887
- },
888
- "config": {
889
- "name": "config",
890
- "type": "option",
891
- "char": "c",
892
- "description": "Path to the config file",
893
- "multiple": false
894
- },
895
- "yes": {
896
- "name": "yes",
897
- "type": "boolean",
898
- "char": "y",
899
- "description": "Agree to process the command with the current configuration",
900
- "allowNo": false
901
- },
902
- "branch": {
903
- "name": "branch",
904
- "type": "option",
905
- "char": "B",
906
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
907
- "multiple": false,
908
- "default": "main"
909
- }
910
- },
911
- "args": {}
912
- },
913
- "cm:entries:publish": {
914
- "id": "cm:entries:publish",
915
- "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",
916
- "strict": true,
917
- "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>]",
918
- "pluginName": "@contentstack/cli-cm-bulk-publish",
919
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
920
- "pluginType": "core",
921
- "aliases": [
922
- "cm:bulk-publish:entries"
923
- ],
924
- "examples": [
925
- "General Usage",
926
- "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]",
927
- "",
928
- "Using --config or -c flag",
929
- "Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
930
- "csdx cm:entries:publish --config [PATH TO CONFIG FILE]",
931
- "csdx cm:entries:publish -c [PATH TO CONFIG FILE]",
932
- "",
933
- "Using --retry-failed",
934
- "csdx cm:entries:publish --retry-failed [LOG FILE NAME]",
935
- "csdx cm:entries:publish -r [LOG FILE NAME]",
936
- "",
937
- "Using --branch",
938
- "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]",
939
- "",
940
- "Using --source-env",
941
- "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]",
942
- "",
943
- "Using --stack-api-key",
944
- "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]"
945
- ],
946
- "flags": {
947
- "alias": {
948
- "name": "alias",
949
- "type": "option",
950
- "char": "a",
951
- "description": "Alias(name) for the management token",
952
- "multiple": false
953
- },
954
- "stack-api-key": {
955
- "name": "stack-api-key",
956
- "type": "option",
957
- "char": "k",
958
- "description": "Stack api key to be used",
959
- "multiple": false
960
- },
961
- "retryFailed": {
962
- "name": "retryFailed",
963
- "type": "option",
964
- "char": "r",
965
- "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",
966
- "hidden": true,
967
- "multiple": false
968
- },
969
- "retry-failed": {
970
- "name": "retry-failed",
971
- "type": "option",
972
- "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",
973
- "multiple": false
974
- },
975
- "bulkPublish": {
976
- "name": "bulkPublish",
977
- "type": "option",
978
- "char": "b",
979
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
980
- "hidden": true,
981
- "multiple": false
982
- },
983
- "bulk-publish": {
984
- "name": "bulk-publish",
985
- "type": "option",
986
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
987
- "multiple": false,
988
- "default": "true"
989
- },
990
- "api-version": {
991
- "name": "api-version",
992
- "type": "option",
993
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
994
- "multiple": false
995
- },
996
- "publish-all-content-types": {
997
- "name": "publish-all-content-types",
998
- "type": "boolean",
999
- "description": "(optional) Publish all contenttypes (cannot be set when contentTypes flag is set)",
1000
- "allowNo": false
1001
- },
1002
- "publishAllContentTypes": {
1003
- "name": "publishAllContentTypes",
1004
- "type": "boolean",
1005
- "char": "o",
1006
- "description": "Publish all content-types (optional, cannot be set when contentTypes flag is set)",
1007
- "hidden": true,
1008
- "allowNo": false
1009
- },
1010
- "content-types": {
1011
- "name": "content-types",
1012
- "type": "option",
1013
- "description": "The Contenttypes from which entries need to be published",
1014
- "multiple": true
1015
- },
1016
- "contentTypes": {
1017
- "name": "contentTypes",
1018
- "type": "option",
1019
- "char": "t",
1020
- "description": "The Contenttypes from which entries will be published",
1021
- "hidden": true,
1022
- "multiple": true
1023
- },
1024
- "locales": {
1025
- "name": "locales",
1026
- "type": "option",
1027
- "char": "l",
1028
- "description": "Locales where entries will be published",
1029
- "multiple": true
1030
- },
1031
- "environments": {
1032
- "name": "environments",
1033
- "type": "option",
1034
- "char": "e",
1035
- "description": "Environments where entries will be published",
1036
- "multiple": true
1037
- },
1038
- "config": {
1039
- "name": "config",
1040
- "type": "option",
1041
- "char": "c",
1042
- "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]`)",
1043
- "multiple": false
1044
- },
1045
- "yes": {
1046
- "name": "yes",
1047
- "type": "boolean",
1048
- "char": "y",
1049
- "description": "Agree to process the command with the current configuration",
1050
- "allowNo": false
1051
- },
1052
- "branch": {
1053
- "name": "branch",
1054
- "type": "option",
1055
- "char": "B",
1056
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
1057
- "multiple": false,
1058
- "default": "main"
1059
- },
1060
- "delivery-token": {
1061
- "name": "delivery-token",
1062
- "type": "option",
1063
- "description": "Delivery token for source environment",
1064
- "multiple": false
1065
- },
1066
- "source-env": {
1067
- "name": "source-env",
1068
- "type": "option",
1069
- "description": "Source environment",
1070
- "multiple": false
1071
- }
1072
- },
1073
- "args": {}
1074
- },
1075
- "cm:entries:unpublish": {
1076
- "id": "cm:entries:unpublish",
1077
- "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",
1078
- "strict": true,
1079
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1080
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1081
- "pluginType": "core",
1082
- "aliases": [],
1083
- "examples": [
1084
- "General Usage",
1085
- "csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]",
1086
- "",
1087
- "Using --config or -c flag",
1088
- "Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`",
1089
- "csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]",
1090
- "csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]",
1091
- "",
1092
- "Using --retry-failed flag",
1093
- "csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]",
1094
- "",
1095
- "Using --branch flag",
1096
- "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]",
1097
- "",
1098
- "Using --stack-api-key flag",
1099
- "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]"
1100
- ],
1101
- "flags": {
1102
- "alias": {
1103
- "name": "alias",
1104
- "type": "option",
1105
- "char": "a",
1106
- "description": "Alias(name) for the management token",
1107
- "multiple": false
1108
- },
1109
- "stack-api-key": {
1110
- "name": "stack-api-key",
1111
- "type": "option",
1112
- "char": "k",
1113
- "description": "Stack api key to be used",
1114
- "multiple": false
1115
- },
1116
- "environment": {
1117
- "name": "environment",
1118
- "type": "option",
1119
- "char": "e",
1120
- "description": "Source Environment",
1121
- "multiple": false
1122
- },
1123
- "config": {
1124
- "name": "config",
1125
- "type": "option",
1126
- "char": "c",
1127
- "description": "Path to the config file",
1128
- "multiple": false
1129
- },
1130
- "yes": {
1131
- "name": "yes",
1132
- "type": "boolean",
1133
- "char": "y",
1134
- "description": "Agree to process the command with the current configuration",
1135
- "allowNo": false
1136
- },
1137
- "locale": {
1138
- "name": "locale",
1139
- "type": "option",
1140
- "description": "Locale filter",
1141
- "multiple": false
1142
- },
1143
- "branch": {
1144
- "name": "branch",
1145
- "type": "option",
1146
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
1147
- "multiple": false,
1148
- "default": "main"
1149
- },
1150
- "retry-failed": {
1151
- "name": "retry-failed",
1152
- "type": "option",
1153
- "description": "Retry publishing failed entries from the logfile",
1154
- "multiple": false
1155
- },
1156
- "bulk-unpublish": {
1157
- "name": "bulk-unpublish",
1158
- "type": "option",
1159
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to unpublish the entries",
1160
- "multiple": false,
1161
- "default": "true"
1162
- },
1163
- "api-version": {
1164
- "name": "api-version",
1165
- "type": "option",
1166
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
1167
- "multiple": false
1168
- },
1169
- "content-type": {
1170
- "name": "content-type",
1171
- "type": "option",
1172
- "description": "Content type filter",
1173
- "multiple": false
1174
- },
1175
- "delivery-token": {
1176
- "name": "delivery-token",
1177
- "type": "option",
1178
- "description": "Delivery token for source environment",
1179
- "multiple": false
1180
- }
1181
- },
1182
- "args": {}
1183
- },
1184
- "cm:entries:update-and-publish": {
1185
- "id": "cm:entries:update-and-publish",
1186
- "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",
1187
- "strict": true,
1188
- "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>]",
1189
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1190
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1191
- "pluginType": "core",
1192
- "aliases": [
1193
- "cm:bulk-publish:add-fields"
1194
- ],
1195
- "examples": [
1196
- "General Usage",
1197
- "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]",
1198
- "",
1199
- "Using --config or -c flag",
1200
- "Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
1201
- "csdx cm:entries:update-and-publish --config [PATH TO CONFIG FILE]",
1202
- "csdx cm:entries:update-and-publish -c [PATH TO CONFIG FILE]",
1203
- "",
1204
- "Using --retry-failed",
1205
- "csdx cm:entries:update-and-publish --retry-failed [LOG FILE NAME]",
1206
- "",
1207
- "Using --branch",
1208
- "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]",
1209
- "",
1210
- "Using --stack-api-key",
1211
- "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]"
1212
- ],
1213
- "flags": {
1214
- "alias": {
1215
- "name": "alias",
1216
- "type": "option",
1217
- "char": "a",
1218
- "description": "Alias(name) for the management token",
1219
- "multiple": false
1220
- },
1221
- "stack-api-key": {
1222
- "name": "stack-api-key",
1223
- "type": "option",
1224
- "char": "k",
1225
- "description": "Stack api key to be used",
1226
- "multiple": false
1227
- },
1228
- "retry-failed": {
1229
- "name": "retry-failed",
1230
- "type": "option",
1231
- "description": "Retry publishing failed entries from the logfile (optional, overrides all other flags)",
1232
- "multiple": false
1233
- },
1234
- "bulk-publish": {
1235
- "name": "bulk-publish",
1236
- "type": "option",
1237
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
1238
- "multiple": false,
1239
- "default": "true"
1240
- },
1241
- "api-version": {
1242
- "name": "api-version",
1243
- "type": "option",
1244
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
1245
- "multiple": false
1246
- },
1247
- "content-types": {
1248
- "name": "content-types",
1249
- "type": "option",
1250
- "description": "The Contenttypes from which entries will be published",
1251
- "multiple": true
1252
- },
1253
- "environments": {
1254
- "name": "environments",
1255
- "type": "option",
1256
- "char": "e",
1257
- "description": "Environments where entries will be published",
1258
- "multiple": true
1259
- },
1260
- "config": {
1261
- "name": "config",
1262
- "type": "option",
1263
- "char": "c",
1264
- "description": "Path to the config file",
1265
- "multiple": false
1266
- },
1267
- "yes": {
1268
- "name": "yes",
1269
- "type": "boolean",
1270
- "char": "y",
1271
- "description": "Agree to process the command with the current configuration",
1272
- "allowNo": false
1273
- },
1274
- "locales": {
1275
- "name": "locales",
1276
- "type": "option",
1277
- "char": "l",
1278
- "description": "Locales where entries will be published",
1279
- "multiple": true
1280
- },
1281
- "branch": {
1282
- "name": "branch",
1283
- "type": "option",
1284
- "char": "B",
1285
- "description": "Specify the branch to fetch the content (by default the main branch is selected)",
1286
- "multiple": false,
1287
- "default": "main"
1288
- },
1289
- "force": {
1290
- "name": "force",
1291
- "type": "boolean",
1292
- "description": "Update and publish all entries even if no fields have been added",
1293
- "allowNo": false
1294
- },
1295
- "retryFailed": {
1296
- "name": "retryFailed",
1297
- "type": "option",
1298
- "char": "r",
1299
- "description": "Retry publishing failed entries from the logfile (optional, overrides all other flags)",
1300
- "hidden": true,
1301
- "multiple": false
1302
- },
1303
- "bulkPublish": {
1304
- "name": "bulkPublish",
1305
- "type": "option",
1306
- "char": "b",
1307
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries",
1308
- "hidden": true,
1309
- "multiple": false
1310
- },
1311
- "contentTypes": {
1312
- "name": "contentTypes",
1313
- "type": "option",
1314
- "char": "t",
1315
- "description": "The Contenttypes from which entries will be published",
1316
- "multiple": true
1317
- }
1318
- },
1319
- "args": {}
1320
- },
1321
- "cm:stacks:publish-clear-logs": {
1322
- "id": "cm:stacks:publish-clear-logs",
1323
- "description": "Clear the log folder",
1324
- "strict": true,
1325
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1326
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1327
- "pluginType": "core",
1328
- "aliases": [
1329
- "cm:bulk-publish:clear"
1330
- ],
1331
- "examples": [
1332
- "csdx cm:stacks:publish-clear-logs",
1333
- "csdx cm:stacks:publish-clear-logs --log-files-count",
1334
- "csdx cm:stacks:publish-clear-logs --yes",
1335
- "csdx cm:stacks:publish-clear-logs -y"
1336
- ],
1337
- "flags": {
1338
- "log-files-count": {
1339
- "name": "log-files-count",
1340
- "type": "boolean",
1341
- "description": "List number of log files",
1342
- "allowNo": false
1343
- },
1344
- "yes": {
1345
- "name": "yes",
1346
- "type": "boolean",
1347
- "char": "y",
1348
- "description": "Delete all files without asking for confirmation",
1349
- "allowNo": false
1350
- },
1351
- "list": {
1352
- "name": "list",
1353
- "type": "boolean",
1354
- "char": "l",
1355
- "description": "List number of log files",
1356
- "hidden": true,
1357
- "allowNo": false
1358
- }
1359
- },
1360
- "args": {}
1361
- },
1362
- "cm:stacks:publish-configure": {
1363
- "id": "cm:stacks:publish-configure",
1364
- "description": "The configure command is used to generate a configuration file for publish scripts.",
1365
- "strict": true,
1366
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1367
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1368
- "pluginType": "core",
1369
- "aliases": [
1370
- "cm:bulk-publish:configure"
1371
- ],
1372
- "examples": [
1373
- "csdx cm:stacks:publish-configure",
1374
- "csdx cm:stacks:publish-configure -a <management_token_alias>",
1375
- "csdx cm:stacks:publish-configure --alias <management_token_alias>",
1376
- "csdx cm:stacks:publish-configure --stack-api-key <stack_api_key>"
1377
- ],
1378
- "flags": {
1379
- "alias": {
1380
- "name": "alias",
1381
- "type": "option",
1382
- "char": "a",
1383
- "description": "Alias(name) for the management token",
1384
- "multiple": false
1385
- },
1386
- "stack-api-key": {
1387
- "name": "stack-api-key",
1388
- "type": "option",
1389
- "char": "k",
1390
- "description": "Stack api key to be used",
1391
- "multiple": false
1392
- }
1393
- },
1394
- "args": {}
1395
- },
1396
- "cm:stacks:publish-revert": {
1397
- "id": "cm:stacks:publish-revert",
1398
- "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",
1399
- "strict": true,
1400
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1401
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1402
- "pluginType": "core",
1403
- "aliases": [
1404
- "cm:bulk-publish:revert"
1405
- ],
1406
- "examples": [
1407
- "Using --log-file",
1408
- "cm:bulk-publish:revert --log-file [LOG FILE NAME]",
1409
- "",
1410
- "Using --retry-failed",
1411
- "cm:bulk-publish:revert --retry-failed [LOG FILE NAME]"
1412
- ],
1413
- "flags": {
1414
- "retry-failed": {
1415
- "name": "retry-failed",
1416
- "type": "option",
1417
- "description": "retry publishing failed entries from the logfile",
1418
- "multiple": false
1419
- },
1420
- "log-file": {
1421
- "name": "log-file",
1422
- "type": "option",
1423
- "description": "logfile to be used to revert",
1424
- "multiple": false
1425
- },
1426
- "retryFailed": {
1427
- "name": "retryFailed",
1428
- "type": "option",
1429
- "char": "r",
1430
- "description": "retry publishing failed entries from the logfile",
1431
- "hidden": true,
1432
- "multiple": false
1433
- },
1434
- "logFile": {
1435
- "name": "logFile",
1436
- "type": "option",
1437
- "char": "l",
1438
- "description": "logfile to be used to revert",
1439
- "hidden": true,
1440
- "multiple": false
1441
- }
1442
- },
1443
- "args": {}
1444
- },
1445
- "cm:stacks:publish": {
1446
- "id": "cm:stacks:publish",
1447
- "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",
1448
- "strict": true,
1449
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1450
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1451
- "pluginType": "core",
1452
- "aliases": [],
1453
- "examples": [
1454
- "General Usage",
1455
- "csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]",
1456
- "",
1457
- "Using --config or -c flag",
1458
- "Generate a config file in the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
1459
- "csdx cm:stacks:publish --config [PATH TO CONFIG FILE]",
1460
- "csdx cm:stacks:publish -c [PATH TO CONFIG FILE]",
1461
- "",
1462
- "Using --retry-failed flag",
1463
- "csdx cm:stacks:publish --retry-failed [LOG FILE NAME]",
1464
- "",
1465
- "Using --branch flag",
1466
- "csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]",
1467
- "",
1468
- "Using --api-version flag",
1469
- "csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --api-version [API VERSION]"
1470
- ],
1471
- "flags": {},
1472
- "args": {}
1473
- },
1474
- "cm:stacks:unpublish": {
1475
- "id": "cm:stacks:unpublish",
1476
- "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",
1477
- "strict": true,
1478
- "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]",
1479
- "pluginName": "@contentstack/cli-cm-bulk-publish",
1480
- "pluginAlias": "@contentstack/cli-cm-bulk-publish",
1481
- "pluginType": "core",
1482
- "aliases": [
1483
- "cm:bulk-publish:unpublish"
1484
- ],
1485
- "examples": [
1486
- "General Usage",
1487
- "csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] ----delivery-token [DELIVERY TOKEN]",
1488
- "",
1489
- "Using --config or -c flag",
1490
- "Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`",
1491
- "csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]",
1492
- "csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]",
1493
- "",
1494
- "Using --retry-failed flag",
1495
- "csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]",
1496
- "",
1497
- "No content type",
1498
- "csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all content types and assets from the source environment)",
1499
- "",
1500
- "Using --only-assets",
1501
- "csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-assets (Will unpublish only assets from the source environment)",
1502
- "",
1503
- "Using --only-entries",
1504
- "csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, all entries, from the source environment)",
1505
- "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)",
1506
- "",
1507
- "Using --branch flag",
1508
- "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]",
1509
- "",
1510
- "Using --stack-api-key flag",
1511
- "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]"
1512
- ],
1513
- "flags": {
1514
- "alias": {
1515
- "name": "alias",
1516
- "type": "option",
1517
- "char": "a",
1518
- "description": "Alias(name) for the management token",
1519
- "multiple": false
1520
- },
1521
- "stack-api-key": {
1522
- "name": "stack-api-key",
1523
- "type": "option",
1524
- "char": "k",
1525
- "description": "Stack api key to be used",
1526
- "multiple": false
1527
- },
1528
- "environment": {
1529
- "name": "environment",
1530
- "type": "option",
1531
- "char": "e",
1532
- "description": "Source Environment",
1533
- "multiple": false
1534
- },
1535
- "config": {
1536
- "name": "config",
1537
- "type": "option",
1538
- "char": "c",
1539
- "description": "Path to the config file",
1540
- "multiple": false
1541
- },
1542
- "yes": {
1543
- "name": "yes",
1544
- "type": "boolean",
1545
- "char": "y",
1546
- "description": "Agree to process the command with the current configuration",
1547
- "allowNo": false
1548
- },
1549
- "locale": {
1550
- "name": "locale",
1551
- "type": "option",
1552
- "char": "l",
1553
- "description": "Locale filter",
1554
- "multiple": false
1555
- },
1556
- "branch": {
1557
- "name": "branch",
1558
- "type": "option",
1559
- "char": "B",
1560
- "description": "Specify the branch to fetch the content from (default is main branch)",
1561
- "multiple": false,
1562
- "default": "main"
1563
- },
1564
- "retry-failed": {
1565
- "name": "retry-failed",
1566
- "type": "option",
1567
- "description": "Retry publishing failed entries from the logfile (optional, overrides all other flags)",
1568
- "multiple": false
1569
- },
1570
- "bulk-unpublish": {
1571
- "name": "bulk-unpublish",
1572
- "type": "option",
1573
- "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",
1574
- "multiple": false,
1575
- "default": "true"
1576
- },
1577
- "api-version": {
1578
- "name": "api-version",
1579
- "type": "option",
1580
- "description": "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
1581
- "multiple": false
1582
- },
1583
- "content-type": {
1584
- "name": "content-type",
1585
- "type": "option",
1586
- "description": "Content type filter",
1587
- "multiple": false
1588
- },
1589
- "delivery-token": {
1590
- "name": "delivery-token",
1591
- "type": "option",
1592
- "description": "Delivery token for source environment",
1593
- "multiple": false
1594
- },
1595
- "only-assets": {
1596
- "name": "only-assets",
1597
- "type": "boolean",
1598
- "description": "Unpublish only assets",
1599
- "hidden": true,
1600
- "allowNo": false
1601
- },
1602
- "only-entries": {
1603
- "name": "only-entries",
1604
- "type": "boolean",
1605
- "description": "Unpublish only entries",
1606
- "hidden": true,
1607
- "allowNo": false
1608
- },
1609
- "retryFailed": {
1610
- "name": "retryFailed",
1611
- "type": "option",
1612
- "char": "r",
1613
- "description": "Retry publishing failed entries from the logfile",
1614
- "hidden": true,
1615
- "multiple": false
1616
- },
1617
- "bulkUnpublish": {
1618
- "name": "bulkUnpublish",
1619
- "type": "option",
1620
- "char": "b",
1621
- "description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used for publishing the entries",
1622
- "hidden": true,
1623
- "multiple": false,
1624
- "default": "true"
1625
- },
1626
- "contentType": {
1627
- "name": "contentType",
1628
- "type": "option",
1629
- "char": "t",
1630
- "description": "Content Type filter",
1631
- "hidden": true,
1632
- "multiple": false
1633
- },
1634
- "deliveryToken": {
1635
- "name": "deliveryToken",
1636
- "type": "option",
1637
- "char": "x",
1638
- "description": "Delivery Token for source environment",
1639
- "hidden": true,
1640
- "multiple": false
1641
- },
1642
- "onlyAssets": {
1643
- "name": "onlyAssets",
1644
- "type": "boolean",
1645
- "description": "Unpublish only assets",
1646
- "hidden": true,
1647
- "allowNo": false
1648
- },
1649
- "onlyEntries": {
1650
- "name": "onlyEntries",
1651
- "type": "boolean",
1652
- "description": "Unpublish only entries",
1653
- "hidden": true,
1654
- "allowNo": false
1655
- }
1656
- },
1657
- "args": {}
1658
- }
1659
- }
1660
- }