@contentstack/cli-cm-bulk-publish 0.1.1-beta.3 → 1.0.0
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/LICENSE +21 -0
- package/README.md +533 -281
- package/oclif.manifest.json +1 -1
- package/package.json +27 -12
- package/src/commands/cm/assets/publish.js +233 -0
- package/src/commands/cm/assets/unpublish.js +179 -0
- package/src/commands/cm/bulk-publish/cross-publish.js +187 -68
- package/src/commands/cm/bulk-publish/index.js +5 -6
- package/src/commands/cm/entries/publish-modified.js +197 -0
- package/src/commands/cm/entries/publish-non-localized-fields.js +208 -0
- package/src/commands/cm/entries/publish-only-unpublished.js +109 -0
- package/src/commands/cm/entries/publish.js +254 -0
- package/src/commands/cm/entries/unpublish.js +184 -0
- package/src/commands/cm/entries/update-and-publish.js +191 -0
- package/src/commands/cm/stacks/publish-clear-logs.js +82 -0
- package/src/commands/cm/stacks/publish-configure.js +46 -0
- package/src/commands/cm/stacks/publish-revert.js +102 -0
- package/src/commands/cm/stacks/publish.js +110 -0
- package/src/commands/cm/stacks/unpublish.js +282 -0
- package/src/config/index.js +60 -99
- package/src/consumer/publish.js +600 -377
- package/src/producer/add-fields.js +209 -189
- package/src/producer/cross-publish.js +195 -136
- package/src/producer/nonlocalized-field-changes.js +235 -216
- package/src/producer/publish-assets.js +104 -98
- package/src/producer/publish-edits.js +126 -113
- package/src/producer/publish-entries.js +135 -112
- package/src/producer/publish-unpublished-env.js +126 -114
- package/src/producer/revert.js +261 -230
- package/src/producer/unpublish.js +175 -137
- package/src/services/publish-only-unpublished.js +130 -0
- package/src/util/client.js +21 -17
- package/src/util/command-helper.js +25 -0
- package/src/util/fs.js +10 -11
- package/src/util/index.js +15 -16
- package/src/util/logger.js +21 -25
- package/src/util/queue.js +13 -13
- package/src/util/retryfailed.js +8 -4
- package/src/util/store.js +44 -52
- package/src/commands/cm/bulk-publish/add-fields.js +0 -117
- package/src/commands/cm/bulk-publish/assets.js +0 -117
- package/src/commands/cm/bulk-publish/clear.js +0 -63
- package/src/commands/cm/bulk-publish/configure.js +0 -46
- package/src/commands/cm/bulk-publish/entries.js +0 -125
- package/src/commands/cm/bulk-publish/entry-edits.js +0 -123
- package/src/commands/cm/bulk-publish/nonlocalized-field-changes.js +0 -116
- package/src/commands/cm/bulk-publish/revert.js +0 -81
- package/src/commands/cm/bulk-publish/unpublish.js +0 -164
- package/src/commands/cm/bulk-publish/unpublished-entries.js +0 -122
- package/src/util/request.js +0 -57
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-cm-bulk-publish
|
|
|
18
18
|
$ csdx COMMAND
|
|
19
19
|
running command...
|
|
20
20
|
$ csdx (-v|--version|version)
|
|
21
|
-
@contentstack/cli-cm-bulk-publish/
|
|
21
|
+
@contentstack/cli-cm-bulk-publish/1.0.0 linux-x64 node-v16.14.2
|
|
22
22
|
$ csdx --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ csdx COMMAND
|
|
@@ -29,541 +29,793 @@ USAGE
|
|
|
29
29
|
# Commands
|
|
30
30
|
|
|
31
31
|
<!-- commands -->
|
|
32
|
+
* [`csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>] [--content-types <value>]`](#csdx-cmassetspublish--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---content-types-value)
|
|
33
|
+
* [`csdx cm:assets:unpublish`](#csdx-cmassetsunpublish)
|
|
32
34
|
* [`csdx cm:bulk-publish`](#csdx-cmbulk-publish)
|
|
33
|
-
* [`csdx cm:bulk-publish:
|
|
34
|
-
* [`csdx cm:bulk-publish
|
|
35
|
-
* [`csdx cm:bulk-publish
|
|
36
|
-
* [`csdx cm:bulk-publish
|
|
37
|
-
* [`csdx cm:bulk-publish
|
|
38
|
-
* [`csdx cm:
|
|
39
|
-
* [`csdx cm:bulk-publish
|
|
40
|
-
* [`csdx cm:
|
|
41
|
-
* [`csdx cm:
|
|
42
|
-
* [`csdx cm:
|
|
43
|
-
* [`csdx cm:
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
35
|
+
* [`csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries]`](#csdx-cmbulk-publishcross-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)
|
|
36
|
+
* [`csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`](#csdx-cmentriespublish--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)
|
|
37
|
+
* [`csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value)
|
|
38
|
+
* [`csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value)
|
|
39
|
+
* [`csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-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)
|
|
40
|
+
* [`csdx cm:entries:unpublish`](#csdx-cmentriesunpublish)
|
|
41
|
+
* [`csdx 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>]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value)
|
|
42
|
+
* [`csdx cm:stacks:publish`](#csdx-cmstackspublish)
|
|
43
|
+
* [`csdx cm:stacks:publish-clear-logs`](#csdx-cmstackspublish-clear-logs)
|
|
44
|
+
* [`csdx cm:stacks:publish-configure`](#csdx-cmstackspublish-configure)
|
|
45
|
+
* [`csdx cm:stacks:publish-revert`](#csdx-cmstackspublish-revert)
|
|
46
|
+
* [`csdx 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]`](#csdx-csdx-cmstacksunpublish--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)
|
|
47
|
+
|
|
48
|
+
## `csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>] [--content-types <value>]`
|
|
49
|
+
|
|
50
|
+
Publish assets to the specified environments
|
|
48
51
|
|
|
49
52
|
```
|
|
50
53
|
USAGE
|
|
51
|
-
$ csdx cm:bulk-publish
|
|
52
|
-
|
|
54
|
+
$ csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish
|
|
55
|
+
<value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]
|
|
56
|
+
[--content-types <value>]
|
|
53
57
|
|
|
54
|
-
|
|
58
|
+
OPTIONS
|
|
59
|
+
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
|
|
60
|
+
is selected)
|
|
55
61
|
|
|
56
|
-
|
|
62
|
+
-a, --alias=alias Alias(name) for the management token
|
|
57
63
|
|
|
58
|
-
|
|
64
|
+
-c, --config=config Path to the config file
|
|
59
65
|
|
|
60
|
-
|
|
61
|
-
USAGE
|
|
62
|
-
$ csdx cm:bulk-publish:add-fields
|
|
66
|
+
-e, --environments=environments Environments where assets will be published
|
|
63
67
|
|
|
64
|
-
|
|
65
|
-
-a, --alias=alias Alias for the management token to be used
|
|
68
|
+
-l, --locales=locales Locales to where assets will be published
|
|
66
69
|
|
|
67
|
-
-
|
|
68
|
-
bulkpublish API will be used for publishing the entries
|
|
70
|
+
-y, --yes Agree to process the command with the current configuration
|
|
69
71
|
|
|
70
|
-
-
|
|
72
|
+
--bulk-publish=bulk-publish [default: true] By default this flag is set as true. It indicates that contentstack's
|
|
73
|
+
bulkpublish API will be used to publish the assets
|
|
71
74
|
|
|
72
|
-
-
|
|
75
|
+
--content-types=content-types Content types
|
|
73
76
|
|
|
74
|
-
-
|
|
77
|
+
--delivery-token=delivery-token Delivery token for source environment
|
|
75
78
|
|
|
76
|
-
-
|
|
77
|
-
flags)
|
|
79
|
+
--folder-uid=folder-uid [default: cs_root] Folder-uid from where the assets will be published
|
|
78
80
|
|
|
79
|
-
-
|
|
81
|
+
--retry-failed=retry-failed Retry publishing failed assets from the logfile (optional, will override all other
|
|
82
|
+
flags)
|
|
80
83
|
|
|
81
|
-
-
|
|
84
|
+
--source-env=source-env Source environment
|
|
82
85
|
|
|
83
86
|
DESCRIPTION
|
|
84
|
-
The
|
|
85
|
-
Content Type
|
|
87
|
+
The assets command is used to publish assets from the specified stack, to the specified environments
|
|
86
88
|
|
|
87
|
-
|
|
89
|
+
Note: Environment(s) and Locale(s) are required to execute the command successfully
|
|
88
90
|
But, if retryFailed flag is set, then only a logfile is required
|
|
89
91
|
|
|
92
|
+
ALIASES
|
|
93
|
+
$ csdx cm:bulk-publish:assets
|
|
94
|
+
|
|
90
95
|
EXAMPLES
|
|
91
96
|
General Usage
|
|
92
|
-
csdx cm:
|
|
93
|
-
|
|
97
|
+
csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN
|
|
98
|
+
ALIAS]
|
|
94
99
|
|
|
95
100
|
Using --config or -c flag
|
|
96
|
-
Generate a config file at the current working directory using `csdx cm:
|
|
97
|
-
csdx cm:
|
|
98
|
-
csdx cm:
|
|
101
|
+
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
102
|
+
csdx cm:assets:publish --config [PATH TO CONFIG FILE]
|
|
103
|
+
csdx cm:assets:publish -c [PATH TO CONFIG FILE]
|
|
104
|
+
|
|
105
|
+
Using --retry-failed flag
|
|
106
|
+
csdx cm:assets:publish --retry-failed [LOG FILE NAME]
|
|
107
|
+
|
|
108
|
+
Using --branch flag
|
|
109
|
+
csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN
|
|
110
|
+
ALIAS] --branch [BRANCH NAME]
|
|
99
111
|
|
|
100
|
-
Using --
|
|
101
|
-
csdx cm:
|
|
102
|
-
|
|
112
|
+
Using --source-env
|
|
113
|
+
csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN
|
|
114
|
+
ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
103
115
|
```
|
|
104
116
|
|
|
105
|
-
_See code: [src/commands/cm/
|
|
117
|
+
_See code: [src/commands/cm/assets/publish.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/assets/publish.js)_
|
|
106
118
|
|
|
107
|
-
## `csdx cm:
|
|
119
|
+
## `csdx cm:assets:unpublish`
|
|
108
120
|
|
|
109
|
-
|
|
121
|
+
Unpublish assets from given environment
|
|
110
122
|
|
|
111
123
|
```
|
|
112
124
|
USAGE
|
|
113
|
-
$ csdx cm:
|
|
125
|
+
$ csdx cm:assets:unpublish
|
|
114
126
|
|
|
115
127
|
OPTIONS
|
|
116
|
-
-a, --alias=alias Alias for the management token
|
|
117
|
-
|
|
118
|
-
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
-c, --config=config Path to config file to be used
|
|
128
|
+
-a, --alias=alias Alias(name) for the management token
|
|
129
|
+
-c, --config=config Path to the config file
|
|
130
|
+
-e, --environment=environment Source Environment
|
|
131
|
+
-y, --yes Agree to process the command with the current configuration
|
|
122
132
|
|
|
123
|
-
|
|
133
|
+
--branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
|
|
134
|
+
is selected)
|
|
124
135
|
|
|
125
|
-
-
|
|
136
|
+
--bulk-unpublish=bulk-unpublish [default: true] By default this flag is set as true. It indicates that contentstack's
|
|
137
|
+
bulkpublish API will be used to unpublish the assets
|
|
126
138
|
|
|
127
|
-
-
|
|
128
|
-
flags)
|
|
139
|
+
--delivery-token=delivery-token Delivery Token for source environment
|
|
129
140
|
|
|
130
|
-
|
|
141
|
+
--locale=locale Locale filter
|
|
131
142
|
|
|
132
|
-
-
|
|
143
|
+
--retry-failed=retry-failed Retry unpublishing failed assets from the logfile
|
|
133
144
|
|
|
134
145
|
DESCRIPTION
|
|
135
|
-
The
|
|
146
|
+
The unpublish command is used for unpublishing assets from the given environment
|
|
136
147
|
|
|
137
|
-
Environment(
|
|
138
|
-
But, if
|
|
148
|
+
Note: Environment (Source Environment) and Locale are required to execute the command successfully
|
|
149
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
139
150
|
|
|
140
151
|
EXAMPLES
|
|
141
152
|
General Usage
|
|
142
|
-
csdx cm:
|
|
153
|
+
csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN
|
|
154
|
+
ALIAS] --delivery-token [DELIVERY TOKEN]
|
|
143
155
|
|
|
144
156
|
Using --config or -c flag
|
|
145
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure
|
|
146
|
-
csdx cm:
|
|
147
|
-
csdx cm:
|
|
157
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
|
|
158
|
+
csdx cm:assets:unpublish --config [PATH TO CONFIG FILE]
|
|
159
|
+
csdx cm:assets:unpublish -c [PATH TO CONFIG FILE]
|
|
148
160
|
|
|
149
|
-
Using --
|
|
150
|
-
csdx cm:
|
|
151
|
-
|
|
161
|
+
Using --retry-failed flag
|
|
162
|
+
csdx cm:assets:unpublish --retry-failed [LOG FILE NAME]
|
|
163
|
+
|
|
164
|
+
Using --branch flag
|
|
165
|
+
csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN
|
|
166
|
+
ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
152
167
|
```
|
|
153
168
|
|
|
154
|
-
_See code: [src/commands/cm/
|
|
169
|
+
_See code: [src/commands/cm/assets/unpublish.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/assets/unpublish.js)_
|
|
155
170
|
|
|
156
|
-
## `csdx cm:bulk-publish
|
|
171
|
+
## `csdx cm:bulk-publish`
|
|
157
172
|
|
|
158
|
-
|
|
173
|
+
Bulk Publish script for managing entries and assets
|
|
159
174
|
|
|
160
175
|
```
|
|
161
176
|
USAGE
|
|
162
|
-
$ csdx cm:bulk-publish
|
|
163
|
-
|
|
164
|
-
OPTIONS
|
|
165
|
-
-l, --list List number of log files
|
|
166
|
-
-y, --yes Delete all files without asking for confirmation
|
|
177
|
+
$ csdx cm:bulk-publish
|
|
167
178
|
```
|
|
168
179
|
|
|
169
|
-
_See code: [src/commands/cm/bulk-publish/
|
|
180
|
+
_See code: [src/commands/cm/bulk-publish/index.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/index.js)_
|
|
170
181
|
|
|
171
|
-
## `csdx cm:bulk-publish:
|
|
182
|
+
## `csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries]`
|
|
172
183
|
|
|
173
|
-
|
|
184
|
+
Publish entries and assets from one environment to other environments
|
|
174
185
|
|
|
175
186
|
```
|
|
176
187
|
USAGE
|
|
177
|
-
$ csdx cm:bulk-publish:
|
|
188
|
+
$ csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type
|
|
189
|
+
<value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>]
|
|
190
|
+
[-y] [--branch <value>] [--onlyAssets] [--onlyEntries]
|
|
178
191
|
|
|
179
192
|
OPTIONS
|
|
180
|
-
-
|
|
193
|
+
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
|
|
194
|
+
is selected)
|
|
195
|
+
|
|
196
|
+
-a, --alias=alias Alias(name) for the management token
|
|
197
|
+
|
|
198
|
+
-c, --config=config Path to the config file
|
|
199
|
+
|
|
200
|
+
-y, --yes Agree to process the command with the current configuration
|
|
201
|
+
|
|
202
|
+
--bulk-publish=bulk-publish [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
203
|
+
bulkpublish API will be used to publish the entries
|
|
204
|
+
|
|
205
|
+
--content-type=content-type The Contenttypes from which entries will be published
|
|
206
|
+
|
|
207
|
+
--delivery-token=delivery-token Delivery token for source environment
|
|
208
|
+
|
|
209
|
+
--environments=environments Destination Environments
|
|
210
|
+
|
|
211
|
+
--locales=locales Source locale
|
|
212
|
+
|
|
213
|
+
--onlyAssets Unpublish only assets
|
|
214
|
+
|
|
215
|
+
--onlyEntries Unpublish only entries
|
|
216
|
+
|
|
217
|
+
--retry-failed=retry-failed (optional) Retry publishing failed entries from the logfile (this flag overrides all
|
|
218
|
+
other flags)
|
|
219
|
+
|
|
220
|
+
--source-env=source-env Source Env
|
|
181
221
|
|
|
182
222
|
DESCRIPTION
|
|
183
|
-
The
|
|
223
|
+
The cross-publish command is used to publish entries and assets from one environment to other environments
|
|
184
224
|
|
|
185
|
-
|
|
225
|
+
Note: Content Type, Environment, Destination Environment(s) and Locale are required to execute the command
|
|
226
|
+
successfully
|
|
227
|
+
But, if retryFailed flag is set, then only a logfile is required
|
|
186
228
|
|
|
187
|
-
|
|
188
|
-
|
|
229
|
+
EXAMPLES
|
|
230
|
+
General Usage
|
|
231
|
+
csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION
|
|
232
|
+
ENVIRONMENT] --locales [LOCALE] -a [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
|
|
189
233
|
|
|
190
|
-
|
|
191
|
-
|
|
234
|
+
Using --config or -c flag
|
|
235
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
236
|
+
csdx cm:bulk-publish:cross-publish --config [PATH TO CONFIG FILE]
|
|
237
|
+
csdx cm:bulk-publish:cross-publish -c [PATH TO CONFIG FILE]
|
|
238
|
+
|
|
239
|
+
Using --retry-failed flag
|
|
240
|
+
csdx cm:bulk-publish:cross-publish --retry-failed [LOG FILE NAME]
|
|
241
|
+
csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]
|
|
242
|
+
|
|
243
|
+
Using --branch flag
|
|
244
|
+
csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION
|
|
245
|
+
ENVIRONMENT] --locales [LOCALE] -a [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
192
246
|
```
|
|
193
247
|
|
|
194
|
-
_See code: [src/commands/cm/bulk-publish/
|
|
248
|
+
_See code: [src/commands/cm/bulk-publish/cross-publish.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js)_
|
|
195
249
|
|
|
196
|
-
## `csdx cm:bulk-publish
|
|
250
|
+
## `csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`
|
|
197
251
|
|
|
198
|
-
Publish entries
|
|
252
|
+
Publish entries from multiple contenttypes to multiple environments and locales
|
|
199
253
|
|
|
200
254
|
```
|
|
201
255
|
USAGE
|
|
202
|
-
$ csdx cm:bulk-publish
|
|
256
|
+
$ csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types]
|
|
257
|
+
[--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token
|
|
258
|
+
<value>] [--source-env <value>]
|
|
203
259
|
|
|
204
260
|
OPTIONS
|
|
205
|
-
-
|
|
261
|
+
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
|
|
262
|
+
is selected)
|
|
206
263
|
|
|
207
|
-
-
|
|
208
|
-
contentstack's bulkpublish API will be used for publishing the entries
|
|
264
|
+
-a, --alias=alias Alias(name) for the management token
|
|
209
265
|
|
|
210
|
-
-c, --config=config
|
|
266
|
+
-c, --config=config Path for the external config file (A new config file can be generated at the current
|
|
267
|
+
working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
|
|
211
268
|
|
|
212
|
-
-
|
|
269
|
+
-e, --environments=environments Environments where entries will be published
|
|
213
270
|
|
|
214
|
-
-
|
|
271
|
+
-l, --locales=locales Locales where entries will be published
|
|
215
272
|
|
|
216
|
-
-
|
|
273
|
+
-y, --yes Agree to process the command with the current configuration
|
|
217
274
|
|
|
218
|
-
-
|
|
219
|
-
|
|
275
|
+
--bulk-publish=bulk-publish [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
276
|
+
bulkpublish API will be used to publish the entries
|
|
220
277
|
|
|
221
|
-
-
|
|
278
|
+
--content-types=content-types The Contenttypes from which entries need to be published
|
|
222
279
|
|
|
223
|
-
-
|
|
280
|
+
--delivery-token=delivery-token Delivery token for source environment
|
|
224
281
|
|
|
225
|
-
-
|
|
282
|
+
--publish-all-content-types (optional) Publish all contenttypes (cannot be set when contentTypes flag is set)
|
|
226
283
|
|
|
227
|
-
--
|
|
284
|
+
--retry-failed=retry-failed (optional) Retry failed entries from the logfile (overrides all other flags) This
|
|
285
|
+
flag is used to retry publishing entries that failed to publish in a previous
|
|
286
|
+
attempt. A log file for the previous session will be required for processing the
|
|
287
|
+
failed entries
|
|
228
288
|
|
|
229
|
-
--
|
|
289
|
+
--source-env=source-env Source environment
|
|
230
290
|
|
|
231
291
|
DESCRIPTION
|
|
232
|
-
The
|
|
292
|
+
The publish command is used to publish entries from the specified content types, to the
|
|
293
|
+
specified environments and locales
|
|
233
294
|
|
|
234
|
-
Content
|
|
235
|
-
But, if
|
|
295
|
+
Note: Content Types, Environments and Locales are required to execute the command successfully
|
|
296
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
297
|
+
|
|
298
|
+
ALIASES
|
|
299
|
+
$ csdx cm:bulk-publish:entries
|
|
236
300
|
|
|
237
301
|
EXAMPLES
|
|
238
302
|
General Usage
|
|
239
|
-
csdx cm:
|
|
240
|
-
|
|
303
|
+
csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales
|
|
304
|
+
[LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
241
305
|
|
|
242
306
|
Using --config or -c flag
|
|
243
|
-
Generate a config file at the current working directory using `csdx cm:
|
|
244
|
-
csdx cm:
|
|
245
|
-
csdx cm:
|
|
307
|
+
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
308
|
+
csdx cm:entries:publish --config [PATH TO CONFIG FILE]
|
|
309
|
+
csdx cm:entries:publish -c [PATH TO CONFIG FILE]
|
|
246
310
|
|
|
247
|
-
Using --
|
|
248
|
-
csdx cm:
|
|
249
|
-
csdx cm:
|
|
311
|
+
Using --retry-failed
|
|
312
|
+
csdx cm:entries:publish --retry-failed [LOG FILE NAME]
|
|
313
|
+
csdx cm:entries:publish -r [LOG FILE NAME]
|
|
314
|
+
|
|
315
|
+
Using --branch
|
|
316
|
+
csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales
|
|
317
|
+
[LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
318
|
+
|
|
319
|
+
Using --source-env
|
|
320
|
+
csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales
|
|
321
|
+
[LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
250
322
|
```
|
|
251
323
|
|
|
252
|
-
_See code: [src/commands/cm/
|
|
324
|
+
_See code: [src/commands/cm/entries/publish.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js)_
|
|
253
325
|
|
|
254
|
-
## `csdx cm:bulk-publish
|
|
326
|
+
## `csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
255
327
|
|
|
256
|
-
Publish entries from
|
|
328
|
+
Publish edited entries from a specified content type to the given locales and environments
|
|
257
329
|
|
|
258
330
|
```
|
|
259
331
|
USAGE
|
|
260
|
-
$ csdx cm:bulk-publish
|
|
332
|
+
$ csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env
|
|
333
|
+
<value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
261
334
|
|
|
262
335
|
OPTIONS
|
|
263
|
-
-
|
|
336
|
+
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
|
|
337
|
+
is selected)
|
|
264
338
|
|
|
265
|
-
-
|
|
266
|
-
bulkpublish API will be used for publishing the entries
|
|
339
|
+
-a, --alias=alias Alias(name) for the management token
|
|
267
340
|
|
|
268
|
-
-c, --config=config Path
|
|
269
|
-
the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
|
|
341
|
+
-c, --config=config Path to the config file
|
|
270
342
|
|
|
271
|
-
-e, --environments=environments
|
|
343
|
+
-e, --environments=environments Destination environments
|
|
272
344
|
|
|
273
|
-
-l, --locales=locales Locales
|
|
345
|
+
-l, --locales=locales Locales where edited entries will be published
|
|
274
346
|
|
|
275
|
-
-
|
|
347
|
+
-y, --yes Agree to process the command with the current configuration
|
|
276
348
|
|
|
277
|
-
-
|
|
278
|
-
|
|
279
|
-
log file for the previous session will be required for processing the failed entries
|
|
349
|
+
--bulk-publish=bulk-publish [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
350
|
+
bulkpublish API will be used to publish the entries
|
|
280
351
|
|
|
281
|
-
-
|
|
352
|
+
--content-types=content-types The Contenttypes which will be checked for edited entries
|
|
282
353
|
|
|
283
|
-
-
|
|
354
|
+
--retry-failed=retry-failed Retry publishing failed entries from the logfile (optional, overrides all other
|
|
355
|
+
flags)
|
|
356
|
+
|
|
357
|
+
--source-env=source-env Environment from which edited entries will be published
|
|
284
358
|
|
|
285
359
|
DESCRIPTION
|
|
286
|
-
The
|
|
287
|
-
specified environments and locales
|
|
360
|
+
The publish-modified command is used to publish entries from the specified content types, to the
|
|
361
|
+
specified environments and locales
|
|
288
362
|
|
|
289
|
-
Content
|
|
290
|
-
|
|
363
|
+
Note: Content type(s), Source Environment, Destination Environment(s) and Locale(s) are required to execute the
|
|
364
|
+
command successfully
|
|
365
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
366
|
+
|
|
367
|
+
ALIASES
|
|
368
|
+
$ csdx cm:bulk-publish:entry-edits
|
|
291
369
|
|
|
292
370
|
EXAMPLES
|
|
293
371
|
General Usage
|
|
294
|
-
csdx cm:
|
|
295
|
-
[LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
372
|
+
csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e
|
|
373
|
+
[ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
296
374
|
|
|
297
375
|
Using --config or -c flag
|
|
298
|
-
Generate a config file at the current working directory using `csdx cm:
|
|
299
|
-
csdx cm:
|
|
300
|
-
csdx cm:
|
|
376
|
+
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
377
|
+
csdx cm:entries:publish-modified --config [PATH TO CONFIG FILE]
|
|
378
|
+
csdx cm:entries:publish-modified -c [PATH TO CONFIG FILE]
|
|
379
|
+
|
|
380
|
+
Using --retry-failed
|
|
381
|
+
csdx cm:entries:publish-modified --retry-failed [LOG FILE NAME]
|
|
382
|
+
csdx cm:entries:publish-modified -r [LOG FILE NAME]
|
|
301
383
|
|
|
302
|
-
Using --
|
|
303
|
-
csdx cm:
|
|
304
|
-
|
|
384
|
+
Using --branch
|
|
385
|
+
csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e
|
|
386
|
+
[ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
305
387
|
```
|
|
306
388
|
|
|
307
|
-
_See code: [src/commands/cm/
|
|
389
|
+
_See code: [src/commands/cm/entries/publish-modified.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-modified.js)_
|
|
308
390
|
|
|
309
|
-
## `csdx cm:bulk-publish
|
|
391
|
+
## `csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
310
392
|
|
|
311
|
-
Publish
|
|
393
|
+
Publish non-localized fields for the given content types, from a particular source environment to the specified environments
|
|
312
394
|
|
|
313
395
|
```
|
|
314
396
|
USAGE
|
|
315
|
-
$ csdx cm:bulk-publish
|
|
397
|
+
$ csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
398
|
+
[--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
316
399
|
|
|
317
400
|
OPTIONS
|
|
318
|
-
-
|
|
401
|
+
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
|
|
402
|
+
is selected)
|
|
319
403
|
|
|
320
|
-
-
|
|
321
|
-
bulkpublish API will be used for publishing the entries
|
|
404
|
+
-a, --alias=alias Alias(name) for the management token
|
|
322
405
|
|
|
323
|
-
-c, --config=config Path to config file
|
|
406
|
+
-c, --config=config Path to the config file
|
|
324
407
|
|
|
325
408
|
-e, --environments=environments Destination environments
|
|
326
409
|
|
|
327
|
-
-
|
|
410
|
+
-y, --yes Agree to process the command with the current configuration
|
|
328
411
|
|
|
329
|
-
-
|
|
330
|
-
|
|
412
|
+
--bulk-publish=bulk-publish [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
413
|
+
bulkpublish API will be used to publish the entries
|
|
331
414
|
|
|
332
|
-
-
|
|
415
|
+
--content-types=content-types The Contenttypes from which entries will be published
|
|
333
416
|
|
|
334
|
-
-
|
|
417
|
+
--retry-failed=retry-failed Retry publishing failed entries from the logfile
|
|
335
418
|
|
|
336
|
-
-
|
|
419
|
+
--source-env=source-env Source Environment
|
|
337
420
|
|
|
338
421
|
DESCRIPTION
|
|
339
|
-
The
|
|
340
|
-
|
|
422
|
+
The non-localized field changes command is used to publish non-localized field changes from the given content types to
|
|
423
|
+
the specified environments
|
|
341
424
|
|
|
342
|
-
Content
|
|
343
|
-
successfully
|
|
425
|
+
Note: Content types, Environments and Source Environment are required to execute this command successfully.
|
|
344
426
|
But, if retryFailed flag is set, then only a logfile is required
|
|
345
427
|
|
|
428
|
+
ALIASES
|
|
429
|
+
$ csdx cm:bulk-publish:nonlocalized-field-changes
|
|
430
|
+
|
|
346
431
|
EXAMPLES
|
|
347
432
|
General Usage
|
|
348
|
-
csdx cm:
|
|
349
|
-
|
|
433
|
+
csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments
|
|
434
|
+
[ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV]
|
|
350
435
|
|
|
351
436
|
Using --config or -c flag
|
|
352
437
|
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
353
|
-
csdx cm:
|
|
354
|
-
csdx cm:
|
|
438
|
+
csdx cm:entries:publish-non-localized-fields --config [PATH TO CONFIG FILE]
|
|
439
|
+
csdx cm:entries:publish-non-localized-fields -c [PATH TO CONFIG FILE]
|
|
440
|
+
|
|
441
|
+
Using --retry-failed flag
|
|
442
|
+
csdx cm:entries:publish-non-localized-fields --retry-failed [LOG FILE NAME]
|
|
355
443
|
|
|
356
|
-
Using --
|
|
357
|
-
csdx cm:
|
|
358
|
-
|
|
444
|
+
Using --branch flag
|
|
445
|
+
csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments
|
|
446
|
+
[ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV] --branch [BRANCH NAME]
|
|
359
447
|
```
|
|
360
448
|
|
|
361
|
-
_See code: [src/commands/cm/
|
|
449
|
+
_See code: [src/commands/cm/entries/publish-non-localized-fields.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-non-localized-fields.js)_
|
|
362
450
|
|
|
363
|
-
## `csdx cm:bulk-publish
|
|
451
|
+
## `csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
364
452
|
|
|
365
|
-
Publish
|
|
453
|
+
Publish unpublished entries from the source environment, to other environments and locales
|
|
366
454
|
|
|
367
455
|
```
|
|
368
456
|
USAGE
|
|
369
|
-
$ csdx cm:bulk-publish
|
|
457
|
+
$ csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
458
|
+
[--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
370
459
|
|
|
371
460
|
OPTIONS
|
|
372
|
-
-
|
|
461
|
+
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
|
|
462
|
+
is selected)
|
|
463
|
+
|
|
464
|
+
-a, --alias=alias Alias(name) for the management token
|
|
373
465
|
|
|
374
|
-
-b, --
|
|
375
|
-
bulkpublish API will be used
|
|
466
|
+
-b, --bulk-publish=bulk-publish [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
467
|
+
bulkpublish API will be used to publish the entries
|
|
376
468
|
|
|
377
|
-
-c, --config=config Path to config file
|
|
469
|
+
-c, --config=config Path to the config file
|
|
378
470
|
|
|
379
471
|
-e, --environments=environments Destination environments
|
|
380
472
|
|
|
381
|
-
-
|
|
473
|
+
-y, --yes Agree to process the command with the current configuration
|
|
474
|
+
|
|
475
|
+
--content-types=content-types The Contenttypes from which entries will be published
|
|
382
476
|
|
|
383
|
-
|
|
477
|
+
--locales=locales Source locale
|
|
384
478
|
|
|
385
|
-
-
|
|
479
|
+
--retry-failed=retry-failed Retry publishing failed entries from the logfile
|
|
386
480
|
|
|
387
|
-
-
|
|
481
|
+
--source-env=source-env Source Env
|
|
388
482
|
|
|
389
483
|
DESCRIPTION
|
|
390
|
-
The
|
|
391
|
-
|
|
392
|
-
the specified Environments
|
|
484
|
+
The publish-only-unpublished command is used to publish unpublished entries from the source environment, to other
|
|
485
|
+
environments and locales
|
|
393
486
|
|
|
394
|
-
Content
|
|
395
|
-
|
|
487
|
+
Note: Content type(s), Source Environment, Destination Environment(s) and Source Locale are required to execute the
|
|
488
|
+
command successfully
|
|
489
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
490
|
+
|
|
491
|
+
ALIASES
|
|
492
|
+
$ csdx cm:bulk-publish:unpublished-entries
|
|
396
493
|
|
|
397
494
|
EXAMPLES
|
|
398
495
|
General Usage
|
|
399
|
-
csdx cm:
|
|
400
|
-
|
|
496
|
+
csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a
|
|
497
|
+
[MANAGEMENT TOKEN ALIAS] -source-env [SOURCE ENV]
|
|
401
498
|
|
|
402
499
|
Using --config or -c flag
|
|
403
500
|
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
404
|
-
csdx cm:
|
|
405
|
-
csdx cm:
|
|
501
|
+
csdx cm:entries:publish-only-unpublished --config [PATH TO CONFIG FILE]
|
|
502
|
+
csdx cm:entries:publish-only-unpublished -c [PATH TO CONFIG FILE]
|
|
406
503
|
|
|
407
|
-
Using --
|
|
408
|
-
csdx cm:
|
|
409
|
-
|
|
504
|
+
Using --retry-failed
|
|
505
|
+
csdx cm:entries:publish-only-unpublished --retry-failed [LOG FILE NAME]
|
|
506
|
+
|
|
507
|
+
Using --branch
|
|
508
|
+
csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a
|
|
509
|
+
[MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME] -source-env [SOURCE ENV]
|
|
410
510
|
```
|
|
411
511
|
|
|
412
|
-
_See code: [src/commands/cm/
|
|
512
|
+
_See code: [src/commands/cm/entries/publish-only-unpublished.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-only-unpublished.js)_
|
|
413
513
|
|
|
414
|
-
## `csdx cm:
|
|
514
|
+
## `csdx cm:entries:unpublish`
|
|
415
515
|
|
|
416
|
-
|
|
516
|
+
Unpublish entries from the given environment
|
|
417
517
|
|
|
418
518
|
```
|
|
419
519
|
USAGE
|
|
420
|
-
$ csdx cm:
|
|
520
|
+
$ csdx cm:entries:unpublish
|
|
421
521
|
|
|
422
522
|
OPTIONS
|
|
423
|
-
-
|
|
424
|
-
-
|
|
523
|
+
-a, --alias=alias Alias(name) for the management token
|
|
524
|
+
-c, --config=config Path to the config file
|
|
525
|
+
-e, --environment=environment Source Environment
|
|
526
|
+
-y, --yes Agree to process the command with the current configuration
|
|
527
|
+
|
|
528
|
+
--branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
|
|
529
|
+
is selected)
|
|
530
|
+
|
|
531
|
+
--bulk-unpublish=bulk-unpublish [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
532
|
+
bulkpublish API will be used to unpublish the entries
|
|
533
|
+
|
|
534
|
+
--content-type=content-type Content type filter
|
|
535
|
+
|
|
536
|
+
--delivery-token=delivery-token Delivery token for source environment
|
|
537
|
+
|
|
538
|
+
--locale=locale Locale filter
|
|
539
|
+
|
|
540
|
+
--retry-failed=retry-failed Retry publishing failed entries from the logfile
|
|
425
541
|
|
|
426
542
|
DESCRIPTION
|
|
427
|
-
The
|
|
428
|
-
|
|
543
|
+
The unpublish command is used to unpublish entries from the given environment
|
|
544
|
+
|
|
545
|
+
Note: Environment (Source Environment) and Locale are required to execute the command successfully
|
|
546
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
429
547
|
|
|
430
548
|
EXAMPLES
|
|
431
|
-
|
|
432
|
-
cm:bulk-
|
|
433
|
-
|
|
549
|
+
General Usage
|
|
550
|
+
csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE]
|
|
551
|
+
--alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
|
|
552
|
+
|
|
553
|
+
Using --config or -c flag
|
|
554
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
|
|
555
|
+
csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]
|
|
556
|
+
csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]
|
|
557
|
+
|
|
558
|
+
Using --retry-failed flag
|
|
559
|
+
csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]
|
|
560
|
+
|
|
434
561
|
|
|
435
|
-
Using --
|
|
436
|
-
cm:bulk-
|
|
437
|
-
|
|
562
|
+
Using --branch flag
|
|
563
|
+
csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE]
|
|
564
|
+
--alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
438
565
|
```
|
|
439
566
|
|
|
440
|
-
_See code: [src/commands/cm/
|
|
567
|
+
_See code: [src/commands/cm/entries/unpublish.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/entries/unpublish.js)_
|
|
441
568
|
|
|
442
|
-
## `csdx cm:bulk-publish
|
|
569
|
+
## `csdx 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>]`
|
|
443
570
|
|
|
444
|
-
|
|
571
|
+
Add fields from updated content types to their respective entries
|
|
445
572
|
|
|
446
573
|
```
|
|
447
574
|
USAGE
|
|
448
|
-
$ csdx cm:bulk-publish
|
|
575
|
+
$ csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types
|
|
576
|
+
<value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
|
|
449
577
|
|
|
450
578
|
OPTIONS
|
|
451
|
-
-
|
|
579
|
+
-B, --branch=branch [default: main] Specify the branch to fetch the content (by default the main branch
|
|
580
|
+
is selected)
|
|
452
581
|
|
|
453
|
-
-
|
|
454
|
-
contentstack's bulkpublish API will be used for publishing the entries
|
|
582
|
+
-a, --alias=alias Alias(name) for the management token
|
|
455
583
|
|
|
456
|
-
-c, --config=config
|
|
584
|
+
-c, --config=config Path to the config file
|
|
457
585
|
|
|
458
|
-
-e, --
|
|
586
|
+
-e, --environments=environments Environments where entries will be published
|
|
459
587
|
|
|
460
|
-
-l, --
|
|
588
|
+
-l, --locales=locales Locales where entries will be published
|
|
461
589
|
|
|
462
|
-
-
|
|
590
|
+
-t, --contentTypes=contentTypes The Contenttypes from which entries will be published
|
|
463
591
|
|
|
464
|
-
-
|
|
592
|
+
-y, --yes Agree to process the command with the current configuration
|
|
465
593
|
|
|
466
|
-
-
|
|
594
|
+
--bulk-publish=bulk-publish [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
595
|
+
bulkpublish API will be used to publish the entries
|
|
467
596
|
|
|
468
|
-
-
|
|
597
|
+
--content-types=content-types The Contenttypes from which entries will be published
|
|
469
598
|
|
|
470
|
-
--
|
|
599
|
+
--force Update and publish all entries even if no fields have been added
|
|
471
600
|
|
|
472
|
-
--
|
|
601
|
+
--retry-failed=retry-failed Retry publishing failed entries from the logfile (optional, overrides all other
|
|
602
|
+
flags)
|
|
473
603
|
|
|
474
604
|
DESCRIPTION
|
|
475
|
-
The
|
|
605
|
+
The update-and-publish command is used to update existing entries with the updated schema of the respective content
|
|
606
|
+
type
|
|
476
607
|
|
|
477
|
-
|
|
478
|
-
But, if
|
|
608
|
+
Note: Content types, Environments and Locales are required to execute the command successfully
|
|
609
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
479
610
|
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
611
|
+
ALIASES
|
|
612
|
+
$ csdx cm:bulk-publish:add-fields
|
|
613
|
+
|
|
614
|
+
EXAMPLES
|
|
615
|
+
General Usage
|
|
616
|
+
csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT
|
|
617
|
+
2] --locale [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
618
|
+
|
|
619
|
+
Using --config or -c flag
|
|
620
|
+
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
621
|
+
csdx cm:entries:update-and-publish --config [PATH TO CONFIG FILE]
|
|
622
|
+
csdx cm:entries:update-and-publish -c [PATH TO CONFIG FILE]
|
|
623
|
+
|
|
624
|
+
Using --retry-failed
|
|
625
|
+
csdx cm:entries:update-and-publish --retry-failed [LOG FILE NAME]
|
|
626
|
+
|
|
627
|
+
Using --branch
|
|
628
|
+
csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT
|
|
629
|
+
2] --locale [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
630
|
+
```
|
|
631
|
+
|
|
632
|
+
_See code: [src/commands/cm/entries/update-and-publish.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/entries/update-and-publish.js)_
|
|
633
|
+
|
|
634
|
+
## `csdx cm:stacks:publish`
|
|
635
|
+
|
|
636
|
+
Publish entries and assets to multiple environments and locales
|
|
637
|
+
|
|
638
|
+
```
|
|
639
|
+
USAGE
|
|
640
|
+
$ csdx cm:stacks:publish
|
|
641
|
+
|
|
642
|
+
DESCRIPTION
|
|
643
|
+
The publish command is used to publish entries and assets, to the specified environments and locales.
|
|
483
644
|
|
|
484
|
-
|
|
485
|
-
|
|
645
|
+
Note: Content types, Environments and Locales are required to execute the publish entries command successfully.
|
|
646
|
+
Note: Environments and Locales are required to execute the publish assets command successfully.
|
|
647
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
486
648
|
|
|
487
649
|
EXAMPLES
|
|
488
650
|
General Usage
|
|
489
|
-
csdx cm:
|
|
490
|
-
|
|
651
|
+
csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN
|
|
652
|
+
ALIAS]
|
|
491
653
|
|
|
492
654
|
Using --config or -c flag
|
|
493
|
-
Generate a config file
|
|
494
|
-
csdx cm:
|
|
495
|
-
csdx cm:
|
|
655
|
+
Generate a config file in the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
656
|
+
csdx cm:stacks:publish --config [PATH TO CONFIG FILE]
|
|
657
|
+
csdx cm:stacks:publish -c [PATH TO CONFIG FILE]
|
|
496
658
|
|
|
497
|
-
Using --
|
|
498
|
-
csdx cm:
|
|
499
|
-
csdx cm:bulk-publish:unpublish -r [LOG FILE NAME]
|
|
659
|
+
Using --retry-failed flag
|
|
660
|
+
csdx cm:stacks:publish --retry-failed [LOG FILE NAME]
|
|
500
661
|
|
|
501
|
-
|
|
502
|
-
csdx cm:
|
|
503
|
-
|
|
662
|
+
Using --branch flag
|
|
663
|
+
csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN
|
|
664
|
+
ALIAS] --branch [BRANCH NAME]
|
|
665
|
+
```
|
|
504
666
|
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
667
|
+
_See code: [src/commands/cm/stacks/publish.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish.js)_
|
|
668
|
+
|
|
669
|
+
## `csdx cm:stacks:publish-clear-logs`
|
|
670
|
+
|
|
671
|
+
Clear the log folder
|
|
508
672
|
|
|
509
|
-
Using --onlyEntries
|
|
510
|
-
csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries (Will unpublish only
|
|
511
|
-
entries, all entries, from the source environment)
|
|
512
|
-
csdx cm:bulk-publish:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries
|
|
513
|
-
(Will unpublish only entries, (from CONTENT TYPE) from the source environment)
|
|
514
673
|
```
|
|
674
|
+
USAGE
|
|
675
|
+
$ csdx cm:stacks:publish-clear-logs
|
|
515
676
|
|
|
516
|
-
|
|
677
|
+
OPTIONS
|
|
678
|
+
-y, --yes Delete all files without asking for confirmation
|
|
679
|
+
--log-files-count List number of log files
|
|
517
680
|
|
|
518
|
-
|
|
681
|
+
ALIASES
|
|
682
|
+
$ csdx cm:bulk-publish:clear
|
|
519
683
|
|
|
520
|
-
|
|
684
|
+
EXAMPLES
|
|
685
|
+
csdx cm:stacks:publish-clear-logs
|
|
686
|
+
csdx cm:stacks:publish-clear-logs --log-files-count
|
|
687
|
+
csdx cm:stacks:publish-clear-logs --yes
|
|
688
|
+
csdx cm:stacks:publish-clear-logs -y
|
|
689
|
+
```
|
|
690
|
+
|
|
691
|
+
_See code: [src/commands/cm/stacks/publish-clear-logs.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-clear-logs.js)_
|
|
692
|
+
|
|
693
|
+
## `csdx cm:stacks:publish-configure`
|
|
694
|
+
|
|
695
|
+
The configure command is used to generate a configuration file for publish scripts.
|
|
521
696
|
|
|
522
697
|
```
|
|
523
698
|
USAGE
|
|
524
|
-
$ csdx cm:
|
|
699
|
+
$ csdx cm:stacks:publish-configure
|
|
525
700
|
|
|
526
701
|
OPTIONS
|
|
527
|
-
-a, --alias=alias
|
|
702
|
+
-a, --alias=alias Alias(name) for the management token
|
|
703
|
+
|
|
704
|
+
ALIASES
|
|
705
|
+
$ csdx cm:bulk-publish:configure
|
|
528
706
|
|
|
529
|
-
|
|
530
|
-
|
|
707
|
+
EXAMPLES
|
|
708
|
+
csdx cm:stacks:publish-configure
|
|
709
|
+
csdx cm:stacks:publish-configure -a <management_token_alias>
|
|
710
|
+
csdx cm:stacks:publish-configure --alias <management_token_alias>
|
|
711
|
+
```
|
|
531
712
|
|
|
532
|
-
|
|
713
|
+
_See code: [src/commands/cm/stacks/publish-configure.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-configure.js)_
|
|
533
714
|
|
|
534
|
-
|
|
715
|
+
## `csdx cm:stacks:publish-revert`
|
|
716
|
+
|
|
717
|
+
Revert publish operations by using a log file
|
|
718
|
+
|
|
719
|
+
```
|
|
720
|
+
USAGE
|
|
721
|
+
$ csdx cm:stacks:publish-revert
|
|
722
|
+
|
|
723
|
+
OPTIONS
|
|
724
|
+
--log-file=log-file logfile to be used to revert
|
|
725
|
+
--retry-failed=retry-failed retry publishing failed entries from the logfile
|
|
726
|
+
|
|
727
|
+
DESCRIPTION
|
|
728
|
+
The revert command is used to revert all publish operations performed using bulk-publish script.
|
|
729
|
+
A log file name is required to execute revert command
|
|
730
|
+
|
|
731
|
+
ALIASES
|
|
732
|
+
$ csdx cm:bulk-publish:revert
|
|
733
|
+
|
|
734
|
+
EXAMPLES
|
|
735
|
+
Using --log-file
|
|
736
|
+
cm:bulk-publish:revert --log-file [LOG FILE NAME]
|
|
535
737
|
|
|
536
|
-
|
|
738
|
+
Using --retry-failed
|
|
739
|
+
cm:bulk-publish:revert --retry-failed [LOG FILE NAME]
|
|
740
|
+
```
|
|
537
741
|
|
|
538
|
-
|
|
742
|
+
_See code: [src/commands/cm/stacks/publish-revert.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-revert.js)_
|
|
539
743
|
|
|
540
|
-
|
|
744
|
+
## `csdx 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]`
|
|
541
745
|
|
|
542
|
-
|
|
746
|
+
Unpublish entries or assets of given content types from the specified environment
|
|
543
747
|
|
|
748
|
+
```
|
|
749
|
+
USAGE
|
|
750
|
+
$ csdx csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>]
|
|
751
|
+
[--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>]
|
|
752
|
+
[--only-assets] [--only-entries]
|
|
753
|
+
|
|
754
|
+
OPTIONS
|
|
755
|
+
-B, --branch=branch [default: main] Specify the branch to fetch the content from (default is main branch)
|
|
756
|
+
-a, --alias=alias Alias(name) for the management token
|
|
757
|
+
-c, --config=config Path to the config file
|
|
758
|
+
-e, --environment=environment Source Environment
|
|
759
|
+
-l, --locale=locale Locale filter
|
|
544
760
|
-y, --yes Agree to process the command with the current configuration
|
|
545
761
|
|
|
762
|
+
--bulk-unpublish=bulk-unpublish [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
763
|
+
bulkpublish API will be used to unpublish the entries and assets
|
|
764
|
+
|
|
765
|
+
--content-type=content-type Content type filter
|
|
766
|
+
|
|
767
|
+
--delivery-token=delivery-token Delivery token for source environment
|
|
768
|
+
|
|
769
|
+
--retry-failed=retry-failed Retry publishing failed entries from the logfile (optional, overrides all other
|
|
770
|
+
flags)
|
|
771
|
+
|
|
546
772
|
DESCRIPTION
|
|
547
|
-
The
|
|
548
|
-
environments and locales
|
|
773
|
+
The unpublish command is used to unpublish entries or assets from given environment
|
|
549
774
|
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
775
|
+
Environment (Source Environment) and Locale are required to execute the command successfully
|
|
776
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
777
|
+
|
|
778
|
+
A content type can be specified for unpublishing entries, but if no content-type(s) is/are specified and --only-assets
|
|
779
|
+
is not used,
|
|
780
|
+
then all entries from all content types will be unpublished from the source environment
|
|
781
|
+
|
|
782
|
+
Note: --only-assets can be used to unpublish only assets and --only-entries can be used to unpublish only entries.
|
|
783
|
+
(--only-assets and --only-entries cannot be used together at the same time)
|
|
784
|
+
|
|
785
|
+
ALIASES
|
|
786
|
+
$ csdx cm:bulk-publish:unpublish
|
|
553
787
|
|
|
554
788
|
EXAMPLES
|
|
555
789
|
General Usage
|
|
556
|
-
csdx cm:
|
|
790
|
+
csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE]
|
|
791
|
+
--alias [MANAGEMENT TOKEN ALIAS] ----delivery-token [DELIVERY TOKEN]
|
|
557
792
|
|
|
558
793
|
Using --config or -c flag
|
|
559
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure
|
|
560
|
-
csdx cm:
|
|
561
|
-
csdx cm:
|
|
794
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
|
|
795
|
+
csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]
|
|
796
|
+
csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]
|
|
797
|
+
|
|
798
|
+
Using --retry-failed flag
|
|
799
|
+
csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]
|
|
800
|
+
|
|
801
|
+
No content type
|
|
802
|
+
csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all content
|
|
803
|
+
types and assets from the source environment)
|
|
804
|
+
|
|
805
|
+
Using --only-assets
|
|
806
|
+
csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-assets (Will unpublish only assets from
|
|
807
|
+
the source environment)
|
|
808
|
+
|
|
809
|
+
Using --only-entries
|
|
810
|
+
csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, all
|
|
811
|
+
entries, from the source environment)
|
|
812
|
+
csdx cm:stacks:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --only-entries
|
|
813
|
+
(Will unpublish only entries, (from CONTENT TYPE) from the source environment)
|
|
562
814
|
|
|
563
|
-
Using --
|
|
564
|
-
csdx cm:bulk-
|
|
565
|
-
|
|
815
|
+
Using --branch flag
|
|
816
|
+
csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE]
|
|
817
|
+
--alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
566
818
|
```
|
|
567
819
|
|
|
568
|
-
_See code: [src/commands/cm/
|
|
820
|
+
_See code: [src/commands/cm/stacks/unpublish.js](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/stacks/unpublish.js)_
|
|
569
821
|
<!-- commandsstop -->
|