@contentstack/cli 2.0.0-beta.3 → 2.0.0-beta.5
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 +1 -1
- package/README.md +243 -833
- package/lib/hooks/prerun/latest-version-warning.js +5 -1
- package/oclif.manifest.json +1 -1
- package/package.json +21 -21
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli
|
|
|
18
18
|
$ csdx COMMAND
|
|
19
19
|
running command...
|
|
20
20
|
$ csdx (--version|-v)
|
|
21
|
-
@contentstack/cli/2.0.0-beta.
|
|
21
|
+
@contentstack/cli/2.0.0-beta.5 linux-x64 node-v22.22.0
|
|
22
22
|
$ csdx --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ csdx COMMAND
|
|
@@ -29,8 +29,6 @@ USAGE
|
|
|
29
29
|
# Commands
|
|
30
30
|
|
|
31
31
|
<!-- commands -->
|
|
32
|
-
* [`csdx audit`](#csdx-audit)
|
|
33
|
-
* [`csdx audit:fix`](#csdx-auditfix)
|
|
34
32
|
* [`csdx auth:login`](#csdx-authlogin)
|
|
35
33
|
* [`csdx auth:logout`](#csdx-authlogout)
|
|
36
34
|
* [`csdx auth:tokens`](#csdx-authtokens)
|
|
@@ -63,40 +61,35 @@ USAGE
|
|
|
63
61
|
* [`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)
|
|
64
62
|
* [`csdx cm:entries:unpublish`](#csdx-cmentriesunpublish)
|
|
65
63
|
* [`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)
|
|
66
|
-
* [`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)
|
|
67
|
-
* [`csdx cm:export-to-csv`](#csdx-cmexport-to-csv)
|
|
68
|
-
* [`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)
|
|
69
|
-
* [`csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]`](#csdx-cmstacksimport-setup--k-value--d-value--a-value---modules-valuevalue)
|
|
70
|
-
* [`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)
|
|
71
|
-
* [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>] [--locale <value>]`](#csdx-cmstacksseed---repo-value---org-value--k-value--n-value--y-value--s-value---locale-value)
|
|
72
|
-
* [`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)
|
|
73
64
|
* [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
|
|
74
65
|
* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
|
|
75
|
-
* [`csdx cm:stacks:
|
|
76
|
-
* [`csdx cm:stacks:
|
|
77
|
-
* [`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)
|
|
66
|
+
* [`csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`](#csdx-cmstacksexport---config-value---stack-api-key-value---data-dir-value---alias-value---module-value---content-types-value---branch-value---secured-assets)
|
|
67
|
+
* [`csdx cm:stacks:import [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport---config-value---stack-api-key-value---data-dir-value---alias-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent)
|
|
78
68
|
* [`csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]`](#csdx-cmstacksimport-setup--k-value--d-value--a-value---modules-valuevalue)
|
|
79
69
|
* [`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)
|
|
80
70
|
* [`csdx cm:stacks:publish`](#csdx-cmstackspublish)
|
|
81
71
|
* [`csdx cm:stacks:publish-clear-logs`](#csdx-cmstackspublish-clear-logs)
|
|
82
72
|
* [`csdx cm:stacks:publish-configure`](#csdx-cmstackspublish-configure)
|
|
83
73
|
* [`csdx cm:stacks:publish-revert`](#csdx-cmstackspublish-revert)
|
|
84
|
-
* [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [-
|
|
74
|
+
* [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes <value>] [--alias <value>] [--locale <value>]`](#csdx-cmstacksseed---repo-value---org-value---stack-api-key-value---stack-name-value---yes-value---alias-value---locale-value)
|
|
85
75
|
* [`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)
|
|
86
76
|
* [`csdx config:get:base-branch`](#csdx-configgetbase-branch)
|
|
87
77
|
* [`csdx config:get:ea-header`](#csdx-configgetea-header)
|
|
88
78
|
* [`csdx config:get:early-access-header`](#csdx-configgetearly-access-header)
|
|
89
79
|
* [`csdx config:get:log`](#csdx-configgetlog)
|
|
80
|
+
* [`csdx config:get:proxy`](#csdx-configgetproxy)
|
|
90
81
|
* [`csdx config:get:rate-limit`](#csdx-configgetrate-limit)
|
|
91
82
|
* [`csdx config:get:region`](#csdx-configgetregion)
|
|
92
83
|
* [`csdx config:remove:base-branch`](#csdx-configremovebase-branch)
|
|
93
84
|
* [`csdx config:remove:ea-header`](#csdx-configremoveea-header)
|
|
94
85
|
* [`csdx config:remove:early-access-header`](#csdx-configremoveearly-access-header)
|
|
86
|
+
* [`csdx config:remove:proxy`](#csdx-configremoveproxy)
|
|
95
87
|
* [`csdx config:remove:rate-limit`](#csdx-configremoverate-limit)
|
|
96
88
|
* [`csdx config:set:base-branch`](#csdx-configsetbase-branch)
|
|
97
89
|
* [`csdx config:set:ea-header`](#csdx-configsetea-header)
|
|
98
90
|
* [`csdx config:set:early-access-header`](#csdx-configsetearly-access-header)
|
|
99
91
|
* [`csdx config:set:log`](#csdx-configsetlog)
|
|
92
|
+
* [`csdx config:set:proxy`](#csdx-configsetproxy)
|
|
100
93
|
* [`csdx config:set:rate-limit`](#csdx-configsetrate-limit)
|
|
101
94
|
* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
|
|
102
95
|
* [`csdx help [COMMAND]`](#csdx-help-command)
|
|
@@ -121,113 +114,6 @@ USAGE
|
|
|
121
114
|
* [`csdx tokens`](#csdx-tokens)
|
|
122
115
|
* [`csdx whoami`](#csdx-whoami)
|
|
123
116
|
|
|
124
|
-
## `csdx audit`
|
|
125
|
-
|
|
126
|
-
Perform audits and find possible errors in the exported Contentstack data
|
|
127
|
-
|
|
128
|
-
```
|
|
129
|
-
USAGE
|
|
130
|
-
$ csdx audit [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
131
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
|
|
132
|
-
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
133
|
-
|
|
134
|
-
FLAGS
|
|
135
|
-
--modules=<option>... Provide the list of modules to be audited
|
|
136
|
-
<options:
|
|
137
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
138
|
-
--report-path=<value> Path to store the audit reports
|
|
139
|
-
|
|
140
|
-
COMMON FLAGS
|
|
141
|
-
-c, --config=<value> Path of the external config
|
|
142
|
-
-d, --data-dir=<value> Path where the data is stored
|
|
143
|
-
--show-console-output Display the audit and audit fix result for individual modules
|
|
144
|
-
|
|
145
|
-
TABLE FLAGS
|
|
146
|
-
--columns=<value> Specify columns to display, comma-separated.
|
|
147
|
-
--csv Output results in CSV format.
|
|
148
|
-
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
149
|
-
--no-header Hide table headers in output.
|
|
150
|
-
--no-truncate Prevent truncation of long text in columns.
|
|
151
|
-
--output=<option> Specify output format: csv, json, or yaml.
|
|
152
|
-
<options: csv|json|yaml>
|
|
153
|
-
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
154
|
-
|
|
155
|
-
DESCRIPTION
|
|
156
|
-
Perform audits and find possible errors in the exported Contentstack data
|
|
157
|
-
|
|
158
|
-
ALIASES
|
|
159
|
-
$ csdx audit
|
|
160
|
-
$ csdx cm:stacks:audit
|
|
161
|
-
|
|
162
|
-
EXAMPLES
|
|
163
|
-
$ csdx audit
|
|
164
|
-
|
|
165
|
-
$ csdx audit --report-path=<path>
|
|
166
|
-
|
|
167
|
-
$ csdx audit --report-path=<path> --csv
|
|
168
|
-
|
|
169
|
-
$ csdx audit --report-path=<path> --filter="name=<filter-value>"
|
|
170
|
-
|
|
171
|
-
$ csdx audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
|
|
172
|
-
```
|
|
173
|
-
|
|
174
|
-
## `csdx audit:fix`
|
|
175
|
-
|
|
176
|
-
Perform audits and fix possible errors in the exported Contentstack data.
|
|
177
|
-
|
|
178
|
-
```
|
|
179
|
-
USAGE
|
|
180
|
-
$ csdx audit:fix [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
181
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
|
|
182
|
-
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
|
|
183
|
-
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
184
|
-
|
|
185
|
-
FLAGS
|
|
186
|
-
--copy-dir Create backup from the original data.
|
|
187
|
-
--copy-path=<value> Provide the path to backup the copied data
|
|
188
|
-
--fix-only=<option>... Provide the list of fix options
|
|
189
|
-
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
190
|
-
--modules=<option>... Provide the list of modules to be audited
|
|
191
|
-
<options:
|
|
192
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
193
|
-
--report-path=<value> Path to store the audit reports
|
|
194
|
-
|
|
195
|
-
COMMON FLAGS
|
|
196
|
-
-c, --config=<value> Path of the external config
|
|
197
|
-
-d, --data-dir=<value> Path where the data is stored
|
|
198
|
-
--show-console-output Display the audit and audit fix result for individual modules
|
|
199
|
-
|
|
200
|
-
TABLE FLAGS
|
|
201
|
-
--columns=<value> Specify columns to display, comma-separated.
|
|
202
|
-
--csv Output results in CSV format.
|
|
203
|
-
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
204
|
-
--no-header Hide table headers in output.
|
|
205
|
-
--no-truncate Prevent truncation of long text in columns.
|
|
206
|
-
--output=<option> Specify output format: csv, json, or yaml.
|
|
207
|
-
<options: csv|json|yaml>
|
|
208
|
-
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
209
|
-
|
|
210
|
-
DESCRIPTION
|
|
211
|
-
Perform audits and fix possible errors in the exported Contentstack data.
|
|
212
|
-
|
|
213
|
-
ALIASES
|
|
214
|
-
$ csdx audit:fix
|
|
215
|
-
$ csdx cm:stacks:audit:fix
|
|
216
|
-
|
|
217
|
-
EXAMPLES
|
|
218
|
-
$ csdx audit:fix --copy-dir
|
|
219
|
-
|
|
220
|
-
$ csdx audit:fix --report-path=<path> --copy-dir
|
|
221
|
-
|
|
222
|
-
$ csdx audit:fix --report-path=<path> --copy-dir --csv
|
|
223
|
-
|
|
224
|
-
$ csdx audit:fix --fix-only=reference,global_field --copy-dir
|
|
225
|
-
|
|
226
|
-
$ csdx audit:fix --report-path=<path> --filter="name=<filter-value>"
|
|
227
|
-
|
|
228
|
-
$ csdx audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
|
|
229
|
-
```
|
|
230
|
-
|
|
231
117
|
## `csdx auth:login`
|
|
232
118
|
|
|
233
119
|
User sessions login
|
|
@@ -329,12 +215,12 @@ USAGE
|
|
|
329
215
|
|
|
330
216
|
FLAGS
|
|
331
217
|
-a, --alias=<value> Alias (name) you want to assign to the token
|
|
332
|
-
-d, --delivery Set this flag to save delivery token
|
|
333
218
|
-e, --environment=<value> Environment name for delivery token
|
|
334
219
|
-k, --stack-api-key=<value> Stack API Key
|
|
335
|
-
-m, --management Set this flag to save management token
|
|
336
|
-
-t, --token=<value> [env: TOKEN] Add the token name
|
|
337
220
|
-y, --yes Use this flag to skip confirmation
|
|
221
|
+
--delivery Set this flag to save delivery token
|
|
222
|
+
--management Set this flag to save management token
|
|
223
|
+
--token=<value> [env: TOKEN] Add the token name
|
|
338
224
|
|
|
339
225
|
DESCRIPTION
|
|
340
226
|
Adds management/delivery tokens to your session to use it with other CLI commands
|
|
@@ -2115,208 +2001,173 @@ EXAMPLES
|
|
|
2115
2001
|
|
|
2116
2002
|
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/update-and-publish.js)_
|
|
2117
2003
|
|
|
2118
|
-
## `csdx cm:stacks:
|
|
2004
|
+
## `csdx cm:stacks:audit`
|
|
2119
2005
|
|
|
2120
|
-
|
|
2006
|
+
Perform audits and find possible errors in the exported Contentstack data
|
|
2121
2007
|
|
|
2122
2008
|
```
|
|
2123
2009
|
USAGE
|
|
2124
|
-
$ csdx cm:
|
|
2125
|
-
|
|
2010
|
+
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
2011
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules|composable-studio...]
|
|
2012
|
+
[--columns <value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output
|
|
2013
|
+
csv|json|yaml]
|
|
2126
2014
|
|
|
2127
2015
|
FLAGS
|
|
2128
|
-
|
|
2129
|
-
|
|
2130
|
-
|
|
2131
|
-
-
|
|
2132
|
-
-c, --config=<value> [optional] Path of the config
|
|
2133
|
-
-d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
|
|
2134
|
-
./content
|
|
2135
|
-
-k, --stack-api-key=<value> API Key of the source stack
|
|
2136
|
-
-m, --module=<value> [optional] Specific module name. If not specified, the export command will export all
|
|
2137
|
-
the modules to the stack. The available modules are assets, content-types, entries,
|
|
2138
|
-
environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
|
|
2139
|
-
workflows, custom-roles, taxonomies, and studio.
|
|
2140
|
-
-t, --content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
|
|
2141
|
-
of multiple content types, specify the IDs separated by spaces.
|
|
2142
|
-
-y, --yes [optional] Force override all Marketplace prompts.
|
|
2143
|
-
--branch-alias=<value> (Optional) The alias of the branch from which you want to export content.
|
|
2144
|
-
--secured-assets [optional] Use this flag for assets that are secured.
|
|
2145
|
-
|
|
2146
|
-
DESCRIPTION
|
|
2147
|
-
Export content from a stack
|
|
2016
|
+
--modules=<option>... Provide the list of modules to be audited
|
|
2017
|
+
<options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-ru
|
|
2018
|
+
les|composable-studio>
|
|
2019
|
+
--report-path=<value> Path to store the audit reports
|
|
2148
2020
|
|
|
2149
|
-
|
|
2150
|
-
|
|
2021
|
+
COMMON FLAGS
|
|
2022
|
+
-c, --config=<value> Path of the external config
|
|
2023
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
2024
|
+
--show-console-output Display the audit and audit fix result for individual modules
|
|
2151
2025
|
|
|
2152
|
-
|
|
2153
|
-
|
|
2026
|
+
TABLE FLAGS
|
|
2027
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
2028
|
+
--csv Output results in CSV format.
|
|
2029
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
2030
|
+
--no-header Hide table headers in output.
|
|
2031
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
2032
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
2033
|
+
<options: csv|json|yaml>
|
|
2034
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
2154
2035
|
|
|
2155
|
-
|
|
2036
|
+
DESCRIPTION
|
|
2037
|
+
Perform audits and find possible errors in the exported Contentstack data
|
|
2156
2038
|
|
|
2157
|
-
|
|
2039
|
+
EXAMPLES
|
|
2040
|
+
$ csdx cm:stacks:audit
|
|
2158
2041
|
|
|
2159
|
-
$ csdx cm:stacks:
|
|
2042
|
+
$ csdx cm:stacks:audit --report-path=<path>
|
|
2160
2043
|
|
|
2161
|
-
$ csdx cm:stacks:
|
|
2044
|
+
$ csdx cm:stacks:audit --report-path=<path> --csv
|
|
2162
2045
|
|
|
2163
|
-
$ csdx cm:stacks:
|
|
2046
|
+
$ csdx cm:stacks:audit --report-path=<path> --filter="name=<filter-value>"
|
|
2164
2047
|
|
|
2165
|
-
$ csdx cm:stacks:
|
|
2048
|
+
$ csdx cm:stacks:audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
|
|
2166
2049
|
```
|
|
2167
2050
|
|
|
2168
|
-
|
|
2051
|
+
_See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts)_
|
|
2052
|
+
|
|
2053
|
+
## `csdx cm:stacks:audit:fix`
|
|
2169
2054
|
|
|
2170
|
-
|
|
2055
|
+
Perform audits and fix possible errors in the exported Contentstack data.
|
|
2171
2056
|
|
|
2172
2057
|
```
|
|
2173
2058
|
USAGE
|
|
2174
|
-
$ csdx cm:
|
|
2175
|
-
|
|
2176
|
-
[--
|
|
2059
|
+
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
2060
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules|composable-studio...]
|
|
2061
|
+
[--copy-path <value> --copy-dir] [--fix-only
|
|
2062
|
+
reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns <value>] [--sort <value>]
|
|
2063
|
+
[--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
2177
2064
|
|
|
2178
2065
|
FLAGS
|
|
2179
|
-
-
|
|
2180
|
-
|
|
2181
|
-
|
|
2182
|
-
|
|
2183
|
-
|
|
2184
|
-
|
|
2185
|
-
|
|
2186
|
-
|
|
2187
|
-
--delimiter=<value> [default: ,] [optional] Provide a delimiter to separate individual data fields within
|
|
2188
|
-
the CSV file. For example: cm:export-to-csv --delimiter '|'
|
|
2189
|
-
--fallback-locale=<value> [Optional] Specify a specific fallback locale for taxonomy export. This locale will be
|
|
2190
|
-
used when a taxonomy term doesn't exist in the primary locale. Takes priority over
|
|
2191
|
-
branch fallback hierarchy when both are specified.
|
|
2192
|
-
--include-fallback [Optional] Include fallback locale data when exporting taxonomies. When enabled, if a
|
|
2193
|
-
taxonomy term doesn't exist in the specified locale, it will fallback to the hierarchy
|
|
2194
|
-
defined in the branch settings.
|
|
2195
|
-
--locale=<value> Locale of entries that will be exported.
|
|
2196
|
-
--org=<value> Provide organization UID to clone org users.
|
|
2197
|
-
--org-name=<value> Name of the organization that needs to be created as CSV filename.
|
|
2198
|
-
--taxonomy-uid=<value> Provide the taxonomy UID of the related terms you want to export.
|
|
2199
|
-
--team-uid=<value> Provide the UID of a specific team in an organization.
|
|
2200
|
-
|
|
2201
|
-
DESCRIPTION
|
|
2202
|
-
Export entries, taxonomies, terms or organization users to csv using this command
|
|
2203
|
-
|
|
2204
|
-
EXAMPLES
|
|
2205
|
-
$ csdx cm:export-to-csv
|
|
2206
|
-
|
|
2207
|
-
|
|
2208
|
-
|
|
2209
|
-
Exporting entries to CSV
|
|
2210
|
-
|
|
2211
|
-
$ csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type>
|
|
2212
|
-
|
|
2213
|
-
|
|
2214
|
-
|
|
2215
|
-
Exporting entries to CSV with stack name provided and branch name provided
|
|
2216
|
-
|
|
2217
|
-
$ csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type> --stack-name <stack-name> --branch <branch-name>
|
|
2218
|
-
|
|
2219
|
-
|
|
2220
|
-
|
|
2221
|
-
Exporting organization users to CSV
|
|
2222
|
-
|
|
2223
|
-
$ csdx cm:export-to-csv --action <users> --org <org-uid>
|
|
2224
|
-
|
|
2225
|
-
|
|
2226
|
-
|
|
2227
|
-
Exporting organization users to CSV with organization name provided
|
|
2228
|
-
|
|
2229
|
-
$ csdx cm:export-to-csv --action <users> --org <org-uid> --org-name <org-name>
|
|
2230
|
-
|
|
2231
|
-
|
|
2232
|
-
|
|
2233
|
-
Exporting organization teams to CSV
|
|
2234
|
-
|
|
2235
|
-
$ csdx cm:export-to-csv --action <teams>
|
|
2236
|
-
|
|
2237
|
-
|
|
2238
|
-
|
|
2239
|
-
Exporting organization teams to CSV with org UID
|
|
2240
|
-
|
|
2241
|
-
$ csdx cm:export-to-csv --action <teams> --org <org-uid>
|
|
2242
|
-
|
|
2243
|
-
|
|
2244
|
-
|
|
2245
|
-
Exporting organization teams to CSV with team UID
|
|
2246
|
-
|
|
2247
|
-
$ csdx cm:export-to-csv --action <teams> --team-uid <team-uid>
|
|
2248
|
-
|
|
2249
|
-
|
|
2250
|
-
|
|
2251
|
-
Exporting organization teams to CSV with org UID and team UID
|
|
2252
|
-
|
|
2253
|
-
$ csdx cm:export-to-csv --action <teams> --org <org-uid> --team-uid <team-uid>
|
|
2254
|
-
|
|
2255
|
-
|
|
2256
|
-
|
|
2257
|
-
Exporting organization teams to CSV with org UID and team UID
|
|
2258
|
-
|
|
2259
|
-
$ csdx cm:export-to-csv --action <teams> --org <org-uid> --team-uid <team-uid> --org-name <org-name>
|
|
2260
|
-
|
|
2261
|
-
|
|
2066
|
+
--copy-dir Create backup from the original data.
|
|
2067
|
+
--copy-path=<value> Provide the path to backup the copied data
|
|
2068
|
+
--fix-only=<option>... Provide the list of fix options
|
|
2069
|
+
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
2070
|
+
--modules=<option>... Provide the list of modules to be audited
|
|
2071
|
+
<options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-r
|
|
2072
|
+
ules|composable-studio>
|
|
2073
|
+
--report-path=<value> Path to store the audit reports
|
|
2262
2074
|
|
|
2263
|
-
|
|
2075
|
+
COMMON FLAGS
|
|
2076
|
+
-c, --config=<value> Path of the external config
|
|
2077
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
2078
|
+
--show-console-output Display the audit and audit fix result for individual modules
|
|
2264
2079
|
|
|
2265
|
-
|
|
2080
|
+
TABLE FLAGS
|
|
2081
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
2082
|
+
--csv Output results in CSV format.
|
|
2083
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
2084
|
+
--no-header Hide table headers in output.
|
|
2085
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
2086
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
2087
|
+
<options: csv|json|yaml>
|
|
2088
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
2266
2089
|
|
|
2090
|
+
DESCRIPTION
|
|
2091
|
+
Perform audits and fix possible errors in the exported Contentstack data.
|
|
2267
2092
|
|
|
2093
|
+
EXAMPLES
|
|
2094
|
+
$ csdx cm:stacks:audit:fix --copy-dir
|
|
2268
2095
|
|
|
2269
|
-
|
|
2096
|
+
$ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir
|
|
2270
2097
|
|
|
2271
|
-
$ csdx cm:
|
|
2098
|
+
$ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
|
|
2272
2099
|
|
|
2100
|
+
$ csdx cm:stacks:audit:fix --fix-only=reference,global_field --copy-dir
|
|
2273
2101
|
|
|
2102
|
+
$ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
|
|
2274
2103
|
|
|
2275
|
-
|
|
2104
|
+
$ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
|
|
2105
|
+
```
|
|
2276
2106
|
|
|
2277
|
-
|
|
2107
|
+
_See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
|
|
2278
2108
|
|
|
2109
|
+
## `csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
|
|
2279
2110
|
|
|
2111
|
+
Export content from a stack
|
|
2280
2112
|
|
|
2281
|
-
|
|
2113
|
+
```
|
|
2114
|
+
USAGE
|
|
2115
|
+
$ csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>]
|
|
2116
|
+
[--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]
|
|
2282
2117
|
|
|
2283
|
-
|
|
2118
|
+
FLAGS
|
|
2119
|
+
-a, --alias=<value> The management token alias of the source stack from which you will export content.
|
|
2120
|
+
-c, --config=<value> [optional] Path of the config
|
|
2121
|
+
-d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
|
|
2122
|
+
./content
|
|
2123
|
+
-k, --stack-api-key=<value> API Key of the source stack
|
|
2124
|
+
-y, --yes [optional] Force override all Marketplace prompts.
|
|
2125
|
+
--branch=<value> [optional] The name of the branch where you want to export your content. If you don't
|
|
2126
|
+
mention the branch name, then by default the content will be exported from all the
|
|
2127
|
+
branches of your stack.
|
|
2128
|
+
--branch-alias=<value> (Optional) The alias of the branch from which you want to export content.
|
|
2129
|
+
--content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
|
|
2130
|
+
of multiple content types, specify the IDs separated by spaces.
|
|
2131
|
+
--module=<value> [optional] Specific module name. If not specified, the export command will export all
|
|
2132
|
+
the modules to the stack. The available modules are assets, content-types, entries,
|
|
2133
|
+
environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
|
|
2134
|
+
workflows, custom-roles, taxonomies, and studio.
|
|
2135
|
+
--secured-assets [optional] Use this flag for assets that are secured.
|
|
2284
2136
|
|
|
2137
|
+
DESCRIPTION
|
|
2138
|
+
Export content from a stack
|
|
2285
2139
|
|
|
2140
|
+
EXAMPLES
|
|
2141
|
+
$ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
2286
2142
|
|
|
2287
|
-
|
|
2143
|
+
$ csdx cm:stacks:export --config <path/to/config/dir>
|
|
2288
2144
|
|
|
2289
|
-
$ csdx cm:export
|
|
2145
|
+
$ csdx cm:stacks:export --alias <management_token_alias>
|
|
2290
2146
|
|
|
2147
|
+
$ csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>
|
|
2291
2148
|
|
|
2149
|
+
$ csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>
|
|
2292
2150
|
|
|
2293
|
-
|
|
2151
|
+
$ csdx cm:stacks:export --module <single module name>
|
|
2294
2152
|
|
|
2295
|
-
$ csdx cm:export
|
|
2153
|
+
$ csdx cm:stacks:export --branch [optional] branch name
|
|
2296
2154
|
```
|
|
2297
2155
|
|
|
2298
|
-
_See code: [@contentstack/cli-cm-export
|
|
2156
|
+
_See code: [@contentstack/cli-cm-export](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/stacks/export.ts)_
|
|
2299
2157
|
|
|
2300
|
-
## `csdx cm:stacks:import [
|
|
2158
|
+
## `csdx cm:stacks:import [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
|
|
2301
2159
|
|
|
2302
2160
|
Import content from a stack
|
|
2303
2161
|
|
|
2304
2162
|
```
|
|
2305
2163
|
USAGE
|
|
2306
|
-
$ csdx cm:
|
|
2307
|
-
[--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
|
|
2164
|
+
$ csdx cm:stacks:import [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>]
|
|
2165
|
+
[--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
|
|
2308
2166
|
|
|
2309
2167
|
FLAGS
|
|
2310
|
-
-B, --branch=<value>
|
|
2311
|
-
The name of the branch where you want to import your content. If you don't mention the branch name, then by default
|
|
2312
|
-
the content will be imported to the main branch.
|
|
2313
|
-
|
|
2314
2168
|
-a, --alias=<value>
|
|
2315
2169
|
The management token of the destination stack where you will import the content.
|
|
2316
2170
|
|
|
2317
|
-
-b, --backup-dir=<value>
|
|
2318
|
-
[optional] Backup directory name when using specific module.
|
|
2319
|
-
|
|
2320
2171
|
-c, --config=<value>
|
|
2321
2172
|
[optional] The path of the configuration JSON file containing all the options for a single run.
|
|
2322
2173
|
|
|
@@ -2328,15 +2179,16 @@ FLAGS
|
|
|
2328
2179
|
-k, --stack-api-key=<value>
|
|
2329
2180
|
API Key of the target stack
|
|
2330
2181
|
|
|
2331
|
-
-m, --module=<value>
|
|
2332
|
-
[optional] Specify the module to import into the target stack. If not specified, the import command will import all
|
|
2333
|
-
the modules into the stack. The available modules are assets, content-types, entries, environments, extensions,
|
|
2334
|
-
marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, personalize projects,
|
|
2335
|
-
taxonomies, and composable-studio.
|
|
2336
|
-
|
|
2337
2182
|
-y, --yes
|
|
2338
2183
|
[optional] Force override all Marketplace prompts.
|
|
2339
2184
|
|
|
2185
|
+
--backup-dir=<value>
|
|
2186
|
+
[optional] Backup directory name when using specific module.
|
|
2187
|
+
|
|
2188
|
+
--branch=<value>
|
|
2189
|
+
The name of the branch where you want to import your content. If you don't mention the branch name, then by default
|
|
2190
|
+
the content will be imported to the main branch.
|
|
2191
|
+
|
|
2340
2192
|
--branch-alias=<value>
|
|
2341
2193
|
Specify the branch alias where you want to import your content. If not specified, the content is imported into the
|
|
2342
2194
|
main branch by default.
|
|
@@ -2349,503 +2201,18 @@ FLAGS
|
|
|
2349
2201
|
stack. <options: disable|current>
|
|
2350
2202
|
<options: disable|current>
|
|
2351
2203
|
|
|
2352
|
-
--
|
|
2353
|
-
(optional) Provide a unique name for the Personalize project.
|
|
2354
|
-
|
|
2355
|
-
--replace-existing
|
|
2356
|
-
Replaces the existing module in the target stack.
|
|
2357
|
-
|
|
2358
|
-
--skip-app-recreation
|
|
2359
|
-
(optional) Skips the recreation of private apps if they already exist.
|
|
2360
|
-
|
|
2361
|
-
--skip-assets-publish
|
|
2362
|
-
Skips asset publishing during the import process.
|
|
2363
|
-
|
|
2364
|
-
--skip-audit
|
|
2365
|
-
Skips the audit fix that occurs during an import operation.
|
|
2366
|
-
|
|
2367
|
-
--skip-entries-publish
|
|
2368
|
-
Skips entry publishing during the import process
|
|
2369
|
-
|
|
2370
|
-
--skip-existing
|
|
2371
|
-
Skips the module exists warning messages.
|
|
2372
|
-
|
|
2373
|
-
DESCRIPTION
|
|
2374
|
-
Import content from a stack
|
|
2375
|
-
|
|
2376
|
-
ALIASES
|
|
2377
|
-
$ csdx cm:import
|
|
2378
|
-
|
|
2379
|
-
EXAMPLES
|
|
2380
|
-
$ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
2381
|
-
|
|
2382
|
-
$ csdx cm:stacks:import --config <path/of/config/dir>
|
|
2383
|
-
|
|
2384
|
-
$ csdx cm:stacks:import --module <single module name>
|
|
2385
|
-
|
|
2386
|
-
$ csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>
|
|
2387
|
-
|
|
2388
|
-
$ csdx cm:stacks:import --alias <management_token_alias>
|
|
2389
|
-
|
|
2390
|
-
$ csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>
|
|
2391
|
-
|
|
2392
|
-
$ csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
|
|
2393
|
-
|
|
2394
|
-
$ csdx cm:stacks:import --branch <branch name> --yes --skip-audit
|
|
2395
|
-
```
|
|
2396
|
-
|
|
2397
|
-
## `csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]`
|
|
2398
|
-
|
|
2399
|
-
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
2400
|
-
|
|
2401
|
-
```
|
|
2402
|
-
USAGE
|
|
2403
|
-
$ csdx cm:import-setup cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
|
|
2404
|
-
|
|
2405
|
-
FLAGS
|
|
2406
|
-
-B, --branch=<value> The name of the branch where you want to import your content. If you don't mention the
|
|
2407
|
-
branch name, then by default the content will be imported to the main branch.
|
|
2408
|
-
-a, --alias=<value> The management token of the destination stack where you will import the content.
|
|
2409
|
-
-d, --data-dir=<value> The path or the location in your file system where the content, you intend to import, is
|
|
2410
|
-
stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
|
|
2411
|
-
branches involved, then the path should point till the particular branch. For example,
|
|
2412
|
-
“-d "C:\Users\Name\Desktop\cli\content\branch_name"
|
|
2413
|
-
-k, --stack-api-key=<value> API key of the target stack
|
|
2414
|
-
--branch-alias=<value> Specify the branch alias where you want to import your content. If not specified, the
|
|
2415
|
-
content is imported into the main branch by default.
|
|
2416
|
-
--module=<option>... [optional] Specify the modules/module to import into the target stack. currently options
|
|
2417
|
-
are global-fields, content-types, entries
|
|
2418
|
-
<options: global-fields|content-types|entries>
|
|
2419
|
-
|
|
2420
|
-
DESCRIPTION
|
|
2421
|
-
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
2422
|
-
|
|
2423
|
-
ALIASES
|
|
2424
|
-
$ csdx cm:import-setup
|
|
2425
|
-
|
|
2426
|
-
EXAMPLES
|
|
2427
|
-
$ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
|
|
2428
|
-
|
|
2429
|
-
$ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>
|
|
2430
|
-
|
|
2431
|
-
$ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>
|
|
2432
|
-
```
|
|
2433
|
-
|
|
2434
|
-
## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
|
|
2435
|
-
|
|
2436
|
-
Contentstack migration script.
|
|
2437
|
-
|
|
2438
|
-
```
|
|
2439
|
-
USAGE
|
|
2440
|
-
$ csdx cm:migration cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>]
|
|
2441
|
-
[--config-file <value>] [--config <value>] [--multiple]
|
|
2442
|
-
|
|
2443
|
-
FLAGS
|
|
2444
|
-
-B, --branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
|
|
2445
|
-
branch name)
|
|
2446
|
-
-a, --alias=<value> Use this flag to add the management token alias. You must use either the --alias flag or
|
|
2447
|
-
the --stack-api-key flag.
|
|
2448
|
-
-k, --stack-api-key=<value> Use this flag to add the API key of your stack. You must use either the --stack-api-key
|
|
2449
|
-
flag or the --alias flag.
|
|
2450
|
-
--config=<value>... [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
|
|
2451
|
-
the script re-usable.
|
|
2452
|
-
--config-file=<value> [optional] Path of the JSON configuration file.
|
|
2453
|
-
--file-path=<value> Use this flag to provide the path of the file of the migration script.
|
|
2454
|
-
--multiple This flag helps you to migrate multiple content files in a single instance. Mention the
|
|
2455
|
-
folder path where your migration script files are stored.
|
|
2456
|
-
|
|
2457
|
-
DESCRIPTION
|
|
2458
|
-
Contentstack migration script.
|
|
2459
|
-
|
|
2460
|
-
ALIASES
|
|
2461
|
-
$ csdx cm:migration
|
|
2462
|
-
|
|
2463
|
-
EXAMPLES
|
|
2464
|
-
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>
|
|
2465
|
-
|
|
2466
|
-
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>
|
|
2467
|
-
|
|
2468
|
-
$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>
|
|
2469
|
-
|
|
2470
|
-
$ csdx cm:migration --config-file <path/to/json/config/file> --file-path <migration/script/file/path>
|
|
2471
|
-
|
|
2472
|
-
$ csdx cm:migration --multiple --file-path <migration/scripts/dir/path>
|
|
2473
|
-
|
|
2474
|
-
$ csdx cm:migration --alias --file-path <migration/script/file/path> -k <api-key>
|
|
2475
|
-
```
|
|
2476
|
-
|
|
2477
|
-
## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>] [--locale <value>]`
|
|
2478
|
-
|
|
2479
|
-
Create a stack from existing content types, entries, assets, etc
|
|
2480
|
-
|
|
2481
|
-
```
|
|
2482
|
-
USAGE
|
|
2483
|
-
$ csdx cm:seed cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s
|
|
2484
|
-
<value>] [--locale <value>]
|
|
2485
|
-
|
|
2486
|
-
FLAGS
|
|
2487
|
-
-a, --alias=<value> Alias of the management token
|
|
2488
|
-
-k, --stack-api-key=<value> Provide stack API key to seed content to
|
|
2489
|
-
-n, --stack-name=<value> Name of a new stack that needs to be created.
|
|
2490
|
-
-o, --org=<value> Provide Organization UID to create a new stack
|
|
2491
|
-
-r, --repo=<value> GitHub organization name or GitHub user name/repository name.
|
|
2492
|
-
-s, --stack=<value> Provide the stack UID to seed content.
|
|
2493
|
-
-y, --yes=<value> [Optional] Skip the stack confirmation.
|
|
2494
|
-
|
|
2495
|
-
DESCRIPTION
|
|
2496
|
-
Create a stack from existing content types, entries, assets, etc
|
|
2497
|
-
|
|
2498
|
-
ALIASES
|
|
2499
|
-
$ csdx cm:seed
|
|
2500
|
-
|
|
2501
|
-
EXAMPLES
|
|
2502
|
-
$ csdx cm:stacks:seed
|
|
2503
|
-
|
|
2504
|
-
$ csdx cm:stacks:seed --repo "account"
|
|
2505
|
-
|
|
2506
|
-
$ csdx cm:stacks:seed --repo "account/repository"
|
|
2507
|
-
|
|
2508
|
-
$ csdx cm:stacks:seed --repo "account/repository" --stack-api-key "stack-api-key" //seed content into specific stack
|
|
2509
|
-
|
|
2510
|
-
$ csdx cm:stacks:seed --repo "account/repository" --org "your-org-uid" --stack-name "stack-name" //create a new stack in given org uid
|
|
2511
|
-
```
|
|
2512
|
-
|
|
2513
|
-
## `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]`
|
|
2514
|
-
|
|
2515
|
-
Clone data (structure/content or both) of a stack into another stack
|
|
2516
|
-
|
|
2517
|
-
```
|
|
2518
|
-
USAGE
|
|
2519
|
-
$ csdx cm:stack-clone cm:stacks:clone [--source-branch <value>] [--target-branch <value>]
|
|
2520
|
-
[--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b]
|
|
2521
|
-
[--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]
|
|
2522
|
-
|
|
2523
|
-
FLAGS
|
|
2524
|
-
-c, --config=<value> Path for the external configuration
|
|
2525
|
-
-n, --stack-name=<value> Provide a name for the new stack to store the cloned content.
|
|
2526
|
-
-y, --yes Force override all Marketplace prompts.
|
|
2527
|
-
--destination-management-token-alias=<value> Destination management token alias.
|
|
2528
|
-
--destination-stack-api-key=<value> Destination stack API key
|
|
2529
|
-
--import-webhook-status=<option> [default: disable] [default: disable] (optional) The status of the
|
|
2530
|
-
import webhook. <options: disable|current>
|
|
2531
|
-
<options: disable|current>
|
|
2532
|
-
--skip-audit (optional) Skips the audit fix that occurs during an import
|
|
2533
|
-
operation.
|
|
2534
|
-
--source-branch=<value> Branch of the source stack.
|
|
2535
|
-
--source-branch-alias=<value> Alias of Branch of the source stack.
|
|
2536
|
-
--source-management-token-alias=<value> Source management token alias.
|
|
2537
|
-
--source-stack-api-key=<value> Source stack API key
|
|
2538
|
-
--target-branch=<value> Branch of the target stack.
|
|
2539
|
-
--target-branch-alias=<value> Alias of Branch of the target stack.
|
|
2540
|
-
--type=<option> Type of data to clone. You can select option a or b.
|
|
2541
|
-
a) Structure (all modules except entries & assets).
|
|
2542
|
-
b) Structure with content (all modules including entries & assets).
|
|
2543
|
-
|
|
2544
|
-
<options: a|b>
|
|
2545
|
-
|
|
2546
|
-
DESCRIPTION
|
|
2547
|
-
Clone data (structure/content or both) of a stack into another stack
|
|
2548
|
-
Use this plugin to automate the process of cloning a stack in few steps.
|
|
2549
|
-
|
|
2550
|
-
|
|
2551
|
-
ALIASES
|
|
2552
|
-
$ csdx cm:stack-clone
|
|
2553
|
-
|
|
2554
|
-
EXAMPLES
|
|
2555
|
-
$ csdx cm:stacks:clone
|
|
2556
|
-
|
|
2557
|
-
$ csdx cm:stacks:clone --source-branch <source-branch-name> --target-branch <target-branch-name> --yes
|
|
2558
|
-
|
|
2559
|
-
$ csdx cm:stacks:clone --source-stack-api-key <apiKey> --destination-stack-api-key <apiKey>
|
|
2560
|
-
|
|
2561
|
-
$ csdx cm:stacks:clone --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
|
|
2562
|
-
|
|
2563
|
-
$ csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
|
|
2564
|
-
|
|
2565
|
-
$ 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>
|
|
2566
|
-
```
|
|
2567
|
-
|
|
2568
|
-
## `csdx cm:stacks:audit`
|
|
2569
|
-
|
|
2570
|
-
Perform audits and find possible errors in the exported Contentstack data
|
|
2571
|
-
|
|
2572
|
-
```
|
|
2573
|
-
USAGE
|
|
2574
|
-
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
2575
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
|
|
2576
|
-
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
2577
|
-
|
|
2578
|
-
FLAGS
|
|
2579
|
-
--modules=<option>... Provide the list of modules to be audited
|
|
2580
|
-
<options:
|
|
2581
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
2582
|
-
--report-path=<value> Path to store the audit reports
|
|
2583
|
-
|
|
2584
|
-
COMMON FLAGS
|
|
2585
|
-
-c, --config=<value> Path of the external config
|
|
2586
|
-
-d, --data-dir=<value> Path where the data is stored
|
|
2587
|
-
--show-console-output Display the audit and audit fix result for individual modules
|
|
2588
|
-
|
|
2589
|
-
TABLE FLAGS
|
|
2590
|
-
--columns=<value> Specify columns to display, comma-separated.
|
|
2591
|
-
--csv Output results in CSV format.
|
|
2592
|
-
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
2593
|
-
--no-header Hide table headers in output.
|
|
2594
|
-
--no-truncate Prevent truncation of long text in columns.
|
|
2595
|
-
--output=<option> Specify output format: csv, json, or yaml.
|
|
2596
|
-
<options: csv|json|yaml>
|
|
2597
|
-
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
2598
|
-
|
|
2599
|
-
DESCRIPTION
|
|
2600
|
-
Perform audits and find possible errors in the exported Contentstack data
|
|
2601
|
-
|
|
2602
|
-
ALIASES
|
|
2603
|
-
$ csdx audit
|
|
2604
|
-
$ csdx cm:stacks:audit
|
|
2605
|
-
|
|
2606
|
-
EXAMPLES
|
|
2607
|
-
$ csdx cm:stacks:audit
|
|
2608
|
-
|
|
2609
|
-
$ csdx cm:stacks:audit --report-path=<path>
|
|
2610
|
-
|
|
2611
|
-
$ csdx cm:stacks:audit --report-path=<path> --csv
|
|
2612
|
-
|
|
2613
|
-
$ csdx cm:stacks:audit --report-path=<path> --filter="name=<filter-value>"
|
|
2614
|
-
|
|
2615
|
-
$ csdx cm:stacks:audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
|
|
2616
|
-
```
|
|
2617
|
-
|
|
2618
|
-
_See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts)_
|
|
2619
|
-
|
|
2620
|
-
## `csdx cm:stacks:audit:fix`
|
|
2621
|
-
|
|
2622
|
-
Perform audits and fix possible errors in the exported Contentstack data.
|
|
2623
|
-
|
|
2624
|
-
```
|
|
2625
|
-
USAGE
|
|
2626
|
-
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
2627
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
|
|
2628
|
-
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
|
|
2629
|
-
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
2630
|
-
|
|
2631
|
-
FLAGS
|
|
2632
|
-
--copy-dir Create backup from the original data.
|
|
2633
|
-
--copy-path=<value> Provide the path to backup the copied data
|
|
2634
|
-
--fix-only=<option>... Provide the list of fix options
|
|
2635
|
-
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
2636
|
-
--modules=<option>... Provide the list of modules to be audited
|
|
2637
|
-
<options:
|
|
2638
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
2639
|
-
--report-path=<value> Path to store the audit reports
|
|
2640
|
-
|
|
2641
|
-
COMMON FLAGS
|
|
2642
|
-
-c, --config=<value> Path of the external config
|
|
2643
|
-
-d, --data-dir=<value> Path where the data is stored
|
|
2644
|
-
--show-console-output Display the audit and audit fix result for individual modules
|
|
2645
|
-
|
|
2646
|
-
TABLE FLAGS
|
|
2647
|
-
--columns=<value> Specify columns to display, comma-separated.
|
|
2648
|
-
--csv Output results in CSV format.
|
|
2649
|
-
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
2650
|
-
--no-header Hide table headers in output.
|
|
2651
|
-
--no-truncate Prevent truncation of long text in columns.
|
|
2652
|
-
--output=<option> Specify output format: csv, json, or yaml.
|
|
2653
|
-
<options: csv|json|yaml>
|
|
2654
|
-
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
2655
|
-
|
|
2656
|
-
DESCRIPTION
|
|
2657
|
-
Perform audits and fix possible errors in the exported Contentstack data.
|
|
2658
|
-
|
|
2659
|
-
ALIASES
|
|
2660
|
-
$ csdx audit:fix
|
|
2661
|
-
$ csdx cm:stacks:audit:fix
|
|
2662
|
-
|
|
2663
|
-
EXAMPLES
|
|
2664
|
-
$ csdx cm:stacks:audit:fix --copy-dir
|
|
2665
|
-
|
|
2666
|
-
$ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir
|
|
2667
|
-
|
|
2668
|
-
$ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
|
|
2669
|
-
|
|
2670
|
-
$ csdx cm:stacks:audit:fix --fix-only=reference,global_field --copy-dir
|
|
2671
|
-
|
|
2672
|
-
$ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
|
|
2673
|
-
|
|
2674
|
-
$ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
|
|
2675
|
-
```
|
|
2676
|
-
|
|
2677
|
-
_See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
|
|
2678
|
-
|
|
2679
|
-
## `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]`
|
|
2680
|
-
|
|
2681
|
-
Clone data (structure/content or both) of a stack into another stack
|
|
2682
|
-
|
|
2683
|
-
```
|
|
2684
|
-
USAGE
|
|
2685
|
-
$ csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias
|
|
2686
|
-
<value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>]
|
|
2687
|
-
[--destination-stack-api-key <value>] [--import-webhook-status disable|current]
|
|
2688
|
-
|
|
2689
|
-
FLAGS
|
|
2690
|
-
-c, --config=<value> Path for the external configuration
|
|
2691
|
-
-n, --stack-name=<value> Provide a name for the new stack to store the cloned content.
|
|
2692
|
-
-y, --yes Force override all Marketplace prompts.
|
|
2693
|
-
--destination-management-token-alias=<value> Destination management token alias.
|
|
2694
|
-
--destination-stack-api-key=<value> Destination stack API key
|
|
2695
|
-
--import-webhook-status=<option> [default: disable] [default: disable] (optional) The status of the
|
|
2696
|
-
import webhook. <options: disable|current>
|
|
2697
|
-
<options: disable|current>
|
|
2698
|
-
--skip-audit (optional) Skips the audit fix that occurs during an import
|
|
2699
|
-
operation.
|
|
2700
|
-
--source-branch=<value> Branch of the source stack.
|
|
2701
|
-
--source-branch-alias=<value> Alias of Branch of the source stack.
|
|
2702
|
-
--source-management-token-alias=<value> Source management token alias.
|
|
2703
|
-
--source-stack-api-key=<value> Source stack API key
|
|
2704
|
-
--target-branch=<value> Branch of the target stack.
|
|
2705
|
-
--target-branch-alias=<value> Alias of Branch of the target stack.
|
|
2706
|
-
--type=<option> Type of data to clone. You can select option a or b.
|
|
2707
|
-
a) Structure (all modules except entries & assets).
|
|
2708
|
-
b) Structure with content (all modules including entries & assets).
|
|
2709
|
-
|
|
2710
|
-
<options: a|b>
|
|
2711
|
-
|
|
2712
|
-
DESCRIPTION
|
|
2713
|
-
Clone data (structure/content or both) of a stack into another stack
|
|
2714
|
-
Use this plugin to automate the process of cloning a stack in few steps.
|
|
2715
|
-
|
|
2716
|
-
|
|
2717
|
-
ALIASES
|
|
2718
|
-
$ csdx cm:stack-clone
|
|
2719
|
-
|
|
2720
|
-
EXAMPLES
|
|
2721
|
-
$ csdx cm:stacks:clone
|
|
2722
|
-
|
|
2723
|
-
$ csdx cm:stacks:clone --source-branch <source-branch-name> --target-branch <target-branch-name> --yes
|
|
2724
|
-
|
|
2725
|
-
$ csdx cm:stacks:clone --source-stack-api-key <apiKey> --destination-stack-api-key <apiKey>
|
|
2726
|
-
|
|
2727
|
-
$ csdx cm:stacks:clone --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
|
|
2728
|
-
|
|
2729
|
-
$ csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
|
|
2730
|
-
|
|
2731
|
-
$ 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>
|
|
2732
|
-
```
|
|
2733
|
-
|
|
2734
|
-
_See code: [@contentstack/cli-cm-clone](https://github.com/contentstack/cli/blob/main/packages/contentstack-clone/src/commands/cm/stacks/clone.js)_
|
|
2735
|
-
|
|
2736
|
-
## `csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
|
|
2737
|
-
|
|
2738
|
-
Export content from a stack
|
|
2739
|
-
|
|
2740
|
-
```
|
|
2741
|
-
USAGE
|
|
2742
|
-
$ csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types
|
|
2743
|
-
<value>] [--branch <value>] [--secured-assets]
|
|
2744
|
-
|
|
2745
|
-
FLAGS
|
|
2746
|
-
-B, --branch=<value> [optional] The name of the branch where you want to export your content. If you don't
|
|
2747
|
-
mention the branch name, then by default the content will be exported from all the
|
|
2748
|
-
branches of your stack.
|
|
2749
|
-
-a, --alias=<value> The management token alias of the source stack from which you will export content.
|
|
2750
|
-
-c, --config=<value> [optional] Path of the config
|
|
2751
|
-
-d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
|
|
2752
|
-
./content
|
|
2753
|
-
-k, --stack-api-key=<value> API Key of the source stack
|
|
2754
|
-
-m, --module=<value> [optional] Specific module name. If not specified, the export command will export all
|
|
2755
|
-
the modules to the stack. The available modules are assets, content-types, entries,
|
|
2756
|
-
environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
|
|
2757
|
-
workflows, custom-roles, taxonomies, and studio.
|
|
2758
|
-
-t, --content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
|
|
2759
|
-
of multiple content types, specify the IDs separated by spaces.
|
|
2760
|
-
-y, --yes [optional] Force override all Marketplace prompts.
|
|
2761
|
-
--branch-alias=<value> (Optional) The alias of the branch from which you want to export content.
|
|
2762
|
-
--secured-assets [optional] Use this flag for assets that are secured.
|
|
2763
|
-
|
|
2764
|
-
DESCRIPTION
|
|
2765
|
-
Export content from a stack
|
|
2766
|
-
|
|
2767
|
-
ALIASES
|
|
2768
|
-
$ csdx cm:export
|
|
2769
|
-
|
|
2770
|
-
EXAMPLES
|
|
2771
|
-
$ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
2772
|
-
|
|
2773
|
-
$ csdx cm:stacks:export --config <path/to/config/dir>
|
|
2774
|
-
|
|
2775
|
-
$ csdx cm:stacks:export --alias <management_token_alias>
|
|
2776
|
-
|
|
2777
|
-
$ csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>
|
|
2778
|
-
|
|
2779
|
-
$ csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>
|
|
2780
|
-
|
|
2781
|
-
$ csdx cm:stacks:export --module <single module name>
|
|
2782
|
-
|
|
2783
|
-
$ csdx cm:stacks:export --branch [optional] branch name
|
|
2784
|
-
```
|
|
2785
|
-
|
|
2786
|
-
_See code: [@contentstack/cli-cm-export](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/stacks/export.ts)_
|
|
2787
|
-
|
|
2788
|
-
## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
|
|
2789
|
-
|
|
2790
|
-
Import content from a stack
|
|
2791
|
-
|
|
2792
|
-
```
|
|
2793
|
-
USAGE
|
|
2794
|
-
$ csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir
|
|
2795
|
-
<value>] [--branch <value>] [--import-webhook-status disable|current]
|
|
2796
|
-
|
|
2797
|
-
FLAGS
|
|
2798
|
-
-B, --branch=<value>
|
|
2799
|
-
The name of the branch where you want to import your content. If you don't mention the branch name, then by default
|
|
2800
|
-
the content will be imported to the main branch.
|
|
2801
|
-
|
|
2802
|
-
-a, --alias=<value>
|
|
2803
|
-
The management token of the destination stack where you will import the content.
|
|
2804
|
-
|
|
2805
|
-
-b, --backup-dir=<value>
|
|
2806
|
-
[optional] Backup directory name when using specific module.
|
|
2807
|
-
|
|
2808
|
-
-c, --config=<value>
|
|
2809
|
-
[optional] The path of the configuration JSON file containing all the options for a single run.
|
|
2810
|
-
|
|
2811
|
-
-d, --data-dir=<value>
|
|
2812
|
-
The path or the location in your file system where the content, you intend to import, is stored. For example, -d
|
|
2813
|
-
"C:\Users\Name\Desktop\cli\content". If the export folder has branches involved, then the path should point till the
|
|
2814
|
-
particular branch. For example, “-d "C:\Users\Name\Desktop\cli\content\branch_name"
|
|
2815
|
-
|
|
2816
|
-
-k, --stack-api-key=<value>
|
|
2817
|
-
API Key of the target stack
|
|
2818
|
-
|
|
2819
|
-
-m, --module=<value>
|
|
2204
|
+
--module=<value>
|
|
2820
2205
|
[optional] Specify the module to import into the target stack. If not specified, the import command will import all
|
|
2821
2206
|
the modules into the stack. The available modules are assets, content-types, entries, environments, extensions,
|
|
2822
2207
|
marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, personalize projects,
|
|
2823
2208
|
taxonomies, and composable-studio.
|
|
2824
2209
|
|
|
2825
|
-
-y, --yes
|
|
2826
|
-
[optional] Force override all Marketplace prompts.
|
|
2827
|
-
|
|
2828
|
-
--branch-alias=<value>
|
|
2829
|
-
Specify the branch alias where you want to import your content. If not specified, the content is imported into the
|
|
2830
|
-
main branch by default.
|
|
2831
|
-
|
|
2832
|
-
--exclude-global-modules
|
|
2833
|
-
Excludes the branch-independent module from the import operation.
|
|
2834
|
-
|
|
2835
|
-
--import-webhook-status=<option>
|
|
2836
|
-
[default: disable] [default: disable] (optional) This webhook state keeps the same state of webhooks as the source
|
|
2837
|
-
stack. <options: disable|current>
|
|
2838
|
-
<options: disable|current>
|
|
2839
|
-
|
|
2840
2210
|
--personalize-project-name=<value>
|
|
2841
2211
|
(optional) Provide a unique name for the Personalize project.
|
|
2842
2212
|
|
|
2843
2213
|
--replace-existing
|
|
2844
2214
|
Replaces the existing module in the target stack.
|
|
2845
2215
|
|
|
2846
|
-
--skip-app-recreation
|
|
2847
|
-
(optional) Skips the recreation of private apps if they already exist.
|
|
2848
|
-
|
|
2849
2216
|
--skip-assets-publish
|
|
2850
2217
|
Skips asset publishing during the import process.
|
|
2851
2218
|
|
|
@@ -2861,9 +2228,6 @@ FLAGS
|
|
|
2861
2228
|
DESCRIPTION
|
|
2862
2229
|
Import content from a stack
|
|
2863
2230
|
|
|
2864
|
-
ALIASES
|
|
2865
|
-
$ csdx cm:import
|
|
2866
|
-
|
|
2867
2231
|
EXAMPLES
|
|
2868
2232
|
$ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
2869
2233
|
|
|
@@ -2893,14 +2257,14 @@ USAGE
|
|
|
2893
2257
|
$ csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
|
|
2894
2258
|
|
|
2895
2259
|
FLAGS
|
|
2896
|
-
-B, --branch=<value> The name of the branch where you want to import your content. If you don't mention the
|
|
2897
|
-
branch name, then by default the content will be imported to the main branch.
|
|
2898
2260
|
-a, --alias=<value> The management token of the destination stack where you will import the content.
|
|
2899
2261
|
-d, --data-dir=<value> The path or the location in your file system where the content, you intend to import, is
|
|
2900
2262
|
stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
|
|
2901
2263
|
branches involved, then the path should point till the particular branch. For example,
|
|
2902
2264
|
“-d "C:\Users\Name\Desktop\cli\content\branch_name"
|
|
2903
2265
|
-k, --stack-api-key=<value> API key of the target stack
|
|
2266
|
+
--branch=<value> The name of the branch where you want to import your content. If you don't mention the
|
|
2267
|
+
branch name, then by default the content will be imported to the main branch.
|
|
2904
2268
|
--branch-alias=<value> Specify the branch alias where you want to import your content. If not specified, the
|
|
2905
2269
|
content is imported into the main branch by default.
|
|
2906
2270
|
--module=<option>... [optional] Specify the modules/module to import into the target stack. currently options
|
|
@@ -2910,15 +2274,8 @@ FLAGS
|
|
|
2910
2274
|
DESCRIPTION
|
|
2911
2275
|
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
2912
2276
|
|
|
2913
|
-
ALIASES
|
|
2914
|
-
$ csdx cm:import-setup
|
|
2915
|
-
|
|
2916
2277
|
EXAMPLES
|
|
2917
|
-
$ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
|
|
2918
|
-
|
|
2919
|
-
$ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>
|
|
2920
|
-
|
|
2921
|
-
$ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>
|
|
2278
|
+
$ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name> --branch <branch_name>
|
|
2922
2279
|
```
|
|
2923
2280
|
|
|
2924
2281
|
_See code: [@contentstack/cli-cm-import-setup](https://github.com/contentstack/cli/blob/main/packages/contentstack-import-setup/src/commands/cm/stacks/import-setup.ts)_
|
|
@@ -2933,12 +2290,12 @@ USAGE
|
|
|
2933
2290
|
[--config <value>] [--multiple]
|
|
2934
2291
|
|
|
2935
2292
|
FLAGS
|
|
2936
|
-
-B, --branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
|
|
2937
|
-
branch name)
|
|
2938
2293
|
-a, --alias=<value> Use this flag to add the management token alias. You must use either the --alias flag or
|
|
2939
2294
|
the --stack-api-key flag.
|
|
2940
2295
|
-k, --stack-api-key=<value> Use this flag to add the API key of your stack. You must use either the --stack-api-key
|
|
2941
2296
|
flag or the --alias flag.
|
|
2297
|
+
--branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
|
|
2298
|
+
branch name)
|
|
2942
2299
|
--config=<value>... [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
|
|
2943
2300
|
the script re-usable.
|
|
2944
2301
|
--config-file=<value> [optional] Path of the JSON configuration file.
|
|
@@ -2949,13 +2306,10 @@ FLAGS
|
|
|
2949
2306
|
DESCRIPTION
|
|
2950
2307
|
Contentstack migration script.
|
|
2951
2308
|
|
|
2952
|
-
ALIASES
|
|
2953
|
-
$ csdx cm:migration
|
|
2954
|
-
|
|
2955
2309
|
EXAMPLES
|
|
2956
|
-
$ csdx cm:migration --file-path <migration/script/file/path> -
|
|
2310
|
+
$ csdx cm:migration --file-path <migration/script/file/path> --stack-api-key <stack-api-key>
|
|
2957
2311
|
|
|
2958
|
-
$ csdx cm:migration --file-path <migration/script/file/path> -
|
|
2312
|
+
$ csdx cm:migration --file-path <migration/script/file/path> --stack-api-key <stack-api-key> --branch <target branch name>
|
|
2959
2313
|
|
|
2960
2314
|
$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>
|
|
2961
2315
|
|
|
@@ -2963,7 +2317,7 @@ EXAMPLES
|
|
|
2963
2317
|
|
|
2964
2318
|
$ csdx cm:migration --multiple --file-path <migration/scripts/dir/path>
|
|
2965
2319
|
|
|
2966
|
-
$ csdx cm:migration --alias --file-path <migration/script/file/path>
|
|
2320
|
+
$ csdx cm:migration --alias <management-token-alias> --file-path <migration/script/file/path>
|
|
2967
2321
|
```
|
|
2968
2322
|
|
|
2969
2323
|
_See code: [@contentstack/cli-migration](https://github.com/contentstack/cli/blob/main/packages/contentstack-migration/src/commands/cm/stacks/migration.js)_
|
|
@@ -3119,30 +2473,26 @@ EXAMPLES
|
|
|
3119
2473
|
|
|
3120
2474
|
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-revert.js)_
|
|
3121
2475
|
|
|
3122
|
-
## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [-
|
|
2476
|
+
## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes <value>] [--alias <value>] [--locale <value>]`
|
|
3123
2477
|
|
|
3124
2478
|
Create a stack from existing content types, entries, assets, etc
|
|
3125
2479
|
|
|
3126
2480
|
```
|
|
3127
2481
|
USAGE
|
|
3128
|
-
$ csdx cm:stacks:seed [--repo <value>] [--org <value>] [-
|
|
3129
|
-
[--locale <value>]
|
|
2482
|
+
$ csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes
|
|
2483
|
+
<value>] [--alias <value>] [--locale <value>]
|
|
3130
2484
|
|
|
3131
2485
|
FLAGS
|
|
3132
2486
|
-a, --alias=<value> Alias of the management token
|
|
3133
2487
|
-k, --stack-api-key=<value> Provide stack API key to seed content to
|
|
3134
2488
|
-n, --stack-name=<value> Name of a new stack that needs to be created.
|
|
3135
|
-
-o, --org=<value> Provide Organization UID to create a new stack
|
|
3136
|
-
-r, --repo=<value> GitHub organization name or GitHub user name/repository name.
|
|
3137
|
-
-s, --stack=<value> Provide the stack UID to seed content.
|
|
3138
2489
|
-y, --yes=<value> [Optional] Skip the stack confirmation.
|
|
2490
|
+
--org=<value> Provide Organization UID to create a new stack
|
|
2491
|
+
--repo=<value> GitHub organization name or GitHub user name/repository name.
|
|
3139
2492
|
|
|
3140
2493
|
DESCRIPTION
|
|
3141
2494
|
Create a stack from existing content types, entries, assets, etc
|
|
3142
2495
|
|
|
3143
|
-
ALIASES
|
|
3144
|
-
$ csdx cm:seed
|
|
3145
|
-
|
|
3146
2496
|
EXAMPLES
|
|
3147
2497
|
$ csdx cm:stacks:seed
|
|
3148
2498
|
|
|
@@ -3328,6 +2678,23 @@ EXAMPLES
|
|
|
3328
2678
|
|
|
3329
2679
|
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/log.ts)_
|
|
3330
2680
|
|
|
2681
|
+
## `csdx config:get:proxy`
|
|
2682
|
+
|
|
2683
|
+
Get proxy configuration for CLI
|
|
2684
|
+
|
|
2685
|
+
```
|
|
2686
|
+
USAGE
|
|
2687
|
+
$ csdx config:get:proxy
|
|
2688
|
+
|
|
2689
|
+
DESCRIPTION
|
|
2690
|
+
Get proxy configuration for CLI
|
|
2691
|
+
|
|
2692
|
+
EXAMPLES
|
|
2693
|
+
$ csdx config:get:proxy
|
|
2694
|
+
```
|
|
2695
|
+
|
|
2696
|
+
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/proxy.ts)_
|
|
2697
|
+
|
|
3331
2698
|
## `csdx config:get:rate-limit`
|
|
3332
2699
|
|
|
3333
2700
|
Get rate-limit of organizations
|
|
@@ -3437,6 +2804,23 @@ EXAMPLES
|
|
|
3437
2804
|
|
|
3438
2805
|
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/remove/early-access-header.ts)_
|
|
3439
2806
|
|
|
2807
|
+
## `csdx config:remove:proxy`
|
|
2808
|
+
|
|
2809
|
+
Remove proxy configuration from global config
|
|
2810
|
+
|
|
2811
|
+
```
|
|
2812
|
+
USAGE
|
|
2813
|
+
$ csdx config:remove:proxy
|
|
2814
|
+
|
|
2815
|
+
DESCRIPTION
|
|
2816
|
+
Remove proxy configuration from global config
|
|
2817
|
+
|
|
2818
|
+
EXAMPLES
|
|
2819
|
+
$ csdx config:remove:proxy
|
|
2820
|
+
```
|
|
2821
|
+
|
|
2822
|
+
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/remove/proxy.ts)_
|
|
2823
|
+
|
|
3440
2824
|
## `csdx config:remove:rate-limit`
|
|
3441
2825
|
|
|
3442
2826
|
Remove rate-limit of the organization
|
|
@@ -3568,6 +2952,34 @@ EXAMPLES
|
|
|
3568
2952
|
|
|
3569
2953
|
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/log.ts)_
|
|
3570
2954
|
|
|
2955
|
+
## `csdx config:set:proxy`
|
|
2956
|
+
|
|
2957
|
+
Set proxy configuration for CLI
|
|
2958
|
+
|
|
2959
|
+
```
|
|
2960
|
+
USAGE
|
|
2961
|
+
$ csdx config:set:proxy --host <value> --port <value> --protocol http|https [--username <value>]
|
|
2962
|
+
|
|
2963
|
+
FLAGS
|
|
2964
|
+
--host=<value> (required) Proxy host address
|
|
2965
|
+
--port=<value> (required) Proxy port number
|
|
2966
|
+
--protocol=<option> (required) [default: http] Proxy protocol (http or https)
|
|
2967
|
+
<options: http|https>
|
|
2968
|
+
--username=<value> Proxy username (optional)
|
|
2969
|
+
|
|
2970
|
+
DESCRIPTION
|
|
2971
|
+
Set proxy configuration for CLI
|
|
2972
|
+
|
|
2973
|
+
EXAMPLES
|
|
2974
|
+
$ csdx config:set:proxy --host 127.0.0.1 --port 3128
|
|
2975
|
+
|
|
2976
|
+
$ csdx config:set:proxy --host proxy.example.com --port 8080 --protocol https
|
|
2977
|
+
|
|
2978
|
+
$ csdx config:set:proxy --host proxy.example.com --port 8080 --username user
|
|
2979
|
+
```
|
|
2980
|
+
|
|
2981
|
+
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/proxy.ts)_
|
|
2982
|
+
|
|
3571
2983
|
## `csdx config:set:rate-limit`
|
|
3572
2984
|
|
|
3573
2985
|
Set rate-limit for CLI
|
|
@@ -3601,18 +3013,18 @@ Set region for CLI
|
|
|
3601
3013
|
|
|
3602
3014
|
```
|
|
3603
3015
|
USAGE
|
|
3604
|
-
$ csdx config:set:region [REGION] [
|
|
3605
|
-
[--personalize <value>] [--launch <value>] [--studio <value>]
|
|
3016
|
+
$ csdx config:set:region [REGION] [--cda <value> --cma <value> --ui-host <value> -n <value>] [--developer-hub
|
|
3017
|
+
<value>] [--personalize <value>] [--launch <value>] [--studio <value>]
|
|
3606
3018
|
|
|
3607
3019
|
ARGUMENTS
|
|
3608
3020
|
[REGION] Name for the region
|
|
3609
3021
|
|
|
3610
3022
|
FLAGS
|
|
3611
|
-
-
|
|
3023
|
+
-n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are required
|
|
3024
|
+
--cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host and
|
|
3612
3025
|
name flags are required
|
|
3613
|
-
|
|
3026
|
+
--cma=<value> Custom host to set for content management API, , if this flag is added then cda, ui-host
|
|
3614
3027
|
and name flags are required
|
|
3615
|
-
-n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are required
|
|
3616
3028
|
--developer-hub=<value> Custom host to set for Developer hub API
|
|
3617
3029
|
--launch=<value> Custom host to set for Launch API
|
|
3618
3030
|
--personalize=<value> Custom host to set for Personalize API
|
|
@@ -3673,7 +3085,7 @@ DESCRIPTION
|
|
|
3673
3085
|
Display help for csdx.
|
|
3674
3086
|
```
|
|
3675
3087
|
|
|
3676
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.
|
|
3088
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.37/src/commands/help.ts)_
|
|
3677
3089
|
|
|
3678
3090
|
## `csdx launch`
|
|
3679
3091
|
|
|
@@ -3685,33 +3097,33 @@ USAGE
|
|
|
3685
3097
|
React App)|CSR (Client-Side Rendered)|Angular|Nuxt|VueJs|Remix|Other] [--org <value>] [-n <value>] [-e <value>]
|
|
3686
3098
|
[--branch <value>] [--build-command <value>] [--out-dir <value>] [--server-command <value>] [--variable-type Import
|
|
3687
3099
|
variables from a stack|Manually add custom variables to the list|Import variables from the .env.local file|Skip
|
|
3688
|
-
adding environment variables
|
|
3689
|
-
|
|
3690
|
-
FLAGS
|
|
3691
|
-
-a, --alias=<value>
|
|
3692
|
-
-c, --config=<value>
|
|
3693
|
-
-d, --data-dir=<value>
|
|
3694
|
-
-e, --environment=<value>
|
|
3695
|
-
-n, --name=<value>
|
|
3696
|
-
--branch=<value>
|
|
3697
|
-
--build-command=<value>
|
|
3698
|
-
--env-variables=<value>
|
|
3699
|
-
|
|
3700
|
-
--framework=<option>
|
|
3701
|
-
|
|
3702
|
-
|
|
3703
|
-
--org=<value>
|
|
3704
|
-
--out-dir=<value>
|
|
3705
|
-
--redeploy-last-upload
|
|
3706
|
-
--redeploy-latest
|
|
3707
|
-
--server-command=<value>
|
|
3708
|
-
--type=<option>
|
|
3709
|
-
|
|
3710
|
-
--variable-type=<option
|
|
3711
|
-
|
|
3712
|
-
|
|
3713
|
-
|
|
3714
|
-
|
|
3100
|
+
adding environment variables] [-a <value>] [--env-variables <value>] [--redeploy-latest] [--redeploy-last-upload]
|
|
3101
|
+
|
|
3102
|
+
FLAGS
|
|
3103
|
+
-a, --alias=<value> [optional] Alias (name) for the delivery token.
|
|
3104
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
3105
|
+
-d, --data-dir=<value> Current working directory
|
|
3106
|
+
-e, --environment=<value> [optional] Environment name for the Launch project.
|
|
3107
|
+
-n, --name=<value> [optional] Name of the project.
|
|
3108
|
+
--branch=<value> [optional] GitHub branch name.
|
|
3109
|
+
--build-command=<value> [optional] Build Command.
|
|
3110
|
+
--env-variables=<value> [optional] Provide the environment variables in the key:value format, separated by
|
|
3111
|
+
comma. For example: APP_ENV:prod, TEST_ENV:testVal.
|
|
3112
|
+
--framework=<option> [optional] Type of framework. <options: Gatsby|NextJS|Other>
|
|
3113
|
+
<options: Gatsby|NextJs|CRA (Create React App)|CSR (Client-Side
|
|
3114
|
+
Rendered)|Angular|Nuxt|VueJs|Remix|Other>
|
|
3115
|
+
--org=<value> [optional] Provide the organization UID to create a new project or deployment.
|
|
3116
|
+
--out-dir=<value> [optional] Output Directory.
|
|
3117
|
+
--redeploy-last-upload [optional] Redeploy with last file upload
|
|
3118
|
+
--redeploy-latest [optional] Redeploy latest commit/code
|
|
3119
|
+
--server-command=<value> [optional] Server Command.
|
|
3120
|
+
--type=<option> [optional] Type of adapters. <options: GitHub|FileUpload>
|
|
3121
|
+
<options: GitHub|FileUpload>
|
|
3122
|
+
--variable-type=<option> [optional] Provide a variable type. <options: Import variables from a stack|Manually add
|
|
3123
|
+
custom variables to the list|Import variables from the .env.local file|Skip adding
|
|
3124
|
+
environment variables>
|
|
3125
|
+
<options: Import variables from a stack|Manually add custom variables to the list|Import
|
|
3126
|
+
variables from the .env.local file|Skip adding environment variables>
|
|
3715
3127
|
|
|
3716
3128
|
DESCRIPTION
|
|
3717
3129
|
Launch related operations
|
|
@@ -3742,8 +3154,6 @@ EXAMPLES
|
|
|
3742
3154
|
$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --variable-type="Import variables from a stack" --alias=<value>
|
|
3743
3155
|
|
|
3744
3156
|
$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --variable-type="Manually add custom variables to the list" --env-variables="APP_ENV:prod, TEST_ENV:testVal"
|
|
3745
|
-
|
|
3746
|
-
$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --variable-type="Import variables from a stack" --variable-type="Manually add custom variables to the list" --alias=<value>
|
|
3747
3157
|
```
|
|
3748
3158
|
|
|
3749
3159
|
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/index.ts)_
|
|
@@ -3992,7 +3402,7 @@ EXAMPLES
|
|
|
3992
3402
|
$ csdx plugins
|
|
3993
3403
|
```
|
|
3994
3404
|
|
|
3995
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3405
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/index.ts)_
|
|
3996
3406
|
|
|
3997
3407
|
## `csdx plugins:add PLUGIN`
|
|
3998
3408
|
|
|
@@ -4066,7 +3476,7 @@ EXAMPLES
|
|
|
4066
3476
|
$ csdx plugins:inspect myplugin
|
|
4067
3477
|
```
|
|
4068
3478
|
|
|
4069
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3479
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/inspect.ts)_
|
|
4070
3480
|
|
|
4071
3481
|
## `csdx plugins:install PLUGIN`
|
|
4072
3482
|
|
|
@@ -4115,7 +3525,7 @@ EXAMPLES
|
|
|
4115
3525
|
$ csdx plugins:install someuser/someplugin
|
|
4116
3526
|
```
|
|
4117
3527
|
|
|
4118
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3528
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/install.ts)_
|
|
4119
3529
|
|
|
4120
3530
|
## `csdx plugins:link PATH`
|
|
4121
3531
|
|
|
@@ -4146,7 +3556,7 @@ EXAMPLES
|
|
|
4146
3556
|
$ csdx plugins:link myplugin
|
|
4147
3557
|
```
|
|
4148
3558
|
|
|
4149
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3559
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/link.ts)_
|
|
4150
3560
|
|
|
4151
3561
|
## `csdx plugins:remove [PLUGIN]`
|
|
4152
3562
|
|
|
@@ -4187,7 +3597,7 @@ FLAGS
|
|
|
4187
3597
|
--reinstall Reinstall all plugins after uninstalling.
|
|
4188
3598
|
```
|
|
4189
3599
|
|
|
4190
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3600
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/reset.ts)_
|
|
4191
3601
|
|
|
4192
3602
|
## `csdx plugins:uninstall [PLUGIN]`
|
|
4193
3603
|
|
|
@@ -4215,7 +3625,7 @@ EXAMPLES
|
|
|
4215
3625
|
$ csdx plugins:uninstall myplugin
|
|
4216
3626
|
```
|
|
4217
3627
|
|
|
4218
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3628
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/uninstall.ts)_
|
|
4219
3629
|
|
|
4220
3630
|
## `csdx plugins:unlink [PLUGIN]`
|
|
4221
3631
|
|
|
@@ -4259,7 +3669,7 @@ DESCRIPTION
|
|
|
4259
3669
|
Update installed plugins.
|
|
4260
3670
|
```
|
|
4261
3671
|
|
|
4262
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3672
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.55/src/commands/plugins/update.ts)_
|
|
4263
3673
|
|
|
4264
3674
|
## `csdx tokens`
|
|
4265
3675
|
|