@contentstack/cli 2.0.0-beta.3 → 2.0.0-beta.4
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/README.md +79 -548
- package/oclif.manifest.json +1 -1
- package/package.json +12 -12
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.4 linux-x64 node-v22.21.1
|
|
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,25 +61,19 @@ 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
64
|
* [`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
65
|
* [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
|
|
74
66
|
* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
|
|
75
67
|
* [`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)
|
|
76
|
-
* [`csdx cm:stacks:export [
|
|
77
|
-
* [`csdx cm:stacks:import [
|
|
68
|
+
* [`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)
|
|
69
|
+
* [`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
70
|
* [`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
71
|
* [`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
72
|
* [`csdx cm:stacks:publish`](#csdx-cmstackspublish)
|
|
81
73
|
* [`csdx cm:stacks:publish-clear-logs`](#csdx-cmstackspublish-clear-logs)
|
|
82
74
|
* [`csdx cm:stacks:publish-configure`](#csdx-cmstackspublish-configure)
|
|
83
75
|
* [`csdx cm:stacks:publish-revert`](#csdx-cmstackspublish-revert)
|
|
84
|
-
* [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [-
|
|
76
|
+
* [`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
77
|
* [`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
78
|
* [`csdx config:get:base-branch`](#csdx-configgetbase-branch)
|
|
87
79
|
* [`csdx config:get:ea-header`](#csdx-configgetea-header)
|
|
@@ -121,113 +113,6 @@ USAGE
|
|
|
121
113
|
* [`csdx tokens`](#csdx-tokens)
|
|
122
114
|
* [`csdx whoami`](#csdx-whoami)
|
|
123
115
|
|
|
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
116
|
## `csdx auth:login`
|
|
232
117
|
|
|
233
118
|
User sessions login
|
|
@@ -329,12 +214,12 @@ USAGE
|
|
|
329
214
|
|
|
330
215
|
FLAGS
|
|
331
216
|
-a, --alias=<value> Alias (name) you want to assign to the token
|
|
332
|
-
-d, --delivery Set this flag to save delivery token
|
|
333
217
|
-e, --environment=<value> Environment name for delivery token
|
|
334
218
|
-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
219
|
-y, --yes Use this flag to skip confirmation
|
|
220
|
+
--delivery Set this flag to save delivery token
|
|
221
|
+
--management Set this flag to save management token
|
|
222
|
+
--token=<value> [env: TOKEN] Add the token name
|
|
338
223
|
|
|
339
224
|
DESCRIPTION
|
|
340
225
|
Adds management/delivery tokens to your session to use it with other CLI commands
|
|
@@ -2115,56 +2000,6 @@ EXAMPLES
|
|
|
2115
2000
|
|
|
2116
2001
|
_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
2002
|
|
|
2118
|
-
## `csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
|
|
2119
|
-
|
|
2120
|
-
Export content from a stack
|
|
2121
|
-
|
|
2122
|
-
```
|
|
2123
|
-
USAGE
|
|
2124
|
-
$ csdx cm:export cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>]
|
|
2125
|
-
[--content-types <value>] [--branch <value>] [--secured-assets]
|
|
2126
|
-
|
|
2127
|
-
FLAGS
|
|
2128
|
-
-B, --branch=<value> [optional] The name of the branch where you want to export your content. If you don't
|
|
2129
|
-
mention the branch name, then by default the content will be exported from all the
|
|
2130
|
-
branches of your stack.
|
|
2131
|
-
-a, --alias=<value> The management token alias of the source stack from which you will export content.
|
|
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
|
|
2148
|
-
|
|
2149
|
-
ALIASES
|
|
2150
|
-
$ csdx cm:export
|
|
2151
|
-
|
|
2152
|
-
EXAMPLES
|
|
2153
|
-
$ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
2154
|
-
|
|
2155
|
-
$ csdx cm:stacks:export --config <path/to/config/dir>
|
|
2156
|
-
|
|
2157
|
-
$ csdx cm:stacks:export --alias <management_token_alias>
|
|
2158
|
-
|
|
2159
|
-
$ csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>
|
|
2160
|
-
|
|
2161
|
-
$ csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>
|
|
2162
|
-
|
|
2163
|
-
$ csdx cm:stacks:export --module <single module name>
|
|
2164
|
-
|
|
2165
|
-
$ csdx cm:stacks:export --branch [optional] branch name
|
|
2166
|
-
```
|
|
2167
|
-
|
|
2168
2003
|
## `csdx cm:export-to-csv`
|
|
2169
2004
|
|
|
2170
2005
|
Export entries, taxonomies, terms or organization users to csv using this command
|
|
@@ -2297,274 +2132,6 @@ EXAMPLES
|
|
|
2297
2132
|
|
|
2298
2133
|
_See code: [@contentstack/cli-cm-export-to-csv](https://github.com/contentstack/cli/blob/main/packages/contentstack-export-to-csv/src/commands/cm/export-to-csv.js)_
|
|
2299
2134
|
|
|
2300
|
-
## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
|
|
2301
|
-
|
|
2302
|
-
Import content from a stack
|
|
2303
|
-
|
|
2304
|
-
```
|
|
2305
|
-
USAGE
|
|
2306
|
-
$ csdx cm:import cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>]
|
|
2307
|
-
[--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
|
|
2308
|
-
|
|
2309
|
-
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
|
-
-a, --alias=<value>
|
|
2315
|
-
The management token of the destination stack where you will import the content.
|
|
2316
|
-
|
|
2317
|
-
-b, --backup-dir=<value>
|
|
2318
|
-
[optional] Backup directory name when using specific module.
|
|
2319
|
-
|
|
2320
|
-
-c, --config=<value>
|
|
2321
|
-
[optional] The path of the configuration JSON file containing all the options for a single run.
|
|
2322
|
-
|
|
2323
|
-
-d, --data-dir=<value>
|
|
2324
|
-
The path or the location in your file system where the content, you intend to import, is stored. For example, -d
|
|
2325
|
-
"C:\Users\Name\Desktop\cli\content". If the export folder has branches involved, then the path should point till the
|
|
2326
|
-
particular branch. For example, “-d "C:\Users\Name\Desktop\cli\content\branch_name"
|
|
2327
|
-
|
|
2328
|
-
-k, --stack-api-key=<value>
|
|
2329
|
-
API Key of the target stack
|
|
2330
|
-
|
|
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
|
-
-y, --yes
|
|
2338
|
-
[optional] Force override all Marketplace prompts.
|
|
2339
|
-
|
|
2340
|
-
--branch-alias=<value>
|
|
2341
|
-
Specify the branch alias where you want to import your content. If not specified, the content is imported into the
|
|
2342
|
-
main branch by default.
|
|
2343
|
-
|
|
2344
|
-
--exclude-global-modules
|
|
2345
|
-
Excludes the branch-independent module from the import operation.
|
|
2346
|
-
|
|
2347
|
-
--import-webhook-status=<option>
|
|
2348
|
-
[default: disable] [default: disable] (optional) This webhook state keeps the same state of webhooks as the source
|
|
2349
|
-
stack. <options: disable|current>
|
|
2350
|
-
<options: disable|current>
|
|
2351
|
-
|
|
2352
|
-
--personalize-project-name=<value>
|
|
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
2135
|
## `csdx cm:stacks:audit`
|
|
2569
2136
|
|
|
2570
2137
|
Perform audits and find possible errors in the exported Contentstack data
|
|
@@ -2599,10 +2166,6 @@ TABLE FLAGS
|
|
|
2599
2166
|
DESCRIPTION
|
|
2600
2167
|
Perform audits and find possible errors in the exported Contentstack data
|
|
2601
2168
|
|
|
2602
|
-
ALIASES
|
|
2603
|
-
$ csdx audit
|
|
2604
|
-
$ csdx cm:stacks:audit
|
|
2605
|
-
|
|
2606
2169
|
EXAMPLES
|
|
2607
2170
|
$ csdx cm:stacks:audit
|
|
2608
2171
|
|
|
@@ -2656,10 +2219,6 @@ TABLE FLAGS
|
|
|
2656
2219
|
DESCRIPTION
|
|
2657
2220
|
Perform audits and fix possible errors in the exported Contentstack data.
|
|
2658
2221
|
|
|
2659
|
-
ALIASES
|
|
2660
|
-
$ csdx audit:fix
|
|
2661
|
-
$ csdx cm:stacks:audit:fix
|
|
2662
|
-
|
|
2663
2222
|
EXAMPLES
|
|
2664
2223
|
$ csdx cm:stacks:audit:fix --copy-dir
|
|
2665
2224
|
|
|
@@ -2714,9 +2273,6 @@ DESCRIPTION
|
|
|
2714
2273
|
Use this plugin to automate the process of cloning a stack in few steps.
|
|
2715
2274
|
|
|
2716
2275
|
|
|
2717
|
-
ALIASES
|
|
2718
|
-
$ csdx cm:stack-clone
|
|
2719
|
-
|
|
2720
2276
|
EXAMPLES
|
|
2721
2277
|
$ csdx cm:stacks:clone
|
|
2722
2278
|
|
|
@@ -2733,40 +2289,37 @@ EXAMPLES
|
|
|
2733
2289
|
|
|
2734
2290
|
_See code: [@contentstack/cli-cm-clone](https://github.com/contentstack/cli/blob/main/packages/contentstack-clone/src/commands/cm/stacks/clone.js)_
|
|
2735
2291
|
|
|
2736
|
-
## `csdx cm:stacks:export [
|
|
2292
|
+
## `csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
|
|
2737
2293
|
|
|
2738
2294
|
Export content from a stack
|
|
2739
2295
|
|
|
2740
2296
|
```
|
|
2741
2297
|
USAGE
|
|
2742
|
-
$ csdx cm:stacks:export [
|
|
2743
|
-
<value>] [--branch <value>] [--secured-assets]
|
|
2298
|
+
$ csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>]
|
|
2299
|
+
[--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]
|
|
2744
2300
|
|
|
2745
2301
|
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
2302
|
-a, --alias=<value> The management token alias of the source stack from which you will export content.
|
|
2750
2303
|
-c, --config=<value> [optional] Path of the config
|
|
2751
2304
|
-d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
|
|
2752
2305
|
./content
|
|
2753
2306
|
-k, --stack-api-key=<value> API Key of the source stack
|
|
2754
|
-
-
|
|
2307
|
+
-y, --yes [optional] Force override all Marketplace prompts.
|
|
2308
|
+
--branch=<value> [optional] The name of the branch where you want to export your content. If you don't
|
|
2309
|
+
mention the branch name, then by default the content will be exported from all the
|
|
2310
|
+
branches of your stack.
|
|
2311
|
+
--branch-alias=<value> (Optional) The alias of the branch from which you want to export content.
|
|
2312
|
+
--content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
|
|
2313
|
+
of multiple content types, specify the IDs separated by spaces.
|
|
2314
|
+
--module=<value> [optional] Specific module name. If not specified, the export command will export all
|
|
2755
2315
|
the modules to the stack. The available modules are assets, content-types, entries,
|
|
2756
2316
|
environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
|
|
2757
2317
|
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
2318
|
--secured-assets [optional] Use this flag for assets that are secured.
|
|
2763
2319
|
|
|
2764
2320
|
DESCRIPTION
|
|
2765
2321
|
Export content from a stack
|
|
2766
2322
|
|
|
2767
|
-
ALIASES
|
|
2768
|
-
$ csdx cm:export
|
|
2769
|
-
|
|
2770
2323
|
EXAMPLES
|
|
2771
2324
|
$ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
2772
2325
|
|
|
@@ -2785,26 +2338,19 @@ EXAMPLES
|
|
|
2785
2338
|
|
|
2786
2339
|
_See code: [@contentstack/cli-cm-export](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/stacks/export.ts)_
|
|
2787
2340
|
|
|
2788
|
-
## `csdx cm:stacks:import [
|
|
2341
|
+
## `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]`
|
|
2789
2342
|
|
|
2790
2343
|
Import content from a stack
|
|
2791
2344
|
|
|
2792
2345
|
```
|
|
2793
2346
|
USAGE
|
|
2794
|
-
$ csdx cm:stacks:import [
|
|
2795
|
-
<value>] [--branch <value>] [--import-webhook-status disable|current]
|
|
2347
|
+
$ csdx cm:stacks:import [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>]
|
|
2348
|
+
[--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
|
|
2796
2349
|
|
|
2797
2350
|
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
2351
|
-a, --alias=<value>
|
|
2803
2352
|
The management token of the destination stack where you will import the content.
|
|
2804
2353
|
|
|
2805
|
-
-b, --backup-dir=<value>
|
|
2806
|
-
[optional] Backup directory name when using specific module.
|
|
2807
|
-
|
|
2808
2354
|
-c, --config=<value>
|
|
2809
2355
|
[optional] The path of the configuration JSON file containing all the options for a single run.
|
|
2810
2356
|
|
|
@@ -2816,15 +2362,16 @@ FLAGS
|
|
|
2816
2362
|
-k, --stack-api-key=<value>
|
|
2817
2363
|
API Key of the target stack
|
|
2818
2364
|
|
|
2819
|
-
-m, --module=<value>
|
|
2820
|
-
[optional] Specify the module to import into the target stack. If not specified, the import command will import all
|
|
2821
|
-
the modules into the stack. The available modules are assets, content-types, entries, environments, extensions,
|
|
2822
|
-
marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, personalize projects,
|
|
2823
|
-
taxonomies, and composable-studio.
|
|
2824
|
-
|
|
2825
2365
|
-y, --yes
|
|
2826
2366
|
[optional] Force override all Marketplace prompts.
|
|
2827
2367
|
|
|
2368
|
+
--backup-dir=<value>
|
|
2369
|
+
[optional] Backup directory name when using specific module.
|
|
2370
|
+
|
|
2371
|
+
--branch=<value>
|
|
2372
|
+
The name of the branch where you want to import your content. If you don't mention the branch name, then by default
|
|
2373
|
+
the content will be imported to the main branch.
|
|
2374
|
+
|
|
2828
2375
|
--branch-alias=<value>
|
|
2829
2376
|
Specify the branch alias where you want to import your content. If not specified, the content is imported into the
|
|
2830
2377
|
main branch by default.
|
|
@@ -2837,15 +2384,18 @@ FLAGS
|
|
|
2837
2384
|
stack. <options: disable|current>
|
|
2838
2385
|
<options: disable|current>
|
|
2839
2386
|
|
|
2387
|
+
--module=<value>
|
|
2388
|
+
[optional] Specify the module to import into the target stack. If not specified, the import command will import all
|
|
2389
|
+
the modules into the stack. The available modules are assets, content-types, entries, environments, extensions,
|
|
2390
|
+
marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, personalize projects,
|
|
2391
|
+
taxonomies, and composable-studio.
|
|
2392
|
+
|
|
2840
2393
|
--personalize-project-name=<value>
|
|
2841
2394
|
(optional) Provide a unique name for the Personalize project.
|
|
2842
2395
|
|
|
2843
2396
|
--replace-existing
|
|
2844
2397
|
Replaces the existing module in the target stack.
|
|
2845
2398
|
|
|
2846
|
-
--skip-app-recreation
|
|
2847
|
-
(optional) Skips the recreation of private apps if they already exist.
|
|
2848
|
-
|
|
2849
2399
|
--skip-assets-publish
|
|
2850
2400
|
Skips asset publishing during the import process.
|
|
2851
2401
|
|
|
@@ -2861,9 +2411,6 @@ FLAGS
|
|
|
2861
2411
|
DESCRIPTION
|
|
2862
2412
|
Import content from a stack
|
|
2863
2413
|
|
|
2864
|
-
ALIASES
|
|
2865
|
-
$ csdx cm:import
|
|
2866
|
-
|
|
2867
2414
|
EXAMPLES
|
|
2868
2415
|
$ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
2869
2416
|
|
|
@@ -2893,14 +2440,14 @@ USAGE
|
|
|
2893
2440
|
$ csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
|
|
2894
2441
|
|
|
2895
2442
|
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
2443
|
-a, --alias=<value> The management token of the destination stack where you will import the content.
|
|
2899
2444
|
-d, --data-dir=<value> The path or the location in your file system where the content, you intend to import, is
|
|
2900
2445
|
stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
|
|
2901
2446
|
branches involved, then the path should point till the particular branch. For example,
|
|
2902
2447
|
“-d "C:\Users\Name\Desktop\cli\content\branch_name"
|
|
2903
2448
|
-k, --stack-api-key=<value> API key of the target stack
|
|
2449
|
+
--branch=<value> The name of the branch where you want to import your content. If you don't mention the
|
|
2450
|
+
branch name, then by default the content will be imported to the main branch.
|
|
2904
2451
|
--branch-alias=<value> Specify the branch alias where you want to import your content. If not specified, the
|
|
2905
2452
|
content is imported into the main branch by default.
|
|
2906
2453
|
--module=<option>... [optional] Specify the modules/module to import into the target stack. currently options
|
|
@@ -2910,15 +2457,8 @@ FLAGS
|
|
|
2910
2457
|
DESCRIPTION
|
|
2911
2458
|
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
2912
2459
|
|
|
2913
|
-
ALIASES
|
|
2914
|
-
$ csdx cm:import-setup
|
|
2915
|
-
|
|
2916
2460
|
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>
|
|
2461
|
+
$ 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
2462
|
```
|
|
2923
2463
|
|
|
2924
2464
|
_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 +2473,12 @@ USAGE
|
|
|
2933
2473
|
[--config <value>] [--multiple]
|
|
2934
2474
|
|
|
2935
2475
|
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
2476
|
-a, --alias=<value> Use this flag to add the management token alias. You must use either the --alias flag or
|
|
2939
2477
|
the --stack-api-key flag.
|
|
2940
2478
|
-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
2479
|
flag or the --alias flag.
|
|
2480
|
+
--branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
|
|
2481
|
+
branch name)
|
|
2942
2482
|
--config=<value>... [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
|
|
2943
2483
|
the script re-usable.
|
|
2944
2484
|
--config-file=<value> [optional] Path of the JSON configuration file.
|
|
@@ -2949,13 +2489,10 @@ FLAGS
|
|
|
2949
2489
|
DESCRIPTION
|
|
2950
2490
|
Contentstack migration script.
|
|
2951
2491
|
|
|
2952
|
-
ALIASES
|
|
2953
|
-
$ csdx cm:migration
|
|
2954
|
-
|
|
2955
2492
|
EXAMPLES
|
|
2956
|
-
$ csdx cm:migration --file-path <migration/script/file/path> -
|
|
2493
|
+
$ csdx cm:migration --file-path <migration/script/file/path> --stack-api-key <stack-api-key>
|
|
2957
2494
|
|
|
2958
|
-
$ csdx cm:migration --file-path <migration/script/file/path> -
|
|
2495
|
+
$ csdx cm:migration --file-path <migration/script/file/path> --stack-api-key <stack-api-key> --branch <target branch name>
|
|
2959
2496
|
|
|
2960
2497
|
$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>
|
|
2961
2498
|
|
|
@@ -2963,7 +2500,7 @@ EXAMPLES
|
|
|
2963
2500
|
|
|
2964
2501
|
$ csdx cm:migration --multiple --file-path <migration/scripts/dir/path>
|
|
2965
2502
|
|
|
2966
|
-
$ csdx cm:migration --alias --file-path <migration/script/file/path>
|
|
2503
|
+
$ csdx cm:migration --alias <management-token-alias> --file-path <migration/script/file/path>
|
|
2967
2504
|
```
|
|
2968
2505
|
|
|
2969
2506
|
_See code: [@contentstack/cli-migration](https://github.com/contentstack/cli/blob/main/packages/contentstack-migration/src/commands/cm/stacks/migration.js)_
|
|
@@ -3119,30 +2656,26 @@ EXAMPLES
|
|
|
3119
2656
|
|
|
3120
2657
|
_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
2658
|
|
|
3122
|
-
## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [-
|
|
2659
|
+
## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes <value>] [--alias <value>] [--locale <value>]`
|
|
3123
2660
|
|
|
3124
2661
|
Create a stack from existing content types, entries, assets, etc
|
|
3125
2662
|
|
|
3126
2663
|
```
|
|
3127
2664
|
USAGE
|
|
3128
|
-
$ csdx cm:stacks:seed [--repo <value>] [--org <value>] [-
|
|
3129
|
-
[--locale <value>]
|
|
2665
|
+
$ csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes
|
|
2666
|
+
<value>] [--alias <value>] [--locale <value>]
|
|
3130
2667
|
|
|
3131
2668
|
FLAGS
|
|
3132
2669
|
-a, --alias=<value> Alias of the management token
|
|
3133
2670
|
-k, --stack-api-key=<value> Provide stack API key to seed content to
|
|
3134
2671
|
-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
2672
|
-y, --yes=<value> [Optional] Skip the stack confirmation.
|
|
2673
|
+
--org=<value> Provide Organization UID to create a new stack
|
|
2674
|
+
--repo=<value> GitHub organization name or GitHub user name/repository name.
|
|
3139
2675
|
|
|
3140
2676
|
DESCRIPTION
|
|
3141
2677
|
Create a stack from existing content types, entries, assets, etc
|
|
3142
2678
|
|
|
3143
|
-
ALIASES
|
|
3144
|
-
$ csdx cm:seed
|
|
3145
|
-
|
|
3146
2679
|
EXAMPLES
|
|
3147
2680
|
$ csdx cm:stacks:seed
|
|
3148
2681
|
|
|
@@ -3601,18 +3134,18 @@ Set region for CLI
|
|
|
3601
3134
|
|
|
3602
3135
|
```
|
|
3603
3136
|
USAGE
|
|
3604
|
-
$ csdx config:set:region [REGION] [
|
|
3605
|
-
[--personalize <value>] [--launch <value>] [--studio <value>]
|
|
3137
|
+
$ csdx config:set:region [REGION] [--cda <value> --cma <value> --ui-host <value> -n <value>] [--developer-hub
|
|
3138
|
+
<value>] [--personalize <value>] [--launch <value>] [--studio <value>]
|
|
3606
3139
|
|
|
3607
3140
|
ARGUMENTS
|
|
3608
3141
|
[REGION] Name for the region
|
|
3609
3142
|
|
|
3610
3143
|
FLAGS
|
|
3611
|
-
-
|
|
3144
|
+
-n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are required
|
|
3145
|
+
--cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host and
|
|
3612
3146
|
name flags are required
|
|
3613
|
-
|
|
3147
|
+
--cma=<value> Custom host to set for content management API, , if this flag is added then cda, ui-host
|
|
3614
3148
|
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
3149
|
--developer-hub=<value> Custom host to set for Developer hub API
|
|
3617
3150
|
--launch=<value> Custom host to set for Launch API
|
|
3618
3151
|
--personalize=<value> Custom host to set for Personalize API
|
|
@@ -3685,33 +3218,33 @@ USAGE
|
|
|
3685
3218
|
React App)|CSR (Client-Side Rendered)|Angular|Nuxt|VueJs|Remix|Other] [--org <value>] [-n <value>] [-e <value>]
|
|
3686
3219
|
[--branch <value>] [--build-command <value>] [--out-dir <value>] [--server-command <value>] [--variable-type Import
|
|
3687
3220
|
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
|
-
|
|
3221
|
+
adding environment variables] [-a <value>] [--env-variables <value>] [--redeploy-latest] [--redeploy-last-upload]
|
|
3222
|
+
|
|
3223
|
+
FLAGS
|
|
3224
|
+
-a, --alias=<value> [optional] Alias (name) for the delivery token.
|
|
3225
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
3226
|
+
-d, --data-dir=<value> Current working directory
|
|
3227
|
+
-e, --environment=<value> [optional] Environment name for the Launch project.
|
|
3228
|
+
-n, --name=<value> [optional] Name of the project.
|
|
3229
|
+
--branch=<value> [optional] GitHub branch name.
|
|
3230
|
+
--build-command=<value> [optional] Build Command.
|
|
3231
|
+
--env-variables=<value> [optional] Provide the environment variables in the key:value format, separated by
|
|
3232
|
+
comma. For example: APP_ENV:prod, TEST_ENV:testVal.
|
|
3233
|
+
--framework=<option> [optional] Type of framework. <options: Gatsby|NextJS|Other>
|
|
3234
|
+
<options: Gatsby|NextJs|CRA (Create React App)|CSR (Client-Side
|
|
3235
|
+
Rendered)|Angular|Nuxt|VueJs|Remix|Other>
|
|
3236
|
+
--org=<value> [optional] Provide the organization UID to create a new project or deployment.
|
|
3237
|
+
--out-dir=<value> [optional] Output Directory.
|
|
3238
|
+
--redeploy-last-upload [optional] Redeploy with last file upload
|
|
3239
|
+
--redeploy-latest [optional] Redeploy latest commit/code
|
|
3240
|
+
--server-command=<value> [optional] Server Command.
|
|
3241
|
+
--type=<option> [optional] Type of adapters. <options: GitHub|FileUpload>
|
|
3242
|
+
<options: GitHub|FileUpload>
|
|
3243
|
+
--variable-type=<option> [optional] Provide a variable type. <options: Import variables from a stack|Manually add
|
|
3244
|
+
custom variables to the list|Import variables from the .env.local file|Skip adding
|
|
3245
|
+
environment variables>
|
|
3246
|
+
<options: Import variables from a stack|Manually add custom variables to the list|Import
|
|
3247
|
+
variables from the .env.local file|Skip adding environment variables>
|
|
3715
3248
|
|
|
3716
3249
|
DESCRIPTION
|
|
3717
3250
|
Launch related operations
|
|
@@ -3742,8 +3275,6 @@ EXAMPLES
|
|
|
3742
3275
|
$ 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
3276
|
|
|
3744
3277
|
$ 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
3278
|
```
|
|
3748
3279
|
|
|
3749
3280
|
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/index.ts)_
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentstack/cli",
|
|
3
3
|
"description": "Command-line tool (CLI) to interact with Contentstack",
|
|
4
|
-
"version": "2.0.0-beta.
|
|
4
|
+
"version": "2.0.0-beta.4",
|
|
5
5
|
"author": "Contentstack",
|
|
6
6
|
"bin": {
|
|
7
7
|
"csdx": "./bin/run.js"
|
|
@@ -22,28 +22,28 @@
|
|
|
22
22
|
"prepack": "pnpm compile && oclif manifest && oclif readme"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@contentstack/cli-audit": "~2.0.0-beta",
|
|
26
|
-
"@contentstack/cli-auth": "~
|
|
27
|
-
"@contentstack/cli-cm-bootstrap": "~2.0.0-beta.
|
|
25
|
+
"@contentstack/cli-audit": "~2.0.0-beta.1",
|
|
26
|
+
"@contentstack/cli-auth": "~2.0.0-beta.1",
|
|
27
|
+
"@contentstack/cli-cm-bootstrap": "~2.0.0-beta.3",
|
|
28
28
|
"@contentstack/cli-cm-branches": "~1.6.1",
|
|
29
29
|
"@contentstack/cli-cm-bulk-publish": "~1.10.3",
|
|
30
|
-
"@contentstack/cli-cm-clone": "~2.0.0-beta.
|
|
31
|
-
"@contentstack/cli-cm-export": "~2.0.0-beta.
|
|
30
|
+
"@contentstack/cli-cm-clone": "~2.0.0-beta.4",
|
|
31
|
+
"@contentstack/cli-cm-export": "~2.0.0-beta.4",
|
|
32
32
|
"@contentstack/cli-cm-export-to-csv": "~1.10.1",
|
|
33
|
-
"@contentstack/cli-cm-import": "~2.0.0-beta.
|
|
34
|
-
"@contentstack/cli-cm-import-setup": "~2.0.0-beta.
|
|
35
|
-
"@contentstack/cli-cm-seed": "~2.0.0-beta.
|
|
33
|
+
"@contentstack/cli-cm-import": "~2.0.0-beta.3",
|
|
34
|
+
"@contentstack/cli-cm-import-setup": "~2.0.0-beta.2",
|
|
35
|
+
"@contentstack/cli-cm-seed": "~2.0.0-beta.3",
|
|
36
36
|
"@contentstack/cli-command": "~1.7.0",
|
|
37
37
|
"@contentstack/cli-config": "~1.16.1",
|
|
38
|
-
"@contentstack/cli-launch": "
|
|
39
|
-
"@contentstack/cli-migration": "~2.0.0-beta",
|
|
38
|
+
"@contentstack/cli-launch": "1.9.3",
|
|
39
|
+
"@contentstack/cli-migration": "~2.0.0-beta.1",
|
|
40
40
|
"@contentstack/cli-utilities": "~1.15.0",
|
|
41
41
|
"@contentstack/cli-variants": "~2.0.0-beta.3",
|
|
42
42
|
"@contentstack/management": "~1.22.0",
|
|
43
43
|
"@oclif/core": "^4.3.0",
|
|
44
44
|
"@oclif/plugin-help": "^6.2.28",
|
|
45
45
|
"@oclif/plugin-not-found": "^3.2.53",
|
|
46
|
-
"@oclif/plugin-plugins": "^5.4.
|
|
46
|
+
"@oclif/plugin-plugins": "^5.4.54",
|
|
47
47
|
"chalk": "^4.1.2",
|
|
48
48
|
"cli-progress": "^3.12.0",
|
|
49
49
|
"debug": "^4.4.1",
|