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