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