@contentstack/cli-cm-bulk-publish 1.10.7 → 1.11.0-beta.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -1
- package/oclif.manifest.json +1997 -0
- package/package.json +5 -4
|
@@ -0,0 +1,1997 @@
|
|
|
1
|
+
{
|
|
2
|
+
"commands": {
|
|
3
|
+
"cm:assets:publish": {
|
|
4
|
+
"aliases": [
|
|
5
|
+
"cm:bulk-publish:assets"
|
|
6
|
+
],
|
|
7
|
+
"args": {},
|
|
8
|
+
"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",
|
|
9
|
+
"examples": [
|
|
10
|
+
"General Usage",
|
|
11
|
+
"csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]",
|
|
12
|
+
"",
|
|
13
|
+
"Using --config or -c flag",
|
|
14
|
+
"Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
|
|
15
|
+
"csdx cm:assets:publish --config [PATH TO CONFIG FILE]",
|
|
16
|
+
"csdx cm:assets:publish -c [PATH TO CONFIG FILE]",
|
|
17
|
+
"",
|
|
18
|
+
"Using --retry-failed flag",
|
|
19
|
+
"csdx cm:assets:publish --retry-failed [LOG FILE NAME]",
|
|
20
|
+
"",
|
|
21
|
+
"Using --branch flag",
|
|
22
|
+
"csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]",
|
|
23
|
+
"",
|
|
24
|
+
"Using --source-env",
|
|
25
|
+
"csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]",
|
|
26
|
+
"",
|
|
27
|
+
"Using --stack-api-key flag",
|
|
28
|
+
"csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --stack-api-key [STACK API KEY]"
|
|
29
|
+
],
|
|
30
|
+
"flags": {
|
|
31
|
+
"alias": {
|
|
32
|
+
"char": "a",
|
|
33
|
+
"description": "Alias (name) for the management token. You must use either the --alias flag or the --stack-api-key flag.",
|
|
34
|
+
"name": "alias",
|
|
35
|
+
"hasDynamicHelp": false,
|
|
36
|
+
"multiple": false,
|
|
37
|
+
"type": "option"
|
|
38
|
+
},
|
|
39
|
+
"stack-api-key": {
|
|
40
|
+
"char": "k",
|
|
41
|
+
"description": "API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.",
|
|
42
|
+
"name": "stack-api-key",
|
|
43
|
+
"required": false,
|
|
44
|
+
"hasDynamicHelp": false,
|
|
45
|
+
"multiple": false,
|
|
46
|
+
"type": "option"
|
|
47
|
+
},
|
|
48
|
+
"retry-failed": {
|
|
49
|
+
"description": "Use this option to retry publishing the failed assets from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.",
|
|
50
|
+
"name": "retry-failed",
|
|
51
|
+
"hasDynamicHelp": false,
|
|
52
|
+
"multiple": false,
|
|
53
|
+
"type": "option"
|
|
54
|
+
},
|
|
55
|
+
"environments": {
|
|
56
|
+
"char": "e",
|
|
57
|
+
"description": "The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.",
|
|
58
|
+
"name": "environments",
|
|
59
|
+
"hasDynamicHelp": false,
|
|
60
|
+
"multiple": true,
|
|
61
|
+
"type": "option"
|
|
62
|
+
},
|
|
63
|
+
"folder-uid": {
|
|
64
|
+
"description": "(optional) The UID of the Assets’ folder from which the assets need to be published. The default value is cs_root.",
|
|
65
|
+
"exclusive": [
|
|
66
|
+
"source-env"
|
|
67
|
+
],
|
|
68
|
+
"name": "folder-uid",
|
|
69
|
+
"hasDynamicHelp": false,
|
|
70
|
+
"multiple": false,
|
|
71
|
+
"type": "option"
|
|
72
|
+
},
|
|
73
|
+
"bulk-publish": {
|
|
74
|
+
"description": "Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.",
|
|
75
|
+
"name": "bulk-publish",
|
|
76
|
+
"default": "true",
|
|
77
|
+
"hasDynamicHelp": false,
|
|
78
|
+
"multiple": false,
|
|
79
|
+
"type": "option"
|
|
80
|
+
},
|
|
81
|
+
"config": {
|
|
82
|
+
"char": "c",
|
|
83
|
+
"description": "(optional) The path of the optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.",
|
|
84
|
+
"name": "config",
|
|
85
|
+
"hasDynamicHelp": false,
|
|
86
|
+
"multiple": false,
|
|
87
|
+
"type": "option"
|
|
88
|
+
},
|
|
89
|
+
"yes": {
|
|
90
|
+
"char": "y",
|
|
91
|
+
"description": "Set it to true to process the command with the current configuration.",
|
|
92
|
+
"name": "yes",
|
|
93
|
+
"allowNo": false,
|
|
94
|
+
"type": "boolean"
|
|
95
|
+
},
|
|
96
|
+
"locales": {
|
|
97
|
+
"char": "l",
|
|
98
|
+
"description": "Locales in which assets will be published, e.g., en-us. In the case of multiple locales, specify the codes separated by spaces.",
|
|
99
|
+
"name": "locales",
|
|
100
|
+
"hasDynamicHelp": false,
|
|
101
|
+
"multiple": true,
|
|
102
|
+
"type": "option"
|
|
103
|
+
},
|
|
104
|
+
"branch": {
|
|
105
|
+
"char": "B",
|
|
106
|
+
"description": "The name of the branch where you want to perform the bulk publish operation. If you don’t mention the branch name, then by default the assets from the main branch will be published.",
|
|
107
|
+
"name": "branch",
|
|
108
|
+
"default": "main",
|
|
109
|
+
"hasDynamicHelp": false,
|
|
110
|
+
"multiple": false,
|
|
111
|
+
"type": "option"
|
|
112
|
+
},
|
|
113
|
+
"retryFailed": {
|
|
114
|
+
"char": "r",
|
|
115
|
+
"description": "Retry publishing failed assets from the logfile (optional, will override all other flags).",
|
|
116
|
+
"hidden": true,
|
|
117
|
+
"name": "retryFailed",
|
|
118
|
+
"hasDynamicHelp": false,
|
|
119
|
+
"multiple": false,
|
|
120
|
+
"type": "option"
|
|
121
|
+
},
|
|
122
|
+
"folderUid": {
|
|
123
|
+
"char": "u",
|
|
124
|
+
"description": "(default: cs_root) Folder-uid from where the assets will be published.",
|
|
125
|
+
"exclusive": [
|
|
126
|
+
"source-env"
|
|
127
|
+
],
|
|
128
|
+
"hidden": true,
|
|
129
|
+
"name": "folderUid",
|
|
130
|
+
"hasDynamicHelp": false,
|
|
131
|
+
"multiple": false,
|
|
132
|
+
"type": "option"
|
|
133
|
+
},
|
|
134
|
+
"bulkPublish": {
|
|
135
|
+
"char": "b",
|
|
136
|
+
"description": "By default this flag is set as true. It indicates that Contentstack's bulk publish API will be used to publish the entries.",
|
|
137
|
+
"hidden": true,
|
|
138
|
+
"name": "bulkPublish",
|
|
139
|
+
"default": "true",
|
|
140
|
+
"hasDynamicHelp": false,
|
|
141
|
+
"multiple": false,
|
|
142
|
+
"type": "option"
|
|
143
|
+
},
|
|
144
|
+
"api-version": {
|
|
145
|
+
"description": "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
|
|
146
|
+
"name": "api-version",
|
|
147
|
+
"hasDynamicHelp": false,
|
|
148
|
+
"multiple": false,
|
|
149
|
+
"type": "option"
|
|
150
|
+
},
|
|
151
|
+
"delivery-token": {
|
|
152
|
+
"description": "The delivery token of the source environment.",
|
|
153
|
+
"name": "delivery-token",
|
|
154
|
+
"hasDynamicHelp": false,
|
|
155
|
+
"multiple": false,
|
|
156
|
+
"type": "option"
|
|
157
|
+
},
|
|
158
|
+
"source-env": {
|
|
159
|
+
"description": "Source environment",
|
|
160
|
+
"name": "source-env",
|
|
161
|
+
"hasDynamicHelp": false,
|
|
162
|
+
"multiple": false,
|
|
163
|
+
"type": "option"
|
|
164
|
+
},
|
|
165
|
+
"content-types": {
|
|
166
|
+
"description": "Content types",
|
|
167
|
+
"hidden": true,
|
|
168
|
+
"name": "content-types",
|
|
169
|
+
"hasDynamicHelp": false,
|
|
170
|
+
"multiple": true,
|
|
171
|
+
"type": "option"
|
|
172
|
+
}
|
|
173
|
+
},
|
|
174
|
+
"hasDynamicHelp": false,
|
|
175
|
+
"hiddenAliases": [],
|
|
176
|
+
"id": "cm:assets:publish",
|
|
177
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
178
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
179
|
+
"pluginType": "core",
|
|
180
|
+
"strict": true,
|
|
181
|
+
"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>]",
|
|
182
|
+
"isESM": false,
|
|
183
|
+
"relativePath": [
|
|
184
|
+
"src",
|
|
185
|
+
"commands",
|
|
186
|
+
"cm",
|
|
187
|
+
"assets",
|
|
188
|
+
"publish.js"
|
|
189
|
+
]
|
|
190
|
+
},
|
|
191
|
+
"cm:assets:unpublish": {
|
|
192
|
+
"aliases": [],
|
|
193
|
+
"args": {},
|
|
194
|
+
"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",
|
|
195
|
+
"examples": [
|
|
196
|
+
"General Usage",
|
|
197
|
+
"csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]",
|
|
198
|
+
"",
|
|
199
|
+
"Using --config or -c flag",
|
|
200
|
+
"Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`",
|
|
201
|
+
"csdx cm:assets:unpublish --config [PATH TO CONFIG FILE]",
|
|
202
|
+
"csdx cm:assets:unpublish -c [PATH TO CONFIG FILE]",
|
|
203
|
+
"",
|
|
204
|
+
"Using --retry-failed flag",
|
|
205
|
+
"csdx cm:assets:unpublish --retry-failed [LOG FILE NAME]",
|
|
206
|
+
"",
|
|
207
|
+
"Using --branch flag",
|
|
208
|
+
"csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]",
|
|
209
|
+
"",
|
|
210
|
+
"Using --stack-api-key flag",
|
|
211
|
+
"csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]"
|
|
212
|
+
],
|
|
213
|
+
"flags": {
|
|
214
|
+
"alias": {
|
|
215
|
+
"char": "a",
|
|
216
|
+
"description": "Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.",
|
|
217
|
+
"name": "alias",
|
|
218
|
+
"hasDynamicHelp": false,
|
|
219
|
+
"multiple": false,
|
|
220
|
+
"type": "option"
|
|
221
|
+
},
|
|
222
|
+
"stack-api-key": {
|
|
223
|
+
"char": "k",
|
|
224
|
+
"description": "API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.",
|
|
225
|
+
"name": "stack-api-key",
|
|
226
|
+
"required": false,
|
|
227
|
+
"hasDynamicHelp": false,
|
|
228
|
+
"multiple": false,
|
|
229
|
+
"type": "option"
|
|
230
|
+
},
|
|
231
|
+
"environment": {
|
|
232
|
+
"char": "e",
|
|
233
|
+
"description": "The name of the environment from where entries/assets need to be unpublished.",
|
|
234
|
+
"name": "environment",
|
|
235
|
+
"hasDynamicHelp": false,
|
|
236
|
+
"multiple": false,
|
|
237
|
+
"type": "option"
|
|
238
|
+
},
|
|
239
|
+
"config": {
|
|
240
|
+
"char": "c",
|
|
241
|
+
"description": "(optional) Path of an optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.",
|
|
242
|
+
"name": "config",
|
|
243
|
+
"hasDynamicHelp": false,
|
|
244
|
+
"multiple": false,
|
|
245
|
+
"type": "option"
|
|
246
|
+
},
|
|
247
|
+
"yes": {
|
|
248
|
+
"char": "y",
|
|
249
|
+
"description": "Set it to true to process the command with the current configuration.",
|
|
250
|
+
"name": "yes",
|
|
251
|
+
"allowNo": false,
|
|
252
|
+
"type": "boolean"
|
|
253
|
+
},
|
|
254
|
+
"locale": {
|
|
255
|
+
"description": "Locale from which entries/assets will be unpublished, e.g., en-us.",
|
|
256
|
+
"name": "locale",
|
|
257
|
+
"hasDynamicHelp": false,
|
|
258
|
+
"multiple": false,
|
|
259
|
+
"type": "option"
|
|
260
|
+
},
|
|
261
|
+
"branch": {
|
|
262
|
+
"description": "The name of the branch where you want to perform the bulk unpublish operation. If you don’t mention the branch name, then by default the content from the main branch will be unpublished.",
|
|
263
|
+
"name": "branch",
|
|
264
|
+
"default": "main",
|
|
265
|
+
"hasDynamicHelp": false,
|
|
266
|
+
"multiple": false,
|
|
267
|
+
"type": "option"
|
|
268
|
+
},
|
|
269
|
+
"retry-failed": {
|
|
270
|
+
"description": "(optional) Use this option to retry unpublishing the failed entries from the logfile. Specify the name of the logfile that lists failed unpublish calls. If this option is used, it will override all other flags.",
|
|
271
|
+
"name": "retry-failed",
|
|
272
|
+
"hasDynamicHelp": false,
|
|
273
|
+
"multiple": false,
|
|
274
|
+
"type": "option"
|
|
275
|
+
},
|
|
276
|
+
"bulk-unpublish": {
|
|
277
|
+
"description": "Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.",
|
|
278
|
+
"name": "bulk-unpublish",
|
|
279
|
+
"default": "true",
|
|
280
|
+
"hasDynamicHelp": false,
|
|
281
|
+
"multiple": false,
|
|
282
|
+
"type": "option"
|
|
283
|
+
},
|
|
284
|
+
"api-version": {
|
|
285
|
+
"description": "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
|
|
286
|
+
"name": "api-version",
|
|
287
|
+
"hasDynamicHelp": false,
|
|
288
|
+
"multiple": false,
|
|
289
|
+
"type": "option"
|
|
290
|
+
},
|
|
291
|
+
"delivery-token": {
|
|
292
|
+
"description": "The delivery token of the source environment.",
|
|
293
|
+
"name": "delivery-token",
|
|
294
|
+
"hasDynamicHelp": false,
|
|
295
|
+
"multiple": false,
|
|
296
|
+
"type": "option"
|
|
297
|
+
}
|
|
298
|
+
},
|
|
299
|
+
"hasDynamicHelp": false,
|
|
300
|
+
"hiddenAliases": [],
|
|
301
|
+
"id": "cm:assets:unpublish",
|
|
302
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
303
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
304
|
+
"pluginType": "core",
|
|
305
|
+
"strict": true,
|
|
306
|
+
"isESM": false,
|
|
307
|
+
"relativePath": [
|
|
308
|
+
"src",
|
|
309
|
+
"commands",
|
|
310
|
+
"cm",
|
|
311
|
+
"assets",
|
|
312
|
+
"unpublish.js"
|
|
313
|
+
]
|
|
314
|
+
},
|
|
315
|
+
"cm:bulk-publish:cross-publish": {
|
|
316
|
+
"aliases": [],
|
|
317
|
+
"args": {},
|
|
318
|
+
"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",
|
|
319
|
+
"examples": [
|
|
320
|
+
"General Usage",
|
|
321
|
+
"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]",
|
|
322
|
+
"",
|
|
323
|
+
"Using --config or -c flag",
|
|
324
|
+
"Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`",
|
|
325
|
+
"csdx cm:bulk-publish:cross-publish --config [PATH TO CONFIG FILE]",
|
|
326
|
+
"csdx cm:bulk-publish:cross-publish -c [PATH TO CONFIG FILE]",
|
|
327
|
+
"",
|
|
328
|
+
"Using --retry-failed flag",
|
|
329
|
+
"csdx cm:bulk-publish:cross-publish --retry-failed [LOG FILE NAME]",
|
|
330
|
+
"csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]",
|
|
331
|
+
"",
|
|
332
|
+
"Using --branch flag",
|
|
333
|
+
"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]",
|
|
334
|
+
"",
|
|
335
|
+
"Using --stack-api-key flag",
|
|
336
|
+
"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]",
|
|
337
|
+
"",
|
|
338
|
+
"Using --include-variants flag",
|
|
339
|
+
"csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN] [--include-variants]",
|
|
340
|
+
""
|
|
341
|
+
],
|
|
342
|
+
"flags": {
|
|
343
|
+
"alias": {
|
|
344
|
+
"char": "a",
|
|
345
|
+
"description": "Alias(name) for the management token",
|
|
346
|
+
"name": "alias",
|
|
347
|
+
"hasDynamicHelp": false,
|
|
348
|
+
"multiple": false,
|
|
349
|
+
"type": "option"
|
|
350
|
+
},
|
|
351
|
+
"stack-api-key": {
|
|
352
|
+
"char": "k",
|
|
353
|
+
"description": "Stack API key to be used",
|
|
354
|
+
"name": "stack-api-key",
|
|
355
|
+
"required": false,
|
|
356
|
+
"hasDynamicHelp": false,
|
|
357
|
+
"multiple": false,
|
|
358
|
+
"type": "option"
|
|
359
|
+
},
|
|
360
|
+
"retryFailed": {
|
|
361
|
+
"char": "r",
|
|
362
|
+
"description": "(optional) Retry publishing failed entries from the logfile (this flag overrides all other flags)",
|
|
363
|
+
"hidden": true,
|
|
364
|
+
"name": "retryFailed",
|
|
365
|
+
"hasDynamicHelp": false,
|
|
366
|
+
"multiple": false,
|
|
367
|
+
"type": "option"
|
|
368
|
+
},
|
|
369
|
+
"retry-failed": {
|
|
370
|
+
"description": "(optional) Retry publishing failed entries from the logfile (this flag overrides all other flags)",
|
|
371
|
+
"name": "retry-failed",
|
|
372
|
+
"hasDynamicHelp": false,
|
|
373
|
+
"multiple": false,
|
|
374
|
+
"type": "option"
|
|
375
|
+
},
|
|
376
|
+
"bulkPublish": {
|
|
377
|
+
"char": "b",
|
|
378
|
+
"description": "Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.",
|
|
379
|
+
"hidden": true,
|
|
380
|
+
"name": "bulkPublish",
|
|
381
|
+
"default": "true",
|
|
382
|
+
"hasDynamicHelp": false,
|
|
383
|
+
"multiple": false,
|
|
384
|
+
"type": "option"
|
|
385
|
+
},
|
|
386
|
+
"bulk-publish": {
|
|
387
|
+
"description": "Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.",
|
|
388
|
+
"name": "bulk-publish",
|
|
389
|
+
"default": "true",
|
|
390
|
+
"hasDynamicHelp": false,
|
|
391
|
+
"multiple": false,
|
|
392
|
+
"type": "option"
|
|
393
|
+
},
|
|
394
|
+
"api-version": {
|
|
395
|
+
"description": "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
|
|
396
|
+
"name": "api-version",
|
|
397
|
+
"hasDynamicHelp": false,
|
|
398
|
+
"multiple": false,
|
|
399
|
+
"type": "option"
|
|
400
|
+
},
|
|
401
|
+
"contentType": {
|
|
402
|
+
"char": "t",
|
|
403
|
+
"description": "The Content-Types from which entries need to be published",
|
|
404
|
+
"hidden": true,
|
|
405
|
+
"name": "contentType",
|
|
406
|
+
"hasDynamicHelp": false,
|
|
407
|
+
"multiple": true,
|
|
408
|
+
"type": "option"
|
|
409
|
+
},
|
|
410
|
+
"content-type": {
|
|
411
|
+
"description": "The Contenttypes from which entries will be published",
|
|
412
|
+
"name": "content-type",
|
|
413
|
+
"hasDynamicHelp": false,
|
|
414
|
+
"multiple": true,
|
|
415
|
+
"type": "option"
|
|
416
|
+
},
|
|
417
|
+
"locale": {
|
|
418
|
+
"char": "l",
|
|
419
|
+
"description": "Source locale",
|
|
420
|
+
"hidden": true,
|
|
421
|
+
"name": "locale",
|
|
422
|
+
"hasDynamicHelp": false,
|
|
423
|
+
"multiple": false,
|
|
424
|
+
"type": "option"
|
|
425
|
+
},
|
|
426
|
+
"locales": {
|
|
427
|
+
"description": "Source locale",
|
|
428
|
+
"name": "locales",
|
|
429
|
+
"hasDynamicHelp": false,
|
|
430
|
+
"multiple": false,
|
|
431
|
+
"type": "option"
|
|
432
|
+
},
|
|
433
|
+
"environment": {
|
|
434
|
+
"char": "e",
|
|
435
|
+
"description": "Source Environment",
|
|
436
|
+
"hidden": true,
|
|
437
|
+
"name": "environment",
|
|
438
|
+
"hasDynamicHelp": false,
|
|
439
|
+
"multiple": false,
|
|
440
|
+
"type": "option"
|
|
441
|
+
},
|
|
442
|
+
"source-env": {
|
|
443
|
+
"description": "Source Env",
|
|
444
|
+
"name": "source-env",
|
|
445
|
+
"hasDynamicHelp": false,
|
|
446
|
+
"multiple": false,
|
|
447
|
+
"type": "option"
|
|
448
|
+
},
|
|
449
|
+
"destEnv": {
|
|
450
|
+
"char": "d",
|
|
451
|
+
"description": "Destination Environments",
|
|
452
|
+
"hidden": true,
|
|
453
|
+
"name": "destEnv",
|
|
454
|
+
"hasDynamicHelp": false,
|
|
455
|
+
"multiple": true,
|
|
456
|
+
"type": "option"
|
|
457
|
+
},
|
|
458
|
+
"environments": {
|
|
459
|
+
"description": "Destination Environments",
|
|
460
|
+
"name": "environments",
|
|
461
|
+
"hasDynamicHelp": false,
|
|
462
|
+
"multiple": true,
|
|
463
|
+
"type": "option"
|
|
464
|
+
},
|
|
465
|
+
"deliveryToken": {
|
|
466
|
+
"char": "x",
|
|
467
|
+
"description": "The delivery token of the source environment.",
|
|
468
|
+
"hidden": true,
|
|
469
|
+
"name": "deliveryToken",
|
|
470
|
+
"hasDynamicHelp": false,
|
|
471
|
+
"multiple": false,
|
|
472
|
+
"type": "option"
|
|
473
|
+
},
|
|
474
|
+
"delivery-token": {
|
|
475
|
+
"description": "The delivery token of the source environment.",
|
|
476
|
+
"name": "delivery-token",
|
|
477
|
+
"hasDynamicHelp": false,
|
|
478
|
+
"multiple": false,
|
|
479
|
+
"type": "option"
|
|
480
|
+
},
|
|
481
|
+
"config": {
|
|
482
|
+
"char": "c",
|
|
483
|
+
"description": "Path to the config file",
|
|
484
|
+
"name": "config",
|
|
485
|
+
"hasDynamicHelp": false,
|
|
486
|
+
"multiple": false,
|
|
487
|
+
"type": "option"
|
|
488
|
+
},
|
|
489
|
+
"yes": {
|
|
490
|
+
"char": "y",
|
|
491
|
+
"description": "Agree to process the command with the current configuration",
|
|
492
|
+
"name": "yes",
|
|
493
|
+
"allowNo": false,
|
|
494
|
+
"type": "boolean"
|
|
495
|
+
},
|
|
496
|
+
"branch": {
|
|
497
|
+
"char": "B",
|
|
498
|
+
"description": "Specify the branch to fetch the content (by default the main branch is selected)",
|
|
499
|
+
"name": "branch",
|
|
500
|
+
"default": "main",
|
|
501
|
+
"hasDynamicHelp": false,
|
|
502
|
+
"multiple": false,
|
|
503
|
+
"type": "option"
|
|
504
|
+
},
|
|
505
|
+
"onlyAssets": {
|
|
506
|
+
"description": "Unpublish only assets",
|
|
507
|
+
"name": "onlyAssets",
|
|
508
|
+
"allowNo": false,
|
|
509
|
+
"type": "boolean"
|
|
510
|
+
},
|
|
511
|
+
"onlyEntries": {
|
|
512
|
+
"description": "Unpublish only entries",
|
|
513
|
+
"name": "onlyEntries",
|
|
514
|
+
"allowNo": false,
|
|
515
|
+
"type": "boolean"
|
|
516
|
+
},
|
|
517
|
+
"include-variants": {
|
|
518
|
+
"description": "Include Variants flag will publish all associated variant entries.",
|
|
519
|
+
"name": "include-variants",
|
|
520
|
+
"allowNo": false,
|
|
521
|
+
"type": "boolean"
|
|
522
|
+
}
|
|
523
|
+
},
|
|
524
|
+
"hasDynamicHelp": false,
|
|
525
|
+
"hiddenAliases": [],
|
|
526
|
+
"id": "cm:bulk-publish:cross-publish",
|
|
527
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
528
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
529
|
+
"pluginType": "core",
|
|
530
|
+
"strict": true,
|
|
531
|
+
"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] [--include-variants]",
|
|
532
|
+
"isESM": false,
|
|
533
|
+
"relativePath": [
|
|
534
|
+
"src",
|
|
535
|
+
"commands",
|
|
536
|
+
"cm",
|
|
537
|
+
"bulk-publish",
|
|
538
|
+
"cross-publish.js"
|
|
539
|
+
]
|
|
540
|
+
},
|
|
541
|
+
"cm:bulk-publish": {
|
|
542
|
+
"aliases": [],
|
|
543
|
+
"args": {},
|
|
544
|
+
"description": "Bulk Publish script for managing entries and assets\n",
|
|
545
|
+
"flags": {},
|
|
546
|
+
"hasDynamicHelp": false,
|
|
547
|
+
"hiddenAliases": [],
|
|
548
|
+
"id": "cm:bulk-publish",
|
|
549
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
550
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
551
|
+
"pluginType": "core",
|
|
552
|
+
"strict": true,
|
|
553
|
+
"isESM": false,
|
|
554
|
+
"relativePath": [
|
|
555
|
+
"src",
|
|
556
|
+
"commands",
|
|
557
|
+
"cm",
|
|
558
|
+
"bulk-publish",
|
|
559
|
+
"index.js"
|
|
560
|
+
]
|
|
561
|
+
},
|
|
562
|
+
"cm:entries:publish-modified": {
|
|
563
|
+
"aliases": [
|
|
564
|
+
"cm:bulk-publish:entry-edits"
|
|
565
|
+
],
|
|
566
|
+
"args": {},
|
|
567
|
+
"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",
|
|
568
|
+
"examples": [
|
|
569
|
+
"General Usage",
|
|
570
|
+
"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]",
|
|
571
|
+
"",
|
|
572
|
+
"Using --config or -c flag",
|
|
573
|
+
"Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
|
|
574
|
+
"csdx cm:entries:publish-modified --config [PATH TO CONFIG FILE]",
|
|
575
|
+
"csdx cm:entries:publish-modified -c [PATH TO CONFIG FILE]",
|
|
576
|
+
"",
|
|
577
|
+
"Using --retry-failed",
|
|
578
|
+
"csdx cm:entries:publish-modified --retry-failed [LOG FILE NAME]",
|
|
579
|
+
"csdx cm:entries:publish-modified -r [LOG FILE NAME]",
|
|
580
|
+
"",
|
|
581
|
+
"Using --branch",
|
|
582
|
+
"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]",
|
|
583
|
+
"",
|
|
584
|
+
"Using --stack-api-key",
|
|
585
|
+
"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]"
|
|
586
|
+
],
|
|
587
|
+
"flags": {
|
|
588
|
+
"alias": {
|
|
589
|
+
"char": "a",
|
|
590
|
+
"description": "Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.",
|
|
591
|
+
"name": "alias",
|
|
592
|
+
"hasDynamicHelp": false,
|
|
593
|
+
"multiple": false,
|
|
594
|
+
"type": "option"
|
|
595
|
+
},
|
|
596
|
+
"stack-api-key": {
|
|
597
|
+
"char": "k",
|
|
598
|
+
"description": "API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.",
|
|
599
|
+
"name": "stack-api-key",
|
|
600
|
+
"required": false,
|
|
601
|
+
"hasDynamicHelp": false,
|
|
602
|
+
"multiple": false,
|
|
603
|
+
"type": "option"
|
|
604
|
+
},
|
|
605
|
+
"retryFailed": {
|
|
606
|
+
"char": "r",
|
|
607
|
+
"description": "(optional) Use this option to retry publishing the failed entries/assets from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags",
|
|
608
|
+
"hidden": true,
|
|
609
|
+
"name": "retryFailed",
|
|
610
|
+
"hasDynamicHelp": false,
|
|
611
|
+
"multiple": false,
|
|
612
|
+
"type": "option"
|
|
613
|
+
},
|
|
614
|
+
"retry-failed": {
|
|
615
|
+
"description": "(optional) Use this option to retry publishing the failed entries/assets from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags",
|
|
616
|
+
"name": "retry-failed",
|
|
617
|
+
"hasDynamicHelp": false,
|
|
618
|
+
"multiple": false,
|
|
619
|
+
"type": "option"
|
|
620
|
+
},
|
|
621
|
+
"bulkPublish": {
|
|
622
|
+
"char": "b",
|
|
623
|
+
"description": "Set this flag to use Contentstack's Bulk Publish APIs. It is true, by default.",
|
|
624
|
+
"hidden": true,
|
|
625
|
+
"name": "bulkPublish",
|
|
626
|
+
"hasDynamicHelp": false,
|
|
627
|
+
"multiple": false,
|
|
628
|
+
"type": "option"
|
|
629
|
+
},
|
|
630
|
+
"bulk-publish": {
|
|
631
|
+
"description": "Set this flag to use Contentstack's Bulk Publish APIs. It is true, by default.",
|
|
632
|
+
"name": "bulk-publish",
|
|
633
|
+
"default": "true",
|
|
634
|
+
"hasDynamicHelp": false,
|
|
635
|
+
"multiple": false,
|
|
636
|
+
"type": "option"
|
|
637
|
+
},
|
|
638
|
+
"api-version": {
|
|
639
|
+
"description": "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
|
|
640
|
+
"name": "api-version",
|
|
641
|
+
"hasDynamicHelp": false,
|
|
642
|
+
"multiple": false,
|
|
643
|
+
"type": "option"
|
|
644
|
+
},
|
|
645
|
+
"sourceEnv": {
|
|
646
|
+
"char": "s",
|
|
647
|
+
"description": "The name of the source environment where the entries were initially published.",
|
|
648
|
+
"hidden": true,
|
|
649
|
+
"name": "sourceEnv",
|
|
650
|
+
"hasDynamicHelp": false,
|
|
651
|
+
"multiple": false,
|
|
652
|
+
"type": "option"
|
|
653
|
+
},
|
|
654
|
+
"source-env": {
|
|
655
|
+
"description": "The name of the source environment where the entries were initially published.",
|
|
656
|
+
"name": "source-env",
|
|
657
|
+
"hasDynamicHelp": false,
|
|
658
|
+
"multiple": false,
|
|
659
|
+
"type": "option"
|
|
660
|
+
},
|
|
661
|
+
"contentTypes": {
|
|
662
|
+
"char": "t",
|
|
663
|
+
"description": "The UID of the content type(s) whose edited entries you want to publish in bulk. In case of multiple content types, specify the IDs separated by spaces.",
|
|
664
|
+
"hidden": true,
|
|
665
|
+
"name": "contentTypes",
|
|
666
|
+
"hasDynamicHelp": false,
|
|
667
|
+
"multiple": true,
|
|
668
|
+
"type": "option"
|
|
669
|
+
},
|
|
670
|
+
"content-types": {
|
|
671
|
+
"description": "The UID of the content type(s) whose edited entries you want to publish in bulk. In case of multiple content types, specify the IDs separated by spaces.",
|
|
672
|
+
"name": "content-types",
|
|
673
|
+
"hasDynamicHelp": false,
|
|
674
|
+
"multiple": true,
|
|
675
|
+
"type": "option"
|
|
676
|
+
},
|
|
677
|
+
"locales": {
|
|
678
|
+
"char": "l",
|
|
679
|
+
"description": "Locales in which entries will be published, e.g., en-us. In the case of multiple locales, specify the codes separated by spaces.",
|
|
680
|
+
"name": "locales",
|
|
681
|
+
"hasDynamicHelp": false,
|
|
682
|
+
"multiple": true,
|
|
683
|
+
"type": "option"
|
|
684
|
+
},
|
|
685
|
+
"environments": {
|
|
686
|
+
"char": "e",
|
|
687
|
+
"description": "The name of the environment(s) on which the entries will be published. In case of multiple environments, specify their names separated by spaces.",
|
|
688
|
+
"name": "environments",
|
|
689
|
+
"hasDynamicHelp": false,
|
|
690
|
+
"multiple": true,
|
|
691
|
+
"type": "option"
|
|
692
|
+
},
|
|
693
|
+
"config": {
|
|
694
|
+
"char": "c",
|
|
695
|
+
"description": "(optional) The path of the optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.",
|
|
696
|
+
"name": "config",
|
|
697
|
+
"hasDynamicHelp": false,
|
|
698
|
+
"multiple": false,
|
|
699
|
+
"type": "option"
|
|
700
|
+
},
|
|
701
|
+
"yes": {
|
|
702
|
+
"char": "y",
|
|
703
|
+
"description": "Set it to true to process the command with the current configuration.",
|
|
704
|
+
"name": "yes",
|
|
705
|
+
"allowNo": false,
|
|
706
|
+
"type": "boolean"
|
|
707
|
+
},
|
|
708
|
+
"branch": {
|
|
709
|
+
"char": "B",
|
|
710
|
+
"description": "The name of the branch where you want to perform the bulk publish operation. If you don't mention the branch name, then by default the entries from main branch will be published.",
|
|
711
|
+
"name": "branch",
|
|
712
|
+
"default": "main",
|
|
713
|
+
"hasDynamicHelp": false,
|
|
714
|
+
"multiple": false,
|
|
715
|
+
"type": "option"
|
|
716
|
+
}
|
|
717
|
+
},
|
|
718
|
+
"hasDynamicHelp": false,
|
|
719
|
+
"hiddenAliases": [],
|
|
720
|
+
"id": "cm:entries:publish-modified",
|
|
721
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
722
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
723
|
+
"pluginType": "core",
|
|
724
|
+
"strict": true,
|
|
725
|
+
"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>]",
|
|
726
|
+
"isESM": false,
|
|
727
|
+
"relativePath": [
|
|
728
|
+
"src",
|
|
729
|
+
"commands",
|
|
730
|
+
"cm",
|
|
731
|
+
"entries",
|
|
732
|
+
"publish-modified.js"
|
|
733
|
+
]
|
|
734
|
+
},
|
|
735
|
+
"cm:entries:publish-non-localized-fields": {
|
|
736
|
+
"aliases": [
|
|
737
|
+
"cm:bulk-publish:nonlocalized-field-changes"
|
|
738
|
+
],
|
|
739
|
+
"args": {},
|
|
740
|
+
"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",
|
|
741
|
+
"examples": [
|
|
742
|
+
"General Usage",
|
|
743
|
+
"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]",
|
|
744
|
+
"",
|
|
745
|
+
"Using --config or -c flag",
|
|
746
|
+
"Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`",
|
|
747
|
+
"csdx cm:entries:publish-non-localized-fields --config [PATH TO CONFIG FILE]",
|
|
748
|
+
"csdx cm:entries:publish-non-localized-fields -c [PATH TO CONFIG FILE]",
|
|
749
|
+
"",
|
|
750
|
+
"Using --retry-failed flag",
|
|
751
|
+
"csdx cm:entries:publish-non-localized-fields --retry-failed [LOG FILE NAME]",
|
|
752
|
+
"",
|
|
753
|
+
"Using --branch flag",
|
|
754
|
+
"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]",
|
|
755
|
+
"",
|
|
756
|
+
"Using --stack-api-key flag",
|
|
757
|
+
"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]"
|
|
758
|
+
],
|
|
759
|
+
"flags": {
|
|
760
|
+
"alias": {
|
|
761
|
+
"char": "a",
|
|
762
|
+
"description": "Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.",
|
|
763
|
+
"name": "alias",
|
|
764
|
+
"hasDynamicHelp": false,
|
|
765
|
+
"multiple": false,
|
|
766
|
+
"type": "option"
|
|
767
|
+
},
|
|
768
|
+
"stack-api-key": {
|
|
769
|
+
"char": "k",
|
|
770
|
+
"description": "API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.",
|
|
771
|
+
"name": "stack-api-key",
|
|
772
|
+
"required": false,
|
|
773
|
+
"hasDynamicHelp": false,
|
|
774
|
+
"multiple": false,
|
|
775
|
+
"type": "option"
|
|
776
|
+
},
|
|
777
|
+
"retry-failed": {
|
|
778
|
+
"description": "Use this option to retry publishing the failed entries from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.",
|
|
779
|
+
"name": "retry-failed",
|
|
780
|
+
"hasDynamicHelp": false,
|
|
781
|
+
"multiple": false,
|
|
782
|
+
"type": "option"
|
|
783
|
+
},
|
|
784
|
+
"bulk-publish": {
|
|
785
|
+
"description": "Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.",
|
|
786
|
+
"name": "bulk-publish",
|
|
787
|
+
"default": "true",
|
|
788
|
+
"hasDynamicHelp": false,
|
|
789
|
+
"multiple": false,
|
|
790
|
+
"type": "option"
|
|
791
|
+
},
|
|
792
|
+
"source-env": {
|
|
793
|
+
"description": "The name of the source environment.",
|
|
794
|
+
"name": "source-env",
|
|
795
|
+
"hasDynamicHelp": false,
|
|
796
|
+
"multiple": false,
|
|
797
|
+
"type": "option"
|
|
798
|
+
},
|
|
799
|
+
"content-types": {
|
|
800
|
+
"description": "The UID of the content type whose entries you want to publish in bulk. In case of multiple content types, specify their IDs separated by spaces.",
|
|
801
|
+
"name": "content-types",
|
|
802
|
+
"hasDynamicHelp": false,
|
|
803
|
+
"multiple": true,
|
|
804
|
+
"type": "option"
|
|
805
|
+
},
|
|
806
|
+
"environments": {
|
|
807
|
+
"char": "e",
|
|
808
|
+
"description": "The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.",
|
|
809
|
+
"name": "environments",
|
|
810
|
+
"hasDynamicHelp": false,
|
|
811
|
+
"multiple": true,
|
|
812
|
+
"type": "option"
|
|
813
|
+
},
|
|
814
|
+
"config": {
|
|
815
|
+
"char": "c",
|
|
816
|
+
"description": "(optional) The path of the optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.",
|
|
817
|
+
"name": "config",
|
|
818
|
+
"hasDynamicHelp": false,
|
|
819
|
+
"multiple": false,
|
|
820
|
+
"type": "option"
|
|
821
|
+
},
|
|
822
|
+
"yes": {
|
|
823
|
+
"char": "y",
|
|
824
|
+
"description": "Set it to true to process the command with the current configuration.",
|
|
825
|
+
"name": "yes",
|
|
826
|
+
"allowNo": false,
|
|
827
|
+
"type": "boolean"
|
|
828
|
+
},
|
|
829
|
+
"branch": {
|
|
830
|
+
"char": "B",
|
|
831
|
+
"description": "The name of the branch where you want to perform the bulk publish operation. If you don’t mention the branch name, then by default the content from the main branch will be published.",
|
|
832
|
+
"name": "branch",
|
|
833
|
+
"default": "main",
|
|
834
|
+
"hasDynamicHelp": false,
|
|
835
|
+
"multiple": false,
|
|
836
|
+
"type": "option"
|
|
837
|
+
},
|
|
838
|
+
"retryFailed": {
|
|
839
|
+
"char": "r",
|
|
840
|
+
"description": "Retry publishing failed entries from the logfile.",
|
|
841
|
+
"hidden": true,
|
|
842
|
+
"name": "retryFailed",
|
|
843
|
+
"hasDynamicHelp": false,
|
|
844
|
+
"multiple": false,
|
|
845
|
+
"type": "option"
|
|
846
|
+
},
|
|
847
|
+
"bulkPublish": {
|
|
848
|
+
"char": "b",
|
|
849
|
+
"description": "This flag is set to true by default. It indicates that Contentstack's bulk publish API will be used to publish the entries.",
|
|
850
|
+
"hidden": true,
|
|
851
|
+
"name": "bulkPublish",
|
|
852
|
+
"default": "true",
|
|
853
|
+
"hasDynamicHelp": false,
|
|
854
|
+
"multiple": false,
|
|
855
|
+
"type": "option"
|
|
856
|
+
},
|
|
857
|
+
"api-version": {
|
|
858
|
+
"description": "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
|
|
859
|
+
"name": "api-version",
|
|
860
|
+
"hasDynamicHelp": false,
|
|
861
|
+
"multiple": false,
|
|
862
|
+
"type": "option"
|
|
863
|
+
},
|
|
864
|
+
"sourceEnv": {
|
|
865
|
+
"char": "s",
|
|
866
|
+
"description": "Source Environment",
|
|
867
|
+
"hidden": true,
|
|
868
|
+
"name": "sourceEnv",
|
|
869
|
+
"hasDynamicHelp": false,
|
|
870
|
+
"multiple": false,
|
|
871
|
+
"type": "option"
|
|
872
|
+
},
|
|
873
|
+
"contentTypes": {
|
|
874
|
+
"char": "t",
|
|
875
|
+
"description": "The content types from which entries will be published.",
|
|
876
|
+
"hidden": true,
|
|
877
|
+
"name": "contentTypes",
|
|
878
|
+
"hasDynamicHelp": false,
|
|
879
|
+
"multiple": true,
|
|
880
|
+
"type": "option"
|
|
881
|
+
}
|
|
882
|
+
},
|
|
883
|
+
"hasDynamicHelp": false,
|
|
884
|
+
"hiddenAliases": [],
|
|
885
|
+
"id": "cm:entries:publish-non-localized-fields",
|
|
886
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
887
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
888
|
+
"pluginType": "core",
|
|
889
|
+
"strict": true,
|
|
890
|
+
"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>]",
|
|
891
|
+
"isESM": false,
|
|
892
|
+
"relativePath": [
|
|
893
|
+
"src",
|
|
894
|
+
"commands",
|
|
895
|
+
"cm",
|
|
896
|
+
"entries",
|
|
897
|
+
"publish-non-localized-fields.js"
|
|
898
|
+
]
|
|
899
|
+
},
|
|
900
|
+
"cm:entries:publish-only-unpublished": {
|
|
901
|
+
"aliases": [
|
|
902
|
+
"cm:bulk-publish:unpublished-entries"
|
|
903
|
+
],
|
|
904
|
+
"args": {},
|
|
905
|
+
"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",
|
|
906
|
+
"examples": [
|
|
907
|
+
"General Usage",
|
|
908
|
+
"csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] -source-env [SOURCE ENV]",
|
|
909
|
+
"",
|
|
910
|
+
"Using --config or -c flag",
|
|
911
|
+
"Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`",
|
|
912
|
+
"csdx cm:entries:publish-only-unpublished --config [PATH TO CONFIG FILE]",
|
|
913
|
+
"csdx cm:entries:publish-only-unpublished -c [PATH TO CONFIG FILE]",
|
|
914
|
+
"",
|
|
915
|
+
"Using --retry-failed",
|
|
916
|
+
"csdx cm:entries:publish-only-unpublished --retry-failed [LOG FILE NAME]",
|
|
917
|
+
"",
|
|
918
|
+
"Using --branch",
|
|
919
|
+
"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]",
|
|
920
|
+
"",
|
|
921
|
+
"Using --stack-api-key",
|
|
922
|
+
"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]"
|
|
923
|
+
],
|
|
924
|
+
"flags": {
|
|
925
|
+
"alias": {
|
|
926
|
+
"char": "a",
|
|
927
|
+
"description": "Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.",
|
|
928
|
+
"name": "alias",
|
|
929
|
+
"hasDynamicHelp": false,
|
|
930
|
+
"multiple": false,
|
|
931
|
+
"type": "option"
|
|
932
|
+
},
|
|
933
|
+
"stack-api-key": {
|
|
934
|
+
"char": "k",
|
|
935
|
+
"description": "API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.",
|
|
936
|
+
"name": "stack-api-key",
|
|
937
|
+
"hasDynamicHelp": false,
|
|
938
|
+
"multiple": false,
|
|
939
|
+
"type": "option"
|
|
940
|
+
},
|
|
941
|
+
"retryFailed": {
|
|
942
|
+
"char": "r",
|
|
943
|
+
"description": "(optional) Use this option to retry publishing the failed entries from the logfile. It is optional. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.",
|
|
944
|
+
"hidden": true,
|
|
945
|
+
"name": "retryFailed",
|
|
946
|
+
"hasDynamicHelp": false,
|
|
947
|
+
"multiple": false,
|
|
948
|
+
"type": "option"
|
|
949
|
+
},
|
|
950
|
+
"retry-failed": {
|
|
951
|
+
"description": "(optional) Use this option to retry publishing the failed entries from the logfile. It is optional. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.",
|
|
952
|
+
"name": "retry-failed",
|
|
953
|
+
"hasDynamicHelp": false,
|
|
954
|
+
"multiple": false,
|
|
955
|
+
"type": "option"
|
|
956
|
+
},
|
|
957
|
+
"bulkPublish": {
|
|
958
|
+
"char": "b",
|
|
959
|
+
"description": "Set this flag to use Contentstack's Bulk Publish APIs. It is true, by default.",
|
|
960
|
+
"hidden": true,
|
|
961
|
+
"name": "bulkPublish",
|
|
962
|
+
"default": "true",
|
|
963
|
+
"hasDynamicHelp": false,
|
|
964
|
+
"multiple": false,
|
|
965
|
+
"type": "option"
|
|
966
|
+
},
|
|
967
|
+
"bulk-publish": {
|
|
968
|
+
"char": "b",
|
|
969
|
+
"description": "Set this flag to use Contentstack's Bulk Publish APIs. It is true, by default.",
|
|
970
|
+
"name": "bulk-publish",
|
|
971
|
+
"default": "true",
|
|
972
|
+
"hasDynamicHelp": false,
|
|
973
|
+
"multiple": false,
|
|
974
|
+
"type": "option"
|
|
975
|
+
},
|
|
976
|
+
"api-version": {
|
|
977
|
+
"description": "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]..",
|
|
978
|
+
"name": "api-version",
|
|
979
|
+
"hasDynamicHelp": false,
|
|
980
|
+
"multiple": false,
|
|
981
|
+
"type": "option"
|
|
982
|
+
},
|
|
983
|
+
"sourceEnv": {
|
|
984
|
+
"char": "s",
|
|
985
|
+
"description": "The name of the source environment where the entries were initially published.",
|
|
986
|
+
"hidden": true,
|
|
987
|
+
"name": "sourceEnv",
|
|
988
|
+
"hasDynamicHelp": false,
|
|
989
|
+
"multiple": false,
|
|
990
|
+
"type": "option"
|
|
991
|
+
},
|
|
992
|
+
"source-env": {
|
|
993
|
+
"description": "The name of the source environment where the entries were initially published.",
|
|
994
|
+
"name": "source-env",
|
|
995
|
+
"hasDynamicHelp": false,
|
|
996
|
+
"multiple": false,
|
|
997
|
+
"type": "option"
|
|
998
|
+
},
|
|
999
|
+
"contentTypes": {
|
|
1000
|
+
"char": "t",
|
|
1001
|
+
"description": "The UID of the content type(s) whose entries you want to publish in bulk. In case of multiple content types, specify their IDs separated by spaces.",
|
|
1002
|
+
"hidden": true,
|
|
1003
|
+
"name": "contentTypes",
|
|
1004
|
+
"hasDynamicHelp": false,
|
|
1005
|
+
"multiple": true,
|
|
1006
|
+
"type": "option"
|
|
1007
|
+
},
|
|
1008
|
+
"content-types": {
|
|
1009
|
+
"description": "The UID of the content type(s) whose entries you want to publish in bulk. In case of multiple content types, specify their IDs separated by spaces.",
|
|
1010
|
+
"name": "content-types",
|
|
1011
|
+
"hasDynamicHelp": false,
|
|
1012
|
+
"multiple": true,
|
|
1013
|
+
"type": "option"
|
|
1014
|
+
},
|
|
1015
|
+
"locale": {
|
|
1016
|
+
"char": "l",
|
|
1017
|
+
"description": "Locale in which entries will be published, e.g., en-us",
|
|
1018
|
+
"hidden": true,
|
|
1019
|
+
"name": "locale",
|
|
1020
|
+
"hasDynamicHelp": false,
|
|
1021
|
+
"multiple": false,
|
|
1022
|
+
"type": "option"
|
|
1023
|
+
},
|
|
1024
|
+
"locales": {
|
|
1025
|
+
"description": "Locale in which entries will be published, e.g., en-us",
|
|
1026
|
+
"name": "locales",
|
|
1027
|
+
"hasDynamicHelp": false,
|
|
1028
|
+
"multiple": false,
|
|
1029
|
+
"type": "option"
|
|
1030
|
+
},
|
|
1031
|
+
"environments": {
|
|
1032
|
+
"char": "e",
|
|
1033
|
+
"description": "The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.",
|
|
1034
|
+
"name": "environments",
|
|
1035
|
+
"hasDynamicHelp": false,
|
|
1036
|
+
"multiple": true,
|
|
1037
|
+
"type": "option"
|
|
1038
|
+
},
|
|
1039
|
+
"config": {
|
|
1040
|
+
"char": "c",
|
|
1041
|
+
"description": "(optional) The path of the optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.",
|
|
1042
|
+
"name": "config",
|
|
1043
|
+
"hasDynamicHelp": false,
|
|
1044
|
+
"multiple": false,
|
|
1045
|
+
"type": "option"
|
|
1046
|
+
},
|
|
1047
|
+
"yes": {
|
|
1048
|
+
"char": "y",
|
|
1049
|
+
"description": "Set it to true to process the command with the current configuration.",
|
|
1050
|
+
"name": "yes",
|
|
1051
|
+
"allowNo": false,
|
|
1052
|
+
"type": "boolean"
|
|
1053
|
+
},
|
|
1054
|
+
"branch": {
|
|
1055
|
+
"char": "B",
|
|
1056
|
+
"description": "The name of the branch where you want to perform the bulk publish operation. If you don't mention the branch name, then by default the entries from main branch will be published.",
|
|
1057
|
+
"name": "branch",
|
|
1058
|
+
"default": "main",
|
|
1059
|
+
"hasDynamicHelp": false,
|
|
1060
|
+
"multiple": false,
|
|
1061
|
+
"type": "option"
|
|
1062
|
+
}
|
|
1063
|
+
},
|
|
1064
|
+
"hasDynamicHelp": false,
|
|
1065
|
+
"hiddenAliases": [],
|
|
1066
|
+
"id": "cm:entries:publish-only-unpublished",
|
|
1067
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
1068
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
1069
|
+
"pluginType": "core",
|
|
1070
|
+
"strict": true,
|
|
1071
|
+
"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>]",
|
|
1072
|
+
"isESM": false,
|
|
1073
|
+
"relativePath": [
|
|
1074
|
+
"src",
|
|
1075
|
+
"commands",
|
|
1076
|
+
"cm",
|
|
1077
|
+
"entries",
|
|
1078
|
+
"publish-only-unpublished.js"
|
|
1079
|
+
]
|
|
1080
|
+
},
|
|
1081
|
+
"cm:entries:publish": {
|
|
1082
|
+
"aliases": [
|
|
1083
|
+
"cm:bulk-publish:entries"
|
|
1084
|
+
],
|
|
1085
|
+
"args": {},
|
|
1086
|
+
"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",
|
|
1087
|
+
"examples": [
|
|
1088
|
+
"General Usage",
|
|
1089
|
+
"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]",
|
|
1090
|
+
"",
|
|
1091
|
+
"Using --config or -c flag",
|
|
1092
|
+
"Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
|
|
1093
|
+
"csdx cm:entries:publish --config [PATH TO CONFIG FILE]",
|
|
1094
|
+
"csdx cm:entries:publish -c [PATH TO CONFIG FILE]",
|
|
1095
|
+
"",
|
|
1096
|
+
"Using --retry-failed",
|
|
1097
|
+
"csdx cm:entries:publish --retry-failed [LOG FILE NAME]",
|
|
1098
|
+
"csdx cm:entries:publish -r [LOG FILE NAME]",
|
|
1099
|
+
"",
|
|
1100
|
+
"Using --branch",
|
|
1101
|
+
"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]",
|
|
1102
|
+
"",
|
|
1103
|
+
"Using --source-env",
|
|
1104
|
+
"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]",
|
|
1105
|
+
"",
|
|
1106
|
+
"Using --stack-api-key",
|
|
1107
|
+
"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]",
|
|
1108
|
+
"",
|
|
1109
|
+
"Using --include-variants",
|
|
1110
|
+
"csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] [--include-variants]",
|
|
1111
|
+
"",
|
|
1112
|
+
"Using --entry-uid and --include-variants",
|
|
1113
|
+
"csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] --entry-uid [ENTRY UID] [--include-variants]"
|
|
1114
|
+
],
|
|
1115
|
+
"flags": {
|
|
1116
|
+
"alias": {
|
|
1117
|
+
"char": "a",
|
|
1118
|
+
"description": "Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.",
|
|
1119
|
+
"name": "alias",
|
|
1120
|
+
"hasDynamicHelp": false,
|
|
1121
|
+
"multiple": false,
|
|
1122
|
+
"type": "option"
|
|
1123
|
+
},
|
|
1124
|
+
"stack-api-key": {
|
|
1125
|
+
"char": "k",
|
|
1126
|
+
"description": "API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.",
|
|
1127
|
+
"name": "stack-api-key",
|
|
1128
|
+
"hasDynamicHelp": false,
|
|
1129
|
+
"multiple": false,
|
|
1130
|
+
"type": "option"
|
|
1131
|
+
},
|
|
1132
|
+
"retryFailed": {
|
|
1133
|
+
"char": "r",
|
|
1134
|
+
"description": "(optional) Use this option to retry publishing the failed entries/ assets from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.",
|
|
1135
|
+
"hidden": true,
|
|
1136
|
+
"name": "retryFailed",
|
|
1137
|
+
"hasDynamicHelp": false,
|
|
1138
|
+
"multiple": false,
|
|
1139
|
+
"type": "option"
|
|
1140
|
+
},
|
|
1141
|
+
"retry-failed": {
|
|
1142
|
+
"description": "(optional) Use this option to retry publishing the failed entries/ assets from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.",
|
|
1143
|
+
"name": "retry-failed",
|
|
1144
|
+
"hasDynamicHelp": false,
|
|
1145
|
+
"multiple": false,
|
|
1146
|
+
"type": "option"
|
|
1147
|
+
},
|
|
1148
|
+
"bulkPublish": {
|
|
1149
|
+
"char": "b",
|
|
1150
|
+
"description": "Set this flag to use Contentstack's Bulk Publish APIs. This flag is set to true, by default.",
|
|
1151
|
+
"hidden": true,
|
|
1152
|
+
"name": "bulkPublish",
|
|
1153
|
+
"hasDynamicHelp": false,
|
|
1154
|
+
"multiple": false,
|
|
1155
|
+
"type": "option"
|
|
1156
|
+
},
|
|
1157
|
+
"bulk-publish": {
|
|
1158
|
+
"description": "Set this flag to use Contentstack's Bulk Publish APIs. This flag is set to true, by default.",
|
|
1159
|
+
"name": "bulk-publish",
|
|
1160
|
+
"default": "true",
|
|
1161
|
+
"hasDynamicHelp": false,
|
|
1162
|
+
"multiple": false,
|
|
1163
|
+
"type": "option"
|
|
1164
|
+
},
|
|
1165
|
+
"api-version": {
|
|
1166
|
+
"description": "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
|
|
1167
|
+
"name": "api-version",
|
|
1168
|
+
"hasDynamicHelp": false,
|
|
1169
|
+
"multiple": false,
|
|
1170
|
+
"type": "option"
|
|
1171
|
+
},
|
|
1172
|
+
"publish-all-content-types": {
|
|
1173
|
+
"description": "(optional) Set it to true to bulk publish entries from all content types. If the --content-types option is already used, then you cannot use this option.",
|
|
1174
|
+
"name": "publish-all-content-types",
|
|
1175
|
+
"allowNo": false,
|
|
1176
|
+
"type": "boolean"
|
|
1177
|
+
},
|
|
1178
|
+
"publishAllContentTypes": {
|
|
1179
|
+
"char": "o",
|
|
1180
|
+
"description": "(optional) Set it to true to bulk publish entries from all content types. If the --content-types option is already used, then you cannot use this option.",
|
|
1181
|
+
"hidden": true,
|
|
1182
|
+
"name": "publishAllContentTypes",
|
|
1183
|
+
"allowNo": false,
|
|
1184
|
+
"type": "boolean"
|
|
1185
|
+
},
|
|
1186
|
+
"content-types": {
|
|
1187
|
+
"description": "The UID of the content type(s) whose entries you want to publish in bulk. In case of multiple content types, specify the IDs separated by spaces.",
|
|
1188
|
+
"name": "content-types",
|
|
1189
|
+
"hasDynamicHelp": false,
|
|
1190
|
+
"multiple": true,
|
|
1191
|
+
"type": "option"
|
|
1192
|
+
},
|
|
1193
|
+
"contentTypes": {
|
|
1194
|
+
"char": "t",
|
|
1195
|
+
"description": "The UID of the content type(s) whose entries you want to publish in bulk. In case of multiple content types, specify the IDs separated by spaces.",
|
|
1196
|
+
"hidden": true,
|
|
1197
|
+
"name": "contentTypes",
|
|
1198
|
+
"hasDynamicHelp": false,
|
|
1199
|
+
"multiple": true,
|
|
1200
|
+
"type": "option"
|
|
1201
|
+
},
|
|
1202
|
+
"locales": {
|
|
1203
|
+
"char": "l",
|
|
1204
|
+
"description": " Locales in which entries will be published, e.g., en-us. In the case of multiple locales, specify the codes separated by spaces.",
|
|
1205
|
+
"name": "locales",
|
|
1206
|
+
"hasDynamicHelp": false,
|
|
1207
|
+
"multiple": true,
|
|
1208
|
+
"type": "option"
|
|
1209
|
+
},
|
|
1210
|
+
"environments": {
|
|
1211
|
+
"char": "e",
|
|
1212
|
+
"description": "The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.",
|
|
1213
|
+
"name": "environments",
|
|
1214
|
+
"hasDynamicHelp": false,
|
|
1215
|
+
"multiple": true,
|
|
1216
|
+
"type": "option"
|
|
1217
|
+
},
|
|
1218
|
+
"config": {
|
|
1219
|
+
"char": "c",
|
|
1220
|
+
"description": "(optional) The path of the optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.",
|
|
1221
|
+
"name": "config",
|
|
1222
|
+
"hasDynamicHelp": false,
|
|
1223
|
+
"multiple": false,
|
|
1224
|
+
"type": "option"
|
|
1225
|
+
},
|
|
1226
|
+
"yes": {
|
|
1227
|
+
"char": "y",
|
|
1228
|
+
"description": "Set it to true to process the command with the current configuration.",
|
|
1229
|
+
"name": "yes",
|
|
1230
|
+
"allowNo": false,
|
|
1231
|
+
"type": "boolean"
|
|
1232
|
+
},
|
|
1233
|
+
"branch": {
|
|
1234
|
+
"char": "B",
|
|
1235
|
+
"description": "The name of the branch where you want to perform the bulk publish operation. If you don’t mention the branch name, then by default the content from main branch will be published.",
|
|
1236
|
+
"name": "branch",
|
|
1237
|
+
"default": "main",
|
|
1238
|
+
"hasDynamicHelp": false,
|
|
1239
|
+
"multiple": false,
|
|
1240
|
+
"type": "option"
|
|
1241
|
+
},
|
|
1242
|
+
"delivery-token": {
|
|
1243
|
+
"description": "The delivery token of the source environment.",
|
|
1244
|
+
"name": "delivery-token",
|
|
1245
|
+
"hasDynamicHelp": false,
|
|
1246
|
+
"multiple": false,
|
|
1247
|
+
"type": "option"
|
|
1248
|
+
},
|
|
1249
|
+
"source-env": {
|
|
1250
|
+
"description": "Source environment",
|
|
1251
|
+
"name": "source-env",
|
|
1252
|
+
"hasDynamicHelp": false,
|
|
1253
|
+
"multiple": false,
|
|
1254
|
+
"type": "option"
|
|
1255
|
+
},
|
|
1256
|
+
"entry-uid": {
|
|
1257
|
+
"description": "Entry Uid for publish all associated variant entries.",
|
|
1258
|
+
"name": "entry-uid",
|
|
1259
|
+
"hasDynamicHelp": false,
|
|
1260
|
+
"multiple": false,
|
|
1261
|
+
"type": "option"
|
|
1262
|
+
},
|
|
1263
|
+
"include-variants": {
|
|
1264
|
+
"description": "Include Variants flag will publish all associated variant entries with base entry.",
|
|
1265
|
+
"name": "include-variants",
|
|
1266
|
+
"allowNo": false,
|
|
1267
|
+
"type": "boolean"
|
|
1268
|
+
}
|
|
1269
|
+
},
|
|
1270
|
+
"hasDynamicHelp": false,
|
|
1271
|
+
"hiddenAliases": [],
|
|
1272
|
+
"id": "cm:entries:publish",
|
|
1273
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
1274
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
1275
|
+
"pluginType": "core",
|
|
1276
|
+
"strict": true,
|
|
1277
|
+
"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>] [--entry-uid <value>] [--include-variants]",
|
|
1278
|
+
"isESM": false,
|
|
1279
|
+
"relativePath": [
|
|
1280
|
+
"src",
|
|
1281
|
+
"commands",
|
|
1282
|
+
"cm",
|
|
1283
|
+
"entries",
|
|
1284
|
+
"publish.js"
|
|
1285
|
+
]
|
|
1286
|
+
},
|
|
1287
|
+
"cm:entries:unpublish": {
|
|
1288
|
+
"aliases": [],
|
|
1289
|
+
"args": {},
|
|
1290
|
+
"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",
|
|
1291
|
+
"examples": [
|
|
1292
|
+
"General Usage",
|
|
1293
|
+
"csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]",
|
|
1294
|
+
"",
|
|
1295
|
+
"Using --config or -c flag",
|
|
1296
|
+
"Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`",
|
|
1297
|
+
"csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]",
|
|
1298
|
+
"csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]",
|
|
1299
|
+
"",
|
|
1300
|
+
"Using --retry-failed flag",
|
|
1301
|
+
"csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]",
|
|
1302
|
+
"",
|
|
1303
|
+
"Using --branch flag",
|
|
1304
|
+
"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]",
|
|
1305
|
+
"",
|
|
1306
|
+
"Using --stack-api-key flag",
|
|
1307
|
+
"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]",
|
|
1308
|
+
"",
|
|
1309
|
+
"Using --include-variants flag",
|
|
1310
|
+
"csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN] --include-variants"
|
|
1311
|
+
],
|
|
1312
|
+
"flags": {
|
|
1313
|
+
"alias": {
|
|
1314
|
+
"char": "a",
|
|
1315
|
+
"description": "Alias (name) for the management token. You must use either the --alias flag or the --stack-api-key flag.",
|
|
1316
|
+
"name": "alias",
|
|
1317
|
+
"hasDynamicHelp": false,
|
|
1318
|
+
"multiple": false,
|
|
1319
|
+
"type": "option"
|
|
1320
|
+
},
|
|
1321
|
+
"stack-api-key": {
|
|
1322
|
+
"char": "k",
|
|
1323
|
+
"description": "API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.",
|
|
1324
|
+
"name": "stack-api-key",
|
|
1325
|
+
"hasDynamicHelp": false,
|
|
1326
|
+
"multiple": false,
|
|
1327
|
+
"type": "option"
|
|
1328
|
+
},
|
|
1329
|
+
"environment": {
|
|
1330
|
+
"char": "e",
|
|
1331
|
+
"description": "The name of the environment from where entries/assets need to be unpublished.",
|
|
1332
|
+
"name": "environment",
|
|
1333
|
+
"hasDynamicHelp": false,
|
|
1334
|
+
"multiple": false,
|
|
1335
|
+
"type": "option"
|
|
1336
|
+
},
|
|
1337
|
+
"config": {
|
|
1338
|
+
"char": "c",
|
|
1339
|
+
"description": "(optional) Path to the configuration JSON file containing all options for a single run. Refer to the configure command to create a configuration file.",
|
|
1340
|
+
"name": "config",
|
|
1341
|
+
"hasDynamicHelp": false,
|
|
1342
|
+
"multiple": false,
|
|
1343
|
+
"type": "option"
|
|
1344
|
+
},
|
|
1345
|
+
"yes": {
|
|
1346
|
+
"char": "y",
|
|
1347
|
+
"description": "Set to true to process the command with the current configuration.",
|
|
1348
|
+
"name": "yes",
|
|
1349
|
+
"allowNo": false,
|
|
1350
|
+
"type": "boolean"
|
|
1351
|
+
},
|
|
1352
|
+
"locale": {
|
|
1353
|
+
"description": "Locale from which entries/assets will be unpublished, e.g., en-us.",
|
|
1354
|
+
"name": "locale",
|
|
1355
|
+
"hasDynamicHelp": false,
|
|
1356
|
+
"multiple": false,
|
|
1357
|
+
"type": "option"
|
|
1358
|
+
},
|
|
1359
|
+
"branch": {
|
|
1360
|
+
"description": "Specify the branch to fetch the content. If not mentioned, the main branch will be used by default.",
|
|
1361
|
+
"name": "branch",
|
|
1362
|
+
"default": "main",
|
|
1363
|
+
"hasDynamicHelp": false,
|
|
1364
|
+
"multiple": false,
|
|
1365
|
+
"type": "option"
|
|
1366
|
+
},
|
|
1367
|
+
"retry-failed": {
|
|
1368
|
+
"description": "(optional) Use this option to retry unpublishing the failed entries from the logfile. Specify the name of the logfile that lists failed unpublish calls. If used, this option will override all other flags.",
|
|
1369
|
+
"name": "retry-failed",
|
|
1370
|
+
"hasDynamicHelp": false,
|
|
1371
|
+
"multiple": false,
|
|
1372
|
+
"type": "option"
|
|
1373
|
+
},
|
|
1374
|
+
"bulk-unpublish": {
|
|
1375
|
+
"description": "This flag is set to true by default. It indicates that Contentstack's Bulk Publish APIs will be used to unpublish the entries.",
|
|
1376
|
+
"name": "bulk-unpublish",
|
|
1377
|
+
"default": "true",
|
|
1378
|
+
"hasDynamicHelp": false,
|
|
1379
|
+
"multiple": false,
|
|
1380
|
+
"type": "option"
|
|
1381
|
+
},
|
|
1382
|
+
"api-version": {
|
|
1383
|
+
"description": "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
|
|
1384
|
+
"name": "api-version",
|
|
1385
|
+
"hasDynamicHelp": false,
|
|
1386
|
+
"multiple": false,
|
|
1387
|
+
"type": "option"
|
|
1388
|
+
},
|
|
1389
|
+
"content-type": {
|
|
1390
|
+
"description": "The UID of the content type whose entries you want to unpublish in bulk.",
|
|
1391
|
+
"name": "content-type",
|
|
1392
|
+
"hasDynamicHelp": false,
|
|
1393
|
+
"multiple": false,
|
|
1394
|
+
"type": "option"
|
|
1395
|
+
},
|
|
1396
|
+
"delivery-token": {
|
|
1397
|
+
"description": "The delivery token of the source environment.",
|
|
1398
|
+
"name": "delivery-token",
|
|
1399
|
+
"hasDynamicHelp": false,
|
|
1400
|
+
"multiple": false,
|
|
1401
|
+
"type": "option"
|
|
1402
|
+
},
|
|
1403
|
+
"include-variants": {
|
|
1404
|
+
"description": "Include Variants flag will unpublish all associated variant entries.",
|
|
1405
|
+
"name": "include-variants",
|
|
1406
|
+
"allowNo": false,
|
|
1407
|
+
"type": "boolean"
|
|
1408
|
+
}
|
|
1409
|
+
},
|
|
1410
|
+
"hasDynamicHelp": false,
|
|
1411
|
+
"hiddenAliases": [],
|
|
1412
|
+
"id": "cm:entries:unpublish",
|
|
1413
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
1414
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
1415
|
+
"pluginType": "core",
|
|
1416
|
+
"strict": true,
|
|
1417
|
+
"isESM": false,
|
|
1418
|
+
"relativePath": [
|
|
1419
|
+
"src",
|
|
1420
|
+
"commands",
|
|
1421
|
+
"cm",
|
|
1422
|
+
"entries",
|
|
1423
|
+
"unpublish.js"
|
|
1424
|
+
]
|
|
1425
|
+
},
|
|
1426
|
+
"cm:entries:update-and-publish": {
|
|
1427
|
+
"aliases": [
|
|
1428
|
+
"cm:bulk-publish:add-fields"
|
|
1429
|
+
],
|
|
1430
|
+
"args": {},
|
|
1431
|
+
"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",
|
|
1432
|
+
"examples": [
|
|
1433
|
+
"General Usage",
|
|
1434
|
+
"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]",
|
|
1435
|
+
"",
|
|
1436
|
+
"Using --config or -c flag",
|
|
1437
|
+
"Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
|
|
1438
|
+
"csdx cm:entries:update-and-publish --config [PATH TO CONFIG FILE]",
|
|
1439
|
+
"csdx cm:entries:update-and-publish -c [PATH TO CONFIG FILE]",
|
|
1440
|
+
"",
|
|
1441
|
+
"Using --retry-failed",
|
|
1442
|
+
"csdx cm:entries:update-and-publish --retry-failed [LOG FILE NAME]",
|
|
1443
|
+
"",
|
|
1444
|
+
"Using --branch",
|
|
1445
|
+
"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]",
|
|
1446
|
+
"",
|
|
1447
|
+
"Using --stack-api-key",
|
|
1448
|
+
"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]"
|
|
1449
|
+
],
|
|
1450
|
+
"flags": {
|
|
1451
|
+
"alias": {
|
|
1452
|
+
"char": "a",
|
|
1453
|
+
"description": "Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.",
|
|
1454
|
+
"name": "alias",
|
|
1455
|
+
"hasDynamicHelp": false,
|
|
1456
|
+
"multiple": false,
|
|
1457
|
+
"type": "option"
|
|
1458
|
+
},
|
|
1459
|
+
"stack-api-key": {
|
|
1460
|
+
"char": "k",
|
|
1461
|
+
"description": "API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.",
|
|
1462
|
+
"name": "stack-api-key",
|
|
1463
|
+
"hasDynamicHelp": false,
|
|
1464
|
+
"multiple": false,
|
|
1465
|
+
"type": "option"
|
|
1466
|
+
},
|
|
1467
|
+
"retry-failed": {
|
|
1468
|
+
"description": "Use this option to retry publishing the failed entries from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.",
|
|
1469
|
+
"name": "retry-failed",
|
|
1470
|
+
"hasDynamicHelp": false,
|
|
1471
|
+
"multiple": false,
|
|
1472
|
+
"type": "option"
|
|
1473
|
+
},
|
|
1474
|
+
"bulk-publish": {
|
|
1475
|
+
"description": "Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.",
|
|
1476
|
+
"name": "bulk-publish",
|
|
1477
|
+
"default": "true",
|
|
1478
|
+
"hasDynamicHelp": false,
|
|
1479
|
+
"multiple": false,
|
|
1480
|
+
"type": "option"
|
|
1481
|
+
},
|
|
1482
|
+
"api-version": {
|
|
1483
|
+
"description": "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
|
|
1484
|
+
"name": "api-version",
|
|
1485
|
+
"hasDynamicHelp": false,
|
|
1486
|
+
"multiple": false,
|
|
1487
|
+
"type": "option"
|
|
1488
|
+
},
|
|
1489
|
+
"content-types": {
|
|
1490
|
+
"description": "The UID of the content type ID whose entries you want to publish in bulk. In case of multiple content types, specify their IDs separated by spaces.",
|
|
1491
|
+
"name": "content-types",
|
|
1492
|
+
"hasDynamicHelp": false,
|
|
1493
|
+
"multiple": true,
|
|
1494
|
+
"type": "option"
|
|
1495
|
+
},
|
|
1496
|
+
"environments": {
|
|
1497
|
+
"char": "e",
|
|
1498
|
+
"description": "The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.",
|
|
1499
|
+
"name": "environments",
|
|
1500
|
+
"hasDynamicHelp": false,
|
|
1501
|
+
"multiple": true,
|
|
1502
|
+
"type": "option"
|
|
1503
|
+
},
|
|
1504
|
+
"config": {
|
|
1505
|
+
"char": "c",
|
|
1506
|
+
"description": "(optional) The path of the optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.",
|
|
1507
|
+
"name": "config",
|
|
1508
|
+
"hasDynamicHelp": false,
|
|
1509
|
+
"multiple": false,
|
|
1510
|
+
"type": "option"
|
|
1511
|
+
},
|
|
1512
|
+
"yes": {
|
|
1513
|
+
"char": "y",
|
|
1514
|
+
"description": "Set it to true to process the command with the current configuration.",
|
|
1515
|
+
"name": "yes",
|
|
1516
|
+
"allowNo": false,
|
|
1517
|
+
"type": "boolean"
|
|
1518
|
+
},
|
|
1519
|
+
"locales": {
|
|
1520
|
+
"char": "l",
|
|
1521
|
+
"description": "Locales in which entries will be published, e.g., en-us. In the case of multiple locales, specify the codes separated by spaces.",
|
|
1522
|
+
"name": "locales",
|
|
1523
|
+
"hasDynamicHelp": false,
|
|
1524
|
+
"multiple": true,
|
|
1525
|
+
"type": "option"
|
|
1526
|
+
},
|
|
1527
|
+
"branch": {
|
|
1528
|
+
"char": "B",
|
|
1529
|
+
"description": "The name of the branch where you want to perform the bulk publish operation. If you don’t mention the branch name, then by default the content from the main branch will be published.",
|
|
1530
|
+
"name": "branch",
|
|
1531
|
+
"default": "main",
|
|
1532
|
+
"hasDynamicHelp": false,
|
|
1533
|
+
"multiple": false,
|
|
1534
|
+
"type": "option"
|
|
1535
|
+
},
|
|
1536
|
+
"force": {
|
|
1537
|
+
"description": "Update and publish all entries even if no fields have been added.",
|
|
1538
|
+
"name": "force",
|
|
1539
|
+
"allowNo": false,
|
|
1540
|
+
"type": "boolean"
|
|
1541
|
+
},
|
|
1542
|
+
"retryFailed": {
|
|
1543
|
+
"char": "r",
|
|
1544
|
+
"description": "Retry publishing failed entries from the logfile (optional, overrides all other flags).",
|
|
1545
|
+
"hidden": true,
|
|
1546
|
+
"name": "retryFailed",
|
|
1547
|
+
"hasDynamicHelp": false,
|
|
1548
|
+
"multiple": false,
|
|
1549
|
+
"type": "option"
|
|
1550
|
+
},
|
|
1551
|
+
"bulkPublish": {
|
|
1552
|
+
"char": "b",
|
|
1553
|
+
"description": "This flag is set to true by default. It indicates that contentstack's bulk publish API will be used to publish the entries.",
|
|
1554
|
+
"hidden": true,
|
|
1555
|
+
"name": "bulkPublish",
|
|
1556
|
+
"hasDynamicHelp": false,
|
|
1557
|
+
"multiple": false,
|
|
1558
|
+
"type": "option"
|
|
1559
|
+
},
|
|
1560
|
+
"contentTypes": {
|
|
1561
|
+
"char": "t",
|
|
1562
|
+
"description": "The Contenttypes from which entries will be published.",
|
|
1563
|
+
"name": "contentTypes",
|
|
1564
|
+
"hasDynamicHelp": false,
|
|
1565
|
+
"multiple": true,
|
|
1566
|
+
"type": "option"
|
|
1567
|
+
}
|
|
1568
|
+
},
|
|
1569
|
+
"hasDynamicHelp": false,
|
|
1570
|
+
"hiddenAliases": [],
|
|
1571
|
+
"id": "cm:entries:update-and-publish",
|
|
1572
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
1573
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
1574
|
+
"pluginType": "core",
|
|
1575
|
+
"strict": true,
|
|
1576
|
+
"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>]",
|
|
1577
|
+
"isESM": false,
|
|
1578
|
+
"relativePath": [
|
|
1579
|
+
"src",
|
|
1580
|
+
"commands",
|
|
1581
|
+
"cm",
|
|
1582
|
+
"entries",
|
|
1583
|
+
"update-and-publish.js"
|
|
1584
|
+
]
|
|
1585
|
+
},
|
|
1586
|
+
"cm:stacks:publish-clear-logs": {
|
|
1587
|
+
"aliases": [
|
|
1588
|
+
"cm:bulk-publish:clear"
|
|
1589
|
+
],
|
|
1590
|
+
"args": {},
|
|
1591
|
+
"description": "Clear the log folder",
|
|
1592
|
+
"examples": [
|
|
1593
|
+
"csdx cm:stacks:publish-clear-logs",
|
|
1594
|
+
"csdx cm:stacks:publish-clear-logs --log-files-count",
|
|
1595
|
+
"csdx cm:stacks:publish-clear-logs --yes",
|
|
1596
|
+
"csdx cm:stacks:publish-clear-logs -y"
|
|
1597
|
+
],
|
|
1598
|
+
"flags": {
|
|
1599
|
+
"log-files-count": {
|
|
1600
|
+
"description": "List number of log files",
|
|
1601
|
+
"name": "log-files-count",
|
|
1602
|
+
"allowNo": false,
|
|
1603
|
+
"type": "boolean"
|
|
1604
|
+
},
|
|
1605
|
+
"yes": {
|
|
1606
|
+
"char": "y",
|
|
1607
|
+
"description": "Delete all files without asking for confirmation",
|
|
1608
|
+
"name": "yes",
|
|
1609
|
+
"allowNo": false,
|
|
1610
|
+
"type": "boolean"
|
|
1611
|
+
},
|
|
1612
|
+
"list": {
|
|
1613
|
+
"char": "l",
|
|
1614
|
+
"description": "List number of log files",
|
|
1615
|
+
"hidden": true,
|
|
1616
|
+
"name": "list",
|
|
1617
|
+
"allowNo": false,
|
|
1618
|
+
"type": "boolean"
|
|
1619
|
+
}
|
|
1620
|
+
},
|
|
1621
|
+
"hasDynamicHelp": false,
|
|
1622
|
+
"hiddenAliases": [],
|
|
1623
|
+
"id": "cm:stacks:publish-clear-logs",
|
|
1624
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
1625
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
1626
|
+
"pluginType": "core",
|
|
1627
|
+
"strict": true,
|
|
1628
|
+
"isESM": false,
|
|
1629
|
+
"relativePath": [
|
|
1630
|
+
"src",
|
|
1631
|
+
"commands",
|
|
1632
|
+
"cm",
|
|
1633
|
+
"stacks",
|
|
1634
|
+
"publish-clear-logs.js"
|
|
1635
|
+
]
|
|
1636
|
+
},
|
|
1637
|
+
"cm:stacks:publish-configure": {
|
|
1638
|
+
"aliases": [
|
|
1639
|
+
"cm:bulk-publish:configure"
|
|
1640
|
+
],
|
|
1641
|
+
"args": {},
|
|
1642
|
+
"description": "The configure command is used to generate a configuration file for publish scripts.",
|
|
1643
|
+
"examples": [
|
|
1644
|
+
"csdx cm:stacks:publish-configure",
|
|
1645
|
+
"csdx cm:stacks:publish-configure -a <management_token_alias>",
|
|
1646
|
+
"csdx cm:stacks:publish-configure --alias <management_token_alias>",
|
|
1647
|
+
"csdx cm:stacks:publish-configure --stack-api-key <stack_api_key>"
|
|
1648
|
+
],
|
|
1649
|
+
"flags": {
|
|
1650
|
+
"alias": {
|
|
1651
|
+
"char": "a",
|
|
1652
|
+
"description": "Name (alias) of the management token you want to use. You must use either the --alias flag or the --stack-api-key flag.",
|
|
1653
|
+
"name": "alias",
|
|
1654
|
+
"hasDynamicHelp": false,
|
|
1655
|
+
"multiple": false,
|
|
1656
|
+
"type": "option"
|
|
1657
|
+
},
|
|
1658
|
+
"stack-api-key": {
|
|
1659
|
+
"char": "k",
|
|
1660
|
+
"description": "API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.",
|
|
1661
|
+
"name": "stack-api-key",
|
|
1662
|
+
"hasDynamicHelp": false,
|
|
1663
|
+
"multiple": false,
|
|
1664
|
+
"type": "option"
|
|
1665
|
+
}
|
|
1666
|
+
},
|
|
1667
|
+
"hasDynamicHelp": false,
|
|
1668
|
+
"hiddenAliases": [],
|
|
1669
|
+
"id": "cm:stacks:publish-configure",
|
|
1670
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
1671
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
1672
|
+
"pluginType": "core",
|
|
1673
|
+
"strict": true,
|
|
1674
|
+
"isESM": false,
|
|
1675
|
+
"relativePath": [
|
|
1676
|
+
"src",
|
|
1677
|
+
"commands",
|
|
1678
|
+
"cm",
|
|
1679
|
+
"stacks",
|
|
1680
|
+
"publish-configure.js"
|
|
1681
|
+
]
|
|
1682
|
+
},
|
|
1683
|
+
"cm:stacks:publish-revert": {
|
|
1684
|
+
"aliases": [
|
|
1685
|
+
"cm:bulk-publish:revert"
|
|
1686
|
+
],
|
|
1687
|
+
"args": {},
|
|
1688
|
+
"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",
|
|
1689
|
+
"examples": [
|
|
1690
|
+
"Using --log-file",
|
|
1691
|
+
"cm:bulk-publish:revert --log-file [LOG FILE NAME]",
|
|
1692
|
+
"",
|
|
1693
|
+
"Using --retry-failed",
|
|
1694
|
+
"cm:bulk-publish:revert --retry-failed [LOG FILE NAME]"
|
|
1695
|
+
],
|
|
1696
|
+
"flags": {
|
|
1697
|
+
"retry-failed": {
|
|
1698
|
+
"description": "(optional) Use this option to retry publishing the failed entries from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.",
|
|
1699
|
+
"name": "retry-failed",
|
|
1700
|
+
"hasDynamicHelp": false,
|
|
1701
|
+
"multiple": false,
|
|
1702
|
+
"type": "option"
|
|
1703
|
+
},
|
|
1704
|
+
"log-file": {
|
|
1705
|
+
"description": "Path of the success logfile of a particular publish action.",
|
|
1706
|
+
"name": "log-file",
|
|
1707
|
+
"hasDynamicHelp": false,
|
|
1708
|
+
"multiple": false,
|
|
1709
|
+
"type": "option"
|
|
1710
|
+
},
|
|
1711
|
+
"retryFailed": {
|
|
1712
|
+
"char": "r",
|
|
1713
|
+
"description": "(optional) Use this option to retry publishing the failed entries from the logfile. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.",
|
|
1714
|
+
"hidden": true,
|
|
1715
|
+
"name": "retryFailed",
|
|
1716
|
+
"hasDynamicHelp": false,
|
|
1717
|
+
"multiple": false,
|
|
1718
|
+
"type": "option"
|
|
1719
|
+
},
|
|
1720
|
+
"logFile": {
|
|
1721
|
+
"char": "l",
|
|
1722
|
+
"description": "Path of the success logfile of a particular publish action.",
|
|
1723
|
+
"hidden": true,
|
|
1724
|
+
"name": "logFile",
|
|
1725
|
+
"hasDynamicHelp": false,
|
|
1726
|
+
"multiple": false,
|
|
1727
|
+
"type": "option"
|
|
1728
|
+
}
|
|
1729
|
+
},
|
|
1730
|
+
"hasDynamicHelp": false,
|
|
1731
|
+
"hiddenAliases": [],
|
|
1732
|
+
"id": "cm:stacks:publish-revert",
|
|
1733
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
1734
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
1735
|
+
"pluginType": "core",
|
|
1736
|
+
"strict": true,
|
|
1737
|
+
"isESM": false,
|
|
1738
|
+
"relativePath": [
|
|
1739
|
+
"src",
|
|
1740
|
+
"commands",
|
|
1741
|
+
"cm",
|
|
1742
|
+
"stacks",
|
|
1743
|
+
"publish-revert.js"
|
|
1744
|
+
]
|
|
1745
|
+
},
|
|
1746
|
+
"cm:stacks:publish": {
|
|
1747
|
+
"aliases": [],
|
|
1748
|
+
"args": {},
|
|
1749
|
+
"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",
|
|
1750
|
+
"examples": [
|
|
1751
|
+
"General Usage",
|
|
1752
|
+
"csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]",
|
|
1753
|
+
"",
|
|
1754
|
+
"Using --config or -c flag",
|
|
1755
|
+
"Generate a config file in the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`",
|
|
1756
|
+
"csdx cm:stacks:publish --config [PATH TO CONFIG FILE]",
|
|
1757
|
+
"csdx cm:stacks:publish -c [PATH TO CONFIG FILE]",
|
|
1758
|
+
"",
|
|
1759
|
+
"Using --retry-failed flag",
|
|
1760
|
+
"csdx cm:stacks:publish --retry-failed [LOG FILE NAME]",
|
|
1761
|
+
"",
|
|
1762
|
+
"Using --branch flag",
|
|
1763
|
+
"csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]",
|
|
1764
|
+
"",
|
|
1765
|
+
"Using --api-version flag",
|
|
1766
|
+
"csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --api-version [API VERSION]"
|
|
1767
|
+
],
|
|
1768
|
+
"flags": {},
|
|
1769
|
+
"hasDynamicHelp": false,
|
|
1770
|
+
"hiddenAliases": [],
|
|
1771
|
+
"id": "cm:stacks:publish",
|
|
1772
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
1773
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
1774
|
+
"pluginType": "core",
|
|
1775
|
+
"strict": true,
|
|
1776
|
+
"isESM": false,
|
|
1777
|
+
"relativePath": [
|
|
1778
|
+
"src",
|
|
1779
|
+
"commands",
|
|
1780
|
+
"cm",
|
|
1781
|
+
"stacks",
|
|
1782
|
+
"publish.js"
|
|
1783
|
+
]
|
|
1784
|
+
},
|
|
1785
|
+
"cm:stacks:unpublish": {
|
|
1786
|
+
"aliases": [
|
|
1787
|
+
"cm:bulk-publish:unpublish"
|
|
1788
|
+
],
|
|
1789
|
+
"args": {},
|
|
1790
|
+
"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",
|
|
1791
|
+
"examples": [
|
|
1792
|
+
"General Usage",
|
|
1793
|
+
"csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] ----delivery-token [DELIVERY TOKEN]",
|
|
1794
|
+
"",
|
|
1795
|
+
"Using --config or -c flag",
|
|
1796
|
+
"Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`",
|
|
1797
|
+
"csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]",
|
|
1798
|
+
"csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]",
|
|
1799
|
+
"",
|
|
1800
|
+
"Using --retry-failed flag",
|
|
1801
|
+
"csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]",
|
|
1802
|
+
"",
|
|
1803
|
+
"No content type",
|
|
1804
|
+
"csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all content types and assets from the source environment)",
|
|
1805
|
+
"",
|
|
1806
|
+
"Using --only-assets",
|
|
1807
|
+
"csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-assets (Will unpublish only assets from the source environment)",
|
|
1808
|
+
"",
|
|
1809
|
+
"Using --only-entries",
|
|
1810
|
+
"csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, all entries, from the source environment)",
|
|
1811
|
+
"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)",
|
|
1812
|
+
"",
|
|
1813
|
+
"Using --branch flag",
|
|
1814
|
+
"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]",
|
|
1815
|
+
"",
|
|
1816
|
+
"Using --stack-api-key flag",
|
|
1817
|
+
"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]"
|
|
1818
|
+
],
|
|
1819
|
+
"flags": {
|
|
1820
|
+
"alias": {
|
|
1821
|
+
"char": "a",
|
|
1822
|
+
"description": "Alias(name) for the management token",
|
|
1823
|
+
"name": "alias",
|
|
1824
|
+
"hasDynamicHelp": false,
|
|
1825
|
+
"multiple": false,
|
|
1826
|
+
"type": "option"
|
|
1827
|
+
},
|
|
1828
|
+
"stack-api-key": {
|
|
1829
|
+
"char": "k",
|
|
1830
|
+
"description": "Stack API key to be used",
|
|
1831
|
+
"name": "stack-api-key",
|
|
1832
|
+
"hasDynamicHelp": false,
|
|
1833
|
+
"multiple": false,
|
|
1834
|
+
"type": "option"
|
|
1835
|
+
},
|
|
1836
|
+
"environment": {
|
|
1837
|
+
"char": "e",
|
|
1838
|
+
"description": "Source Environment",
|
|
1839
|
+
"name": "environment",
|
|
1840
|
+
"hasDynamicHelp": false,
|
|
1841
|
+
"multiple": false,
|
|
1842
|
+
"type": "option"
|
|
1843
|
+
},
|
|
1844
|
+
"config": {
|
|
1845
|
+
"char": "c",
|
|
1846
|
+
"description": "Path to the config file",
|
|
1847
|
+
"name": "config",
|
|
1848
|
+
"hasDynamicHelp": false,
|
|
1849
|
+
"multiple": false,
|
|
1850
|
+
"type": "option"
|
|
1851
|
+
},
|
|
1852
|
+
"yes": {
|
|
1853
|
+
"char": "y",
|
|
1854
|
+
"description": "Agree to process the command with the current configuration",
|
|
1855
|
+
"name": "yes",
|
|
1856
|
+
"allowNo": false,
|
|
1857
|
+
"type": "boolean"
|
|
1858
|
+
},
|
|
1859
|
+
"locale": {
|
|
1860
|
+
"char": "l",
|
|
1861
|
+
"description": "Locale filter",
|
|
1862
|
+
"name": "locale",
|
|
1863
|
+
"hasDynamicHelp": false,
|
|
1864
|
+
"multiple": false,
|
|
1865
|
+
"type": "option"
|
|
1866
|
+
},
|
|
1867
|
+
"branch": {
|
|
1868
|
+
"char": "B",
|
|
1869
|
+
"description": "Specify the branch to fetch the content from (default is main branch)",
|
|
1870
|
+
"name": "branch",
|
|
1871
|
+
"default": "main",
|
|
1872
|
+
"hasDynamicHelp": false,
|
|
1873
|
+
"multiple": false,
|
|
1874
|
+
"type": "option"
|
|
1875
|
+
},
|
|
1876
|
+
"retry-failed": {
|
|
1877
|
+
"description": "Retry publishing failed entries from the logfile (optional, overrides all other flags)",
|
|
1878
|
+
"name": "retry-failed",
|
|
1879
|
+
"hasDynamicHelp": false,
|
|
1880
|
+
"multiple": false,
|
|
1881
|
+
"type": "option"
|
|
1882
|
+
},
|
|
1883
|
+
"bulk-unpublish": {
|
|
1884
|
+
"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",
|
|
1885
|
+
"name": "bulk-unpublish",
|
|
1886
|
+
"default": "true",
|
|
1887
|
+
"hasDynamicHelp": false,
|
|
1888
|
+
"multiple": false,
|
|
1889
|
+
"type": "option"
|
|
1890
|
+
},
|
|
1891
|
+
"api-version": {
|
|
1892
|
+
"description": "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].",
|
|
1893
|
+
"name": "api-version",
|
|
1894
|
+
"hasDynamicHelp": false,
|
|
1895
|
+
"multiple": false,
|
|
1896
|
+
"type": "option"
|
|
1897
|
+
},
|
|
1898
|
+
"content-type": {
|
|
1899
|
+
"description": "Content type filter",
|
|
1900
|
+
"name": "content-type",
|
|
1901
|
+
"hasDynamicHelp": false,
|
|
1902
|
+
"multiple": false,
|
|
1903
|
+
"type": "option"
|
|
1904
|
+
},
|
|
1905
|
+
"delivery-token": {
|
|
1906
|
+
"description": "The delivery token of the source environment.",
|
|
1907
|
+
"name": "delivery-token",
|
|
1908
|
+
"hasDynamicHelp": false,
|
|
1909
|
+
"multiple": false,
|
|
1910
|
+
"type": "option"
|
|
1911
|
+
},
|
|
1912
|
+
"only-assets": {
|
|
1913
|
+
"description": "Unpublish only assets",
|
|
1914
|
+
"hidden": true,
|
|
1915
|
+
"name": "only-assets",
|
|
1916
|
+
"allowNo": false,
|
|
1917
|
+
"type": "boolean"
|
|
1918
|
+
},
|
|
1919
|
+
"only-entries": {
|
|
1920
|
+
"description": "Unpublish only entries",
|
|
1921
|
+
"hidden": true,
|
|
1922
|
+
"name": "only-entries",
|
|
1923
|
+
"allowNo": false,
|
|
1924
|
+
"type": "boolean"
|
|
1925
|
+
},
|
|
1926
|
+
"retryFailed": {
|
|
1927
|
+
"char": "r",
|
|
1928
|
+
"description": "Retry publishing failed entries from the logfile",
|
|
1929
|
+
"hidden": true,
|
|
1930
|
+
"name": "retryFailed",
|
|
1931
|
+
"hasDynamicHelp": false,
|
|
1932
|
+
"multiple": false,
|
|
1933
|
+
"type": "option"
|
|
1934
|
+
},
|
|
1935
|
+
"bulkUnpublish": {
|
|
1936
|
+
"char": "b",
|
|
1937
|
+
"description": "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used for publishing the entries",
|
|
1938
|
+
"hidden": true,
|
|
1939
|
+
"name": "bulkUnpublish",
|
|
1940
|
+
"default": "true",
|
|
1941
|
+
"hasDynamicHelp": false,
|
|
1942
|
+
"multiple": false,
|
|
1943
|
+
"type": "option"
|
|
1944
|
+
},
|
|
1945
|
+
"contentType": {
|
|
1946
|
+
"char": "t",
|
|
1947
|
+
"description": "Content Type filter",
|
|
1948
|
+
"hidden": true,
|
|
1949
|
+
"name": "contentType",
|
|
1950
|
+
"hasDynamicHelp": false,
|
|
1951
|
+
"multiple": false,
|
|
1952
|
+
"type": "option"
|
|
1953
|
+
},
|
|
1954
|
+
"deliveryToken": {
|
|
1955
|
+
"char": "x",
|
|
1956
|
+
"description": "Delivery Token for source environment",
|
|
1957
|
+
"hidden": true,
|
|
1958
|
+
"name": "deliveryToken",
|
|
1959
|
+
"hasDynamicHelp": false,
|
|
1960
|
+
"multiple": false,
|
|
1961
|
+
"type": "option"
|
|
1962
|
+
},
|
|
1963
|
+
"onlyAssets": {
|
|
1964
|
+
"description": "Unpublish only assets",
|
|
1965
|
+
"hidden": true,
|
|
1966
|
+
"name": "onlyAssets",
|
|
1967
|
+
"allowNo": false,
|
|
1968
|
+
"type": "boolean"
|
|
1969
|
+
},
|
|
1970
|
+
"onlyEntries": {
|
|
1971
|
+
"description": "Unpublish only entries",
|
|
1972
|
+
"hidden": true,
|
|
1973
|
+
"name": "onlyEntries",
|
|
1974
|
+
"allowNo": false,
|
|
1975
|
+
"type": "boolean"
|
|
1976
|
+
}
|
|
1977
|
+
},
|
|
1978
|
+
"hasDynamicHelp": false,
|
|
1979
|
+
"hiddenAliases": [],
|
|
1980
|
+
"id": "cm:stacks:unpublish",
|
|
1981
|
+
"pluginAlias": "@contentstack/cli-cm-bulk-publish",
|
|
1982
|
+
"pluginName": "@contentstack/cli-cm-bulk-publish",
|
|
1983
|
+
"pluginType": "core",
|
|
1984
|
+
"strict": true,
|
|
1985
|
+
"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]",
|
|
1986
|
+
"isESM": false,
|
|
1987
|
+
"relativePath": [
|
|
1988
|
+
"src",
|
|
1989
|
+
"commands",
|
|
1990
|
+
"cm",
|
|
1991
|
+
"stacks",
|
|
1992
|
+
"unpublish.js"
|
|
1993
|
+
]
|
|
1994
|
+
}
|
|
1995
|
+
},
|
|
1996
|
+
"version": "1.11.0-beta.1"
|
|
1997
|
+
}
|