33
44Bulk publish command for managing entries and assets.
55
6- [ ![ oclif] ( https://img.shields.io/badge/cli-oclif-brightgreen.svg )] ( https://oclif.io )
7- [ ![ Version] ( https://img.shields.io/npm/v/bulk-publish.svg )] ( https://npmjs.org/package/bulk-publish )
8- [ ![ Downloads/week] ( https://img.shields.io/npm/dw/bulk-publish.svg )] ( https://npmjs.org/package/bulk-publish )
96[ ![ License] ( https://img.shields.io/npm/l/bulk-publish.svg )] ( https://github.com/abhinav-from-contentstack/bulk-publish/blob/master/package.json )
107
118<!-- toc -->
@@ -19,7 +16,7 @@ $ npm install -g @contentstack/cli-cm-bulk-publish
1916$ csdx COMMAND
2017running command...
2118$ csdx (-v| --version| version)
22- @contentstack/cli-cm-bulk-publish/0.0.20 darwin-x64 node-v10.19.0
19+ @contentstack/cli-cm-bulk-publish/0.1.0-beta darwin-x64 node-v10.19.0
2320$ csdx --help [COMMAND]
2421USAGE
2522 $ csdx COMMAND
5047 $ csdx cm:bulk-publish
5148```
5249
53- _ See code: [ src/commands/cm/bulk-publish/index.js] ( https://github.com/contentstack/cli/blob/v0.0.20 /src/commands/cm/bulk-publish/index.js ) _
50+ _ See code: [ src/commands/cm/bulk-publish/index.js] ( https://github.com/contentstack/cli/blob/v0.1.0-beta /src/commands/cm/bulk-publish/index.js ) _
5451
5552## ` csdx cm:bulk-publish:add-fields -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] `
5653
@@ -94,11 +91,11 @@ EXAMPLES
9491 csdx cm:bulk-publish:add-fields -c [PATH TO CONFIG FILE]
9592
9693 Using --retryFailed or -r flag
97- csdx cm:bulk-publish:add-fields --retryFailed [PATH TO LOG FILE]
98- csdx cm:bulk-publish:add-fields -r [PATH TO LOG FILE]
94+ csdx cm:bulk-publish:add-fields --retryFailed [LOG FILE NAME ]
95+ csdx cm:bulk-publish:add-fields -r [LOG FILE NAME ]
9996```
10097
101- _ See code: [ src/commands/cm/bulk-publish/add-fields.js] ( https://github.com/contentstack/cli/blob/v0.0.20 /src/commands/cm/bulk-publish/add-fields.js ) _
98+ _ See code: [ src/commands/cm/bulk-publish/add-fields.js] ( https://github.com/contentstack/cli/blob/v0.1.0-beta /src/commands/cm/bulk-publish/add-fields.js ) _
10299
103100## ` csdx cm:bulk-publish:assets -e [ENVIRONMENT 1] [ENVIRONMENT 2] -u [FOLDER_UID] --[no-]bulkPublish -a [MANAGEMENT TOKEN ALIAS] `
104101
@@ -131,7 +128,7 @@ OPTIONS
131128DESCRIPTION
132129 The assets command is used for publishing assets from the specified stack, to the specified environments
133130
134- Environment/s are required for executing the command successfully
131+ Environment(s) and Locale(s) are required for executing the command successfully
135132 But, if retryFailed flag is set, then only a logfile is required
136133
137134EXAMPLES
@@ -141,11 +138,11 @@ EXAMPLES
141138 csdx cm:bulk-publish:assets -c [PATH TO CONFIG FILE]
142139
143140 Using --retryFailed or -r flag
144- csdx cm:bulk-publish:assets --retryFailed [PATH TO LOG FILE]
145- csdx cm:bulk-publish:assets -r [PATH TO LOG FILE]
141+ csdx cm:bulk-publish:assets --retryFailed [LOG FILE NAME ]
142+ csdx cm:bulk-publish:assets -r [LOG FILE NAME ]
146143```
147144
148- _ See code: [ src/commands/cm/bulk-publish/assets.js] ( https://github.com/contentstack/cli/blob/v0.0.20 /src/commands/cm/bulk-publish/assets.js ) _
145+ _ See code: [ src/commands/cm/bulk-publish/assets.js] ( https://github.com/contentstack/cli/blob/v0.1.0-beta /src/commands/cm/bulk-publish/assets.js ) _
149146
150147## ` csdx cm:bulk-publish:clear `
151148
@@ -160,7 +157,7 @@ OPTIONS
160157 -y, --yes Delete all files without asking for confirmation
161158```
162159
163- _ See code: [ src/commands/cm/bulk-publish/clear.js] ( https://github.com/contentstack/cli/blob/v0.0.20 /src/commands/cm/bulk-publish/clear.js ) _
160+ _ See code: [ src/commands/cm/bulk-publish/clear.js] ( https://github.com/contentstack/cli/blob/v0.1.0-beta /src/commands/cm/bulk-publish/clear.js ) _
164161
165162## ` csdx cm:bulk-publish:configure `
166163
@@ -185,7 +182,7 @@ DESCRIPTION
185182 EXAMPLE : cm:bulk-publish:configure -a [MANAGEMENT TOKEN Alias]
186183```
187184
188- _ See code: [ src/commands/cm/bulk-publish/configure.js] ( https://github.com/contentstack/cli/blob/v0.0.20 /src/commands/cm/bulk-publish/configure.js ) _
185+ _ See code: [ src/commands/cm/bulk-publish/configure.js] ( https://github.com/contentstack/cli/blob/v0.1.0-beta /src/commands/cm/bulk-publish/configure.js ) _
189186
190187## ` csdx cm:bulk-publish:cross-publish -t [CONTENT TYPE] -e [ENVIRONMENT] -d [DESTINATION ENVIRONMENT] -l [LOCALE] -a [MANAGEMENT TOKEN ALIAS] -x [DELIVERY TOKEN] `
191188
@@ -222,7 +219,7 @@ OPTIONS
222219DESCRIPTION
223220 The cross-publish command is used for publishing entries and assets from one evironment to other environments
224221
225- Content Types, Environments and Locales are required for executing the command successfully
222+ Content Type, Environment, Destination Environment(s) and Locale are required for executing the command successfully
226223 But, if retryFailed flag is set, then only a logfile is required
227224
228225EXAMPLES
@@ -232,11 +229,11 @@ EXAMPLES
232229 csdx cm:bulk-publish:cross-publish -c [PATH TO CONFIG FILE]
233230
234231 Using --retryFailed or -r flag
235- csdx cm:bulk-publish:cross-publish --retryFailed [PATH TO LOG FILE]
236- csdx cm:bulk-publish:cross-publish -r [PATH TO LOG FILE]
232+ csdx cm:bulk-publish:cross-publish --retryFailed [LOG FILE NAME ]
233+ csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME ]
237234```
238235
239- _ See code: [ src/commands/cm/bulk-publish/cross-publish.js] ( https://github.com/contentstack/cli/blob/v0.0.20 /src/commands/cm/bulk-publish/cross-publish.js ) _
236+ _ See code: [ src/commands/cm/bulk-publish/cross-publish.js] ( https://github.com/contentstack/cli/blob/v0.1.0-beta /src/commands/cm/bulk-publish/cross-publish.js ) _
240237
241238## ` csdx cm:bulk-publish:entries -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] `
242239
@@ -284,11 +281,11 @@ EXAMPLES
284281 csdx cm:bulk-publish:entries -c [PATH TO CONFIG FILE]
285282
286283 Using --retryFailed or -r flag
287- csdx cm:bulk-publish:entries --retryFailed [PATH TO LOG FILE]
288- csdx cm:bulk-publish:entries -r [PATH TO LOG FILE]
284+ csdx cm:bulk-publish:entries --retryFailed [LOG FILE NAME ]
285+ csdx cm:bulk-publish:entries -r [LOG FILE NAME ]
289286```
290287
291- _ See code: [ src/commands/cm/bulk-publish/entries.js] ( https://github.com/contentstack/cli/blob/v0.0.20 /src/commands/cm/bulk-publish/entries.js ) _
288+ _ See code: [ src/commands/cm/bulk-publish/entries.js] ( https://github.com/contentstack/cli/blob/v0.1.0-beta /src/commands/cm/bulk-publish/entries.js ) _
292289
293290## ` csdx cm:bulk-publish:entry-edits -t [CONTENT TYPE 1] [CONTENT TYPE 2] -s [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] `
294291
@@ -324,7 +321,8 @@ DESCRIPTION
324321 The entry-edits command is used for publishing entries from the specified content types, to the
325322 specified environments and locales
326323
327- Content Types, Environments and Locales are required for executing the command successfully
324+ Content Type(s), Source Environment, Destination Environment(s) and Locale(s) are required for executing the command
325+ successfully
328326 But, if retryFailed flag is set, then only a logfile is required
329327
330328EXAMPLES
@@ -334,11 +332,11 @@ EXAMPLES
334332 csdx cm:bulk-publish:entry-edits -c [PATH TO CONFIG FILE]
335333
336334 Using --retryFailed or -r flag
337- csdx cm:bulk-publish:entry-edits --retryFailed [PATH TO LOG FILE]
338- csdx cm:bulk-publish:entry-edits -r [PATH TO LOG FILE]
335+ csdx cm:bulk-publish:entry-edits --retryFailed [LOG FILE NAME ]
336+ csdx cm:bulk-publish:entry-edits -r [LOG FILE NAME ]
339337```
340338
341- _ See code: [ src/commands/cm/bulk-publish/entry-edits.js] ( https://github.com/contentstack/cli/blob/v0.0.20 /src/commands/cm/bulk-publish/entry-edits.js ) _
339+ _ See code: [ src/commands/cm/bulk-publish/entry-edits.js] ( https://github.com/contentstack/cli/blob/v0.1.0-beta /src/commands/cm/bulk-publish/entry-edits.js ) _
342340
343341## ` csdx cm:bulk-publish:nonlocalized-field-changes -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] `
344342
@@ -382,11 +380,11 @@ EXAMPLES
382380 csdx cm:bulk-publish:nonlocalized-field-changes -c [PATH TO CONFIG FILE]
383381
384382 Using --retryFailed or -r flag
385- csdx cm:bulk-publish:nonlocalized-field-changes --retryFailed [PATH TO LOG FILE]
386- csdx cm:bulk-publish:nonlocalized-field-changes -r [PATH TO LOG FILE]
383+ csdx cm:bulk-publish:nonlocalized-field-changes --retryFailed [LOG FILE NAME ]
384+ csdx cm:bulk-publish:nonlocalized-field-changes -r [LOG FILE NAME ]
387385```
388386
389- _ See code: [ src/commands/cm/bulk-publish/nonlocalized-field-changes.js] ( https://github.com/contentstack/cli/blob/v0.0.20 /src/commands/cm/bulk-publish/nonlocalized-field-changes.js ) _
387+ _ See code: [ src/commands/cm/bulk-publish/nonlocalized-field-changes.js] ( https://github.com/contentstack/cli/blob/v0.1.0-beta /src/commands/cm/bulk-publish/nonlocalized-field-changes.js ) _
390388
391389## ` csdx cm:bulk-publish:revert `
392390
@@ -401,27 +399,20 @@ OPTIONS
401399 -r, --retryFailed=retryFailed retry publishing failed entries from the logfile
402400
403401DESCRIPTION
404- ...
405402 The revert command is used for reverting all publish operations performed using bulk-publish script.
403+ A log file name is required to execute revert command
406404
407- Here is a detailed description for all the available flags
408- -----------------------------------------------------------------------------------------------------------
409- --retryFailed or -r : This flag is used to retry publishing entries or assets, that failed to publish in a previous
410- attempt. A log file for the previous session will be required for processing the failed elements.
411-
412- NOTE: When retryFailed flag is set, all other flags will be ignored
413-
414- EXAMPLE : cm:bulk-publish:revert --retryFailed [PATH TO LOG FILE]
415- EXAMPLE : cm:bulk-publish:revert -r [PATH TO LOG FILE]
416- -----------------------------------------------------------------------------------------------------------
417- --logFile or -l : logFile to be used for revert
405+ EXAMPLES
406+ Using --logFile
407+ cm:bulk-publish:revert --logFile [LOG FILE NAME]
408+ cm:bulk-publish:revert -l [LOG FILE NAME]
418409
419- EXAMPLE : cm:bulk-publish:revert --logFile [PATH TO LOG FILE]
420- EXAMPLE : cm:bulk-publish:revert -l [PATH TO LOG FILE]
421- -----------------------------------------------------------------------------------------------------------
410+ Using --retryFailed
411+ cm:bulk-publish:revert --retryFailed [ LOG FILE NAME ]
412+ cm:bulk-publish:revert -r [LOG FILE NAME]
422413```
423414
424- _ See code: [ src/commands/cm/bulk-publish/revert.js] ( https://github.com/contentstack/cli/blob/v0.0.20 /src/commands/cm/bulk-publish/revert.js ) _
415+ _ See code: [ src/commands/cm/bulk-publish/revert.js] ( https://github.com/contentstack/cli/blob/v0.1.0-beta /src/commands/cm/bulk-publish/revert.js ) _
425416
426417## ` csdx cm:bulk-publish:unpublish -b -t [CONTENT TYPE] -e [ENVIRONMENT] -l [LOCALE] -a [MANAGEMENT TOKEN ALIAS] -x [DELIVERY TOKEN] `
427418
@@ -459,21 +450,42 @@ OPTIONS
459450DESCRIPTION
460451 The unpublish command is used for unpublishing entries from given environment
461452
462- Content Types, Environments and Locales are required for executing the command successfully
453+ Environment (Source Environment) and Locale are required for executing the command successfully
463454 But, if retryFailed flag is set, then only a logfile is required
464455
456+ A Content Type can be specified for publishing entries, but if no content-type(s) is/are specified and --onlyAssets is
457+ not used,
458+ then all entries from all content types will be unpublished from the source environment
459+
460+ --onlyAssets can be used to unpublish only assets and --onlyEntries can be used to unpublish only entries.
461+ (--onlyAssets and --onlyEntries cannot be used together at the same time)
462+
465463EXAMPLES
466464 Using --config or -c flag
467465 Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
468466 csdx cm:bulk-publish:unpublish --config [PATH TO CONFIG FILE]
469467 csdx cm:bulk-publish:unpublish -c [PATH TO CONFIG FILE]
470468
471469 Using --retryFailed or -r flag
472- csdx cm:bulk-publish:unpublish --retryFailed [PATH TO LOG FILE]
473- csdx cm:bulk-publish:unpublish -r [PATH TO LOG FILE]
470+ csdx cm:bulk-publish:unpublish --retryFailed [LOG FILE NAME]
471+ csdx cm:bulk-publish:unpublish -r [LOG FILE NAME]
472+
473+ No content type
474+ csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all
475+ content types and assets from the source environment)
476+
477+ Using --onlyAssets
478+ csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] --onlyAssets (Will unpublish only assets
479+ from the source environment)
480+
481+ Using --onlyEntries
482+ csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries (Will unpublish only
483+ entries, all entries, from the source environment)
484+ csdx cm:bulk-publish:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries
485+ (Will unpublish only entries, (from CONTENT TYPE) from the source environment)
474486```
475487
476- _ See code: [ src/commands/cm/bulk-publish/unpublish.js] ( https://github.com/contentstack/cli/blob/v0.0.20 /src/commands/cm/bulk-publish/unpublish.js ) _
488+ _ See code: [ src/commands/cm/bulk-publish/unpublish.js] ( https://github.com/contentstack/cli/blob/v0.1.0-beta /src/commands/cm/bulk-publish/unpublish.js ) _
477489
478490## ` csdx cm:bulk-publish:unpublished-entries -b -t [CONTENT TYPES] -e [ENVIRONMENTS] -l [LOCALES] -a [MANAGEMENT TOKEN ALIAS] `
479491
@@ -508,7 +520,8 @@ DESCRIPTION
508520 The unpublished-entries command is used for publishing unpublished entries from the source environment, to other
509521 environments and locales
510522
511- Content Types, Environments and Locales are required for executing the command successfully
523+ Content Type(s), Source Environment, Destination Environment(s) and Source Locale are required for executing the
524+ command successfully
512525 But, if retryFailed flag is set, then only a logfile is required
513526
514527EXAMPLES
@@ -518,9 +531,9 @@ EXAMPLES
518531 csdx cm:bulk-publish:unpublished-entries -c [PATH TO CONFIG FILE]
519532
520533 Using --retryFailed or -r flag
521- csdx cm:bulk-publish:unpublished-entries --retryFailed [PATH TO LOG FILE]
522- csdx cm:bulk-publish:unpublished-entries -r [PATH TO LOG FILE]
534+ csdx cm:bulk-publish:unpublished-entries --retryFailed [LOG FILE NAME ]
535+ csdx cm:bulk-publish:unpublished-entries -r [LOG FILE NAME ]
523536```
524537
525- _ See code: [ src/commands/cm/bulk-publish/unpublished-entries.js] ( https://github.com/contentstack/cli/blob/v0.0.20 /src/commands/cm/bulk-publish/unpublished-entries.js ) _
538+ _ See code: [ src/commands/cm/bulk-publish/unpublished-entries.js] ( https://github.com/contentstack/cli/blob/v0.1.0-beta /src/commands/cm/bulk-publish/unpublished-entries.js ) _
526539<!-- commandsstop -->
0 commit comments