@contentstack/cli 0.1.1-beta.9 → 1.0.2
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 +1137 -665
- package/bin/run +1 -4
- package/lib/config/index.js +9 -0
- package/lib/help.js +38 -0
- package/lib/hooks/init/context-init.js +10 -0
- package/lib/hooks/init/utils-init.js +12 -0
- package/lib/hooks/prerun/auth-guard.js +40 -0
- package/lib/hooks/prerun/command-deprecation-check.js +10 -0
- package/lib/index.js +3 -0
- package/lib/interfaces/index.js +2 -0
- package/lib/utils/context-handler.js +39 -0
- package/lib/utils/index.js +5 -0
- package/oclif.manifest.json +1 -1
- package/package.json +98 -66
- package/src/commands/config/get/region.js +0 -17
- package/src/commands/config/set/region.js +0 -70
- package/src/help.js +0 -20
- package/src/hooks/init.js +0 -21
- package/src/hooks/prerun/analytics.js +0 -40
- package/src/hooks/prerun/print-region.js +0 -11
- package/src/hooks/validate-auth-token.js +0 -7
- package/src/hooks/validate-management-token.js +0 -19
- package/src/index.js +0 -1
- package/src/util/analytics.js +0 -61
- package/src/util/contentstack-client.js +0 -17
- package/src/util/custom-errors.js +0 -7
- package/src/util/request.js +0 -71
- package/src/util/user-config.js +0 -128
package/README.md
CHANGED
|
@@ -1,59 +1,66 @@
|
|
|
1
|
-
@contentstack/cli
|
|
2
|
-
===
|
|
1
|
+
# @contentstack/cli-auth
|
|
3
2
|
|
|
4
|
-
Use Contentstack Command-line Interface to command Contentstack for executing a set of operations from the terminal. To get started with CLI, refer to the
|
|
3
|
+
Use Contentstack Command-line Interface to command Contentstack for executing a set of operations from the terminal. To get started with CLI, refer to the [CLI’s documentation](https://www.contentstack.com/docs/developers/cli)
|
|
5
4
|
|
|
6
5
|
[](https://github.com/contentstack/cli/blob/main/LICENSE)
|
|
7
6
|
|
|
8
7
|
<!-- toc -->
|
|
8
|
+
* [@contentstack/cli-auth](#contentstackcli-auth)
|
|
9
9
|
* [Usage](#usage)
|
|
10
10
|
* [Commands](#commands)
|
|
11
11
|
<!-- tocstop -->
|
|
12
|
+
|
|
12
13
|
# Usage
|
|
14
|
+
|
|
13
15
|
<!-- usage -->
|
|
14
16
|
```sh-session
|
|
15
17
|
$ npm install -g @contentstack/cli
|
|
16
18
|
$ csdx COMMAND
|
|
17
19
|
running command...
|
|
18
20
|
$ csdx (-v|--version|version)
|
|
19
|
-
@contentstack/cli/
|
|
21
|
+
@contentstack/cli/1.0.2 linux-x64 node-v16.15.1
|
|
20
22
|
$ csdx --help [COMMAND]
|
|
21
23
|
USAGE
|
|
22
24
|
$ csdx COMMAND
|
|
23
25
|
...
|
|
24
26
|
```
|
|
25
27
|
<!-- usagestop -->
|
|
28
|
+
|
|
26
29
|
# Commands
|
|
30
|
+
|
|
27
31
|
<!-- commands -->
|
|
28
32
|
* [`csdx auth:login`](#csdx-authlogin)
|
|
29
33
|
* [`csdx auth:logout`](#csdx-authlogout)
|
|
30
34
|
* [`csdx auth:tokens`](#csdx-authtokens)
|
|
31
|
-
* [`csdx auth:tokens:add`](#csdx-authtokensadd)
|
|
35
|
+
* [`csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]`](#csdx-authtokensadd--a-value---delivery---management--e-value--k-value--y---token-value)
|
|
32
36
|
* [`csdx auth:tokens:remove`](#csdx-authtokensremove)
|
|
33
37
|
* [`csdx auth:whoami`](#csdx-authwhoami)
|
|
38
|
+
* [`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)
|
|
39
|
+
* [`csdx cm:assets:unpublish`](#csdx-cmassetsunpublish)
|
|
40
|
+
* [`csdx cm:bootstrap`](#csdx-cmbootstrap)
|
|
34
41
|
* [`csdx cm:bulk-publish`](#csdx-cmbulk-publish)
|
|
35
|
-
* [`csdx cm:bulk-publish:
|
|
36
|
-
* [`csdx cm:
|
|
37
|
-
* [`csdx cm:bulk-publish
|
|
38
|
-
* [`csdx cm:bulk-publish
|
|
39
|
-
* [`csdx cm:bulk-publish
|
|
40
|
-
* [`csdx cm:bulk-publish
|
|
41
|
-
* [`csdx cm:
|
|
42
|
-
* [`csdx cm:bulk-publish
|
|
43
|
-
* [`csdx cm:bulk-publish:revert`](#csdx-cmbulk-publishrevert)
|
|
44
|
-
* [`csdx cm:bulk-publish:unpublish`](#csdx-cmbulk-publishunpublish)
|
|
45
|
-
* [`csdx cm:bulk-publish:unpublished-entries`](#csdx-cmbulk-publishunpublished-entries)
|
|
46
|
-
* [`csdx cm:export`](#csdx-cmexport)
|
|
42
|
+
* [`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)
|
|
43
|
+
* [`csdx cm:entries:migrate-html-rte`](#csdx-cmentriesmigrate-html-rte)
|
|
44
|
+
* [`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)
|
|
45
|
+
* [`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)
|
|
46
|
+
* [`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)
|
|
47
|
+
* [`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)
|
|
48
|
+
* [`csdx cm:entries:unpublish`](#csdx-cmentriesunpublish)
|
|
49
|
+
* [`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)
|
|
47
50
|
* [`csdx cm:export-to-csv`](#csdx-cmexport-to-csv)
|
|
48
|
-
* [`csdx cm:import`](#csdx-
|
|
49
|
-
* [`csdx cm:
|
|
50
|
-
* [`csdx cm:
|
|
51
|
-
* [`csdx cm:
|
|
51
|
+
* [`csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent)
|
|
52
|
+
* [`csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets)
|
|
53
|
+
* [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent)
|
|
54
|
+
* [`csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple)
|
|
55
|
+
* [`csdx cm:stacks:publish`](#csdx-cmstackspublish)
|
|
56
|
+
* [`csdx cm:stacks:publish-clear-logs`](#csdx-cmstackspublish-clear-logs)
|
|
57
|
+
* [`csdx cm:stacks:publish-configure`](#csdx-cmstackspublish-configure)
|
|
58
|
+
* [`csdx cm:stacks:publish-revert`](#csdx-cmstackspublish-revert)
|
|
59
|
+
* [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]`](#csdx-cmstacksseed---repo-value---org-value--k-value--n-value--y-value--s-value)
|
|
60
|
+
* [`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)
|
|
52
61
|
* [`csdx config:get:region`](#csdx-configgetregion)
|
|
53
62
|
* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
|
|
54
|
-
* [`csdx help [COMMAND]`](#csdx-help-command)
|
|
55
63
|
* [`csdx plugins`](#csdx-plugins)
|
|
56
|
-
* [`csdx plugins:create`](#csdx-pluginscreate)
|
|
57
64
|
* [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin)
|
|
58
65
|
* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin)
|
|
59
66
|
* [`csdx plugins:link PLUGIN`](#csdx-pluginslink-plugin)
|
|
@@ -62,1076 +69,1537 @@ USAGE
|
|
|
62
69
|
|
|
63
70
|
## `csdx auth:login`
|
|
64
71
|
|
|
65
|
-
|
|
72
|
+
User sessions login
|
|
66
73
|
|
|
67
74
|
```
|
|
68
|
-
Login to Contentstack and save the session for further use
|
|
69
|
-
|
|
70
75
|
USAGE
|
|
71
|
-
$ csdx auth:login
|
|
76
|
+
$ csdx auth:login [-u <value>] [-p <value>]
|
|
72
77
|
|
|
73
|
-
|
|
74
|
-
-
|
|
78
|
+
FLAGS
|
|
79
|
+
-p, --password=<value> Password
|
|
80
|
+
-u, --username=<value> User name
|
|
81
|
+
|
|
82
|
+
DESCRIPTION
|
|
83
|
+
User sessions login
|
|
75
84
|
|
|
76
85
|
ALIASES
|
|
77
86
|
$ csdx login
|
|
87
|
+
|
|
88
|
+
EXAMPLES
|
|
89
|
+
$ csdx auth:login
|
|
90
|
+
|
|
91
|
+
$ csdx auth:login -u <username>
|
|
92
|
+
|
|
93
|
+
$ csdx auth:login -u <username> -p <password>
|
|
94
|
+
|
|
95
|
+
$ csdx auth:login --username <username>
|
|
96
|
+
|
|
97
|
+
$ csdx auth:login --username <username> --password <password>
|
|
78
98
|
```
|
|
79
99
|
|
|
80
|
-
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/
|
|
100
|
+
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v1.0.0/src/commands/auth/login.ts)_
|
|
81
101
|
|
|
82
102
|
## `csdx auth:logout`
|
|
83
103
|
|
|
84
|
-
|
|
104
|
+
User session logout
|
|
85
105
|
|
|
86
106
|
```
|
|
87
|
-
Log out from Contentstack and clear the session
|
|
88
|
-
|
|
89
107
|
USAGE
|
|
90
|
-
$ csdx auth:logout
|
|
108
|
+
$ csdx auth:logout [-y]
|
|
109
|
+
|
|
110
|
+
FLAGS
|
|
111
|
+
-y, --yes Force log out by skipping the confirmation
|
|
91
112
|
|
|
92
|
-
|
|
93
|
-
|
|
113
|
+
DESCRIPTION
|
|
114
|
+
User session logout
|
|
94
115
|
|
|
95
116
|
ALIASES
|
|
96
117
|
$ csdx logout
|
|
118
|
+
|
|
119
|
+
EXAMPLES
|
|
120
|
+
$ csdx auth:logout
|
|
121
|
+
|
|
122
|
+
$ csdx auth:logout -y
|
|
123
|
+
|
|
124
|
+
$ csdx auth:logout --yes
|
|
97
125
|
```
|
|
98
126
|
|
|
99
|
-
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/
|
|
127
|
+
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v1.0.0/src/commands/auth/logout.ts)_
|
|
100
128
|
|
|
101
129
|
## `csdx auth:tokens`
|
|
102
130
|
|
|
103
131
|
Lists all existing tokens added to the session
|
|
104
132
|
|
|
105
133
|
```
|
|
106
|
-
Lists all existing tokens added to the session
|
|
107
|
-
|
|
108
|
-
|
|
109
134
|
USAGE
|
|
110
|
-
$ csdx auth:tokens
|
|
135
|
+
$ csdx auth:tokens [--columns <value>] [--sort <value>] [--filter <value>] [--csv] [--output csv|json|yaml]
|
|
136
|
+
[-x] [--no-truncate] [--no-header]
|
|
137
|
+
|
|
138
|
+
FLAGS
|
|
139
|
+
-x, --extended show extra columns
|
|
140
|
+
--columns=<value> only show provided columns (comma-separated)
|
|
141
|
+
--csv output is csv format [alias: --output=csv]
|
|
142
|
+
--filter=<value> filter property by partial string matching, ex: name=foo
|
|
143
|
+
--no-header hide table header from output
|
|
144
|
+
--no-truncate do not truncate output to fit screen
|
|
145
|
+
--output=<option> output in a more machine friendly format
|
|
146
|
+
<options: csv|json|yaml>
|
|
147
|
+
--sort=<value> property to sort by (prepend '-' for descending)
|
|
111
148
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
--columns=columns only show provided columns (comma-separated)
|
|
115
|
-
--csv output is csv format [alias: --output=csv]
|
|
116
|
-
--filter=filter filter property by partial string matching, ex: name=foo
|
|
117
|
-
--no-header hide table header from output
|
|
118
|
-
--no-truncate do not truncate output to fit screen
|
|
119
|
-
--output=csv|json|yaml output in a more machine friendly format
|
|
120
|
-
--sort=sort property to sort by (prepend '-' for descending)
|
|
149
|
+
DESCRIPTION
|
|
150
|
+
Lists all existing tokens added to the session
|
|
121
151
|
|
|
122
152
|
ALIASES
|
|
123
153
|
$ csdx tokens
|
|
154
|
+
|
|
155
|
+
EXAMPLES
|
|
156
|
+
$ csdx auth:tokens
|
|
124
157
|
```
|
|
125
158
|
|
|
126
|
-
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/
|
|
159
|
+
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v1.0.0/src/commands/auth/tokens/index.ts)_
|
|
127
160
|
|
|
128
|
-
## `csdx auth:tokens:add`
|
|
161
|
+
## `csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]`
|
|
129
162
|
|
|
130
|
-
Adds management/delivery tokens to your session to use it with
|
|
163
|
+
Adds management/delivery tokens to your session to use it with other CLI commands
|
|
131
164
|
|
|
132
165
|
```
|
|
133
|
-
Adds management/delivery tokens to your session to use it with further CLI command
|
|
134
|
-
by default it adds management token if either of management or delivery flags are not set
|
|
135
|
-
|
|
136
166
|
USAGE
|
|
167
|
+
$ csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]
|
|
168
|
+
|
|
169
|
+
FLAGS
|
|
170
|
+
-a, --alias=<value> Name of the token alias
|
|
171
|
+
-d, --delivery Set this flag to save delivery token
|
|
172
|
+
-e, --environment=<value> Environment name for delivery token
|
|
173
|
+
-k, --stack-api-key=<value> Stack API Key
|
|
174
|
+
-m, --management Set this flag to save management token
|
|
175
|
+
-t, --token=<value> Add the token name
|
|
176
|
+
-y, --yes Use this flag to skip confirmation
|
|
177
|
+
|
|
178
|
+
DESCRIPTION
|
|
179
|
+
Adds management/delivery tokens to your session to use it with other CLI commands
|
|
180
|
+
|
|
181
|
+
EXAMPLES
|
|
137
182
|
$ csdx auth:tokens:add
|
|
138
183
|
|
|
139
|
-
|
|
140
|
-
-a, --alias=alias
|
|
141
|
-
-d, --delivery Set this while saving delivery token
|
|
142
|
-
-e, --environment=environment Environment name for delivery token
|
|
143
|
-
-f, --force Exclude confirmation to replace existing alias
|
|
144
|
-
-k, --api-key=api-key Stack API key for the token
|
|
145
|
-
-m, --management Set this while saving management token
|
|
184
|
+
$ csdx auth:tokens:add -a <alias>
|
|
146
185
|
|
|
147
|
-
|
|
148
|
-
variable
|
|
186
|
+
$ csdx auth:tokens:add -k <stack api key>
|
|
149
187
|
|
|
150
|
-
|
|
151
|
-
by default it adds management token if either of management or delivery flags are not set
|
|
188
|
+
$ csdx auth:tokens:add --delivery
|
|
152
189
|
|
|
153
|
-
|
|
154
|
-
|
|
190
|
+
$ csdx auth:tokens:add --management
|
|
191
|
+
|
|
192
|
+
$ csdx auth:tokens:add -e <environment>
|
|
193
|
+
|
|
194
|
+
$ csdx auth:tokens:add --token <token>
|
|
195
|
+
|
|
196
|
+
$ csdx auth:tokens:add -a <alias> -k <stack api key> --management --token <management token>
|
|
197
|
+
|
|
198
|
+
$ csdx auth:tokens:add -a <alias> -k <stack api key> --delivery -e <environment> --token <delivery token>
|
|
199
|
+
|
|
200
|
+
$ csdx auth:tokens:add --alias <alias> --stack-api-key <stack api key> --management --token <management token>
|
|
201
|
+
|
|
202
|
+
$ csdx auth:tokens:add --alias <alias> --stack-api-key <stack api key> --delivery -e <environment> --token <delivery token>
|
|
155
203
|
```
|
|
156
204
|
|
|
157
|
-
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/
|
|
205
|
+
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v1.0.0/src/commands/auth/tokens/add.ts)_
|
|
158
206
|
|
|
159
207
|
## `csdx auth:tokens:remove`
|
|
160
208
|
|
|
161
|
-
Removes
|
|
209
|
+
Removes selected tokens
|
|
162
210
|
|
|
163
211
|
```
|
|
164
|
-
Removes stored tokens
|
|
165
|
-
|
|
166
212
|
USAGE
|
|
167
|
-
$ csdx auth:tokens:remove
|
|
213
|
+
$ csdx auth:tokens:remove [-a <value>] [-i]
|
|
168
214
|
|
|
169
|
-
|
|
170
|
-
-a, --alias
|
|
215
|
+
FLAGS
|
|
216
|
+
-a, --alias=<value> Token alias
|
|
217
|
+
-i, --ignore Ignore
|
|
171
218
|
|
|
172
|
-
|
|
173
|
-
|
|
219
|
+
DESCRIPTION
|
|
220
|
+
Removes selected tokens
|
|
174
221
|
|
|
175
|
-
|
|
176
|
-
$ csdx tokens:remove
|
|
222
|
+
EXAMPLES
|
|
223
|
+
$ csdx auth:tokens:remove
|
|
224
|
+
|
|
225
|
+
$ csdx auth:tokens:remove -a <alias>
|
|
177
226
|
```
|
|
178
227
|
|
|
179
|
-
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/
|
|
228
|
+
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v1.0.0/src/commands/auth/tokens/remove.ts)_
|
|
180
229
|
|
|
181
230
|
## `csdx auth:whoami`
|
|
182
231
|
|
|
183
232
|
Display current users email address
|
|
184
233
|
|
|
185
234
|
```
|
|
186
|
-
Display current users email address
|
|
187
|
-
|
|
188
|
-
|
|
189
235
|
USAGE
|
|
190
236
|
$ csdx auth:whoami
|
|
191
237
|
|
|
238
|
+
DESCRIPTION
|
|
239
|
+
Display current users email address
|
|
240
|
+
|
|
192
241
|
ALIASES
|
|
193
242
|
$ csdx whoami
|
|
243
|
+
|
|
244
|
+
EXAMPLES
|
|
245
|
+
$ csdx auth:whoami
|
|
194
246
|
```
|
|
195
247
|
|
|
196
|
-
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/
|
|
248
|
+
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/v1.0.0/src/commands/auth/whoami.ts)_
|
|
197
249
|
|
|
198
|
-
## `csdx cm:bulk-publish`
|
|
250
|
+
## `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>]`
|
|
199
251
|
|
|
200
|
-
|
|
252
|
+
Publish assets to the specified environments
|
|
201
253
|
|
|
202
254
|
```
|
|
203
|
-
|
|
255
|
+
USAGE
|
|
256
|
+
$ csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish
|
|
257
|
+
<value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]
|
|
258
|
+
[--content-types <value>]
|
|
259
|
+
|
|
260
|
+
FLAGS
|
|
261
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
262
|
+
selected)
|
|
263
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
264
|
+
-c, --config=<value> Path to the config file
|
|
265
|
+
-e, --environments=<value> Environments where assets will be published
|
|
266
|
+
-l, --locales=<value> Locales to where assets will be published
|
|
267
|
+
-y, --yes Agree to process the command with the current configuration
|
|
268
|
+
--bulk-publish=<value> [default: true] By default this flag is set as true. It indicates that contentstack's
|
|
269
|
+
bulkpublish API will be used to publish the assets
|
|
270
|
+
--content-types=<value> Content types
|
|
271
|
+
--delivery-token=<value> Delivery token for source environment
|
|
272
|
+
--folder-uid=<value> [default: cs_root] Folder-uid from where the assets will be published
|
|
273
|
+
--retry-failed=<value> Retry publishing failed assets from the logfile (optional, will override all other flags)
|
|
274
|
+
--source-env=<value> Source environment
|
|
204
275
|
|
|
276
|
+
DESCRIPTION
|
|
277
|
+
Publish assets to the specified environments
|
|
205
278
|
|
|
206
|
-
|
|
207
|
-
|
|
279
|
+
The assets command is used to publish assets from the specified stack, to the specified environments
|
|
280
|
+
|
|
281
|
+
Note: Environment(s) and Locale(s) are required to execute the command successfully
|
|
282
|
+
|
|
283
|
+
But, if retryFailed flag is set, then only a logfile is required
|
|
284
|
+
|
|
285
|
+
ALIASES
|
|
286
|
+
$ csdx cm:bulk-publish:assets
|
|
287
|
+
|
|
288
|
+
EXAMPLES
|
|
289
|
+
General Usage
|
|
290
|
+
|
|
291
|
+
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
Using --config or -c flag
|
|
296
|
+
|
|
297
|
+
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
298
|
+
|
|
299
|
+
$ csdx cm:assets:publish --config [PATH TO CONFIG FILE]
|
|
300
|
+
|
|
301
|
+
$ csdx cm:assets:publish -c [PATH TO CONFIG FILE]
|
|
302
|
+
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
Using --retry-failed flag
|
|
306
|
+
|
|
307
|
+
$ csdx cm:assets:publish --retry-failed [LOG FILE NAME]
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
Using --branch flag
|
|
312
|
+
|
|
313
|
+
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
Using --source-env
|
|
318
|
+
|
|
319
|
+
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
208
320
|
```
|
|
209
321
|
|
|
210
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/
|
|
322
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/assets/publish.js)_
|
|
211
323
|
|
|
212
|
-
## `csdx cm:
|
|
324
|
+
## `csdx cm:assets:unpublish`
|
|
213
325
|
|
|
214
|
-
|
|
326
|
+
Unpublish assets from given environment
|
|
215
327
|
|
|
216
328
|
```
|
|
217
|
-
|
|
218
|
-
|
|
329
|
+
USAGE
|
|
330
|
+
$ csdx cm:assets:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>]
|
|
331
|
+
[--retry-failed <value>] [--bulk-unpublish <value>] [--delivery-token <value>]
|
|
332
|
+
|
|
333
|
+
FLAGS
|
|
334
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
335
|
+
-c, --config=<value> Path to the config file
|
|
336
|
+
-e, --environment=<value> Source Environment
|
|
337
|
+
-y, --yes Agree to process the command with the current configuration
|
|
338
|
+
--branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
339
|
+
selected)
|
|
340
|
+
--bulk-unpublish=<value> [default: true] By default this flag is set as true. It indicates that contentstack's
|
|
341
|
+
bulkpublish API will be used to unpublish the assets
|
|
342
|
+
--delivery-token=<value> Delivery Token for source environment
|
|
343
|
+
--locale=<value> Locale filter
|
|
344
|
+
--retry-failed=<value> Retry unpublishing failed assets from the logfile
|
|
345
|
+
|
|
346
|
+
DESCRIPTION
|
|
347
|
+
Unpublish assets from given environment
|
|
348
|
+
|
|
349
|
+
The unpublish command is used for unpublishing assets from the given environment
|
|
350
|
+
|
|
351
|
+
Note: Environment (Source Environment) and Locale are required to execute the command successfully
|
|
352
|
+
|
|
353
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
354
|
+
|
|
355
|
+
EXAMPLES
|
|
356
|
+
General Usage
|
|
357
|
+
|
|
358
|
+
$ csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
Using --config or -c flag
|
|
363
|
+
|
|
364
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
|
|
365
|
+
|
|
366
|
+
$ csdx cm:assets:unpublish --config [PATH TO CONFIG FILE]
|
|
367
|
+
|
|
368
|
+
$ csdx cm:assets:unpublish -c [PATH TO CONFIG FILE]
|
|
369
|
+
|
|
219
370
|
|
|
220
|
-
Content Types, Environments and Locales are required for executing the command successfully
|
|
221
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
222
371
|
|
|
372
|
+
Using --retry-failed flag
|
|
223
373
|
|
|
374
|
+
$ csdx cm:assets:unpublish --retry-failed [LOG FILE NAME]
|
|
375
|
+
|
|
376
|
+
|
|
377
|
+
|
|
378
|
+
Using --branch flag
|
|
379
|
+
|
|
380
|
+
$ csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
381
|
+
```
|
|
382
|
+
|
|
383
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/assets/unpublish.js)_
|
|
384
|
+
|
|
385
|
+
## `csdx cm:bootstrap`
|
|
386
|
+
|
|
387
|
+
Bootstrap contentstack apps
|
|
388
|
+
|
|
389
|
+
```
|
|
224
390
|
USAGE
|
|
225
|
-
$ csdx cm:
|
|
391
|
+
$ csdx cm:bootstrap [--app-name <value>] [--project-dir <value>] [-k <value>] [--org <value>] [-n <value>] [-y
|
|
392
|
+
<value>]
|
|
393
|
+
|
|
394
|
+
FLAGS
|
|
395
|
+
-k, --stack-api-key=<value> Provide stack API key to seed content
|
|
396
|
+
-n, --stack-name=<value> Name of a new stack that will be created.
|
|
397
|
+
-y, --yes=<value>
|
|
398
|
+
--app-name=<value> App name, reactjs-starter, nextjs-starter, gatsby-starter, angular-starter, nuxt-starter
|
|
399
|
+
--org=<value> Provide organization UID to create a new stack
|
|
400
|
+
--project-dir=<value> Directory to setup the project. If directory name has a space then provide the path as a
|
|
401
|
+
string or escap the space using back slash eg: "../../test space" or ../../test\ space
|
|
402
|
+
|
|
403
|
+
DESCRIPTION
|
|
404
|
+
Bootstrap contentstack apps
|
|
226
405
|
|
|
227
|
-
|
|
228
|
-
|
|
406
|
+
EXAMPLES
|
|
407
|
+
$ csdx cm:bootstrap
|
|
229
408
|
|
|
230
|
-
|
|
231
|
-
bulkpublish API will be used for publishing the entries
|
|
409
|
+
$ csdx cm:bootstrap --project-dir <path/to/setup/the/app>
|
|
232
410
|
|
|
233
|
-
|
|
411
|
+
$ csdx cm:bootstrap --app-name "reactjs-starter" --project-dir <path/to/setup/the/app>
|
|
234
412
|
|
|
235
|
-
|
|
413
|
+
$ csdx cm:bootstrap --app-name "reactjs-starter" --project-dir <path/to/setup/the/app> --stack-api-key "stack-api-key"
|
|
236
414
|
|
|
237
|
-
-
|
|
415
|
+
$ csdx cm:bootstrap --app-name "reactjs-starter" --project-dir <path/to/setup/the/app> --org "your-org-uid" --stack-name "stack-name"
|
|
416
|
+
```
|
|
238
417
|
|
|
239
|
-
|
|
240
|
-
flags)
|
|
418
|
+
_See code: [@contentstack/cli-cm-bootstrap](https://github.com/contentstack/cli/blob/v1.1.0/src/commands/cm/bootstrap.ts)_
|
|
241
419
|
|
|
242
|
-
|
|
420
|
+
## `csdx cm:bulk-publish`
|
|
243
421
|
|
|
244
|
-
|
|
422
|
+
Bulk Publish script for managing entries and assets
|
|
423
|
+
|
|
424
|
+
```
|
|
425
|
+
USAGE
|
|
426
|
+
$ csdx cm:bulk-publish
|
|
427
|
+
|
|
428
|
+
DESCRIPTION
|
|
429
|
+
Bulk Publish script for managing entries and assets
|
|
430
|
+
```
|
|
431
|
+
|
|
432
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/index.js)_
|
|
433
|
+
|
|
434
|
+
## `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]`
|
|
435
|
+
|
|
436
|
+
Publish entries and assets from one environment to other environments
|
|
437
|
+
|
|
438
|
+
```
|
|
439
|
+
USAGE
|
|
440
|
+
$ csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type
|
|
441
|
+
<value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>]
|
|
442
|
+
[-y] [--branch <value>] [--onlyAssets] [--onlyEntries]
|
|
443
|
+
|
|
444
|
+
FLAGS
|
|
445
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
446
|
+
selected)
|
|
447
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
448
|
+
-c, --config=<value> Path to the config file
|
|
449
|
+
-y, --yes Agree to process the command with the current configuration
|
|
450
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
451
|
+
bulkpublish API will be used to publish the entries
|
|
452
|
+
--content-type=<value> The Contenttypes from which entries will be published
|
|
453
|
+
--delivery-token=<value> Delivery token for source environment
|
|
454
|
+
--environments=<value> Destination Environments
|
|
455
|
+
--locales=<value> Source locale
|
|
456
|
+
--onlyAssets Unpublish only assets
|
|
457
|
+
--onlyEntries Unpublish only entries
|
|
458
|
+
--retry-failed=<value> (optional) Retry publishing failed entries from the logfile (this flag overrides all other
|
|
459
|
+
flags)
|
|
460
|
+
--source-env=<value> Source Env
|
|
245
461
|
|
|
246
462
|
DESCRIPTION
|
|
247
|
-
|
|
248
|
-
|
|
463
|
+
Publish entries and assets from one environment to other environments
|
|
464
|
+
|
|
465
|
+
The cross-publish command is used to publish entries and assets from one environment to other environments
|
|
466
|
+
|
|
467
|
+
Note: Content Type, Environment, Destination Environment(s) and Locale are required to execute the command
|
|
468
|
+
successfully
|
|
249
469
|
|
|
250
|
-
Content Types, Environments and Locales are required for executing the command successfully
|
|
251
470
|
But, if retryFailed flag is set, then only a logfile is required
|
|
252
471
|
|
|
253
472
|
EXAMPLES
|
|
254
473
|
General Usage
|
|
255
|
-
|
|
256
|
-
[
|
|
474
|
+
|
|
475
|
+
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] -a [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
|
|
476
|
+
|
|
477
|
+
|
|
257
478
|
|
|
258
479
|
Using --config or -c flag
|
|
480
|
+
|
|
259
481
|
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
260
|
-
csdx cm:bulk-publish:add-fields --config [PATH TO CONFIG FILE]
|
|
261
|
-
csdx cm:bulk-publish:add-fields -c [PATH TO CONFIG FILE]
|
|
262
482
|
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
csdx cm:bulk-publish:
|
|
483
|
+
$ csdx cm:bulk-publish:cross-publish --config [PATH TO CONFIG FILE]
|
|
484
|
+
|
|
485
|
+
$ csdx cm:bulk-publish:cross-publish -c [PATH TO CONFIG FILE]
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
Using --retry-failed flag
|
|
490
|
+
|
|
491
|
+
$ csdx cm:bulk-publish:cross-publish --retry-failed [LOG FILE NAME]
|
|
492
|
+
|
|
493
|
+
$ csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]
|
|
494
|
+
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
Using --branch flag
|
|
498
|
+
|
|
499
|
+
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] -a [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
500
|
+
```
|
|
501
|
+
|
|
502
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js)_
|
|
503
|
+
|
|
504
|
+
## `csdx cm:entries:migrate-html-rte`
|
|
505
|
+
|
|
506
|
+
Migration script to migrate content from HTML RTE to JSON RTE
|
|
507
|
+
|
|
266
508
|
```
|
|
509
|
+
USAGE
|
|
510
|
+
$ csdx cm:entries:migrate-html-rte [-c <value>] [-a <value>] [--content-type <value>] [--global-field] [-y] [--html-path
|
|
511
|
+
<value>] [--json-path <value>] [--delay <value>] [--locale <value>] [--batch-limit <value>]
|
|
512
|
+
|
|
513
|
+
FLAGS
|
|
514
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
515
|
+
-c, --config-path=<value> Path to config file
|
|
516
|
+
-y, --yes Agree to process the command with the current configuration
|
|
517
|
+
--batch-limit=<value> [default: 50] Provide batch limit for updating entries
|
|
518
|
+
--content-type=<value> The content type from which entries will be migrated
|
|
519
|
+
--delay=<value> [default: 1000] Provide delay in ms between two entry update
|
|
520
|
+
--global-field This flag is set to false by default. It indicates that current content type is a
|
|
521
|
+
globalfield
|
|
522
|
+
--html-path=<value> Provide path of HTML RTE to migrate
|
|
523
|
+
--json-path=<value> Provide path of JSON RTE to migrate
|
|
524
|
+
--locale=<value> The locale from which entries will be migrated
|
|
525
|
+
|
|
526
|
+
DESCRIPTION
|
|
527
|
+
Migration script to migrate content from HTML RTE to JSON RTE
|
|
528
|
+
|
|
529
|
+
ALIASES
|
|
530
|
+
$ csdx cm:migrate-rte
|
|
531
|
+
|
|
532
|
+
EXAMPLES
|
|
533
|
+
General Usage
|
|
534
|
+
|
|
535
|
+
$ csdx cm:entries:migrate-html-rte --config-path path/to/config.json
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
Using Flags
|
|
540
|
+
|
|
541
|
+
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path html-path --json-path json-path
|
|
542
|
+
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
Nested RTE
|
|
267
546
|
|
|
268
|
-
|
|
547
|
+
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path modular_block_uid.block_uid.html_rte_uid --json-path modular_block_uid.block_uid.json_rte_uid
|
|
269
548
|
|
|
270
|
-
## `csdx cm:bulk-publish:assets`
|
|
271
549
|
|
|
272
|
-
Publish assets to specified environments
|
|
273
550
|
|
|
551
|
+
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path group_uid.html_rte_uid --json-path group_uid.json_rte_uid
|
|
552
|
+
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
Global Field
|
|
556
|
+
|
|
557
|
+
$ csdx cm:entries:migrate-html-rte --alias alias --content-type global_field_uid --global-field --html-path html-path --json-path json-path
|
|
274
558
|
```
|
|
275
|
-
Publish assets to specified environments
|
|
276
|
-
The assets command is used for publishing assets from the specified stack, to the specified environments
|
|
277
559
|
|
|
278
|
-
|
|
279
|
-
|
|
560
|
+
_See code: [@contentstack/cli-cm-migrate-rte](https://github.com/contentstack/cli/blob/v1.1.1/src/commands/cm/entries/migrate-html-rte.js)_
|
|
561
|
+
|
|
562
|
+
## `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>]`
|
|
280
563
|
|
|
564
|
+
Publish entries from multiple contenttypes to multiple environments and locales
|
|
281
565
|
|
|
566
|
+
```
|
|
282
567
|
USAGE
|
|
283
|
-
$ csdx cm:bulk-publish
|
|
568
|
+
$ csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
569
|
+
[--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
|
|
570
|
+
<value>] [--delivery-token <value>] [--source-env <value>]
|
|
571
|
+
|
|
572
|
+
FLAGS
|
|
573
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
574
|
+
selected)
|
|
575
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
576
|
+
-c, --config=<value> Path for the external config file (A new config file can be generated at the current
|
|
577
|
+
working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
|
|
578
|
+
-e, --environments=<value> Environments where entries will be published
|
|
579
|
+
-l, --locales=<value> Locales where entries will be published
|
|
580
|
+
-y, --yes Agree to process the command with the current configuration
|
|
581
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
582
|
+
bulkpublish API will be used to publish the entries
|
|
583
|
+
--content-types=<value> The Contenttypes from which entries need to be published
|
|
584
|
+
--delivery-token=<value> Delivery token for source environment
|
|
585
|
+
--publish-all-content-types (optional) Publish all contenttypes (cannot be set when contentTypes flag is set)
|
|
586
|
+
--retry-failed=<value> (optional) Retry failed entries from the logfile (overrides all other flags) This flag is
|
|
587
|
+
used to retry publishing entries that failed to publish in a previous attempt. A log file
|
|
588
|
+
for the previous session will be required for processing the failed entries
|
|
589
|
+
--source-env=<value> Source environment
|
|
590
|
+
|
|
591
|
+
DESCRIPTION
|
|
592
|
+
Publish entries from multiple contenttypes to multiple environments and locales
|
|
593
|
+
|
|
594
|
+
The publish command is used to publish entries from the specified content types, to the
|
|
595
|
+
|
|
596
|
+
specified environments and locales
|
|
597
|
+
|
|
598
|
+
Note: Content Types, Environments and Locales are required to execute the command successfully
|
|
599
|
+
|
|
600
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
601
|
+
|
|
602
|
+
ALIASES
|
|
603
|
+
$ csdx cm:bulk-publish:entries
|
|
604
|
+
|
|
605
|
+
EXAMPLES
|
|
606
|
+
General Usage
|
|
284
607
|
|
|
285
|
-
|
|
286
|
-
-a, --alias=alias Alias for the management token to be used
|
|
608
|
+
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
287
609
|
|
|
288
|
-
-b, --bulkPublish=bulkPublish [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
289
|
-
bulkpublish API will be used for publishing the entries
|
|
290
610
|
|
|
291
|
-
-c, --config=config Path to config file to be used
|
|
292
611
|
|
|
293
|
-
|
|
612
|
+
Using --config or -c flag
|
|
613
|
+
|
|
614
|
+
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
615
|
+
|
|
616
|
+
$ csdx cm:entries:publish --config [PATH TO CONFIG FILE]
|
|
617
|
+
|
|
618
|
+
$ csdx cm:entries:publish -c [PATH TO CONFIG FILE]
|
|
619
|
+
|
|
620
|
+
|
|
621
|
+
|
|
622
|
+
Using --retry-failed
|
|
623
|
+
|
|
624
|
+
$ csdx cm:entries:publish --retry-failed [LOG FILE NAME]
|
|
625
|
+
|
|
626
|
+
$ csdx cm:entries:publish -r [LOG FILE NAME]
|
|
627
|
+
|
|
628
|
+
|
|
294
629
|
|
|
295
|
-
|
|
630
|
+
Using --branch
|
|
296
631
|
|
|
297
|
-
-
|
|
298
|
-
flags)
|
|
632
|
+
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
299
633
|
|
|
300
|
-
-u, --folderUid=folderUid [default: cs_root] Folder-uid from which the assets need to be published
|
|
301
634
|
|
|
302
|
-
|
|
635
|
+
|
|
636
|
+
Using --source-env
|
|
637
|
+
|
|
638
|
+
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
639
|
+
```
|
|
640
|
+
|
|
641
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js)_
|
|
642
|
+
|
|
643
|
+
## `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>]`
|
|
644
|
+
|
|
645
|
+
Publish edited entries from a specified content type to the given locales and environments
|
|
646
|
+
|
|
647
|
+
```
|
|
648
|
+
USAGE
|
|
649
|
+
$ csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env
|
|
650
|
+
<value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
651
|
+
|
|
652
|
+
FLAGS
|
|
653
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
654
|
+
selected)
|
|
655
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
656
|
+
-c, --config=<value> Path to the config file
|
|
657
|
+
-e, --environments=<value> Destination environments
|
|
658
|
+
-l, --locales=<value> Locales where edited entries will be published
|
|
659
|
+
-y, --yes Agree to process the command with the current configuration
|
|
660
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
661
|
+
bulkpublish API will be used to publish the entries
|
|
662
|
+
--content-types=<value> The Contenttypes which will be checked for edited entries
|
|
663
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
664
|
+
--source-env=<value> Environment from which edited entries will be published
|
|
303
665
|
|
|
304
666
|
DESCRIPTION
|
|
305
|
-
|
|
667
|
+
Publish edited entries from a specified content type to the given locales and environments
|
|
668
|
+
|
|
669
|
+
The publish-modified command is used to publish entries from the specified content types, to the
|
|
670
|
+
|
|
671
|
+
specified environments and locales
|
|
672
|
+
|
|
673
|
+
Note: Content type(s), Source Environment, Destination Environment(s) and Locale(s) are required to execute the
|
|
674
|
+
command successfully
|
|
675
|
+
|
|
676
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
677
|
+
|
|
678
|
+
ALIASES
|
|
679
|
+
$ csdx cm:bulk-publish:entry-edits
|
|
680
|
+
|
|
681
|
+
EXAMPLES
|
|
682
|
+
General Usage
|
|
683
|
+
|
|
684
|
+
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
Using --config or -c flag
|
|
689
|
+
|
|
690
|
+
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
691
|
+
|
|
692
|
+
$ csdx cm:entries:publish-modified --config [PATH TO CONFIG FILE]
|
|
693
|
+
|
|
694
|
+
$ csdx cm:entries:publish-modified -c [PATH TO CONFIG FILE]
|
|
695
|
+
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
Using --retry-failed
|
|
699
|
+
|
|
700
|
+
$ csdx cm:entries:publish-modified --retry-failed [LOG FILE NAME]
|
|
701
|
+
|
|
702
|
+
$ csdx cm:entries:publish-modified -r [LOG FILE NAME]
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
Using --branch
|
|
707
|
+
|
|
708
|
+
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
709
|
+
```
|
|
710
|
+
|
|
711
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-modified.js)_
|
|
712
|
+
|
|
713
|
+
## `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>]`
|
|
714
|
+
|
|
715
|
+
Publish non-localized fields for the given content types, from a particular source environment to the specified environments
|
|
716
|
+
|
|
717
|
+
```
|
|
718
|
+
USAGE
|
|
719
|
+
$ csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
720
|
+
[--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
721
|
+
|
|
722
|
+
FLAGS
|
|
723
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
724
|
+
selected)
|
|
725
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
726
|
+
-c, --config=<value> Path to the config file
|
|
727
|
+
-e, --environments=<value> Destination environments
|
|
728
|
+
-y, --yes Agree to process the command with the current configuration
|
|
729
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
730
|
+
bulkpublish API will be used to publish the entries
|
|
731
|
+
--content-types=<value> The Contenttypes from which entries will be published
|
|
732
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile
|
|
733
|
+
--source-env=<value> Source Environment
|
|
734
|
+
|
|
735
|
+
DESCRIPTION
|
|
736
|
+
Publish non-localized fields for the given content types, from a particular source environment to the specified
|
|
737
|
+
environments
|
|
738
|
+
|
|
739
|
+
The non-localized field changes command is used to publish non-localized field changes from the given content types to
|
|
740
|
+
the specified environments
|
|
741
|
+
|
|
742
|
+
Note: Content types, Environments and Source Environment are required to execute this command successfully.
|
|
306
743
|
|
|
307
|
-
Environment(s) and Locale(s) are required for executing the command successfully
|
|
308
744
|
But, if retryFailed flag is set, then only a logfile is required
|
|
309
745
|
|
|
746
|
+
ALIASES
|
|
747
|
+
$ csdx cm:bulk-publish:nonlocalized-field-changes
|
|
748
|
+
|
|
310
749
|
EXAMPLES
|
|
311
750
|
General Usage
|
|
312
|
-
|
|
751
|
+
|
|
752
|
+
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV]
|
|
753
|
+
|
|
754
|
+
|
|
313
755
|
|
|
314
756
|
Using --config or -c flag
|
|
757
|
+
|
|
315
758
|
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
316
|
-
csdx cm:bulk-publish:assets --config [PATH TO CONFIG FILE]
|
|
317
|
-
csdx cm:bulk-publish:assets -c [PATH TO CONFIG FILE]
|
|
318
759
|
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
csdx cm:
|
|
760
|
+
$ csdx cm:entries:publish-non-localized-fields --config [PATH TO CONFIG FILE]
|
|
761
|
+
|
|
762
|
+
$ csdx cm:entries:publish-non-localized-fields -c [PATH TO CONFIG FILE]
|
|
763
|
+
|
|
764
|
+
|
|
765
|
+
|
|
766
|
+
Using --retry-failed flag
|
|
767
|
+
|
|
768
|
+
$ csdx cm:entries:publish-non-localized-fields --retry-failed [LOG FILE NAME]
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
Using --branch flag
|
|
773
|
+
|
|
774
|
+
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV] --branch [BRANCH NAME]
|
|
322
775
|
```
|
|
323
776
|
|
|
324
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/
|
|
777
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-non-localized-fields.js)_
|
|
325
778
|
|
|
326
|
-
## `csdx cm:bulk-publish
|
|
779
|
+
## `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>]`
|
|
327
780
|
|
|
328
|
-
|
|
781
|
+
Publish unpublished entries from the source environment, to other environments and locales
|
|
329
782
|
|
|
330
783
|
```
|
|
331
|
-
|
|
784
|
+
USAGE
|
|
785
|
+
$ csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
786
|
+
[--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
|
|
787
|
+
<value>]
|
|
788
|
+
|
|
789
|
+
FLAGS
|
|
790
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
791
|
+
selected)
|
|
792
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
793
|
+
-b, --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
794
|
+
bulkpublish API will be used to publish the entries
|
|
795
|
+
-c, --config=<value> Path to the config file
|
|
796
|
+
-e, --environments=<value> Destination environments
|
|
797
|
+
-y, --yes Agree to process the command with the current configuration
|
|
798
|
+
--content-types=<value> The Contenttypes from which entries will be published
|
|
799
|
+
--locales=<value> Source locale
|
|
800
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile
|
|
801
|
+
--source-env=<value> Source Env
|
|
802
|
+
|
|
803
|
+
DESCRIPTION
|
|
804
|
+
Publish unpublished entries from the source environment, to other environments and locales
|
|
805
|
+
|
|
806
|
+
The publish-only-unpublished command is used to publish unpublished entries from the source environment, to other
|
|
807
|
+
environments and locales
|
|
808
|
+
|
|
809
|
+
Note: Content type(s), Source Environment, Destination Environment(s) and Source Locale are required to execute the
|
|
810
|
+
command successfully
|
|
811
|
+
|
|
812
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
813
|
+
|
|
814
|
+
ALIASES
|
|
815
|
+
$ csdx cm:bulk-publish:unpublished-entries
|
|
816
|
+
|
|
817
|
+
EXAMPLES
|
|
818
|
+
General Usage
|
|
819
|
+
|
|
820
|
+
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] -source-env [SOURCE ENV]
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
Using --config or -c flag
|
|
825
|
+
|
|
826
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
827
|
+
|
|
828
|
+
$ csdx cm:entries:publish-only-unpublished --config [PATH TO CONFIG FILE]
|
|
829
|
+
|
|
830
|
+
$ csdx cm:entries:publish-only-unpublished -c [PATH TO CONFIG FILE]
|
|
831
|
+
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
Using --retry-failed
|
|
835
|
+
|
|
836
|
+
$ csdx cm:entries:publish-only-unpublished --retry-failed [LOG FILE NAME]
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
Using --branch
|
|
841
|
+
|
|
842
|
+
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME] -source-env [SOURCE ENV]
|
|
843
|
+
```
|
|
844
|
+
|
|
845
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-only-unpublished.js)_
|
|
846
|
+
|
|
847
|
+
## `csdx cm:entries:unpublish`
|
|
848
|
+
|
|
849
|
+
Unpublish entries from the given environment
|
|
850
|
+
|
|
851
|
+
```
|
|
852
|
+
USAGE
|
|
853
|
+
$ csdx cm:entries:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>]
|
|
854
|
+
[--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>]
|
|
855
|
+
|
|
856
|
+
FLAGS
|
|
857
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
858
|
+
-c, --config=<value> Path to the config file
|
|
859
|
+
-e, --environment=<value> Source Environment
|
|
860
|
+
-y, --yes Agree to process the command with the current configuration
|
|
861
|
+
--branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
862
|
+
selected)
|
|
863
|
+
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
864
|
+
bulkpublish API will be used to unpublish the entries
|
|
865
|
+
--content-type=<value> Content type filter
|
|
866
|
+
--delivery-token=<value> Delivery token for source environment
|
|
867
|
+
--locale=<value> Locale filter
|
|
868
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile
|
|
869
|
+
|
|
870
|
+
DESCRIPTION
|
|
871
|
+
Unpublish entries from the given environment
|
|
872
|
+
|
|
873
|
+
The unpublish command is used to unpublish entries from the given environment
|
|
874
|
+
|
|
875
|
+
Note: Environment (Source Environment) and Locale are required to execute the command successfully
|
|
876
|
+
|
|
877
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
878
|
+
|
|
879
|
+
EXAMPLES
|
|
880
|
+
General Usage
|
|
332
881
|
|
|
882
|
+
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
|
|
333
883
|
|
|
334
|
-
USAGE
|
|
335
|
-
$ csdx cm:bulk-publish:clear
|
|
336
884
|
|
|
337
|
-
OPTIONS
|
|
338
|
-
-l, --list List number of log files
|
|
339
|
-
-y, --yes Delete all files without asking for confirmation
|
|
340
|
-
```
|
|
341
885
|
|
|
342
|
-
|
|
886
|
+
Using --config or -c flag
|
|
343
887
|
|
|
344
|
-
|
|
888
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
|
|
345
889
|
|
|
346
|
-
|
|
890
|
+
$ csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]
|
|
347
891
|
|
|
348
|
-
|
|
349
|
-
Generate configuration template
|
|
350
|
-
The configure command is used for generating a configuration file for bulk-publish script.
|
|
892
|
+
$ csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]
|
|
351
893
|
|
|
352
|
-
Here is a detailed description for all the available flags
|
|
353
894
|
|
|
354
|
-
-----------------------------------------------------------------------------------------------------------
|
|
355
|
-
--alias or -a : Management token Alias for the stack in use.
|
|
356
895
|
|
|
357
|
-
|
|
358
|
-
EXAMPLE : cm:bulk-publish:configure -a [MANAGEMENT TOKEN Alias]
|
|
896
|
+
Using --retry-failed flag
|
|
359
897
|
|
|
898
|
+
$ csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]
|
|
360
899
|
|
|
361
|
-
USAGE
|
|
362
|
-
$ csdx cm:bulk-publish:configure
|
|
363
900
|
|
|
364
|
-
OPTIONS
|
|
365
|
-
-a, --alias=alias Management token alias for the stack
|
|
366
901
|
|
|
367
|
-
DESCRIPTION
|
|
368
|
-
The configure command is used for generating a configuration file for bulk-publish script.
|
|
369
902
|
|
|
370
|
-
Here is a detailed description for all the available flags
|
|
371
903
|
|
|
372
|
-
|
|
373
|
-
--alias or -a : Management token Alias for the stack in use.
|
|
904
|
+
Using --branch flag
|
|
374
905
|
|
|
375
|
-
|
|
376
|
-
EXAMPLE : cm:bulk-publish:configure -a [MANAGEMENT TOKEN Alias]
|
|
906
|
+
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
377
907
|
```
|
|
378
908
|
|
|
379
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/
|
|
909
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/entries/unpublish.js)_
|
|
380
910
|
|
|
381
|
-
## `csdx cm:bulk-publish
|
|
911
|
+
## `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>]`
|
|
382
912
|
|
|
383
|
-
|
|
913
|
+
Add fields from updated content types to their respective entries
|
|
384
914
|
|
|
385
915
|
```
|
|
386
|
-
|
|
387
|
-
|
|
916
|
+
USAGE
|
|
917
|
+
$ csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types
|
|
918
|
+
<value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
|
|
919
|
+
|
|
920
|
+
FLAGS
|
|
921
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
922
|
+
selected)
|
|
923
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
924
|
+
-c, --config=<value> Path to the config file
|
|
925
|
+
-e, --environments=<value> Environments where entries will be published
|
|
926
|
+
-l, --locales=<value> Locales where entries will be published
|
|
927
|
+
-t, --contentTypes=<value> The Contenttypes from which entries will be published
|
|
928
|
+
-y, --yes Agree to process the command with the current configuration
|
|
929
|
+
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
930
|
+
bulkpublish API will be used to publish the entries
|
|
931
|
+
--content-types=<value> The Contenttypes from which entries will be published
|
|
932
|
+
--force Update and publish all entries even if no fields have been added
|
|
933
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
388
934
|
|
|
389
|
-
|
|
390
|
-
|
|
935
|
+
DESCRIPTION
|
|
936
|
+
Add fields from updated content types to their respective entries
|
|
391
937
|
|
|
938
|
+
The update-and-publish command is used to update existing entries with the updated schema of the respective content
|
|
939
|
+
type
|
|
392
940
|
|
|
393
|
-
|
|
394
|
-
|
|
941
|
+
Note: Content types, Environments and Locales are required to execute the command successfully
|
|
942
|
+
|
|
943
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
944
|
+
|
|
945
|
+
ALIASES
|
|
946
|
+
$ csdx cm:bulk-publish:add-fields
|
|
395
947
|
|
|
396
|
-
|
|
397
|
-
|
|
948
|
+
EXAMPLES
|
|
949
|
+
General Usage
|
|
398
950
|
|
|
399
|
-
-
|
|
400
|
-
contentstack's bulkpublish API will be used for publishing the entries
|
|
951
|
+
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locale [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
401
952
|
|
|
402
|
-
-c, --config=config Path to config file to be used
|
|
403
953
|
|
|
404
|
-
-d, --destEnv=destEnv Destination Environments
|
|
405
954
|
|
|
406
|
-
|
|
955
|
+
Using --config or -c flag
|
|
407
956
|
|
|
408
|
-
-
|
|
957
|
+
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
409
958
|
|
|
410
|
-
|
|
411
|
-
flags)
|
|
959
|
+
$ csdx cm:entries:update-and-publish --config [PATH TO CONFIG FILE]
|
|
412
960
|
|
|
413
|
-
-
|
|
961
|
+
$ csdx cm:entries:update-and-publish -c [PATH TO CONFIG FILE]
|
|
414
962
|
|
|
415
|
-
-x, --deliveryToken=deliveryToken Delivery Token for source environment
|
|
416
963
|
|
|
417
|
-
-y, --yes Agree to process the command with the current configuration
|
|
418
964
|
|
|
419
|
-
|
|
420
|
-
The cross-publish command is used for publishing entries and assets from one evironment to other environments
|
|
965
|
+
Using --retry-failed
|
|
421
966
|
|
|
422
|
-
|
|
423
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
967
|
+
$ csdx cm:entries:update-and-publish --retry-failed [LOG FILE NAME]
|
|
424
968
|
|
|
425
|
-
EXAMPLES
|
|
426
|
-
General Usage
|
|
427
|
-
csdx cm:bulk-publish:cross-publish -t [CONTENT TYPE] -e [SOURCE ENV] -d [DESTINATION ENVIRONMENT] -l [LOCALE] -a
|
|
428
|
-
[MANAGEMENT TOKEN ALIAS] -x [DELIVERY TOKEN]
|
|
429
969
|
|
|
430
|
-
Using --config or -c flag
|
|
431
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
432
|
-
csdx cm:bulk-publish:cross-publish --config [PATH TO CONFIG FILE]
|
|
433
|
-
csdx cm:bulk-publish:cross-publish -c [PATH TO CONFIG FILE]
|
|
434
970
|
|
|
435
|
-
Using --
|
|
436
|
-
|
|
437
|
-
csdx cm:
|
|
971
|
+
Using --branch
|
|
972
|
+
|
|
973
|
+
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locale [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
438
974
|
```
|
|
439
975
|
|
|
440
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/
|
|
976
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/entries/update-and-publish.js)_
|
|
441
977
|
|
|
442
|
-
## `csdx cm:
|
|
978
|
+
## `csdx cm:export-to-csv`
|
|
443
979
|
|
|
444
|
-
|
|
980
|
+
Export entries or organization users to csv using this command
|
|
445
981
|
|
|
446
982
|
```
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
983
|
+
USAGE
|
|
984
|
+
$ csdx cm:export-to-csv [--action entries|users] [-a <value>] [--org <value>] [-n <value>] [--org-name <value>]
|
|
985
|
+
[--locale <value>] [--content-type <value>]
|
|
986
|
+
|
|
987
|
+
FLAGS
|
|
988
|
+
-a, --alias=<value> Alias of the management token
|
|
989
|
+
-n, --stack-name=<value> Name of the stack that needs to be created as csv filename.
|
|
990
|
+
--action=<option> Option to export data (entries, users)
|
|
991
|
+
<options: entries|users>
|
|
992
|
+
--content-type=<value> Content type for which entries needs to be exported
|
|
993
|
+
--locale=<value> Locale for which entries need to be exported
|
|
994
|
+
--org=<value> Provide organization UID to clone org users
|
|
995
|
+
--org-name=<value> Name of the organization that needs to be created as csv filename.
|
|
996
|
+
|
|
997
|
+
DESCRIPTION
|
|
998
|
+
Export entries or organization users to csv using this command
|
|
450
999
|
|
|
451
|
-
|
|
452
|
-
|
|
1000
|
+
EXAMPLES
|
|
1001
|
+
$ csdx cm:export-to-csv
|
|
453
1002
|
|
|
454
1003
|
|
|
455
|
-
USAGE
|
|
456
|
-
$ csdx cm:bulk-publish:entries
|
|
457
1004
|
|
|
458
|
-
|
|
459
|
-
-a, --alias=alias Alias for the management token to be used
|
|
1005
|
+
Exporting entries to csv
|
|
460
1006
|
|
|
461
|
-
-
|
|
462
|
-
bulkpublish API will be used for publishing the entries
|
|
1007
|
+
$ csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type>
|
|
463
1008
|
|
|
464
|
-
-c, --config=config Path for the external config file to be used (A new config file can be generated at
|
|
465
|
-
the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
|
|
466
1009
|
|
|
467
|
-
-e, --environments=environments Environments to which entries need to be published
|
|
468
1010
|
|
|
469
|
-
|
|
1011
|
+
Exporting entries to csv with stack name provided
|
|
470
1012
|
|
|
471
|
-
-
|
|
1013
|
+
$ csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type> --stack-name <stack-name>
|
|
472
1014
|
|
|
473
|
-
-r, --retryFailed=retryFailed Retry failed entries from the logfile (optional, overrides all other flags) This flag
|
|
474
|
-
is used to retry publishing entries that failed to publish in a previous attempt. A
|
|
475
|
-
log file for the previous session will be required for processing the failed entries
|
|
476
1015
|
|
|
477
|
-
-t, --contentTypes=contentTypes The Content-types from which entries need to be published
|
|
478
1016
|
|
|
479
|
-
|
|
1017
|
+
Exporting organization users to csv
|
|
480
1018
|
|
|
481
|
-
|
|
482
|
-
The entries command is used for publishing entries from the specified content types, to the
|
|
483
|
-
specified environments and locales
|
|
1019
|
+
$ csdx cm:export-to-csv --action <users> --org <org-uid>
|
|
484
1020
|
|
|
485
|
-
Content Types, Environments and Locales are required for executing the command successfully
|
|
486
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
487
1021
|
|
|
488
|
-
EXAMPLES
|
|
489
|
-
General Usage
|
|
490
|
-
csdx cm:bulk-publish:entries -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] -l [LOCALE 1]
|
|
491
|
-
[LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
492
1022
|
|
|
493
|
-
|
|
494
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
495
|
-
csdx cm:bulk-publish:entries --config [PATH TO CONFIG FILE]
|
|
496
|
-
csdx cm:bulk-publish:entries -c [PATH TO CONFIG FILE]
|
|
1023
|
+
Exporting organization users to csv with organization name provided
|
|
497
1024
|
|
|
498
|
-
|
|
499
|
-
csdx cm:bulk-publish:entries --retryFailed [LOG FILE NAME]
|
|
500
|
-
csdx cm:bulk-publish:entries -r [LOG FILE NAME]
|
|
1025
|
+
$ csdx cm:export-to-csv --action <users> --org <org-uid> --org-name <org-name>
|
|
501
1026
|
```
|
|
502
1027
|
|
|
503
|
-
_See code: [@contentstack/cli-cm-
|
|
1028
|
+
_See code: [@contentstack/cli-cm-export-to-csv](https://github.com/contentstack/cli/blob/v1.0.0/src/commands/cm/export-to-csv.js)_
|
|
504
1029
|
|
|
505
|
-
## `csdx cm:
|
|
1030
|
+
## `csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`
|
|
506
1031
|
|
|
507
|
-
|
|
1032
|
+
Clone data (structure/content or both) of a stack into another stack
|
|
508
1033
|
|
|
509
1034
|
```
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
1035
|
+
USAGE
|
|
1036
|
+
$ csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>]
|
|
1037
|
+
[--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>]
|
|
1038
|
+
[--destination-stack-api-key <value>] [--import-webhook-status disable|current]
|
|
1039
|
+
|
|
1040
|
+
FLAGS
|
|
1041
|
+
-n, --stack-name=<value> Name for the new stack to store the cloned content.
|
|
1042
|
+
--destination-management-token-alias=<value> Source API key of the target stack token alias.
|
|
1043
|
+
--destination-stack-api-key=<value> Destination stack API Key
|
|
1044
|
+
--import-webhook-status=<option> [default: disable] Webhook state
|
|
1045
|
+
<options: disable|current>
|
|
1046
|
+
--source-branch=<value> Branch of the source stack.
|
|
1047
|
+
--source-management-token-alias=<value> Source API key of the target stack token alias.
|
|
1048
|
+
--source-stack-api-key=<value> Source stack API Key
|
|
1049
|
+
--target-branch=<value> Branch of the target stack.
|
|
1050
|
+
--type=<option> Type of data to clone
|
|
1051
|
+
a) Structure (all modules except entries & assets)
|
|
1052
|
+
b) Structure with content (all modules including entries & assets)
|
|
1053
|
+
|
|
1054
|
+
<options: a|b>
|
|
513
1055
|
|
|
514
|
-
|
|
515
|
-
|
|
1056
|
+
DESCRIPTION
|
|
1057
|
+
Clone data (structure/content or both) of a stack into another stack
|
|
516
1058
|
|
|
1059
|
+
Use this plugin to automate the process of cloning a stack in few steps.
|
|
517
1060
|
|
|
518
|
-
|
|
519
|
-
$ csdx cm:
|
|
1061
|
+
ALIASES
|
|
1062
|
+
$ csdx cm:stack-clone
|
|
1063
|
+
|
|
1064
|
+
EXAMPLES
|
|
1065
|
+
$ csdx cm:stacks:clone
|
|
520
1066
|
|
|
521
|
-
|
|
522
|
-
-a, --alias=alias Alias for the management token to be used
|
|
1067
|
+
$ csdx cm:stacks:clone --source-branch <source-branch-name> --target-branch <target-branch-name>
|
|
523
1068
|
|
|
524
|
-
|
|
525
|
-
bulkpublish API will be used for publishing the entries
|
|
1069
|
+
$ csdx cm:stacks:clone --source-stack-api-key <apiKey> --destination-stack-api-key <apiKey>
|
|
526
1070
|
|
|
527
|
-
|
|
1071
|
+
$ csdx cm:stacks:clone --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
|
|
528
1072
|
|
|
529
|
-
-
|
|
1073
|
+
$ csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
|
|
530
1074
|
|
|
531
|
-
-
|
|
1075
|
+
$ csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias> --type <value a or b>
|
|
1076
|
+
```
|
|
532
1077
|
|
|
533
|
-
|
|
534
|
-
flags)
|
|
1078
|
+
_See code: [@contentstack/cli-cm-clone](https://github.com/contentstack/cli/blob/v1.0.0/src/commands/cm/stacks/clone.js)_
|
|
535
1079
|
|
|
536
|
-
|
|
1080
|
+
## `csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
|
|
537
1081
|
|
|
538
|
-
|
|
1082
|
+
Export content from a stack
|
|
539
1083
|
|
|
540
|
-
|
|
1084
|
+
```
|
|
1085
|
+
USAGE
|
|
1086
|
+
$ csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types
|
|
1087
|
+
<value>] [--branch <value>] [--secured-assets]
|
|
1088
|
+
|
|
1089
|
+
FLAGS
|
|
1090
|
+
-B, --branch=<value> [optional] branch name
|
|
1091
|
+
-a, --alias=<value> alias of the management token
|
|
1092
|
+
-c, --config=<value> [optional] path of the config
|
|
1093
|
+
-d, --data-dir=<value> path or location to store the data
|
|
1094
|
+
-k, --stack-api-key=<value> API key of the source stack
|
|
1095
|
+
-m, --module=<value> [optional] specific module name
|
|
1096
|
+
-t, --content-types=<value> [optional] content type
|
|
1097
|
+
--secured-assets [optional] use when assets are secured
|
|
541
1098
|
|
|
542
1099
|
DESCRIPTION
|
|
543
|
-
|
|
544
|
-
specified environments and locales
|
|
1100
|
+
Export content from a stack
|
|
545
1101
|
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
1102
|
+
ALIASES
|
|
1103
|
+
$ csdx cm:export
|
|
549
1104
|
|
|
550
1105
|
EXAMPLES
|
|
551
|
-
|
|
552
|
-
csdx cm:bulk-publish:entry-edits -t [CONTENT TYPE 1] [CONTENT TYPE 2] -s [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT
|
|
553
|
-
2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
1106
|
+
$ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
554
1107
|
|
|
555
|
-
|
|
556
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
557
|
-
csdx cm:bulk-publish:entry-edits --config [PATH TO CONFIG FILE]
|
|
558
|
-
csdx cm:bulk-publish:entry-edits -c [PATH TO CONFIG FILE]
|
|
1108
|
+
$ csdx cm:stacks:export --config <path/to/config/dir>
|
|
559
1109
|
|
|
560
|
-
|
|
561
|
-
csdx cm:bulk-publish:entry-edits --retryFailed [LOG FILE NAME]
|
|
562
|
-
csdx cm:bulk-publish:entry-edits -r [LOG FILE NAME]
|
|
563
|
-
```
|
|
1110
|
+
$ csdx cm:stacks:export --alias <management_token_alias>
|
|
564
1111
|
|
|
565
|
-
|
|
1112
|
+
$ csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>
|
|
566
1113
|
|
|
567
|
-
|
|
1114
|
+
$ csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>
|
|
568
1115
|
|
|
569
|
-
|
|
1116
|
+
$ csdx cm:stacks:export --module <single module name>
|
|
570
1117
|
|
|
1118
|
+
$ csdx cm:stacks:export --branch [optional] branch name
|
|
571
1119
|
```
|
|
572
|
-
Publish non-localized-fields for given Content Types, from a particular source environment to specified environments
|
|
573
|
-
The nonlocalized-field-changes command is used for publishing nonlocalized field changes from the given Content Types to
|
|
574
|
-
the specified Environments
|
|
575
1120
|
|
|
576
|
-
|
|
577
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
1121
|
+
_See code: [@contentstack/cli-cm-export](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-export/src/commands/cm/stacks/export.js)_
|
|
578
1122
|
|
|
1123
|
+
## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
|
|
579
1124
|
|
|
580
|
-
|
|
581
|
-
$ csdx cm:bulk-publish:nonlocalized-field-changes
|
|
1125
|
+
Import script for importing the content into the new stack
|
|
582
1126
|
|
|
583
|
-
|
|
584
|
-
|
|
1127
|
+
```
|
|
1128
|
+
USAGE
|
|
1129
|
+
$ csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>]
|
|
1130
|
+
[--branch <value>] [--import-webhook-status disable|current]
|
|
1131
|
+
|
|
1132
|
+
FLAGS
|
|
1133
|
+
-B, --branch=<value> [optional] branch name
|
|
1134
|
+
-a, --alias=<value> alias of the management token
|
|
1135
|
+
-b, --backup-dir=<value> [optional] backup directory name when using specific module
|
|
1136
|
+
-c, --config=<value> [optional] path of config file
|
|
1137
|
+
-d, --data-dir=<value> path and location where data is stored
|
|
1138
|
+
-k, --stack-api-key=<value> API key of the target stack
|
|
1139
|
+
-m, --module=<value> [optional] specific module name
|
|
1140
|
+
--import-webhook-status=<option> [default: disable] Webhook state
|
|
1141
|
+
<options: disable|current>
|
|
585
1142
|
|
|
586
|
-
|
|
587
|
-
|
|
1143
|
+
DESCRIPTION
|
|
1144
|
+
Import script for importing the content into the new stack
|
|
588
1145
|
|
|
589
|
-
|
|
1146
|
+
...
|
|
590
1147
|
|
|
591
|
-
|
|
1148
|
+
Once you export content from the source stack, import it to your destination stack by using the cm:stacks:import
|
|
1149
|
+
command.
|
|
592
1150
|
|
|
593
|
-
|
|
1151
|
+
ALIASES
|
|
1152
|
+
$ csdx cm:import
|
|
594
1153
|
|
|
595
|
-
|
|
1154
|
+
EXAMPLES
|
|
1155
|
+
$ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
596
1156
|
|
|
597
|
-
|
|
1157
|
+
$ csdx cm:stacks:import --config <path/of/config/dir>
|
|
598
1158
|
|
|
599
|
-
|
|
1159
|
+
$ csdx cm:stacks:import --module <single module name>
|
|
600
1160
|
|
|
601
|
-
|
|
602
|
-
The nonlocalized-field-changes command is used for publishing nonlocalized field changes from the given Content Types
|
|
603
|
-
to
|
|
604
|
-
the specified Environments
|
|
1161
|
+
$ csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>
|
|
605
1162
|
|
|
606
|
-
|
|
607
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
1163
|
+
$ csdx cm:stacks:import --alias <management_token_alias>
|
|
608
1164
|
|
|
609
|
-
|
|
610
|
-
General Usage
|
|
611
|
-
csdx cm:bulk-publish:nonlocalized-field-changes -t [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT
|
|
612
|
-
2] -l [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
1165
|
+
$ csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>
|
|
613
1166
|
|
|
614
|
-
|
|
615
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
616
|
-
csdx cm:bulk-publish:nonlocalized-field-changes --config [PATH TO CONFIG FILE]
|
|
617
|
-
csdx cm:bulk-publish:nonlocalized-field-changes -c [PATH TO CONFIG FILE]
|
|
1167
|
+
$ csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
|
|
618
1168
|
|
|
619
|
-
|
|
620
|
-
csdx cm:bulk-publish:nonlocalized-field-changes --retryFailed [LOG FILE NAME]
|
|
621
|
-
csdx cm:bulk-publish:nonlocalized-field-changes -r [LOG FILE NAME]
|
|
1169
|
+
$ csdx cm:stacks:import --branch <branch name>
|
|
622
1170
|
```
|
|
623
1171
|
|
|
624
|
-
_See code: [@contentstack/cli-cm-
|
|
1172
|
+
_See code: [@contentstack/cli-cm-import](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-import/src/commands/cm/stacks/import.js)_
|
|
625
1173
|
|
|
626
|
-
## `csdx cm:
|
|
1174
|
+
## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
|
|
627
1175
|
|
|
628
|
-
|
|
1176
|
+
Contentstack migration script.
|
|
629
1177
|
|
|
630
1178
|
```
|
|
631
|
-
Revert publish operations by using a log file
|
|
632
|
-
The revert command is used for reverting all publish operations performed using bulk-publish script.
|
|
633
|
-
A log file name is required to execute revert command
|
|
634
|
-
|
|
635
|
-
|
|
636
1179
|
USAGE
|
|
637
|
-
$ csdx cm:
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
-
|
|
1180
|
+
$ csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>]
|
|
1181
|
+
[--config <value>] [--multiple]
|
|
1182
|
+
|
|
1183
|
+
FLAGS
|
|
1184
|
+
-B, --branch=<value> Use this flag to add the branch name where you want to perform the migration.
|
|
1185
|
+
-a, --alias=<value> Use this flag to add the management token alias.
|
|
1186
|
+
-k, --stack-api-key=<value> With this flag add the API key of your stack.
|
|
1187
|
+
--config=<value> [optional] inline configuration, <key1>:<value1>
|
|
1188
|
+
--config-file=<value> [optional] Path of the JSON configuration file
|
|
1189
|
+
--file-path=<value> Use this flag to provide the path of the file of the migration script provided by the
|
|
1190
|
+
user.
|
|
1191
|
+
--multiple This flag helps you to migrate multiple content files in a single instance.
|
|
642
1192
|
|
|
643
1193
|
DESCRIPTION
|
|
644
|
-
|
|
645
|
-
|
|
1194
|
+
Contentstack migration script.
|
|
1195
|
+
|
|
1196
|
+
ALIASES
|
|
1197
|
+
$ csdx cm:migration
|
|
646
1198
|
|
|
647
1199
|
EXAMPLES
|
|
648
|
-
|
|
649
|
-
cm:bulk-publish:revert --logFile [LOG FILE NAME]
|
|
650
|
-
cm:bulk-publish:revert -l [LOG FILE NAME]
|
|
1200
|
+
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>
|
|
651
1201
|
|
|
652
|
-
|
|
653
|
-
cm:bulk-publish:revert --retryFailed [LOG FILE NAME]
|
|
654
|
-
cm:bulk-publish:revert -r [LOG FILE NAME]
|
|
655
|
-
```
|
|
1202
|
+
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>
|
|
656
1203
|
|
|
657
|
-
|
|
1204
|
+
$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>
|
|
658
1205
|
|
|
659
|
-
|
|
1206
|
+
$ csdx cm:migration --config-file <path/to/json/config/file> --file-path <migration/script/file/path>
|
|
660
1207
|
|
|
661
|
-
|
|
1208
|
+
$ csdx cm:migration --multiple --file-path <migration/scripts/dir/path>
|
|
662
1209
|
|
|
1210
|
+
$ csdx cm:migration --alias --file-path <migration/script/file/path> -k <api-key>
|
|
663
1211
|
```
|
|
664
|
-
Unpublish entries of given Content Types from given environment
|
|
665
|
-
The unpublish command is used for unpublishing entries from given environment
|
|
666
|
-
|
|
667
|
-
Environment (Source Environment) and Locale are required for executing the command successfully
|
|
668
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
669
1212
|
|
|
670
|
-
|
|
671
|
-
then all entries from all content types will be unpublished from the source environment
|
|
1213
|
+
_See code: [@contentstack/cli-migration](https://github.com/contentstack/cli-migration/blob/v1.0.0/src/commands/cm/stacks/migration.js)_
|
|
672
1214
|
|
|
673
|
-
|
|
674
|
-
(--onlyAssets and --onlyEntries cannot be used together at the same time)
|
|
1215
|
+
## `csdx cm:stacks:publish`
|
|
675
1216
|
|
|
1217
|
+
Publish entries and assets to multiple environments and locales
|
|
676
1218
|
|
|
1219
|
+
```
|
|
677
1220
|
USAGE
|
|
678
|
-
$ csdx cm:
|
|
1221
|
+
$ csdx cm:stacks:publish
|
|
679
1222
|
|
|
680
|
-
|
|
681
|
-
|
|
1223
|
+
DESCRIPTION
|
|
1224
|
+
Publish entries and assets to multiple environments and locales
|
|
682
1225
|
|
|
683
|
-
|
|
684
|
-
contentstack's bulkpublish API will be used for publishing the entries
|
|
1226
|
+
The publish command is used to publish entries and assets, to the specified environments and locales.
|
|
685
1227
|
|
|
686
|
-
|
|
1228
|
+
Note: Content types, Environments and Locales are required to execute the publish entries command successfully.
|
|
687
1229
|
|
|
688
|
-
|
|
1230
|
+
Note: Environments and Locales are required to execute the publish assets command successfully.
|
|
689
1231
|
|
|
690
|
-
-
|
|
1232
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
691
1233
|
|
|
692
|
-
|
|
1234
|
+
EXAMPLES
|
|
1235
|
+
General Usage
|
|
693
1236
|
|
|
694
|
-
|
|
1237
|
+
$ csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]
|
|
695
1238
|
|
|
696
|
-
-x, --deliveryToken=deliveryToken Delivery Token for source environment
|
|
697
1239
|
|
|
698
|
-
-y, --yes Agree to process the command with the current configuration
|
|
699
1240
|
|
|
700
|
-
--
|
|
1241
|
+
Using --config or -c flag
|
|
701
1242
|
|
|
702
|
-
|
|
1243
|
+
Generate a config file in the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
703
1244
|
|
|
704
|
-
|
|
705
|
-
The unpublish command is used for unpublishing entries from given environment
|
|
1245
|
+
$ csdx cm:stacks:publish --config [PATH TO CONFIG FILE]
|
|
706
1246
|
|
|
707
|
-
|
|
708
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
1247
|
+
$ csdx cm:stacks:publish -c [PATH TO CONFIG FILE]
|
|
709
1248
|
|
|
710
|
-
A Content Type can be specified for publishing entries, but if no content-type(s) is/are specified and --onlyAssets is
|
|
711
|
-
not used,
|
|
712
|
-
then all entries from all content types will be unpublished from the source environment
|
|
713
1249
|
|
|
714
|
-
--onlyAssets can be used to unpublish only assets and --onlyEntries can be used to unpublish only entries.
|
|
715
|
-
(--onlyAssets and --onlyEntries cannot be used together at the same time)
|
|
716
1250
|
|
|
717
|
-
|
|
718
|
-
General Usage
|
|
719
|
-
csdx cm:bulk-publish:unpublish -b -t [CONTENT TYPE] -e [SOURCE ENV] -l [LOCALE] -a [MANAGEMENT TOKEN ALIAS] -x
|
|
720
|
-
[DELIVERY TOKEN]
|
|
1251
|
+
Using --retry-failed flag
|
|
721
1252
|
|
|
722
|
-
|
|
723
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
724
|
-
csdx cm:bulk-publish:unpublish --config [PATH TO CONFIG FILE]
|
|
725
|
-
csdx cm:bulk-publish:unpublish -c [PATH TO CONFIG FILE]
|
|
1253
|
+
$ csdx cm:stacks:publish --retry-failed [LOG FILE NAME]
|
|
726
1254
|
|
|
727
|
-
Using --retryFailed or -r flag
|
|
728
|
-
csdx cm:bulk-publish:unpublish --retryFailed [LOG FILE NAME]
|
|
729
|
-
csdx cm:bulk-publish:unpublish -r [LOG FILE NAME]
|
|
730
1255
|
|
|
731
|
-
No content type
|
|
732
|
-
csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all
|
|
733
|
-
content types and assets from the source environment)
|
|
734
1256
|
|
|
735
|
-
Using --
|
|
736
|
-
csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] --onlyAssets (Will unpublish only assets
|
|
737
|
-
from the source environment)
|
|
1257
|
+
Using --branch flag
|
|
738
1258
|
|
|
739
|
-
|
|
740
|
-
csdx cm:bulk-publish:unpublish --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries (Will unpublish only
|
|
741
|
-
entries, all entries, from the source environment)
|
|
742
|
-
csdx cm:bulk-publish:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --onlyEntries
|
|
743
|
-
(Will unpublish only entries, (from CONTENT TYPE) from the source environment)
|
|
1259
|
+
$ csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
744
1260
|
```
|
|
745
1261
|
|
|
746
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/
|
|
1262
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish.js)_
|
|
747
1263
|
|
|
748
|
-
## `csdx cm:
|
|
1264
|
+
## `csdx cm:stacks:publish-clear-logs`
|
|
749
1265
|
|
|
750
|
-
|
|
1266
|
+
Clear the log folder
|
|
751
1267
|
|
|
752
1268
|
```
|
|
753
|
-
|
|
754
|
-
|
|
1269
|
+
USAGE
|
|
1270
|
+
$ csdx cm:stacks:publish-clear-logs [--log-files-count] [-y]
|
|
755
1271
|
|
|
756
|
-
|
|
757
|
-
|
|
1272
|
+
FLAGS
|
|
1273
|
+
-y, --yes Delete all files without asking for confirmation
|
|
1274
|
+
--log-files-count List number of log files
|
|
758
1275
|
|
|
1276
|
+
DESCRIPTION
|
|
1277
|
+
Clear the log folder
|
|
759
1278
|
|
|
760
|
-
|
|
761
|
-
$ csdx cm:bulk-publish:
|
|
1279
|
+
ALIASES
|
|
1280
|
+
$ csdx cm:bulk-publish:clear
|
|
762
1281
|
|
|
763
|
-
|
|
764
|
-
|
|
1282
|
+
EXAMPLES
|
|
1283
|
+
$ csdx cm:stacks:publish-clear-logs
|
|
765
1284
|
|
|
766
|
-
-
|
|
767
|
-
bulkpublish API will be used for publishing the entries
|
|
1285
|
+
$ csdx cm:stacks:publish-clear-logs --log-files-count
|
|
768
1286
|
|
|
769
|
-
-
|
|
1287
|
+
$ csdx cm:stacks:publish-clear-logs --yes
|
|
770
1288
|
|
|
771
|
-
-
|
|
1289
|
+
$ csdx cm:stacks:publish-clear-logs -y
|
|
1290
|
+
```
|
|
772
1291
|
|
|
773
|
-
|
|
1292
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-clear-logs.js)_
|
|
774
1293
|
|
|
775
|
-
|
|
1294
|
+
## `csdx cm:stacks:publish-configure`
|
|
776
1295
|
|
|
777
|
-
|
|
1296
|
+
The configure command is used to generate a configuration file for publish scripts.
|
|
778
1297
|
|
|
779
|
-
|
|
1298
|
+
```
|
|
1299
|
+
USAGE
|
|
1300
|
+
$ csdx cm:stacks:publish-configure [-a <value>]
|
|
780
1301
|
|
|
781
|
-
|
|
1302
|
+
FLAGS
|
|
1303
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
782
1304
|
|
|
783
1305
|
DESCRIPTION
|
|
784
|
-
The
|
|
785
|
-
environments and locales
|
|
1306
|
+
The configure command is used to generate a configuration file for publish scripts.
|
|
786
1307
|
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
1308
|
+
ALIASES
|
|
1309
|
+
$ csdx cm:bulk-publish:configure
|
|
790
1310
|
|
|
791
1311
|
EXAMPLES
|
|
792
|
-
|
|
793
|
-
csdx cm:bulk-publish:unpublished-entries -b -t [CONTENT TYPES] -e [ENVIRONMENTS] -l LOCALE -a [MANAGEMENT TOKEN ALIAS]
|
|
1312
|
+
$ csdx cm:stacks:publish-configure
|
|
794
1313
|
|
|
795
|
-
|
|
796
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
797
|
-
csdx cm:bulk-publish:unpublished-entries --config [PATH TO CONFIG FILE]
|
|
798
|
-
csdx cm:bulk-publish:unpublished-entries -c [PATH TO CONFIG FILE]
|
|
1314
|
+
$ csdx cm:stacks:publish-configure -a <management_token_alias>
|
|
799
1315
|
|
|
800
|
-
|
|
801
|
-
csdx cm:bulk-publish:unpublished-entries --retryFailed [LOG FILE NAME]
|
|
802
|
-
csdx cm:bulk-publish:unpublished-entries -r [LOG FILE NAME]
|
|
1316
|
+
$ csdx cm:stacks:publish-configure --alias <management_token_alias>
|
|
803
1317
|
```
|
|
804
1318
|
|
|
805
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/
|
|
1319
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-configure.js)_
|
|
806
1320
|
|
|
807
|
-
## `csdx cm:
|
|
1321
|
+
## `csdx cm:stacks:publish-revert`
|
|
808
1322
|
|
|
809
|
-
|
|
1323
|
+
Revert publish operations by using a log file
|
|
810
1324
|
|
|
811
1325
|
```
|
|
812
|
-
Export content from a stack
|
|
813
|
-
...
|
|
814
|
-
Export content from one stack to another
|
|
815
|
-
|
|
816
|
-
|
|
817
1326
|
USAGE
|
|
818
|
-
$ csdx cm:
|
|
1327
|
+
$ csdx cm:stacks:publish-revert [--retry-failed <value>] [--log-file <value>]
|
|
819
1328
|
|
|
820
|
-
|
|
821
|
-
-
|
|
822
|
-
|
|
823
|
-
-c, --config=config [optional] path of the config
|
|
824
|
-
-d, --data=data path or location to store the data
|
|
825
|
-
-m, --module=module [optional] specific module name
|
|
826
|
-
-s, --stack-uid=stack-uid API key of the source stack
|
|
1329
|
+
FLAGS
|
|
1330
|
+
--log-file=<value> logfile to be used to revert
|
|
1331
|
+
--retry-failed=<value> retry publishing failed entries from the logfile
|
|
827
1332
|
|
|
828
1333
|
DESCRIPTION
|
|
829
|
-
|
|
830
|
-
Export content from one stack to another
|
|
1334
|
+
Revert publish operations by using a log file
|
|
831
1335
|
|
|
832
|
-
|
|
833
|
-
csdx cm:export -A
|
|
834
|
-
csdx cm:export -A -s <stack_ApiKey> -d <path/of/export/destination/dir>
|
|
835
|
-
csdx cm:export -A -c <path/to/config/dir>
|
|
836
|
-
csdx cm:export -a <management_token_alias>
|
|
837
|
-
csdx cm:export -a <management_token_alias> -d <path/to/export/destination/dir>
|
|
838
|
-
csdx cm:export -a <management_token_alias> -c <path/to/config/file>
|
|
839
|
-
csdx cm:export -A -m <single module name>
|
|
840
|
-
```
|
|
1336
|
+
The revert command is used to revert all publish operations performed using bulk-publish script.
|
|
841
1337
|
|
|
842
|
-
|
|
1338
|
+
A log file name is required to execute revert command
|
|
843
1339
|
|
|
844
|
-
|
|
1340
|
+
ALIASES
|
|
1341
|
+
$ csdx cm:bulk-publish:revert
|
|
845
1342
|
|
|
846
|
-
|
|
1343
|
+
EXAMPLES
|
|
1344
|
+
Using --log-file
|
|
847
1345
|
|
|
848
|
-
|
|
849
|
-
Export entries or organization users to csv using this command
|
|
1346
|
+
cm:bulk-publish:revert --log-file [LOG FILE NAME]
|
|
850
1347
|
|
|
851
1348
|
|
|
852
|
-
USAGE
|
|
853
|
-
$ csdx cm:export-to-csv
|
|
854
|
-
```
|
|
855
1349
|
|
|
856
|
-
|
|
1350
|
+
Using --retry-failed
|
|
857
1351
|
|
|
858
|
-
|
|
1352
|
+
cm:bulk-publish:revert --retry-failed [LOG FILE NAME]
|
|
1353
|
+
```
|
|
859
1354
|
|
|
860
|
-
|
|
1355
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-revert.js)_
|
|
861
1356
|
|
|
862
|
-
|
|
863
|
-
Import script for importing the content into new stack
|
|
864
|
-
...
|
|
865
|
-
Once you export content from the source stack, import it to your destination stack by using the cm:import command.
|
|
1357
|
+
## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]`
|
|
866
1358
|
|
|
1359
|
+
Create a stack from existing content types, entries, assets, etc
|
|
867
1360
|
|
|
1361
|
+
```
|
|
868
1362
|
USAGE
|
|
869
|
-
$ csdx cm:
|
|
1363
|
+
$ csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]
|
|
870
1364
|
|
|
871
|
-
|
|
872
|
-
-
|
|
873
|
-
-
|
|
874
|
-
-
|
|
875
|
-
-
|
|
876
|
-
-
|
|
877
|
-
-
|
|
878
|
-
-s, --stack-uid=stack-uid API key of the target stack
|
|
1365
|
+
FLAGS
|
|
1366
|
+
-k, --stack-api-key=<value> Provide stack api key to seed content to
|
|
1367
|
+
-n, --stack-name=<value> Name of a new stack that needs to be created.
|
|
1368
|
+
-o, --org=<value> Provide Organization UID to create a new stack
|
|
1369
|
+
-r, --repo=<value> GitHub account or GitHub account/repository
|
|
1370
|
+
-s, --stack=<value> Provide stack UID to seed content to
|
|
1371
|
+
-y, --yes=<value>
|
|
879
1372
|
|
|
880
1373
|
DESCRIPTION
|
|
881
|
-
|
|
882
|
-
|
|
1374
|
+
Create a stack from existing content types, entries, assets, etc
|
|
1375
|
+
|
|
1376
|
+
ALIASES
|
|
1377
|
+
$ csdx cm:seed
|
|
883
1378
|
|
|
884
1379
|
EXAMPLES
|
|
885
|
-
csdx cm:
|
|
886
|
-
csdx cm:import -A -s <stack_ApiKey> -d <path/of/export/destination/dir>
|
|
887
|
-
csdx cm:import -A -c <path/of/config/dir>
|
|
888
|
-
csdx cm:import -a <management_token_alias>
|
|
889
|
-
csdx cm:import -a <management_token_alias> -d <path/of/export/destination/dir>
|
|
890
|
-
csdx cm:import -a <management_token_alias> -c <path/of/config/file>
|
|
891
|
-
csdx cm:import -A -m <single module name>
|
|
892
|
-
```
|
|
1380
|
+
$ csdx cm:stacks:seed
|
|
893
1381
|
|
|
894
|
-
|
|
1382
|
+
$ csdx cm:stacks:seed --repo "account"
|
|
895
1383
|
|
|
896
|
-
|
|
1384
|
+
$ csdx cm:stacks:seed --repo "account/repository"
|
|
897
1385
|
|
|
898
|
-
|
|
1386
|
+
$ csdx cm:stacks:seed --repo "account/repository" --stack-api-key "stack-api-key" //seed content into specific stack
|
|
899
1387
|
|
|
1388
|
+
$ csdx cm:stacks:seed --repo "account/repository" --org "your-org-uid" --stack-name "stack-name" //create a new stack in given org uid
|
|
900
1389
|
```
|
|
901
|
-
Migration script for migrating HTML RTE to JSON RTE
|
|
902
|
-
|
|
903
|
-
USAGE
|
|
904
|
-
$ csdx cm:migrate-rte
|
|
905
|
-
|
|
906
|
-
OPTIONS
|
|
907
|
-
-a, --alias=alias Alias for the management token to be used
|
|
908
|
-
-c, --content_type=content_type The content-type from which entries need to be migrated
|
|
909
|
-
-d, --delay=delay [default: 1000] Provide delay in ms between two entry update
|
|
910
1390
|
|
|
911
|
-
|
|
912
|
-
global-field
|
|
1391
|
+
_See code: [@contentstack/cli-cm-seed](https://github.com/contentstack/cli/blob/v1.1.0/src/commands/cm/stacks/seed.ts)_
|
|
913
1392
|
|
|
914
|
-
|
|
1393
|
+
## `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]`
|
|
915
1394
|
|
|
916
|
-
|
|
1395
|
+
Unpublish entries or assets of given content types from the specified environment
|
|
917
1396
|
|
|
918
|
-
|
|
1397
|
+
```
|
|
1398
|
+
USAGE
|
|
1399
|
+
$ csdx csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch <value>]
|
|
1400
|
+
[--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token <value>]
|
|
1401
|
+
[--only-assets] [--only-entries]
|
|
1402
|
+
|
|
1403
|
+
FLAGS
|
|
1404
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content from (default is main branch)
|
|
1405
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
1406
|
+
-c, --config=<value> Path to the config file
|
|
1407
|
+
-e, --environment=<value> Source Environment
|
|
1408
|
+
-l, --locale=<value> Locale filter
|
|
1409
|
+
-y, --yes Agree to process the command with the current configuration
|
|
1410
|
+
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
1411
|
+
bulkpublish API will be used to unpublish the entries and assets
|
|
1412
|
+
--content-type=<value> Content type filter
|
|
1413
|
+
--delivery-token=<value> Delivery token for source environment
|
|
1414
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
919
1415
|
|
|
920
|
-
|
|
1416
|
+
DESCRIPTION
|
|
1417
|
+
Unpublish entries or assets of given content types from the specified environment
|
|
921
1418
|
|
|
922
|
-
|
|
923
|
-
General Usage
|
|
924
|
-
csdx cm:migrate-rte -p path/to/config.json
|
|
1419
|
+
The unpublish command is used to unpublish entries or assets from given environment
|
|
925
1420
|
|
|
926
|
-
|
|
927
|
-
csdx cm:migrate-rte -a alias -c content_type_uid -h htmlPath -j jsonPath
|
|
1421
|
+
Environment (Source Environment) and Locale are required to execute the command successfully
|
|
928
1422
|
|
|
929
|
-
|
|
930
|
-
csdx cm:migrate-rte -a alias -c content_type_uid -h modular_block_uid.block_uid.html_rte_uid -j
|
|
931
|
-
modular_block_uid.block_uid.json_rte_uid
|
|
1423
|
+
But, if retry-failed flag is set, then only a logfile is required
|
|
932
1424
|
|
|
933
|
-
|
|
1425
|
+
A content type can be specified for unpublishing entries, but if no content-type(s) is/are specified and --only-assets
|
|
1426
|
+
is not used,
|
|
934
1427
|
|
|
935
|
-
|
|
936
|
-
csdx cm:migrate-rte -a alias -c global_field_uid -g -h htmlPath -j jsonPath
|
|
937
|
-
```
|
|
1428
|
+
then all entries from all content types will be unpublished from the source environment
|
|
938
1429
|
|
|
939
|
-
|
|
1430
|
+
Note: --only-assets can be used to unpublish only assets and --only-entries can be used to unpublish only entries.
|
|
940
1431
|
|
|
941
|
-
|
|
1432
|
+
(--only-assets and --only-entries cannot be used together at the same time)
|
|
942
1433
|
|
|
943
|
-
|
|
1434
|
+
ALIASES
|
|
1435
|
+
$ csdx cm:bulk-publish:unpublish
|
|
944
1436
|
|
|
945
|
-
|
|
946
|
-
|
|
1437
|
+
EXAMPLES
|
|
1438
|
+
General Usage
|
|
947
1439
|
|
|
948
|
-
|
|
949
|
-
$ csdx cm:seed
|
|
1440
|
+
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] ----delivery-token [DELIVERY TOKEN]
|
|
950
1441
|
|
|
951
|
-
OPTIONS
|
|
952
|
-
-r, --repo=repo GitHub account or GitHub account/repository
|
|
953
1442
|
|
|
954
|
-
EXAMPLES
|
|
955
|
-
$ csdx cm:seed
|
|
956
|
-
$ csdx cm:seed -r "account"
|
|
957
|
-
$ csdx cm:seed -r "account/repository"
|
|
958
|
-
```
|
|
959
1443
|
|
|
960
|
-
|
|
1444
|
+
Using --config or -c flag
|
|
961
1445
|
|
|
962
|
-
|
|
1446
|
+
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
|
|
963
1447
|
|
|
964
|
-
|
|
1448
|
+
$ csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]
|
|
965
1449
|
|
|
966
|
-
|
|
967
|
-
Clone data (structure or content or both) of a stack into another stack
|
|
968
|
-
Use this plugin to automate the process of cloning a stack in a few steps.
|
|
1450
|
+
$ csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]
|
|
969
1451
|
|
|
970
1452
|
|
|
971
|
-
USAGE
|
|
972
|
-
$ csdx cm:stack-clone
|
|
973
1453
|
|
|
974
|
-
|
|
975
|
-
Use this plugin to automate the process of cloning a stack in a few steps.
|
|
1454
|
+
Using --retry-failed flag
|
|
976
1455
|
|
|
977
|
-
|
|
978
|
-
csdx cm:stack-clone
|
|
979
|
-
```
|
|
1456
|
+
$ csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]
|
|
980
1457
|
|
|
981
|
-
_See code: [@contentstack/cli-cm-clone](https://github.com/contentstack/cli/blob/v0.1.0-beta.1/src/commands/cm/stack-clone.js)_
|
|
982
1458
|
|
|
983
|
-
## `csdx config:get:region`
|
|
984
1459
|
|
|
985
|
-
|
|
1460
|
+
No content type
|
|
986
1461
|
|
|
987
|
-
|
|
988
|
-
Get current region set for CLI
|
|
1462
|
+
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all content types and assets from the source environment)
|
|
989
1463
|
|
|
990
1464
|
|
|
991
|
-
USAGE
|
|
992
|
-
$ csdx config:get:region
|
|
993
|
-
```
|
|
994
1465
|
|
|
995
|
-
|
|
1466
|
+
Using --only-assets
|
|
996
1467
|
|
|
997
|
-
|
|
1468
|
+
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-assets (Will unpublish only assets from the source environment)
|
|
998
1469
|
|
|
999
|
-
Set region for CLI
|
|
1000
1470
|
|
|
1001
|
-
```
|
|
1002
|
-
Set region for CLI
|
|
1003
1471
|
|
|
1472
|
+
Using --only-entries
|
|
1004
1473
|
|
|
1005
|
-
|
|
1006
|
-
$ csdx config:set:region [REGION]
|
|
1474
|
+
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, all entries, from the source environment)
|
|
1007
1475
|
|
|
1008
|
-
|
|
1009
|
-
REGION (EU|NA) North America(NA), Europe (EU)
|
|
1476
|
+
$ csdx cm:stacks:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, (from CONTENT TYPE) from the source environment)
|
|
1010
1477
|
|
|
1011
|
-
OPTIONS
|
|
1012
|
-
-d, --cda=cda Custom host to set for content delivery API, if this flag is added then cma and name flags are
|
|
1013
|
-
required
|
|
1014
1478
|
|
|
1015
|
-
-m, --cma=cma Custom host to set for content management API, , if this flag is added then cda and name flags are
|
|
1016
|
-
required
|
|
1017
1479
|
|
|
1018
|
-
|
|
1480
|
+
Using --branch flag
|
|
1019
1481
|
|
|
1020
|
-
|
|
1021
|
-
$ csdx config:set:region EU
|
|
1022
|
-
$ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --name "India"
|
|
1023
|
-
$ csdx config:set:region --cma="https://in-api.contentstack.com" --cda="https://in-cda.contentstack.com"
|
|
1024
|
-
--name="India"
|
|
1482
|
+
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
1025
1483
|
```
|
|
1026
1484
|
|
|
1027
|
-
_See code: [
|
|
1485
|
+
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/v1.0.0/packages/contentstack-bulk-publish/src/commands/cm/stacks/unpublish.js)_
|
|
1028
1486
|
|
|
1029
|
-
## `csdx
|
|
1487
|
+
## `csdx config:get:region`
|
|
1030
1488
|
|
|
1031
|
-
|
|
1489
|
+
Get current region set for CLI
|
|
1032
1490
|
|
|
1033
1491
|
```
|
|
1034
|
-
display help for <%= config.bin %>
|
|
1035
|
-
|
|
1036
1492
|
USAGE
|
|
1037
|
-
$ csdx
|
|
1493
|
+
$ csdx config:get:region
|
|
1038
1494
|
|
|
1039
|
-
|
|
1040
|
-
|
|
1495
|
+
DESCRIPTION
|
|
1496
|
+
Get current region set for CLI
|
|
1041
1497
|
|
|
1042
|
-
|
|
1043
|
-
|
|
1498
|
+
EXAMPLES
|
|
1499
|
+
$ csdx config:get:region
|
|
1044
1500
|
```
|
|
1045
1501
|
|
|
1046
|
-
_See code: [@
|
|
1502
|
+
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/v1.0.0/src/commands/config/get/region.ts)_
|
|
1047
1503
|
|
|
1048
|
-
## `csdx
|
|
1504
|
+
## `csdx config:set:region [REGION]`
|
|
1049
1505
|
|
|
1050
|
-
|
|
1506
|
+
Set region for CLI
|
|
1051
1507
|
|
|
1052
1508
|
```
|
|
1053
|
-
list installed plugins
|
|
1054
|
-
|
|
1055
1509
|
USAGE
|
|
1056
|
-
$ csdx
|
|
1510
|
+
$ csdx config:set:region [REGION] [-d <value>] [-m <value>] [-n <value>]
|
|
1057
1511
|
|
|
1058
|
-
|
|
1059
|
-
--
|
|
1512
|
+
FLAGS
|
|
1513
|
+
-d, --cda=<value> Custom host to set for content delivery API, if this flag is added then cma and name flags are
|
|
1514
|
+
required
|
|
1515
|
+
-m, --cma=<value> Custom host to set for content management API, , if this flag is added then cda and name flags are
|
|
1516
|
+
required
|
|
1517
|
+
-n, --name=<value> Name for the region, if this flag is added then cda and cma flags are required
|
|
1060
1518
|
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
```
|
|
1519
|
+
DESCRIPTION
|
|
1520
|
+
Set region for CLI
|
|
1064
1521
|
|
|
1065
|
-
|
|
1522
|
+
EXAMPLES
|
|
1523
|
+
$ csdx config:set:region
|
|
1066
1524
|
|
|
1067
|
-
|
|
1525
|
+
$ csdx config:set:region NA
|
|
1068
1526
|
|
|
1069
|
-
|
|
1527
|
+
$ csdx config:set:region NA
|
|
1070
1528
|
|
|
1529
|
+
$ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --name "India"
|
|
1071
1530
|
```
|
|
1072
|
-
generate plugin starter code
|
|
1073
1531
|
|
|
1532
|
+
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/v1.0.0/src/commands/config/set/region.ts)_
|
|
1074
1533
|
|
|
1534
|
+
## `csdx plugins`
|
|
1535
|
+
|
|
1536
|
+
List installed plugins.
|
|
1537
|
+
|
|
1538
|
+
```
|
|
1075
1539
|
USAGE
|
|
1076
|
-
$ csdx plugins
|
|
1540
|
+
$ csdx plugins [--core]
|
|
1541
|
+
|
|
1542
|
+
FLAGS
|
|
1543
|
+
--core Show core plugins.
|
|
1544
|
+
|
|
1545
|
+
DESCRIPTION
|
|
1546
|
+
List installed plugins.
|
|
1547
|
+
|
|
1548
|
+
EXAMPLES
|
|
1549
|
+
$ csdx plugins
|
|
1077
1550
|
```
|
|
1078
1551
|
|
|
1079
|
-
_See code: [@
|
|
1552
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/index.ts)_
|
|
1080
1553
|
|
|
1081
1554
|
## `csdx plugins:inspect PLUGIN...`
|
|
1082
1555
|
|
|
1083
|
-
|
|
1556
|
+
Displays installation properties of a plugin.
|
|
1084
1557
|
|
|
1085
1558
|
```
|
|
1086
|
-
displays installation properties of a plugin
|
|
1087
|
-
|
|
1088
1559
|
USAGE
|
|
1089
1560
|
$ csdx plugins:inspect PLUGIN...
|
|
1090
1561
|
|
|
1091
1562
|
ARGUMENTS
|
|
1092
|
-
PLUGIN [default: .]
|
|
1563
|
+
PLUGIN [default: .] Plugin to inspect.
|
|
1093
1564
|
|
|
1094
|
-
|
|
1095
|
-
-h, --help
|
|
1565
|
+
FLAGS
|
|
1566
|
+
-h, --help Show CLI help.
|
|
1096
1567
|
-v, --verbose
|
|
1097
1568
|
|
|
1098
|
-
|
|
1569
|
+
DESCRIPTION
|
|
1570
|
+
Displays installation properties of a plugin.
|
|
1571
|
+
|
|
1572
|
+
EXAMPLES
|
|
1099
1573
|
$ csdx plugins:inspect myplugin
|
|
1100
1574
|
```
|
|
1101
1575
|
|
|
1102
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
1576
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/inspect.ts)_
|
|
1103
1577
|
|
|
1104
1578
|
## `csdx plugins:install PLUGIN...`
|
|
1105
1579
|
|
|
1106
|
-
|
|
1580
|
+
Installs a plugin into the CLI.
|
|
1107
1581
|
|
|
1108
1582
|
```
|
|
1109
|
-
installs a plugin into the CLI
|
|
1110
|
-
Can be installed from npm or a git url.
|
|
1111
|
-
|
|
1112
|
-
Installation of a user-installed plugin will override a core plugin.
|
|
1113
|
-
|
|
1114
|
-
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in the CLI without the need to patch and update the whole CLI.
|
|
1115
|
-
|
|
1116
|
-
|
|
1117
1583
|
USAGE
|
|
1118
1584
|
$ csdx plugins:install PLUGIN...
|
|
1119
1585
|
|
|
1120
1586
|
ARGUMENTS
|
|
1121
|
-
PLUGIN
|
|
1587
|
+
PLUGIN Plugin to install.
|
|
1122
1588
|
|
|
1123
|
-
|
|
1124
|
-
-f, --force yarn install with force flag
|
|
1125
|
-
-h, --help
|
|
1589
|
+
FLAGS
|
|
1590
|
+
-f, --force Run yarn install with force flag.
|
|
1591
|
+
-h, --help Show CLI help.
|
|
1126
1592
|
-v, --verbose
|
|
1127
1593
|
|
|
1128
1594
|
DESCRIPTION
|
|
1595
|
+
Installs a plugin into the CLI.
|
|
1596
|
+
|
|
1129
1597
|
Can be installed from npm or a git url.
|
|
1130
1598
|
|
|
1131
1599
|
Installation of a user-installed plugin will override a core plugin.
|
|
1132
1600
|
|
|
1133
|
-
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
1134
|
-
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
1601
|
+
e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command
|
|
1602
|
+
will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in
|
|
1135
1603
|
the CLI without the need to patch and update the whole CLI.
|
|
1136
1604
|
|
|
1137
1605
|
ALIASES
|
|
@@ -1139,83 +1607,87 @@ ALIASES
|
|
|
1139
1607
|
|
|
1140
1608
|
EXAMPLES
|
|
1141
1609
|
$ csdx plugins:install myplugin
|
|
1610
|
+
|
|
1142
1611
|
$ csdx plugins:install https://github.com/someuser/someplugin
|
|
1612
|
+
|
|
1143
1613
|
$ csdx plugins:install someuser/someplugin
|
|
1144
1614
|
```
|
|
1145
1615
|
|
|
1146
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
1616
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/install.ts)_
|
|
1147
1617
|
|
|
1148
1618
|
## `csdx plugins:link PLUGIN`
|
|
1149
1619
|
|
|
1150
|
-
|
|
1620
|
+
Links a plugin into the CLI for development.
|
|
1151
1621
|
|
|
1152
1622
|
```
|
|
1153
|
-
links a plugin into the CLI for development
|
|
1154
|
-
Installation of a linked plugin will override a user-installed or core plugin.
|
|
1155
|
-
|
|
1156
|
-
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' command will override the user-installed or core plugin implementation. This is useful for development work.
|
|
1157
|
-
|
|
1158
|
-
|
|
1159
1623
|
USAGE
|
|
1160
1624
|
$ csdx plugins:link PLUGIN
|
|
1161
1625
|
|
|
1162
1626
|
ARGUMENTS
|
|
1163
1627
|
PATH [default: .] path to plugin
|
|
1164
1628
|
|
|
1165
|
-
|
|
1166
|
-
-h, --help
|
|
1629
|
+
FLAGS
|
|
1630
|
+
-h, --help Show CLI help.
|
|
1167
1631
|
-v, --verbose
|
|
1168
1632
|
|
|
1169
1633
|
DESCRIPTION
|
|
1634
|
+
Links a plugin into the CLI for development.
|
|
1635
|
+
|
|
1170
1636
|
Installation of a linked plugin will override a user-installed or core plugin.
|
|
1171
1637
|
|
|
1172
|
-
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
1638
|
+
e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
|
|
1173
1639
|
command will override the user-installed or core plugin implementation. This is useful for development work.
|
|
1174
1640
|
|
|
1175
|
-
|
|
1641
|
+
EXAMPLES
|
|
1176
1642
|
$ csdx plugins:link myplugin
|
|
1177
1643
|
```
|
|
1178
1644
|
|
|
1179
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
1645
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/link.ts)_
|
|
1180
1646
|
|
|
1181
1647
|
## `csdx plugins:uninstall PLUGIN...`
|
|
1182
1648
|
|
|
1183
|
-
|
|
1649
|
+
Removes a plugin from the CLI.
|
|
1184
1650
|
|
|
1185
1651
|
```
|
|
1186
|
-
removes a plugin from the CLI
|
|
1187
|
-
|
|
1188
1652
|
USAGE
|
|
1189
1653
|
$ csdx plugins:uninstall PLUGIN...
|
|
1190
1654
|
|
|
1191
1655
|
ARGUMENTS
|
|
1192
1656
|
PLUGIN plugin to uninstall
|
|
1193
1657
|
|
|
1194
|
-
|
|
1195
|
-
-h, --help
|
|
1658
|
+
FLAGS
|
|
1659
|
+
-h, --help Show CLI help.
|
|
1196
1660
|
-v, --verbose
|
|
1197
1661
|
|
|
1662
|
+
DESCRIPTION
|
|
1663
|
+
Removes a plugin from the CLI.
|
|
1664
|
+
|
|
1198
1665
|
ALIASES
|
|
1199
1666
|
$ csdx plugins:unlink
|
|
1200
1667
|
$ csdx plugins:remove
|
|
1201
1668
|
```
|
|
1202
1669
|
|
|
1203
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
1670
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/uninstall.ts)_
|
|
1204
1671
|
|
|
1205
1672
|
## `csdx plugins:update`
|
|
1206
1673
|
|
|
1207
|
-
|
|
1674
|
+
Update installed plugins.
|
|
1208
1675
|
|
|
1209
1676
|
```
|
|
1210
|
-
update installed plugins
|
|
1211
|
-
|
|
1212
1677
|
USAGE
|
|
1213
|
-
$ csdx plugins:update
|
|
1678
|
+
$ csdx plugins:update [-h] [-v]
|
|
1214
1679
|
|
|
1215
|
-
|
|
1216
|
-
-h, --help
|
|
1680
|
+
FLAGS
|
|
1681
|
+
-h, --help Show CLI help.
|
|
1217
1682
|
-v, --verbose
|
|
1683
|
+
|
|
1684
|
+
DESCRIPTION
|
|
1685
|
+
Update installed plugins.
|
|
1218
1686
|
```
|
|
1219
1687
|
|
|
1220
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/
|
|
1688
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v2.1.0/src/commands/plugins/update.ts)_
|
|
1221
1689
|
<!-- commandsstop -->
|
|
1690
|
+
|
|
1691
|
+
```
|
|
1692
|
+
|
|
1693
|
+
```
|