@contentstack/cli 2.0.0-beta → 2.0.0-beta.10
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 +489 -2774
- package/lib/hooks/init/context-init.js +5 -0
- package/lib/hooks/prerun/auth-guard.js +8 -10
- package/lib/hooks/prerun/latest-version-warning.js +7 -4
- package/oclif.manifest.json +1 -1
- package/package.json +37 -39
- package/lib/hooks/prerun/command-deprecation-check.d.ts +0 -1
- package/lib/hooks/prerun/command-deprecation-check.js +0 -10
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 linux-x64 node-v22.
|
|
21
|
+
@contentstack/cli/2.0.0-beta.10 linux-x64 node-v22.22.0
|
|
22
22
|
$ csdx --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ csdx COMMAND
|
|
@@ -29,76 +29,43 @@ 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)
|
|
37
35
|
* [`csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]`](#csdx-authtokensadd--a-value---delivery---management--e-value--k-value--y---token-value)
|
|
38
36
|
* [`csdx auth:tokens:remove`](#csdx-authtokensremove)
|
|
39
37
|
* [`csdx auth:whoami`](#csdx-authwhoami)
|
|
40
|
-
* [`csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`](#csdx-cmassetspublish--a-value---retry-failed-value--e-value---folder-uid-value---bulk-publish-value--c-value--y---locales-value---branch-value---delivery-token-value---source-env-value)
|
|
41
|
-
* [`csdx cm:assets:unpublish`](#csdx-cmassetsunpublish)
|
|
42
38
|
* [`csdx cm:bootstrap`](#csdx-cmbootstrap)
|
|
43
39
|
* [`csdx cm:branches`](#csdx-cmbranches)
|
|
44
40
|
* [`csdx cm:branches:create`](#csdx-cmbranchescreate)
|
|
45
41
|
* [`csdx cm:branches:delete [-uid <value>] [-k <value>]`](#csdx-cmbranchesdelete--uid-value--k-value)
|
|
46
42
|
* [`csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>] [--format <value>] [--csv-path <value>]`](#csdx-cmbranchesdiff---base-branch-value---compare-branch-value--k-value--module-value---format-value---csv-path-value)
|
|
47
43
|
* [`csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>] [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]`](#csdx-cmbranchesmerge--k-value--compare-branch-value---no-revert---export-summary-path-value---use-merge-summary-value---comment-value---base-branch-value)
|
|
48
|
-
* [`csdx cm:bulk-publish`](#csdx-cmbulk-publish)
|
|
49
|
-
* [`csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value)
|
|
50
|
-
* [`csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`](#csdx-cmassetspublish--a-value---retry-failed-value--e-value---folder-uid-value---bulk-publish-value--c-value--y---locales-value---branch-value---delivery-token-value---source-env-value)
|
|
51
|
-
* [`csdx cm:bulk-publish:clear`](#csdx-cmbulk-publishclear)
|
|
52
|
-
* [`csdx cm:bulk-publish:configure`](#csdx-cmbulk-publishconfigure)
|
|
53
|
-
* [`csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries] [--include-variants]`](#csdx-cmbulk-publishcross-publish--a-value---retry-failed-value---bulk-publish-value---content-type-value---locales-value---source-env-value---environments-value---delivery-token-value--c-value--y---branch-value---onlyassets---onlyentries---include-variants)
|
|
54
|
-
* [`csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>] [--entry-uid <value>] [--include-variants]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value---entry-uid-value---include-variants)
|
|
55
|
-
* [`csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value)
|
|
56
|
-
* [`csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value)
|
|
57
|
-
* [`csdx cm:bulk-publish:revert`](#csdx-cmbulk-publishrevert)
|
|
58
|
-
* [`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)
|
|
59
|
-
* [`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)
|
|
60
|
-
* [`csdx cm:entries:migrate-html-rte`](#csdx-cmentriesmigrate-html-rte)
|
|
61
|
-
* [`csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>] [--entry-uid <value>] [--include-variants]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value---entry-uid-value---include-variants)
|
|
62
|
-
* [`csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value)
|
|
63
|
-
* [`csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value)
|
|
64
|
-
* [`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)
|
|
65
|
-
* [`csdx cm:entries:unpublish`](#csdx-cmentriesunpublish)
|
|
66
|
-
* [`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)
|
|
67
|
-
* [`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)
|
|
68
|
-
* [`csdx cm:export-to-csv`](#csdx-cmexport-to-csv)
|
|
69
|
-
* [`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)
|
|
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)
|
|
71
|
-
* [`csdx cm:migrate-rte`](#csdx-cmmigrate-rte)
|
|
72
|
-
* [`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)
|
|
73
|
-
* [`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)
|
|
74
|
-
* [`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)
|
|
75
44
|
* [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
|
|
76
45
|
* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
|
|
77
|
-
* [`csdx cm:stacks:
|
|
78
|
-
* [`csdx cm:stacks:
|
|
79
|
-
* [`csdx cm:stacks:
|
|
46
|
+
* [`csdx cm:stacks:bulk-assets`](#csdx-cmstacksbulk-assets)
|
|
47
|
+
* [`csdx cm:stacks:bulk-entries`](#csdx-cmstacksbulk-entries)
|
|
48
|
+
* [`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)
|
|
49
|
+
* [`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)
|
|
80
50
|
* [`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)
|
|
81
|
-
* [`csdx cm:stacks:
|
|
82
|
-
* [`csdx cm:stacks:publish`](#csdx-cmstackspublish)
|
|
83
|
-
* [`csdx cm:stacks:publish-clear-logs`](#csdx-cmstackspublish-clear-logs)
|
|
84
|
-
* [`csdx cm:stacks:publish-configure`](#csdx-cmstackspublish-configure)
|
|
85
|
-
* [`csdx cm:stacks:publish-revert`](#csdx-cmstackspublish-revert)
|
|
86
|
-
* [`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)
|
|
87
|
-
* [`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)
|
|
51
|
+
* [`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)
|
|
88
52
|
* [`csdx config:get:base-branch`](#csdx-configgetbase-branch)
|
|
89
53
|
* [`csdx config:get:ea-header`](#csdx-configgetea-header)
|
|
90
54
|
* [`csdx config:get:early-access-header`](#csdx-configgetearly-access-header)
|
|
91
55
|
* [`csdx config:get:log`](#csdx-configgetlog)
|
|
56
|
+
* [`csdx config:get:proxy`](#csdx-configgetproxy)
|
|
92
57
|
* [`csdx config:get:rate-limit`](#csdx-configgetrate-limit)
|
|
93
58
|
* [`csdx config:get:region`](#csdx-configgetregion)
|
|
94
59
|
* [`csdx config:remove:base-branch`](#csdx-configremovebase-branch)
|
|
95
60
|
* [`csdx config:remove:ea-header`](#csdx-configremoveea-header)
|
|
96
61
|
* [`csdx config:remove:early-access-header`](#csdx-configremoveearly-access-header)
|
|
62
|
+
* [`csdx config:remove:proxy`](#csdx-configremoveproxy)
|
|
97
63
|
* [`csdx config:remove:rate-limit`](#csdx-configremoverate-limit)
|
|
98
64
|
* [`csdx config:set:base-branch`](#csdx-configsetbase-branch)
|
|
99
65
|
* [`csdx config:set:ea-header`](#csdx-configsetea-header)
|
|
100
66
|
* [`csdx config:set:early-access-header`](#csdx-configsetearly-access-header)
|
|
101
67
|
* [`csdx config:set:log`](#csdx-configsetlog)
|
|
68
|
+
* [`csdx config:set:proxy`](#csdx-configsetproxy)
|
|
102
69
|
* [`csdx config:set:rate-limit`](#csdx-configsetrate-limit)
|
|
103
70
|
* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
|
|
104
71
|
* [`csdx help [COMMAND]`](#csdx-help-command)
|
|
@@ -123,113 +90,6 @@ USAGE
|
|
|
123
90
|
* [`csdx tokens`](#csdx-tokens)
|
|
124
91
|
* [`csdx whoami`](#csdx-whoami)
|
|
125
92
|
|
|
126
|
-
## `csdx audit`
|
|
127
|
-
|
|
128
|
-
Perform audits and find possible errors in the exported Contentstack data
|
|
129
|
-
|
|
130
|
-
```
|
|
131
|
-
USAGE
|
|
132
|
-
$ csdx audit [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
133
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
|
|
134
|
-
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
135
|
-
|
|
136
|
-
FLAGS
|
|
137
|
-
--modules=<option>... Provide the list of modules to be audited
|
|
138
|
-
<options:
|
|
139
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
140
|
-
--report-path=<value> Path to store the audit reports
|
|
141
|
-
|
|
142
|
-
COMMON FLAGS
|
|
143
|
-
-c, --config=<value> Path of the external config
|
|
144
|
-
-d, --data-dir=<value> Path where the data is stored
|
|
145
|
-
--show-console-output Display the audit and audit fix result for individual modules
|
|
146
|
-
|
|
147
|
-
TABLE FLAGS
|
|
148
|
-
--columns=<value> Specify columns to display, comma-separated.
|
|
149
|
-
--csv Output results in CSV format.
|
|
150
|
-
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
151
|
-
--no-header Hide table headers in output.
|
|
152
|
-
--no-truncate Prevent truncation of long text in columns.
|
|
153
|
-
--output=<option> Specify output format: csv, json, or yaml.
|
|
154
|
-
<options: csv|json|yaml>
|
|
155
|
-
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
156
|
-
|
|
157
|
-
DESCRIPTION
|
|
158
|
-
Perform audits and find possible errors in the exported Contentstack data
|
|
159
|
-
|
|
160
|
-
ALIASES
|
|
161
|
-
$ csdx audit
|
|
162
|
-
$ csdx cm:stacks:audit
|
|
163
|
-
|
|
164
|
-
EXAMPLES
|
|
165
|
-
$ csdx audit
|
|
166
|
-
|
|
167
|
-
$ csdx audit --report-path=<path>
|
|
168
|
-
|
|
169
|
-
$ csdx audit --report-path=<path> --csv
|
|
170
|
-
|
|
171
|
-
$ csdx audit --report-path=<path> --filter="name=<filter-value>"
|
|
172
|
-
|
|
173
|
-
$ csdx audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
## `csdx audit:fix`
|
|
177
|
-
|
|
178
|
-
Perform audits and fix possible errors in the exported Contentstack data.
|
|
179
|
-
|
|
180
|
-
```
|
|
181
|
-
USAGE
|
|
182
|
-
$ csdx audit:fix [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
183
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
|
|
184
|
-
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
|
|
185
|
-
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
186
|
-
|
|
187
|
-
FLAGS
|
|
188
|
-
--copy-dir Create backup from the original data.
|
|
189
|
-
--copy-path=<value> Provide the path to backup the copied data
|
|
190
|
-
--fix-only=<option>... Provide the list of fix options
|
|
191
|
-
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
192
|
-
--modules=<option>... Provide the list of modules to be audited
|
|
193
|
-
<options:
|
|
194
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
195
|
-
--report-path=<value> Path to store the audit reports
|
|
196
|
-
|
|
197
|
-
COMMON FLAGS
|
|
198
|
-
-c, --config=<value> Path of the external config
|
|
199
|
-
-d, --data-dir=<value> Path where the data is stored
|
|
200
|
-
--show-console-output Display the audit and audit fix result for individual modules
|
|
201
|
-
|
|
202
|
-
TABLE FLAGS
|
|
203
|
-
--columns=<value> Specify columns to display, comma-separated.
|
|
204
|
-
--csv Output results in CSV format.
|
|
205
|
-
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
206
|
-
--no-header Hide table headers in output.
|
|
207
|
-
--no-truncate Prevent truncation of long text in columns.
|
|
208
|
-
--output=<option> Specify output format: csv, json, or yaml.
|
|
209
|
-
<options: csv|json|yaml>
|
|
210
|
-
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
211
|
-
|
|
212
|
-
DESCRIPTION
|
|
213
|
-
Perform audits and fix possible errors in the exported Contentstack data.
|
|
214
|
-
|
|
215
|
-
ALIASES
|
|
216
|
-
$ csdx audit:fix
|
|
217
|
-
$ csdx cm:stacks:audit:fix
|
|
218
|
-
|
|
219
|
-
EXAMPLES
|
|
220
|
-
$ csdx audit:fix --copy-dir
|
|
221
|
-
|
|
222
|
-
$ csdx audit:fix --report-path=<path> --copy-dir
|
|
223
|
-
|
|
224
|
-
$ csdx audit:fix --report-path=<path> --copy-dir --csv
|
|
225
|
-
|
|
226
|
-
$ csdx audit:fix --fix-only=reference,global_field --copy-dir
|
|
227
|
-
|
|
228
|
-
$ csdx audit:fix --report-path=<path> --filter="name=<filter-value>"
|
|
229
|
-
|
|
230
|
-
$ csdx audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
|
|
231
|
-
```
|
|
232
|
-
|
|
233
93
|
## `csdx auth:login`
|
|
234
94
|
|
|
235
95
|
User sessions login
|
|
@@ -331,12 +191,12 @@ USAGE
|
|
|
331
191
|
|
|
332
192
|
FLAGS
|
|
333
193
|
-a, --alias=<value> Alias (name) you want to assign to the token
|
|
334
|
-
-d, --delivery Set this flag to save delivery token
|
|
335
194
|
-e, --environment=<value> Environment name for delivery token
|
|
336
195
|
-k, --stack-api-key=<value> Stack API Key
|
|
337
|
-
-m, --management Set this flag to save management token
|
|
338
|
-
-t, --token=<value> Add the token name
|
|
339
196
|
-y, --yes Use this flag to skip confirmation
|
|
197
|
+
--delivery Set this flag to save delivery token
|
|
198
|
+
--management Set this flag to save management token
|
|
199
|
+
--token=<value> [env: TOKEN] Add the token name
|
|
340
200
|
|
|
341
201
|
DESCRIPTION
|
|
342
202
|
Adds management/delivery tokens to your session to use it with other CLI commands
|
|
@@ -410,167 +270,6 @@ EXAMPLES
|
|
|
410
270
|
|
|
411
271
|
_See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/main/packages/contentstack-auth/src/commands/auth/whoami.ts)_
|
|
412
272
|
|
|
413
|
-
## `csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`
|
|
414
|
-
|
|
415
|
-
Publish assets to the specified environments
|
|
416
|
-
|
|
417
|
-
```
|
|
418
|
-
USAGE
|
|
419
|
-
$ csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish
|
|
420
|
-
<value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]
|
|
421
|
-
|
|
422
|
-
FLAGS
|
|
423
|
-
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
424
|
-
operation. If you don’t mention the branch name, then by default the assets from the
|
|
425
|
-
main branch will be published.
|
|
426
|
-
-a, --alias=<value> Alias (name) for the management token. You must use either the --alias flag or the
|
|
427
|
-
--stack-api-key flag.
|
|
428
|
-
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
429
|
-
for a single run. Refer to the configure command to create a configuration file.
|
|
430
|
-
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
431
|
-
environments, specify their names separated by spaces.
|
|
432
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
433
|
-
--alias flag.
|
|
434
|
-
-l, --locales=<value>... Locales in which assets will be published, e.g., en-us. In the case of multiple
|
|
435
|
-
locales, specify the codes separated by spaces.
|
|
436
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
437
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
438
|
-
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
439
|
-
default.
|
|
440
|
-
--delivery-token=<value> The delivery token of the source environment.
|
|
441
|
-
--folder-uid=<value> (optional) The UID of the Assets’ folder from which the assets need to be published.
|
|
442
|
-
The default value is cs_root.
|
|
443
|
-
--retry-failed=<value> Use this option to retry publishing the failed assets from the logfile. Specify the
|
|
444
|
-
name of the logfile that lists failed publish calls. If this option is used, it will
|
|
445
|
-
override all other flags.
|
|
446
|
-
--source-env=<value> Source environment
|
|
447
|
-
|
|
448
|
-
DESCRIPTION
|
|
449
|
-
Publish assets to the specified environments
|
|
450
|
-
The assets command is used to publish assets from the specified stack, to the specified environments
|
|
451
|
-
|
|
452
|
-
Note: Environment(s) and Locale(s) are required to execute the command successfully
|
|
453
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
ALIASES
|
|
457
|
-
$ csdx cm:bulk-publish:assets
|
|
458
|
-
|
|
459
|
-
EXAMPLES
|
|
460
|
-
General Usage
|
|
461
|
-
|
|
462
|
-
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
Using --config or -c flag
|
|
467
|
-
|
|
468
|
-
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
469
|
-
|
|
470
|
-
$ csdx cm:assets:publish --config [PATH TO CONFIG FILE]
|
|
471
|
-
|
|
472
|
-
$ csdx cm:assets:publish -c [PATH TO CONFIG FILE]
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
Using --retry-failed flag
|
|
477
|
-
|
|
478
|
-
$ csdx cm:assets:publish --retry-failed [LOG FILE NAME]
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
Using --branch flag
|
|
483
|
-
|
|
484
|
-
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
Using --source-env
|
|
489
|
-
|
|
490
|
-
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
Using --stack-api-key flag
|
|
495
|
-
|
|
496
|
-
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --stack-api-key [STACK API KEY]
|
|
497
|
-
```
|
|
498
|
-
|
|
499
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/assets/publish.js)_
|
|
500
|
-
|
|
501
|
-
## `csdx cm:assets:unpublish`
|
|
502
|
-
|
|
503
|
-
Unpublish assets from given environment
|
|
504
|
-
|
|
505
|
-
```
|
|
506
|
-
USAGE
|
|
507
|
-
$ csdx cm:assets:unpublish [-a <value>] [-k <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch
|
|
508
|
-
<value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--delivery-token <value>]
|
|
509
|
-
|
|
510
|
-
FLAGS
|
|
511
|
-
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
512
|
-
--stack-api-key flag.
|
|
513
|
-
-c, --config=<value> (optional) Path of an optional configuration JSON file containing all the options for a
|
|
514
|
-
single run. Refer to the configure command to create a configuration file.
|
|
515
|
-
-e, --environment=<value> The name of the environment from where entries/assets need to be unpublished.
|
|
516
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
|
|
517
|
-
flag.
|
|
518
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
519
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
520
|
-
--branch=<value> [default: main] The name of the branch where you want to perform the bulk unpublish
|
|
521
|
-
operation. If you don’t mention the branch name, then by default the content from the
|
|
522
|
-
main branch will be unpublished.
|
|
523
|
-
--bulk-unpublish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
524
|
-
default.
|
|
525
|
-
--delivery-token=<value> The delivery token of the source environment.
|
|
526
|
-
--locale=<value> Locale from which entries/assets will be unpublished, e.g., en-us.
|
|
527
|
-
--retry-failed=<value> (optional) Use this option to retry unpublishing the failed entries from the logfile.
|
|
528
|
-
Specify the name of the logfile that lists failed unpublish calls. If this option is
|
|
529
|
-
used, it will override all other flags.
|
|
530
|
-
|
|
531
|
-
DESCRIPTION
|
|
532
|
-
Unpublish assets from given environment
|
|
533
|
-
The unpublish command is used for unpublishing assets from the given environment
|
|
534
|
-
|
|
535
|
-
Note: Environment (Source Environment) and Locale are required to execute the command successfully
|
|
536
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
537
|
-
|
|
538
|
-
EXAMPLES
|
|
539
|
-
General Usage
|
|
540
|
-
|
|
541
|
-
$ csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
Using --config or -c flag
|
|
546
|
-
|
|
547
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
|
|
548
|
-
|
|
549
|
-
$ csdx cm:assets:unpublish --config [PATH TO CONFIG FILE]
|
|
550
|
-
|
|
551
|
-
$ csdx cm:assets:unpublish -c [PATH TO CONFIG FILE]
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
Using --retry-failed flag
|
|
556
|
-
|
|
557
|
-
$ csdx cm:assets:unpublish --retry-failed [LOG FILE NAME]
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
Using --branch flag
|
|
562
|
-
|
|
563
|
-
$ csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
Using --stack-api-key flag
|
|
568
|
-
|
|
569
|
-
$ csdx cm:assets:unpublish --bulk-unpublish --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
|
|
570
|
-
```
|
|
571
|
-
|
|
572
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/assets/unpublish.js)_
|
|
573
|
-
|
|
574
273
|
## `csdx cm:bootstrap`
|
|
575
274
|
|
|
576
275
|
Bootstrap contentstack apps
|
|
@@ -730,2575 +429,524 @@ EXAMPLES
|
|
|
730
429
|
|
|
731
430
|
$ csdx cm:branches:diff --module "content-types" --format "detailed-text"
|
|
732
431
|
|
|
733
|
-
$ csdx cm:branches:diff --compare-branch "develop" --format "detailed-text"
|
|
734
|
-
|
|
735
|
-
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main"
|
|
736
|
-
|
|
737
|
-
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop"
|
|
738
|
-
|
|
739
|
-
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --module "content-types"
|
|
740
|
-
|
|
741
|
-
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types"
|
|
742
|
-
|
|
743
|
-
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text"
|
|
744
|
-
|
|
745
|
-
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "compact-text"
|
|
746
|
-
|
|
747
|
-
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text" --csv-path "./reports/diff-report.csv"
|
|
748
|
-
```
|
|
749
|
-
|
|
750
|
-
_See code: [@contentstack/cli-cm-branches](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/diff.ts)_
|
|
751
|
-
|
|
752
|
-
## `csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>] [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]`
|
|
753
|
-
|
|
754
|
-
Merge changes from a branch
|
|
755
|
-
|
|
756
|
-
```
|
|
757
|
-
USAGE
|
|
758
|
-
$ csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>]
|
|
759
|
-
[--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]
|
|
760
|
-
|
|
761
|
-
FLAGS
|
|
762
|
-
-k, --stack-api-key=<value> [optional] Provide stack API key to show the difference between the branches.
|
|
763
|
-
--base-branch=<value> [optional] Base branch (Target branch).
|
|
764
|
-
--comment=<value> [optional] Pass a comment.
|
|
765
|
-
--compare-branch=<value> [optional] Compare branch (Source branch).
|
|
766
|
-
--export-summary-path=<value> [optional] Export summary file path.
|
|
767
|
-
--no-revert [optional] If passed, will not create the new revert branch.
|
|
768
|
-
--use-merge-summary=<value> [optional] Path of merge summary file.
|
|
769
|
-
|
|
770
|
-
DESCRIPTION
|
|
771
|
-
Merge changes from a branch
|
|
772
|
-
|
|
773
|
-
EXAMPLES
|
|
774
|
-
$ csdx cm:branches:merge --stack-api-key bltxxxxxxxx --compare-branch feature-branch
|
|
775
|
-
|
|
776
|
-
$ csdx cm:branches:merge --stack-api-key bltxxxxxxxx --comment "merge comment"
|
|
777
|
-
|
|
778
|
-
$ csdx cm:branches:merge -k bltxxxxxxxx --base-branch base-branch
|
|
779
|
-
|
|
780
|
-
$ csdx cm:branches:merge --export-summary-path file/path
|
|
781
|
-
|
|
782
|
-
$ csdx cm:branches:merge --use-merge-summary file-path
|
|
783
|
-
|
|
784
|
-
$ csdx cm:branches:merge -k bltxxxxxxxx --no-revert
|
|
785
|
-
|
|
786
|
-
$ csdx cm:branches:merge -k bltxxxxxxxx --compare-branch feature-branch --no-revert
|
|
787
|
-
```
|
|
788
|
-
|
|
789
|
-
_See code: [@contentstack/cli-cm-branches](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/merge.ts)_
|
|
790
|
-
|
|
791
|
-
## `csdx cm:bulk-publish`
|
|
792
|
-
|
|
793
|
-
Bulk Publish script for managing entries and assets
|
|
794
|
-
|
|
795
|
-
```
|
|
796
|
-
USAGE
|
|
797
|
-
$ csdx cm:bulk-publish
|
|
798
|
-
|
|
799
|
-
DESCRIPTION
|
|
800
|
-
Bulk Publish script for managing entries and assets
|
|
801
|
-
```
|
|
802
|
-
|
|
803
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/index.js)_
|
|
804
|
-
|
|
805
|
-
## `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>]`
|
|
806
|
-
|
|
807
|
-
Add fields from updated content types to their respective entries
|
|
808
|
-
|
|
809
|
-
```
|
|
810
|
-
USAGE
|
|
811
|
-
$ csdx cm:bulk-publish:add-fields cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
812
|
-
[--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
|
|
813
|
-
|
|
814
|
-
FLAGS
|
|
815
|
-
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
816
|
-
operation. If you don’t mention the branch name, then by default the content from the
|
|
817
|
-
main branch will be published.
|
|
818
|
-
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
819
|
-
--stack-api-key flag.
|
|
820
|
-
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
821
|
-
for a single run. Refer to the configure command to create a configuration file.
|
|
822
|
-
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
823
|
-
environments, specify their names separated by spaces.
|
|
824
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
825
|
-
--alias flag.
|
|
826
|
-
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
|
|
827
|
-
locales, specify the codes separated by spaces.
|
|
828
|
-
-t, --contentTypes=<value>... The Contenttypes from which entries will be published.
|
|
829
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
830
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
831
|
-
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
832
|
-
default.
|
|
833
|
-
--content-types=<value>... The UID of the content type ID whose entries you want to publish in bulk. In case of
|
|
834
|
-
multiple content types, specify their IDs separated by spaces.
|
|
835
|
-
--force Update and publish all entries even if no fields have been added.
|
|
836
|
-
--retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
|
|
837
|
-
name of the logfile that lists failed publish calls. If this option is used, it will
|
|
838
|
-
override all other flags.
|
|
839
|
-
|
|
840
|
-
DESCRIPTION
|
|
841
|
-
Add fields from updated content types to their respective entries
|
|
842
|
-
The update-and-publish command is used to update existing entries with the updated schema of the respective content
|
|
843
|
-
type
|
|
844
|
-
|
|
845
|
-
Note: Content types, Environments and Locales are required to execute the command successfully
|
|
846
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
ALIASES
|
|
850
|
-
$ csdx cm:bulk-publish:add-fields
|
|
851
|
-
|
|
852
|
-
EXAMPLES
|
|
853
|
-
General Usage
|
|
854
|
-
|
|
855
|
-
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
856
|
-
|
|
857
|
-
|
|
858
|
-
|
|
859
|
-
Using --config or -c flag
|
|
860
|
-
|
|
861
|
-
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
862
|
-
|
|
863
|
-
$ csdx cm:entries:update-and-publish --config [PATH TO CONFIG FILE]
|
|
864
|
-
|
|
865
|
-
$ csdx cm:entries:update-and-publish -c [PATH TO CONFIG FILE]
|
|
866
|
-
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
Using --retry-failed
|
|
870
|
-
|
|
871
|
-
$ csdx cm:entries:update-and-publish --retry-failed [LOG FILE NAME]
|
|
872
|
-
|
|
873
|
-
|
|
874
|
-
|
|
875
|
-
Using --branch
|
|
876
|
-
|
|
877
|
-
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
878
|
-
|
|
879
|
-
|
|
880
|
-
|
|
881
|
-
Using --stack-api-key
|
|
882
|
-
|
|
883
|
-
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY]
|
|
884
|
-
```
|
|
885
|
-
|
|
886
|
-
## `csdx cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>] [--bulk-publish <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`
|
|
887
|
-
|
|
888
|
-
Publish assets to the specified environments
|
|
889
|
-
|
|
890
|
-
```
|
|
891
|
-
USAGE
|
|
892
|
-
$ csdx cm:bulk-publish:assets cm:assets:publish [-a <value>] [--retry-failed <value>] [-e <value>] [--folder-uid <value>]
|
|
893
|
-
[--bulk-publish <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>]
|
|
894
|
-
[--source-env <value>]
|
|
895
|
-
|
|
896
|
-
FLAGS
|
|
897
|
-
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
898
|
-
operation. If you don’t mention the branch name, then by default the assets from the
|
|
899
|
-
main branch will be published.
|
|
900
|
-
-a, --alias=<value> Alias (name) for the management token. You must use either the --alias flag or the
|
|
901
|
-
--stack-api-key flag.
|
|
902
|
-
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
903
|
-
for a single run. Refer to the configure command to create a configuration file.
|
|
904
|
-
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
905
|
-
environments, specify their names separated by spaces.
|
|
906
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
907
|
-
--alias flag.
|
|
908
|
-
-l, --locales=<value>... Locales in which assets will be published, e.g., en-us. In the case of multiple
|
|
909
|
-
locales, specify the codes separated by spaces.
|
|
910
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
911
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
912
|
-
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
913
|
-
default.
|
|
914
|
-
--delivery-token=<value> The delivery token of the source environment.
|
|
915
|
-
--folder-uid=<value> (optional) The UID of the Assets’ folder from which the assets need to be published.
|
|
916
|
-
The default value is cs_root.
|
|
917
|
-
--retry-failed=<value> Use this option to retry publishing the failed assets from the logfile. Specify the
|
|
918
|
-
name of the logfile that lists failed publish calls. If this option is used, it will
|
|
919
|
-
override all other flags.
|
|
920
|
-
--source-env=<value> Source environment
|
|
921
|
-
|
|
922
|
-
DESCRIPTION
|
|
923
|
-
Publish assets to the specified environments
|
|
924
|
-
The assets command is used to publish assets from the specified stack, to the specified environments
|
|
925
|
-
|
|
926
|
-
Note: Environment(s) and Locale(s) are required to execute the command successfully
|
|
927
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
ALIASES
|
|
931
|
-
$ csdx cm:bulk-publish:assets
|
|
932
|
-
|
|
933
|
-
EXAMPLES
|
|
934
|
-
General Usage
|
|
935
|
-
|
|
936
|
-
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
940
|
-
Using --config or -c flag
|
|
941
|
-
|
|
942
|
-
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
943
|
-
|
|
944
|
-
$ csdx cm:assets:publish --config [PATH TO CONFIG FILE]
|
|
945
|
-
|
|
946
|
-
$ csdx cm:assets:publish -c [PATH TO CONFIG FILE]
|
|
947
|
-
|
|
948
|
-
|
|
949
|
-
|
|
950
|
-
Using --retry-failed flag
|
|
951
|
-
|
|
952
|
-
$ csdx cm:assets:publish --retry-failed [LOG FILE NAME]
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
Using --branch flag
|
|
957
|
-
|
|
958
|
-
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
Using --source-env
|
|
963
|
-
|
|
964
|
-
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
Using --stack-api-key flag
|
|
969
|
-
|
|
970
|
-
$ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --stack-api-key [STACK API KEY]
|
|
971
|
-
```
|
|
972
|
-
|
|
973
|
-
## `csdx cm:bulk-publish:clear`
|
|
974
|
-
|
|
975
|
-
Clear the log folder
|
|
976
|
-
|
|
977
|
-
```
|
|
978
|
-
USAGE
|
|
979
|
-
$ csdx cm:bulk-publish:clear [--log-files-count] [-y]
|
|
980
|
-
|
|
981
|
-
FLAGS
|
|
982
|
-
-y, --yes Delete all files without asking for confirmation
|
|
983
|
-
--log-files-count List number of log files
|
|
984
|
-
|
|
985
|
-
DESCRIPTION
|
|
986
|
-
Clear the log folder
|
|
987
|
-
|
|
988
|
-
ALIASES
|
|
989
|
-
$ csdx cm:bulk-publish:clear
|
|
990
|
-
|
|
991
|
-
EXAMPLES
|
|
992
|
-
$ csdx cm:stacks:publish-clear-logs
|
|
993
|
-
|
|
994
|
-
$ csdx cm:stacks:publish-clear-logs --log-files-count
|
|
995
|
-
|
|
996
|
-
$ csdx cm:stacks:publish-clear-logs --yes
|
|
997
|
-
|
|
998
|
-
$ csdx cm:stacks:publish-clear-logs -y
|
|
999
|
-
```
|
|
1000
|
-
|
|
1001
|
-
## `csdx cm:bulk-publish:configure`
|
|
1002
|
-
|
|
1003
|
-
The configure command is used to generate a configuration file for publish scripts.
|
|
1004
|
-
|
|
1005
|
-
```
|
|
1006
|
-
USAGE
|
|
1007
|
-
$ csdx cm:bulk-publish:configure [-a <value>] [-k <value>]
|
|
1008
|
-
|
|
1009
|
-
FLAGS
|
|
1010
|
-
-a, --alias=<value> Name (alias) of the management token you want to use. You must use either the --alias
|
|
1011
|
-
flag or the --stack-api-key flag.
|
|
1012
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
|
|
1013
|
-
flag.
|
|
1014
|
-
|
|
1015
|
-
DESCRIPTION
|
|
1016
|
-
The configure command is used to generate a configuration file for publish scripts.
|
|
1017
|
-
|
|
1018
|
-
ALIASES
|
|
1019
|
-
$ csdx cm:bulk-publish:configure
|
|
1020
|
-
|
|
1021
|
-
EXAMPLES
|
|
1022
|
-
$ csdx cm:stacks:publish-configure
|
|
1023
|
-
|
|
1024
|
-
$ csdx cm:stacks:publish-configure -a <management_token_alias>
|
|
1025
|
-
|
|
1026
|
-
$ csdx cm:stacks:publish-configure --alias <management_token_alias>
|
|
1027
|
-
|
|
1028
|
-
$ csdx cm:stacks:publish-configure --stack-api-key <stack_api_key>
|
|
1029
|
-
```
|
|
1030
|
-
|
|
1031
|
-
## `csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries] [--include-variants]`
|
|
1032
|
-
|
|
1033
|
-
Publish entries and assets from one environment to other environments
|
|
1034
|
-
|
|
1035
|
-
```
|
|
1036
|
-
USAGE
|
|
1037
|
-
$ csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>]
|
|
1038
|
-
[--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y]
|
|
1039
|
-
[--branch <value>] [--onlyAssets] [--onlyEntries] [--include-variants]
|
|
1040
|
-
|
|
1041
|
-
FLAGS
|
|
1042
|
-
-B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
1043
|
-
selected)
|
|
1044
|
-
-a, --alias=<value> Alias(name) for the management token
|
|
1045
|
-
-c, --config=<value> Path to the config file
|
|
1046
|
-
-k, --stack-api-key=<value> Stack API key to be used
|
|
1047
|
-
-y, --yes Agree to process the command with the current configuration
|
|
1048
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1049
|
-
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
1050
|
-
default.
|
|
1051
|
-
--content-type=<value>... The Contenttypes from which entries will be published
|
|
1052
|
-
--delivery-token=<value> The delivery token of the source environment.
|
|
1053
|
-
--environments=<value>... Destination Environments
|
|
1054
|
-
--include-variants Include Variants flag will publish all associated variant entries.
|
|
1055
|
-
--locales=<value> Source locale
|
|
1056
|
-
--onlyAssets Unpublish only assets
|
|
1057
|
-
--onlyEntries Unpublish only entries
|
|
1058
|
-
--retry-failed=<value> (optional) Retry publishing failed entries from the logfile (this flag overrides all
|
|
1059
|
-
other flags)
|
|
1060
|
-
--source-env=<value> Source Env
|
|
1061
|
-
|
|
1062
|
-
DESCRIPTION
|
|
1063
|
-
Publish entries and assets from one environment to other environments
|
|
1064
|
-
The cross-publish command is used to publish entries and assets from one environment to other environments
|
|
1065
|
-
|
|
1066
|
-
Note: Content Type, Environment, Destination Environment(s) and Locale are required to execute the command
|
|
1067
|
-
successfully
|
|
1068
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
1069
|
-
|
|
1070
|
-
|
|
1071
|
-
EXAMPLES
|
|
1072
|
-
General Usage
|
|
1073
|
-
|
|
1074
|
-
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] -a [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
|
|
1075
|
-
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
Using --config or -c flag
|
|
1079
|
-
|
|
1080
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
1081
|
-
|
|
1082
|
-
$ csdx cm:bulk-publish:cross-publish --config [PATH TO CONFIG FILE]
|
|
1083
|
-
|
|
1084
|
-
$ csdx cm:bulk-publish:cross-publish -c [PATH TO CONFIG FILE]
|
|
1085
|
-
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
Using --retry-failed flag
|
|
1089
|
-
|
|
1090
|
-
$ csdx cm:bulk-publish:cross-publish --retry-failed [LOG FILE NAME]
|
|
1091
|
-
|
|
1092
|
-
$ csdx cm:bulk-publish:cross-publish -r [LOG FILE NAME]
|
|
1093
|
-
|
|
1094
|
-
|
|
1095
|
-
|
|
1096
|
-
Using --branch flag
|
|
1097
|
-
|
|
1098
|
-
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] -a [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
1099
|
-
|
|
1100
|
-
|
|
1101
|
-
|
|
1102
|
-
Using --stack-api-key flag
|
|
1103
|
-
|
|
1104
|
-
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
|
|
1105
|
-
|
|
1106
|
-
|
|
1107
|
-
|
|
1108
|
-
Using --include-variants flag
|
|
1109
|
-
|
|
1110
|
-
$ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN] [--include-variants]
|
|
1111
|
-
```
|
|
1112
|
-
|
|
1113
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js)_
|
|
1114
|
-
|
|
1115
|
-
## `csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>] [--entry-uid <value>] [--include-variants]`
|
|
1116
|
-
|
|
1117
|
-
Publish entries from multiple contenttypes to multiple environments and locales
|
|
1118
|
-
|
|
1119
|
-
```
|
|
1120
|
-
USAGE
|
|
1121
|
-
$ csdx cm:bulk-publish:entries cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
1122
|
-
[--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
|
|
1123
|
-
<value>] [--delivery-token <value>] [--source-env <value>] [--entry-uid <value>] [--include-variants]
|
|
1124
|
-
|
|
1125
|
-
FLAGS
|
|
1126
|
-
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1127
|
-
operation. If you don’t mention the branch name, then by default the content from
|
|
1128
|
-
main branch will be published.
|
|
1129
|
-
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1130
|
-
--stack-api-key flag.
|
|
1131
|
-
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the
|
|
1132
|
-
options for a single run. Refer to the configure command to create a configuration
|
|
1133
|
-
file.
|
|
1134
|
-
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
1135
|
-
environments, specify their names separated by spaces.
|
|
1136
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1137
|
-
--alias flag.
|
|
1138
|
-
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
|
|
1139
|
-
locales, specify the codes separated by spaces.
|
|
1140
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
1141
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1142
|
-
--bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. This flag is
|
|
1143
|
-
set to true, by default.
|
|
1144
|
-
--content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
|
|
1145
|
-
multiple content types, specify the IDs separated by spaces.
|
|
1146
|
-
--delivery-token=<value> The delivery token of the source environment.
|
|
1147
|
-
--entry-uid=<value> Entry Uid for publish all associated variant entries.
|
|
1148
|
-
--include-variants Include Variants flag will publish all associated variant entries with base entry.
|
|
1149
|
-
--publish-all-content-types (optional) Set it to true to bulk publish entries from all content types. If the
|
|
1150
|
-
--content-types option is already used, then you cannot use this option.
|
|
1151
|
-
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/ assets from the
|
|
1152
|
-
logfile. Specify the name of the logfile that lists failed publish calls. If this
|
|
1153
|
-
option is used, it will override all other flags.
|
|
1154
|
-
--source-env=<value> Source environment
|
|
1155
|
-
|
|
1156
|
-
DESCRIPTION
|
|
1157
|
-
Publish entries from multiple contenttypes to multiple environments and locales
|
|
1158
|
-
The publish command is used to publish entries from the specified content types, to the
|
|
1159
|
-
specified environments and locales
|
|
1160
|
-
|
|
1161
|
-
Note: Content Types, Environments and Locales are required to execute the command successfully
|
|
1162
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
1163
|
-
|
|
1164
|
-
|
|
1165
|
-
ALIASES
|
|
1166
|
-
$ csdx cm:bulk-publish:entries
|
|
1167
|
-
|
|
1168
|
-
EXAMPLES
|
|
1169
|
-
General Usage
|
|
1170
|
-
|
|
1171
|
-
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
1172
|
-
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
Using --config or -c flag
|
|
1176
|
-
|
|
1177
|
-
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
1178
|
-
|
|
1179
|
-
$ csdx cm:entries:publish --config [PATH TO CONFIG FILE]
|
|
1180
|
-
|
|
1181
|
-
$ csdx cm:entries:publish -c [PATH TO CONFIG FILE]
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
Using --retry-failed
|
|
1186
|
-
|
|
1187
|
-
$ csdx cm:entries:publish --retry-failed [LOG FILE NAME]
|
|
1188
|
-
|
|
1189
|
-
$ csdx cm:entries:publish -r [LOG FILE NAME]
|
|
1190
|
-
|
|
1191
|
-
|
|
1192
|
-
|
|
1193
|
-
Using --branch
|
|
1194
|
-
|
|
1195
|
-
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
Using --source-env
|
|
1200
|
-
|
|
1201
|
-
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
1202
|
-
|
|
1203
|
-
|
|
1204
|
-
|
|
1205
|
-
Using --stack-api-key
|
|
1206
|
-
|
|
1207
|
-
$ csdx cm:entries:publish -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
1208
|
-
|
|
1209
|
-
|
|
1210
|
-
|
|
1211
|
-
Using --include-variants
|
|
1212
|
-
|
|
1213
|
-
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] [--include-variants]
|
|
1214
|
-
|
|
1215
|
-
|
|
1216
|
-
|
|
1217
|
-
Using --entry-uid and --include-variants
|
|
1218
|
-
|
|
1219
|
-
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] --entry-uid [ENTRY UID] [--include-variants]
|
|
1220
|
-
```
|
|
1221
|
-
|
|
1222
|
-
## `csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
1223
|
-
|
|
1224
|
-
Publish edited entries from a specified content type to the given locales and environments
|
|
1225
|
-
|
|
1226
|
-
```
|
|
1227
|
-
USAGE
|
|
1228
|
-
$ csdx cm:bulk-publish:entry-edits cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
|
|
1229
|
-
[--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
|
|
1230
|
-
<value>]
|
|
1231
|
-
|
|
1232
|
-
FLAGS
|
|
1233
|
-
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1234
|
-
operation. If you don't mention the branch name, then by default the entries from main
|
|
1235
|
-
branch will be published.
|
|
1236
|
-
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1237
|
-
--stack-api-key flag.
|
|
1238
|
-
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
1239
|
-
for a single run. Refer to the configure command to create a configuration file.
|
|
1240
|
-
-e, --environments=<value>... The name of the environment(s) on which the entries will be published. In case of
|
|
1241
|
-
multiple environments, specify their names separated by spaces.
|
|
1242
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1243
|
-
--alias flag.
|
|
1244
|
-
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
|
|
1245
|
-
locales, specify the codes separated by spaces.
|
|
1246
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
1247
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1248
|
-
--bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
|
|
1249
|
-
default.
|
|
1250
|
-
--content-types=<value>... The UID of the content type(s) whose edited entries you want to publish in bulk. In
|
|
1251
|
-
case of multiple content types, specify the IDs separated by spaces.
|
|
1252
|
-
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/assets from the
|
|
1253
|
-
logfile. Specify the name of the logfile that lists failed publish calls. If this
|
|
1254
|
-
option is used, it will override all other flags
|
|
1255
|
-
--source-env=<value> The name of the source environment where the entries were initially published.
|
|
1256
|
-
|
|
1257
|
-
DESCRIPTION
|
|
1258
|
-
Publish edited entries from a specified content type to the given locales and environments
|
|
1259
|
-
The publish-modified command is used to publish entries from the specified content types, to the
|
|
1260
|
-
specified environments and locales
|
|
1261
|
-
|
|
1262
|
-
Note: Content type(s), Source Environment, Destination Environment(s) and Locale(s) are required to execute the
|
|
1263
|
-
command successfully
|
|
1264
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
1265
|
-
|
|
1266
|
-
|
|
1267
|
-
ALIASES
|
|
1268
|
-
$ csdx cm:bulk-publish:entry-edits
|
|
1269
|
-
|
|
1270
|
-
EXAMPLES
|
|
1271
|
-
General Usage
|
|
1272
|
-
|
|
1273
|
-
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
1274
|
-
|
|
1275
|
-
|
|
1276
|
-
|
|
1277
|
-
Using --config or -c flag
|
|
1278
|
-
|
|
1279
|
-
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
1280
|
-
|
|
1281
|
-
$ csdx cm:entries:publish-modified --config [PATH TO CONFIG FILE]
|
|
1282
|
-
|
|
1283
|
-
$ csdx cm:entries:publish-modified -c [PATH TO CONFIG FILE]
|
|
1284
|
-
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
Using --retry-failed
|
|
1288
|
-
|
|
1289
|
-
$ csdx cm:entries:publish-modified --retry-failed [LOG FILE NAME]
|
|
1290
|
-
|
|
1291
|
-
$ csdx cm:entries:publish-modified -r [LOG FILE NAME]
|
|
1292
|
-
|
|
1293
|
-
|
|
1294
|
-
|
|
1295
|
-
Using --branch
|
|
1296
|
-
|
|
1297
|
-
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
1298
|
-
|
|
1299
|
-
|
|
1300
|
-
|
|
1301
|
-
Using --stack-api-key
|
|
1302
|
-
|
|
1303
|
-
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -stack-api-key [STACK API KEY]
|
|
1304
|
-
```
|
|
1305
|
-
|
|
1306
|
-
## `csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
1307
|
-
|
|
1308
|
-
Publish non-localized fields for the given content types, from a particular source environment to the specified environments
|
|
1309
|
-
|
|
1310
|
-
```
|
|
1311
|
-
USAGE
|
|
1312
|
-
$ csdx cm:bulk-publish:nonlocalized-field-changes cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>]
|
|
1313
|
-
[--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch
|
|
1314
|
-
<value>]
|
|
1315
|
-
|
|
1316
|
-
FLAGS
|
|
1317
|
-
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1318
|
-
operation. If you don’t mention the branch name, then by default the content from the
|
|
1319
|
-
main branch will be published.
|
|
1320
|
-
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1321
|
-
--stack-api-key flag.
|
|
1322
|
-
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
1323
|
-
for a single run. Refer to the configure command to create a configuration file.
|
|
1324
|
-
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
1325
|
-
environments, specify their names separated by spaces.
|
|
1326
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1327
|
-
--alias flag.
|
|
1328
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
1329
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1330
|
-
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
1331
|
-
default.
|
|
1332
|
-
--content-types=<value>... The UID of the content type whose entries you want to publish in bulk. In case of
|
|
1333
|
-
multiple content types, specify their IDs separated by spaces.
|
|
1334
|
-
--retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
|
|
1335
|
-
name of the logfile that lists failed publish calls. If this option is used, it will
|
|
1336
|
-
override all other flags.
|
|
1337
|
-
--source-env=<value> The name of the source environment.
|
|
1338
|
-
|
|
1339
|
-
DESCRIPTION
|
|
1340
|
-
Publish non-localized fields for the given content types, from a particular source environment to the specified
|
|
1341
|
-
environments
|
|
1342
|
-
The non-localized field changes command is used to publish non-localized field changes from the given content types to
|
|
1343
|
-
the specified environments
|
|
1344
|
-
|
|
1345
|
-
Note: Content types, Environments and Source Environment are required to execute this command successfully.
|
|
1346
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
1347
|
-
|
|
1348
|
-
ALIASES
|
|
1349
|
-
$ csdx cm:bulk-publish:nonlocalized-field-changes
|
|
1350
|
-
|
|
1351
|
-
EXAMPLES
|
|
1352
|
-
General Usage
|
|
1353
|
-
|
|
1354
|
-
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV]
|
|
1355
|
-
|
|
1356
|
-
|
|
1357
|
-
|
|
1358
|
-
Using --config or -c flag
|
|
1359
|
-
|
|
1360
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
1361
|
-
|
|
1362
|
-
$ csdx cm:entries:publish-non-localized-fields --config [PATH TO CONFIG FILE]
|
|
1363
|
-
|
|
1364
|
-
$ csdx cm:entries:publish-non-localized-fields -c [PATH TO CONFIG FILE]
|
|
1365
|
-
|
|
1366
|
-
|
|
1367
|
-
|
|
1368
|
-
Using --retry-failed flag
|
|
1369
|
-
|
|
1370
|
-
$ csdx cm:entries:publish-non-localized-fields --retry-failed [LOG FILE NAME]
|
|
1371
|
-
|
|
1372
|
-
|
|
1373
|
-
|
|
1374
|
-
Using --branch flag
|
|
1375
|
-
|
|
1376
|
-
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV] --branch [BRANCH NAME]
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
Using --stack-api-key flag
|
|
1381
|
-
|
|
1382
|
-
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENV]
|
|
1383
|
-
```
|
|
1384
|
-
|
|
1385
|
-
## `csdx cm:bulk-publish:revert`
|
|
1386
|
-
|
|
1387
|
-
Revert publish operations by using a log file
|
|
1388
|
-
|
|
1389
|
-
```
|
|
1390
|
-
USAGE
|
|
1391
|
-
$ csdx cm:bulk-publish:revert [--retry-failed <value>] [--log-file <value>]
|
|
1392
|
-
|
|
1393
|
-
FLAGS
|
|
1394
|
-
--log-file=<value> Path of the success logfile of a particular publish action.
|
|
1395
|
-
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. Specify
|
|
1396
|
-
the name of the logfile that lists failed publish calls. If this option is used, it will
|
|
1397
|
-
override all other flags.
|
|
1398
|
-
|
|
1399
|
-
DESCRIPTION
|
|
1400
|
-
Revert publish operations by using a log file
|
|
1401
|
-
The revert command is used to revert all publish operations performed using bulk-publish script.
|
|
1402
|
-
A log file name is required to execute revert command
|
|
1403
|
-
|
|
1404
|
-
|
|
1405
|
-
ALIASES
|
|
1406
|
-
$ csdx cm:bulk-publish:revert
|
|
1407
|
-
|
|
1408
|
-
EXAMPLES
|
|
1409
|
-
Using --log-file
|
|
1410
|
-
|
|
1411
|
-
cm:bulk-publish:revert --log-file [LOG FILE NAME]
|
|
1412
|
-
|
|
1413
|
-
|
|
1414
|
-
|
|
1415
|
-
Using --retry-failed
|
|
1416
|
-
|
|
1417
|
-
cm:bulk-publish:revert --retry-failed [LOG FILE NAME]
|
|
1418
|
-
```
|
|
1419
|
-
|
|
1420
|
-
## `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]`
|
|
1421
|
-
|
|
1422
|
-
Unpublish entries or assets of given content types from the specified environment
|
|
1423
|
-
|
|
1424
|
-
```
|
|
1425
|
-
USAGE
|
|
1426
|
-
$ csdx cm:bulk-publish:unpublish csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>]
|
|
1427
|
-
[--branch <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token
|
|
1428
|
-
<value>] [--only-assets] [--only-entries]
|
|
1429
|
-
|
|
1430
|
-
FLAGS
|
|
1431
|
-
-B, --branch=<value> [default: main] Specify the branch to fetch the content from (default is main branch)
|
|
1432
|
-
-a, --alias=<value> Alias(name) for the management token
|
|
1433
|
-
-c, --config=<value> Path to the config file
|
|
1434
|
-
-e, --environment=<value> Source Environment
|
|
1435
|
-
-k, --stack-api-key=<value> Stack API key to be used
|
|
1436
|
-
-l, --locale=<value> Locale filter
|
|
1437
|
-
-y, --yes Agree to process the command with the current configuration
|
|
1438
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1439
|
-
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
1440
|
-
bulkpublish API will be used to unpublish the entries and assets
|
|
1441
|
-
--content-type=<value> Content type filter
|
|
1442
|
-
--delivery-token=<value> The delivery token of the source environment.
|
|
1443
|
-
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
1444
|
-
|
|
1445
|
-
DESCRIPTION
|
|
1446
|
-
Unpublish entries or assets of given content types from the specified environment
|
|
1447
|
-
The unpublish command is used to unpublish entries or assets from given environment
|
|
1448
|
-
|
|
1449
|
-
Environment (Source Environment) and Locale are required to execute the command successfully
|
|
1450
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
1451
|
-
|
|
1452
|
-
A content type can be specified for unpublishing entries, but if no content-type(s) is/are specified and --only-assets
|
|
1453
|
-
is not used,
|
|
1454
|
-
then all entries from all content types will be unpublished from the source environment
|
|
1455
|
-
|
|
1456
|
-
Note: --only-assets can be used to unpublish only assets and --only-entries can be used to unpublish only entries.
|
|
1457
|
-
(--only-assets and --only-entries cannot be used together at the same time)
|
|
1458
|
-
|
|
1459
|
-
|
|
1460
|
-
ALIASES
|
|
1461
|
-
$ csdx cm:bulk-publish:unpublish
|
|
1462
|
-
|
|
1463
|
-
EXAMPLES
|
|
1464
|
-
General Usage
|
|
1465
|
-
|
|
1466
|
-
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] ----delivery-token [DELIVERY TOKEN]
|
|
1467
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
Using --config or -c flag
|
|
1471
|
-
|
|
1472
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
|
|
1473
|
-
|
|
1474
|
-
$ csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]
|
|
1475
|
-
|
|
1476
|
-
$ csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]
|
|
1477
|
-
|
|
1478
|
-
|
|
1479
|
-
|
|
1480
|
-
Using --retry-failed flag
|
|
1481
|
-
|
|
1482
|
-
$ csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]
|
|
1483
|
-
|
|
1484
|
-
|
|
1485
|
-
|
|
1486
|
-
No content type
|
|
1487
|
-
|
|
1488
|
-
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all content types and assets from the source environment)
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
Using --only-assets
|
|
1493
|
-
|
|
1494
|
-
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-assets (Will unpublish only assets from the source environment)
|
|
1495
|
-
|
|
1496
|
-
|
|
1497
|
-
|
|
1498
|
-
Using --only-entries
|
|
1499
|
-
|
|
1500
|
-
$ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, all entries, from the source environment)
|
|
1501
|
-
|
|
1502
|
-
$ csdx cm:stacks:unpublish --contentType [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, (from CONTENT TYPE) from the source environment)
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
|
|
1506
|
-
Using --branch flag
|
|
1507
|
-
|
|
1508
|
-
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
1509
|
-
|
|
1510
|
-
|
|
1511
|
-
|
|
1512
|
-
Using --stack-api-key flag
|
|
1513
|
-
|
|
1514
|
-
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
|
|
1515
|
-
```
|
|
1516
|
-
|
|
1517
|
-
## `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>]`
|
|
1518
|
-
|
|
1519
|
-
Publish unpublished entries from the source environment, to other environments and locales
|
|
1520
|
-
|
|
1521
|
-
```
|
|
1522
|
-
USAGE
|
|
1523
|
-
$ csdx cm:bulk-publish:unpublished-entries cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish
|
|
1524
|
-
<value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y]
|
|
1525
|
-
[--branch <value>]
|
|
1526
|
-
|
|
1527
|
-
FLAGS
|
|
1528
|
-
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1529
|
-
operation. If you don't mention the branch name, then by default the entries from main
|
|
1530
|
-
branch will be published.
|
|
1531
|
-
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1532
|
-
--stack-api-key flag.
|
|
1533
|
-
-b, --bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
|
|
1534
|
-
default.
|
|
1535
|
-
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the
|
|
1536
|
-
options for a single run. Refer to the configure command to create a configuration
|
|
1537
|
-
file.
|
|
1538
|
-
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
1539
|
-
environments, specify their names separated by spaces.
|
|
1540
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1541
|
-
--alias flag.
|
|
1542
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
1543
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]..
|
|
1544
|
-
--content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
|
|
1545
|
-
multiple content types, specify their IDs separated by spaces.
|
|
1546
|
-
--locales=<value> Locale in which entries will be published, e.g., en-us
|
|
1547
|
-
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. It
|
|
1548
|
-
is optional. Specify the name of the logfile that lists failed publish calls. If this
|
|
1549
|
-
option is used, it will override all other flags.
|
|
1550
|
-
--source-env=<value> The name of the source environment where the entries were initially published.
|
|
1551
|
-
|
|
1552
|
-
DESCRIPTION
|
|
1553
|
-
Publish unpublished entries from the source environment, to other environments and locales
|
|
1554
|
-
The publish-only-unpublished command is used to publish unpublished entries from the source environment, to other
|
|
1555
|
-
environments and locales
|
|
1556
|
-
|
|
1557
|
-
Note: Content type(s), Source Environment, Destination Environment(s) and Source Locale are required to execute the
|
|
1558
|
-
command successfully
|
|
1559
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
1560
|
-
|
|
1561
|
-
|
|
1562
|
-
ALIASES
|
|
1563
|
-
$ csdx cm:bulk-publish:unpublished-entries
|
|
1564
|
-
|
|
1565
|
-
EXAMPLES
|
|
1566
|
-
General Usage
|
|
1567
|
-
|
|
1568
|
-
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] -source-env [SOURCE ENV]
|
|
1569
|
-
|
|
1570
|
-
|
|
1571
|
-
|
|
1572
|
-
Using --config or -c flag
|
|
1573
|
-
|
|
1574
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
1575
|
-
|
|
1576
|
-
$ csdx cm:entries:publish-only-unpublished --config [PATH TO CONFIG FILE]
|
|
1577
|
-
|
|
1578
|
-
$ csdx cm:entries:publish-only-unpublished -c [PATH TO CONFIG FILE]
|
|
1579
|
-
|
|
1580
|
-
|
|
1581
|
-
|
|
1582
|
-
Using --retry-failed
|
|
1583
|
-
|
|
1584
|
-
$ csdx cm:entries:publish-only-unpublished --retry-failed [LOG FILE NAME]
|
|
1585
|
-
|
|
1586
|
-
|
|
1587
|
-
|
|
1588
|
-
Using --branch
|
|
1589
|
-
|
|
1590
|
-
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME] -source-env [SOURCE ENV]
|
|
1591
|
-
|
|
1592
|
-
|
|
1593
|
-
|
|
1594
|
-
Using --stack-api-key
|
|
1595
|
-
|
|
1596
|
-
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --stack-api-key [STACK API KEY] -source-env [SOURCE ENV]
|
|
1597
|
-
```
|
|
1598
|
-
|
|
1599
|
-
## `csdx cm:entries:migrate-html-rte`
|
|
1600
|
-
|
|
1601
|
-
Migration script to migrate content from HTML RTE to JSON RTE
|
|
1602
|
-
|
|
1603
|
-
```
|
|
1604
|
-
USAGE
|
|
1605
|
-
$ csdx cm:entries:migrate-html-rte [-c <value>] [-a <value>] [--stack-api-key <value>] [--content-type <value>]
|
|
1606
|
-
[--global-field] [-y] [--branch <value>] [--html-path <value> --json-path <value>] [--delay <value>] [--locale
|
|
1607
|
-
<value>] [--batch-limit <value>]
|
|
1608
|
-
|
|
1609
|
-
FLAGS
|
|
1610
|
-
-a, --alias=<value> Enter the alias name. You must use either the --alias flag or the --stack-api-key flag.
|
|
1611
|
-
-c, --config-path=<value> Specify the path where your config file is located.
|
|
1612
|
-
-y, --yes Avoids reconfirmation of your configuration.
|
|
1613
|
-
--batch-limit=<value> [default: 50] Provide batch limit for updating entries (default: 50).
|
|
1614
|
-
--branch=<value> The name of the branch to be used.
|
|
1615
|
-
--content-type=<value> Specify the UID of the content type for which you want to migrate HTML RTE content.
|
|
1616
|
-
--delay=<value> [default: 1000] To set the interval time between the migration of HTML RTE to JSON RTE in
|
|
1617
|
-
subsequent entries of a content type. The default value is 1,000 milliseconds.
|
|
1618
|
-
--global-field Checks whether the specified UID belongs to a content type or a global field. This flag
|
|
1619
|
-
is set to false by default.
|
|
1620
|
-
--html-path=<value> Enter the path to the HTML RTE whose content you want to migrate.
|
|
1621
|
-
--json-path=<value> Enter the path to the JSON RTE to which you want to migrate the HTML RTE content.
|
|
1622
|
-
--locale=<value> The locale from which entries will be migrated.
|
|
1623
|
-
--stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
|
|
1624
|
-
flag.
|
|
1625
|
-
|
|
1626
|
-
DESCRIPTION
|
|
1627
|
-
Migration script to migrate content from HTML RTE to JSON RTE
|
|
1628
|
-
|
|
1629
|
-
ALIASES
|
|
1630
|
-
$ csdx cm:migrate-rte
|
|
1631
|
-
|
|
1632
|
-
EXAMPLES
|
|
1633
|
-
General Usage
|
|
1634
|
-
|
|
1635
|
-
$ csdx cm:entries:migrate-html-rte --config-path path/to/config.json
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1639
|
-
Using Flags
|
|
1640
|
-
|
|
1641
|
-
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path html-path --json-path json-path
|
|
1642
|
-
|
|
1643
|
-
|
|
1644
|
-
|
|
1645
|
-
Nested RTE
|
|
1646
|
-
|
|
1647
|
-
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path modular_block_uid.block_uid.html_rte_uid --json-path modular_block_uid.block_uid.json_rte_uid
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path group_uid.html_rte_uid --json-path group_uid.json_rte_uid
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
Global Field
|
|
1656
|
-
|
|
1657
|
-
$ csdx cm:entries:migrate-html-rte --alias alias --content-type global_field_uid --global-field --html-path html-path --json-path json-path
|
|
1658
|
-
```
|
|
1659
|
-
|
|
1660
|
-
_See code: [@contentstack/cli-cm-migrate-rte](https://github.com/contentstack/cli/blob/main/packages/contentstack-migrate-rte/src/commands/cm/entries/migrate-html-rte.js)_
|
|
1661
|
-
|
|
1662
|
-
## `csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>] [--entry-uid <value>] [--include-variants]`
|
|
1663
|
-
|
|
1664
|
-
Publish entries from multiple contenttypes to multiple environments and locales
|
|
1665
|
-
|
|
1666
|
-
```
|
|
1667
|
-
USAGE
|
|
1668
|
-
$ csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types]
|
|
1669
|
-
[--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token
|
|
1670
|
-
<value>] [--source-env <value>] [--entry-uid <value>] [--include-variants]
|
|
1671
|
-
|
|
1672
|
-
FLAGS
|
|
1673
|
-
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1674
|
-
operation. If you don’t mention the branch name, then by default the content from
|
|
1675
|
-
main branch will be published.
|
|
1676
|
-
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1677
|
-
--stack-api-key flag.
|
|
1678
|
-
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the
|
|
1679
|
-
options for a single run. Refer to the configure command to create a configuration
|
|
1680
|
-
file.
|
|
1681
|
-
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
1682
|
-
environments, specify their names separated by spaces.
|
|
1683
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1684
|
-
--alias flag.
|
|
1685
|
-
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
|
|
1686
|
-
locales, specify the codes separated by spaces.
|
|
1687
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
1688
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1689
|
-
--bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. This flag is
|
|
1690
|
-
set to true, by default.
|
|
1691
|
-
--content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
|
|
1692
|
-
multiple content types, specify the IDs separated by spaces.
|
|
1693
|
-
--delivery-token=<value> The delivery token of the source environment.
|
|
1694
|
-
--entry-uid=<value> Entry Uid for publish all associated variant entries.
|
|
1695
|
-
--include-variants Include Variants flag will publish all associated variant entries with base entry.
|
|
1696
|
-
--publish-all-content-types (optional) Set it to true to bulk publish entries from all content types. If the
|
|
1697
|
-
--content-types option is already used, then you cannot use this option.
|
|
1698
|
-
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/ assets from the
|
|
1699
|
-
logfile. Specify the name of the logfile that lists failed publish calls. If this
|
|
1700
|
-
option is used, it will override all other flags.
|
|
1701
|
-
--source-env=<value> Source environment
|
|
1702
|
-
|
|
1703
|
-
DESCRIPTION
|
|
1704
|
-
Publish entries from multiple contenttypes to multiple environments and locales
|
|
1705
|
-
The publish command is used to publish entries from the specified content types, to the
|
|
1706
|
-
specified environments and locales
|
|
1707
|
-
|
|
1708
|
-
Note: Content Types, Environments and Locales are required to execute the command successfully
|
|
1709
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
ALIASES
|
|
1713
|
-
$ csdx cm:bulk-publish:entries
|
|
1714
|
-
|
|
1715
|
-
EXAMPLES
|
|
1716
|
-
General Usage
|
|
1717
|
-
|
|
1718
|
-
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
Using --config or -c flag
|
|
1723
|
-
|
|
1724
|
-
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
1725
|
-
|
|
1726
|
-
$ csdx cm:entries:publish --config [PATH TO CONFIG FILE]
|
|
1727
|
-
|
|
1728
|
-
$ csdx cm:entries:publish -c [PATH TO CONFIG FILE]
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
|
|
1732
|
-
Using --retry-failed
|
|
1733
|
-
|
|
1734
|
-
$ csdx cm:entries:publish --retry-failed [LOG FILE NAME]
|
|
1735
|
-
|
|
1736
|
-
$ csdx cm:entries:publish -r [LOG FILE NAME]
|
|
1737
|
-
|
|
1738
|
-
|
|
1739
|
-
|
|
1740
|
-
Using --branch
|
|
1741
|
-
|
|
1742
|
-
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
1743
|
-
|
|
1744
|
-
|
|
1745
|
-
|
|
1746
|
-
Using --source-env
|
|
1747
|
-
|
|
1748
|
-
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
1749
|
-
|
|
1750
|
-
|
|
1751
|
-
|
|
1752
|
-
Using --stack-api-key
|
|
1753
|
-
|
|
1754
|
-
$ csdx cm:entries:publish -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
|
|
1755
|
-
|
|
1756
|
-
|
|
1757
|
-
|
|
1758
|
-
Using --include-variants
|
|
1759
|
-
|
|
1760
|
-
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] [--include-variants]
|
|
1761
|
-
|
|
1762
|
-
|
|
1763
|
-
|
|
1764
|
-
Using --entry-uid and --include-variants
|
|
1765
|
-
|
|
1766
|
-
$ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] --entry-uid [ENTRY UID] [--include-variants]
|
|
1767
|
-
```
|
|
1768
|
-
|
|
1769
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js)_
|
|
1770
|
-
|
|
1771
|
-
## `csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
1772
|
-
|
|
1773
|
-
Publish edited entries from a specified content type to the given locales and environments
|
|
1774
|
-
|
|
1775
|
-
```
|
|
1776
|
-
USAGE
|
|
1777
|
-
$ csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>]
|
|
1778
|
-
[--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
1779
|
-
|
|
1780
|
-
FLAGS
|
|
1781
|
-
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1782
|
-
operation. If you don't mention the branch name, then by default the entries from main
|
|
1783
|
-
branch will be published.
|
|
1784
|
-
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1785
|
-
--stack-api-key flag.
|
|
1786
|
-
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
1787
|
-
for a single run. Refer to the configure command to create a configuration file.
|
|
1788
|
-
-e, --environments=<value>... The name of the environment(s) on which the entries will be published. In case of
|
|
1789
|
-
multiple environments, specify their names separated by spaces.
|
|
1790
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1791
|
-
--alias flag.
|
|
1792
|
-
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
|
|
1793
|
-
locales, specify the codes separated by spaces.
|
|
1794
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
1795
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1796
|
-
--bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
|
|
1797
|
-
default.
|
|
1798
|
-
--content-types=<value>... The UID of the content type(s) whose edited entries you want to publish in bulk. In
|
|
1799
|
-
case of multiple content types, specify the IDs separated by spaces.
|
|
1800
|
-
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/assets from the
|
|
1801
|
-
logfile. Specify the name of the logfile that lists failed publish calls. If this
|
|
1802
|
-
option is used, it will override all other flags
|
|
1803
|
-
--source-env=<value> The name of the source environment where the entries were initially published.
|
|
1804
|
-
|
|
1805
|
-
DESCRIPTION
|
|
1806
|
-
Publish edited entries from a specified content type to the given locales and environments
|
|
1807
|
-
The publish-modified command is used to publish entries from the specified content types, to the
|
|
1808
|
-
specified environments and locales
|
|
1809
|
-
|
|
1810
|
-
Note: Content type(s), Source Environment, Destination Environment(s) and Locale(s) are required to execute the
|
|
1811
|
-
command successfully
|
|
1812
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
1813
|
-
|
|
1814
|
-
|
|
1815
|
-
ALIASES
|
|
1816
|
-
$ csdx cm:bulk-publish:entry-edits
|
|
1817
|
-
|
|
1818
|
-
EXAMPLES
|
|
1819
|
-
General Usage
|
|
1820
|
-
|
|
1821
|
-
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
1822
|
-
|
|
1823
|
-
|
|
1824
|
-
|
|
1825
|
-
Using --config or -c flag
|
|
1826
|
-
|
|
1827
|
-
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
1828
|
-
|
|
1829
|
-
$ csdx cm:entries:publish-modified --config [PATH TO CONFIG FILE]
|
|
1830
|
-
|
|
1831
|
-
$ csdx cm:entries:publish-modified -c [PATH TO CONFIG FILE]
|
|
1832
|
-
|
|
1833
|
-
|
|
1834
|
-
|
|
1835
|
-
Using --retry-failed
|
|
1836
|
-
|
|
1837
|
-
$ csdx cm:entries:publish-modified --retry-failed [LOG FILE NAME]
|
|
1838
|
-
|
|
1839
|
-
$ csdx cm:entries:publish-modified -r [LOG FILE NAME]
|
|
1840
|
-
|
|
1841
|
-
|
|
1842
|
-
|
|
1843
|
-
Using --branch
|
|
1844
|
-
|
|
1845
|
-
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
1846
|
-
|
|
1847
|
-
|
|
1848
|
-
|
|
1849
|
-
Using --stack-api-key
|
|
1850
|
-
|
|
1851
|
-
$ csdx cm:entries:publish-modified --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --source-env [SOURCE_ENV] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -stack-api-key [STACK API KEY]
|
|
1852
|
-
```
|
|
1853
|
-
|
|
1854
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-modified.js)_
|
|
1855
|
-
|
|
1856
|
-
## `csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`
|
|
1857
|
-
|
|
1858
|
-
Publish non-localized fields for the given content types, from a particular source environment to the specified environments
|
|
1859
|
-
|
|
1860
|
-
```
|
|
1861
|
-
USAGE
|
|
1862
|
-
$ csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>]
|
|
1863
|
-
[--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
1864
|
-
|
|
1865
|
-
FLAGS
|
|
1866
|
-
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1867
|
-
operation. If you don’t mention the branch name, then by default the content from the
|
|
1868
|
-
main branch will be published.
|
|
1869
|
-
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1870
|
-
--stack-api-key flag.
|
|
1871
|
-
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
1872
|
-
for a single run. Refer to the configure command to create a configuration file.
|
|
1873
|
-
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
1874
|
-
environments, specify their names separated by spaces.
|
|
1875
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1876
|
-
--alias flag.
|
|
1877
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
1878
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1879
|
-
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
1880
|
-
default.
|
|
1881
|
-
--content-types=<value>... The UID of the content type whose entries you want to publish in bulk. In case of
|
|
1882
|
-
multiple content types, specify their IDs separated by spaces.
|
|
1883
|
-
--retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
|
|
1884
|
-
name of the logfile that lists failed publish calls. If this option is used, it will
|
|
1885
|
-
override all other flags.
|
|
1886
|
-
--source-env=<value> The name of the source environment.
|
|
1887
|
-
|
|
1888
|
-
DESCRIPTION
|
|
1889
|
-
Publish non-localized fields for the given content types, from a particular source environment to the specified
|
|
1890
|
-
environments
|
|
1891
|
-
The non-localized field changes command is used to publish non-localized field changes from the given content types to
|
|
1892
|
-
the specified environments
|
|
1893
|
-
|
|
1894
|
-
Note: Content types, Environments and Source Environment are required to execute this command successfully.
|
|
1895
|
-
But, if retryFailed flag is set, then only a logfile is required
|
|
1896
|
-
|
|
1897
|
-
ALIASES
|
|
1898
|
-
$ csdx cm:bulk-publish:nonlocalized-field-changes
|
|
1899
|
-
|
|
1900
|
-
EXAMPLES
|
|
1901
|
-
General Usage
|
|
1902
|
-
|
|
1903
|
-
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV]
|
|
1904
|
-
|
|
1905
|
-
|
|
1906
|
-
|
|
1907
|
-
Using --config or -c flag
|
|
1908
|
-
|
|
1909
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
1910
|
-
|
|
1911
|
-
$ csdx cm:entries:publish-non-localized-fields --config [PATH TO CONFIG FILE]
|
|
1912
|
-
|
|
1913
|
-
$ csdx cm:entries:publish-non-localized-fields -c [PATH TO CONFIG FILE]
|
|
1914
|
-
|
|
1915
|
-
|
|
1916
|
-
|
|
1917
|
-
Using --retry-failed flag
|
|
1918
|
-
|
|
1919
|
-
$ csdx cm:entries:publish-non-localized-fields --retry-failed [LOG FILE NAME]
|
|
1920
|
-
|
|
1921
|
-
|
|
1922
|
-
|
|
1923
|
-
Using --branch flag
|
|
1924
|
-
|
|
1925
|
-
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENV] --branch [BRANCH NAME]
|
|
1926
|
-
|
|
1927
|
-
|
|
1928
|
-
|
|
1929
|
-
Using --stack-api-key flag
|
|
1930
|
-
|
|
1931
|
-
$ csdx cm:entries:publish-non-localized-fields --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENV]
|
|
1932
|
-
```
|
|
1933
|
-
|
|
1934
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-non-localized-fields.js)_
|
|
1935
|
-
|
|
1936
|
-
## `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>]`
|
|
1937
|
-
|
|
1938
|
-
Publish unpublished entries from the source environment, to other environments and locales
|
|
1939
|
-
|
|
1940
|
-
```
|
|
1941
|
-
USAGE
|
|
1942
|
-
$ csdx cm:entries:publish-only-unpublished [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>]
|
|
1943
|
-
[--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
|
|
1944
|
-
|
|
1945
|
-
FLAGS
|
|
1946
|
-
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
1947
|
-
operation. If you don't mention the branch name, then by default the entries from main
|
|
1948
|
-
branch will be published.
|
|
1949
|
-
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
1950
|
-
--stack-api-key flag.
|
|
1951
|
-
-b, --bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
|
|
1952
|
-
default.
|
|
1953
|
-
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the
|
|
1954
|
-
options for a single run. Refer to the configure command to create a configuration
|
|
1955
|
-
file.
|
|
1956
|
-
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
1957
|
-
environments, specify their names separated by spaces.
|
|
1958
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
1959
|
-
--alias flag.
|
|
1960
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
1961
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]..
|
|
1962
|
-
--content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
|
|
1963
|
-
multiple content types, specify their IDs separated by spaces.
|
|
1964
|
-
--locales=<value> Locale in which entries will be published, e.g., en-us
|
|
1965
|
-
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. It
|
|
1966
|
-
is optional. Specify the name of the logfile that lists failed publish calls. If this
|
|
1967
|
-
option is used, it will override all other flags.
|
|
1968
|
-
--source-env=<value> The name of the source environment where the entries were initially published.
|
|
1969
|
-
|
|
1970
|
-
DESCRIPTION
|
|
1971
|
-
Publish unpublished entries from the source environment, to other environments and locales
|
|
1972
|
-
The publish-only-unpublished command is used to publish unpublished entries from the source environment, to other
|
|
1973
|
-
environments and locales
|
|
1974
|
-
|
|
1975
|
-
Note: Content type(s), Source Environment, Destination Environment(s) and Source Locale are required to execute the
|
|
1976
|
-
command successfully
|
|
1977
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
1978
|
-
|
|
1979
|
-
|
|
1980
|
-
ALIASES
|
|
1981
|
-
$ csdx cm:bulk-publish:unpublished-entries
|
|
1982
|
-
|
|
1983
|
-
EXAMPLES
|
|
1984
|
-
General Usage
|
|
1985
|
-
|
|
1986
|
-
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] -source-env [SOURCE ENV]
|
|
1987
|
-
|
|
1988
|
-
|
|
1989
|
-
|
|
1990
|
-
Using --config or -c flag
|
|
1991
|
-
|
|
1992
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`
|
|
1993
|
-
|
|
1994
|
-
$ csdx cm:entries:publish-only-unpublished --config [PATH TO CONFIG FILE]
|
|
1995
|
-
|
|
1996
|
-
$ csdx cm:entries:publish-only-unpublished -c [PATH TO CONFIG FILE]
|
|
1997
|
-
|
|
1998
|
-
|
|
1999
|
-
|
|
2000
|
-
Using --retry-failed
|
|
2001
|
-
|
|
2002
|
-
$ csdx cm:entries:publish-only-unpublished --retry-failed [LOG FILE NAME]
|
|
2003
|
-
|
|
2004
|
-
|
|
2005
|
-
|
|
2006
|
-
Using --branch
|
|
2007
|
-
|
|
2008
|
-
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME] -source-env [SOURCE ENV]
|
|
2009
|
-
|
|
2010
|
-
|
|
2011
|
-
|
|
2012
|
-
Using --stack-api-key
|
|
2013
|
-
|
|
2014
|
-
$ csdx cm:entries:publish-only-unpublished -b --content-types [CONTENT TYPES] -e [ENVIRONMENTS] --locales LOCALE -a [MANAGEMENT TOKEN ALIAS] --stack-api-key [STACK API KEY] -source-env [SOURCE ENV]
|
|
2015
|
-
```
|
|
2016
|
-
|
|
2017
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-only-unpublished.js)_
|
|
2018
|
-
|
|
2019
|
-
## `csdx cm:entries:unpublish`
|
|
2020
|
-
|
|
2021
|
-
Unpublish entries from the given environment
|
|
2022
|
-
|
|
2023
|
-
```
|
|
2024
|
-
USAGE
|
|
2025
|
-
$ csdx cm:entries:unpublish [-a <value>] [-k <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch
|
|
2026
|
-
<value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--content-type <value>]
|
|
2027
|
-
[--delivery-token <value>] [--include-variants]
|
|
2028
|
-
|
|
2029
|
-
FLAGS
|
|
2030
|
-
-a, --alias=<value> Alias (name) for the management token. You must use either the --alias flag or the
|
|
2031
|
-
--stack-api-key flag.
|
|
2032
|
-
-c, --config=<value> (optional) Path to the configuration JSON file containing all options for a single run.
|
|
2033
|
-
Refer to the configure command to create a configuration file.
|
|
2034
|
-
-e, --environment=<value> The name of the environment from where entries/assets need to be unpublished.
|
|
2035
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
|
|
2036
|
-
flag.
|
|
2037
|
-
-y, --yes Set to true to process the command with the current configuration.
|
|
2038
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
2039
|
-
--branch=<value> [default: main] Specify the branch to fetch the content. If not mentioned, the main
|
|
2040
|
-
branch will be used by default.
|
|
2041
|
-
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that Contentstack's
|
|
2042
|
-
Bulk Publish APIs will be used to unpublish the entries.
|
|
2043
|
-
--content-type=<value> The UID of the content type whose entries you want to unpublish in bulk.
|
|
2044
|
-
--delivery-token=<value> The delivery token of the source environment.
|
|
2045
|
-
--include-variants Include Variants flag will unpublish all associated variant entries.
|
|
2046
|
-
--locale=<value> Locale from which entries/assets will be unpublished, e.g., en-us.
|
|
2047
|
-
--retry-failed=<value> (optional) Use this option to retry unpublishing the failed entries from the logfile.
|
|
2048
|
-
Specify the name of the logfile that lists failed unpublish calls. If used, this option
|
|
2049
|
-
will override all other flags.
|
|
2050
|
-
|
|
2051
|
-
DESCRIPTION
|
|
2052
|
-
Unpublish entries from the given environment
|
|
2053
|
-
The unpublish command is used to unpublish entries from the given environment
|
|
2054
|
-
|
|
2055
|
-
Note: Environment (Source Environment) and Locale are required to execute the command successfully
|
|
2056
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
2057
|
-
|
|
2058
|
-
EXAMPLES
|
|
2059
|
-
General Usage
|
|
2060
|
-
|
|
2061
|
-
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN]
|
|
2062
|
-
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
Using --config or -c flag
|
|
2066
|
-
|
|
2067
|
-
Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
|
|
2068
|
-
|
|
2069
|
-
$ csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]
|
|
2070
|
-
|
|
2071
|
-
$ csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]
|
|
2072
|
-
|
|
2073
|
-
|
|
2074
|
-
|
|
2075
|
-
Using --retry-failed flag
|
|
2076
|
-
|
|
2077
|
-
$ csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]
|
|
2078
|
-
|
|
2079
|
-
|
|
2080
|
-
|
|
2081
|
-
Using --branch flag
|
|
2082
|
-
|
|
2083
|
-
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --delivery-token [DELIVERY TOKEN] --branch [BRANCH NAME]
|
|
2084
|
-
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
Using --stack-api-key flag
|
|
2088
|
-
|
|
2089
|
-
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
|
|
2090
|
-
|
|
2091
|
-
|
|
2092
|
-
|
|
2093
|
-
Using --include-variants flag
|
|
2094
|
-
|
|
2095
|
-
$ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN] --include-variants
|
|
2096
|
-
```
|
|
2097
|
-
|
|
2098
|
-
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/unpublish.js)_
|
|
2099
|
-
|
|
2100
|
-
## `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>]`
|
|
2101
|
-
|
|
2102
|
-
Add fields from updated content types to their respective entries
|
|
2103
|
-
|
|
2104
|
-
```
|
|
2105
|
-
USAGE
|
|
2106
|
-
$ csdx cm:entries:update-and-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-types <value>] [-t
|
|
2107
|
-
<value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
|
|
2108
|
-
|
|
2109
|
-
FLAGS
|
|
2110
|
-
-B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
2111
|
-
operation. If you don’t mention the branch name, then by default the content from the
|
|
2112
|
-
main branch will be published.
|
|
2113
|
-
-a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
|
|
2114
|
-
--stack-api-key flag.
|
|
2115
|
-
-c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
|
|
2116
|
-
for a single run. Refer to the configure command to create a configuration file.
|
|
2117
|
-
-e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
|
|
2118
|
-
environments, specify their names separated by spaces.
|
|
2119
|
-
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
2120
|
-
--alias flag.
|
|
2121
|
-
-l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
|
|
2122
|
-
locales, specify the codes separated by spaces.
|
|
2123
|
-
-t, --contentTypes=<value>... The Contenttypes from which entries will be published.
|
|
2124
|
-
-y, --yes Set it to true to process the command with the current configuration.
|
|
2125
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
2126
|
-
--bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
|
|
2127
|
-
default.
|
|
2128
|
-
--content-types=<value>... The UID of the content type ID whose entries you want to publish in bulk. In case of
|
|
2129
|
-
multiple content types, specify their IDs separated by spaces.
|
|
2130
|
-
--force Update and publish all entries even if no fields have been added.
|
|
2131
|
-
--retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
|
|
2132
|
-
name of the logfile that lists failed publish calls. If this option is used, it will
|
|
2133
|
-
override all other flags.
|
|
2134
|
-
|
|
2135
|
-
DESCRIPTION
|
|
2136
|
-
Add fields from updated content types to their respective entries
|
|
2137
|
-
The update-and-publish command is used to update existing entries with the updated schema of the respective content
|
|
2138
|
-
type
|
|
2139
|
-
|
|
2140
|
-
Note: Content types, Environments and Locales are required to execute the command successfully
|
|
2141
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
2142
|
-
|
|
2143
|
-
|
|
2144
|
-
ALIASES
|
|
2145
|
-
$ csdx cm:bulk-publish:add-fields
|
|
2146
|
-
|
|
2147
|
-
EXAMPLES
|
|
2148
|
-
General Usage
|
|
2149
|
-
|
|
2150
|
-
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS]
|
|
2151
|
-
|
|
2152
|
-
|
|
2153
|
-
|
|
2154
|
-
Using --config or -c flag
|
|
2155
|
-
|
|
2156
|
-
Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
|
|
2157
|
-
|
|
2158
|
-
$ csdx cm:entries:update-and-publish --config [PATH TO CONFIG FILE]
|
|
2159
|
-
|
|
2160
|
-
$ csdx cm:entries:update-and-publish -c [PATH TO CONFIG FILE]
|
|
2161
|
-
|
|
2162
|
-
|
|
2163
|
-
|
|
2164
|
-
Using --retry-failed
|
|
2165
|
-
|
|
2166
|
-
$ csdx cm:entries:update-and-publish --retry-failed [LOG FILE NAME]
|
|
2167
|
-
|
|
2168
|
-
|
|
2169
|
-
|
|
2170
|
-
Using --branch
|
|
2171
|
-
|
|
2172
|
-
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] -a [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
|
|
2173
|
-
|
|
2174
|
-
|
|
2175
|
-
|
|
2176
|
-
Using --stack-api-key
|
|
2177
|
-
|
|
2178
|
-
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY]
|
|
2179
|
-
```
|
|
2180
|
-
|
|
2181
|
-
_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)_
|
|
2182
|
-
|
|
2183
|
-
## `csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
|
|
2184
|
-
|
|
2185
|
-
Export content from a stack
|
|
2186
|
-
|
|
2187
|
-
```
|
|
2188
|
-
USAGE
|
|
2189
|
-
$ csdx cm:export cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>]
|
|
2190
|
-
[--content-types <value>] [--branch <value>] [--secured-assets]
|
|
2191
|
-
|
|
2192
|
-
FLAGS
|
|
2193
|
-
-B, --branch=<value> [optional] The name of the branch where you want to export your content. If you don't
|
|
2194
|
-
mention the branch name, then by default the content will be exported from all the
|
|
2195
|
-
branches of your stack.
|
|
2196
|
-
-a, --alias=<value> The management token alias of the source stack from which you will export content.
|
|
2197
|
-
-c, --config=<value> [optional] Path of the config
|
|
2198
|
-
-d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
|
|
2199
|
-
./content
|
|
2200
|
-
-k, --stack-api-key=<value> API Key of the source stack
|
|
2201
|
-
-m, --module=<value> [optional] Specific module name. If not specified, the export command will export all
|
|
2202
|
-
the modules to the stack. The available modules are assets, content-types, entries,
|
|
2203
|
-
environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
|
|
2204
|
-
workflows, custom-roles, and taxonomies.
|
|
2205
|
-
-t, --content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
|
|
2206
|
-
of multiple content types, specify the IDs separated by spaces.
|
|
2207
|
-
-y, --yes [optional] Force override all Marketplace prompts.
|
|
2208
|
-
--branch-alias=<value> (Optional) The alias of the branch from which you want to export content.
|
|
2209
|
-
--secured-assets [optional] Use this flag for assets that are secured.
|
|
2210
|
-
|
|
2211
|
-
DESCRIPTION
|
|
2212
|
-
Export content from a stack
|
|
2213
|
-
|
|
2214
|
-
ALIASES
|
|
2215
|
-
$ csdx cm:export
|
|
2216
|
-
|
|
2217
|
-
EXAMPLES
|
|
2218
|
-
$ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
2219
|
-
|
|
2220
|
-
$ csdx cm:stacks:export --config <path/to/config/dir>
|
|
2221
|
-
|
|
2222
|
-
$ csdx cm:stacks:export --alias <management_token_alias>
|
|
2223
|
-
|
|
2224
|
-
$ csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>
|
|
2225
|
-
|
|
2226
|
-
$ csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>
|
|
2227
|
-
|
|
2228
|
-
$ csdx cm:stacks:export --module <single module name>
|
|
2229
|
-
|
|
2230
|
-
$ csdx cm:stacks:export --branch [optional] branch name
|
|
2231
|
-
```
|
|
2232
|
-
|
|
2233
|
-
## `csdx cm:export-to-csv`
|
|
2234
|
-
|
|
2235
|
-
Export entries, taxonomies, terms or organization users to csv using this command
|
|
2236
|
-
|
|
2237
|
-
```
|
|
2238
|
-
USAGE
|
|
2239
|
-
$ csdx cm:export-to-csv [--action entries|users|teams|taxonomies] [-a <value>] [--org <value>] [-n <value>] [-k
|
|
2240
|
-
<value>] [--org-name <value>] [--locale <value>] [--content-type <value>] [--branch <value>] [--team-uid <value>]
|
|
2241
|
-
[--taxonomy-uid <value>] [--delimiter <value>]
|
|
2242
|
-
|
|
2243
|
-
FLAGS
|
|
2244
|
-
-a, --alias=<value> Alias of the management token.
|
|
2245
|
-
-k, --stack-api-key=<value> API Key of the source stack.
|
|
2246
|
-
-n, --stack-name=<value> Name of the stack that needs to be created as CSV filename.
|
|
2247
|
-
--action=<option> Option to export data (entries, users, teams, taxonomies). <options:
|
|
2248
|
-
entries|users|teams|taxonomies>
|
|
2249
|
-
<options: entries|users|teams|taxonomies>
|
|
2250
|
-
--branch=<value> Branch from which entries will be exported.
|
|
2251
|
-
--content-type=<value> Content type of entries that will be exported.
|
|
2252
|
-
--delimiter=<value> [default: ,] [optional] Provide a delimiter to separate individual data fields within the
|
|
2253
|
-
CSV file. For example: cm:export-to-csv --delimiter '|'
|
|
2254
|
-
--locale=<value> Locale of entries that will be exported.
|
|
2255
|
-
--org=<value> Provide organization UID to clone org users.
|
|
2256
|
-
--org-name=<value> Name of the organization that needs to be created as CSV filename.
|
|
2257
|
-
--taxonomy-uid=<value> Provide the taxonomy UID of the related terms you want to export.
|
|
2258
|
-
--team-uid=<value> Provide the UID of a specific team in an organization.
|
|
2259
|
-
|
|
2260
|
-
DESCRIPTION
|
|
2261
|
-
Export entries, taxonomies, terms or organization users to csv using this command
|
|
2262
|
-
|
|
2263
|
-
EXAMPLES
|
|
2264
|
-
$ csdx cm:export-to-csv
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
|
|
2268
|
-
Exporting entries to CSV
|
|
2269
|
-
|
|
2270
|
-
$ csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type>
|
|
2271
|
-
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
|
-
Exporting entries to CSV with stack name provided and branch name provided
|
|
2275
|
-
|
|
2276
|
-
$ csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type> --stack-name <stack-name> --branch <branch-name>
|
|
2277
|
-
|
|
2278
|
-
|
|
2279
|
-
|
|
2280
|
-
Exporting organization users to CSV
|
|
2281
|
-
|
|
2282
|
-
$ csdx cm:export-to-csv --action <users> --org <org-uid>
|
|
2283
|
-
|
|
2284
|
-
|
|
2285
|
-
|
|
2286
|
-
Exporting organization users to CSV with organization name provided
|
|
2287
|
-
|
|
2288
|
-
$ csdx cm:export-to-csv --action <users> --org <org-uid> --org-name <org-name>
|
|
2289
|
-
|
|
2290
|
-
|
|
2291
|
-
|
|
2292
|
-
Exporting organization teams to CSV
|
|
2293
|
-
|
|
2294
|
-
$ csdx cm:export-to-csv --action <teams>
|
|
2295
|
-
|
|
2296
|
-
|
|
2297
|
-
|
|
2298
|
-
Exporting organization teams to CSV with org UID
|
|
2299
|
-
|
|
2300
|
-
$ csdx cm:export-to-csv --action <teams> --org <org-uid>
|
|
2301
|
-
|
|
2302
|
-
|
|
2303
|
-
|
|
2304
|
-
Exporting organization teams to CSV with team UID
|
|
2305
|
-
|
|
2306
|
-
$ csdx cm:export-to-csv --action <teams> --team-uid <team-uid>
|
|
2307
|
-
|
|
2308
|
-
|
|
2309
|
-
|
|
2310
|
-
Exporting organization teams to CSV with org UID and team UID
|
|
2311
|
-
|
|
2312
|
-
$ csdx cm:export-to-csv --action <teams> --org <org-uid> --team-uid <team-uid>
|
|
2313
|
-
|
|
2314
|
-
|
|
2315
|
-
|
|
2316
|
-
Exporting organization teams to CSV with org UID and team UID
|
|
2317
|
-
|
|
2318
|
-
$ csdx cm:export-to-csv --action <teams> --org <org-uid> --team-uid <team-uid> --org-name <org-name>
|
|
2319
|
-
|
|
2320
|
-
|
|
2321
|
-
|
|
2322
|
-
Exporting taxonomies and related terms to a .CSV file with the provided taxonomy UID
|
|
2323
|
-
|
|
2324
|
-
$ csdx cm:export-to-csv --action <taxonomies> --alias <management-token-alias> --taxonomy-uid <taxonomy-uid>
|
|
2325
|
-
|
|
2326
|
-
|
|
2327
|
-
|
|
2328
|
-
Exporting taxonomies and respective terms to a .CSV file
|
|
2329
|
-
|
|
2330
|
-
$ csdx cm:export-to-csv --action <taxonomies> --alias <management-token-alias>
|
|
2331
|
-
|
|
2332
|
-
|
|
2333
|
-
|
|
2334
|
-
Exporting taxonomies and respective terms to a .CSV file with a delimiter
|
|
2335
|
-
|
|
2336
|
-
$ csdx cm:export-to-csv --action <taxonomies> --alias <management-token-alias> --delimiter <delimiter>
|
|
2337
|
-
```
|
|
2338
|
-
|
|
2339
|
-
_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)_
|
|
2340
|
-
|
|
2341
|
-
## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
|
|
2342
|
-
|
|
2343
|
-
Import content from a stack
|
|
2344
|
-
|
|
2345
|
-
```
|
|
2346
|
-
USAGE
|
|
2347
|
-
$ csdx cm:import cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>]
|
|
2348
|
-
[--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
|
|
2349
|
-
|
|
2350
|
-
FLAGS
|
|
2351
|
-
-B, --branch=<value> The name of the branch where you want to import your content. If you don't
|
|
2352
|
-
mention the branch name, then by default the content will be imported to the
|
|
2353
|
-
main branch.
|
|
2354
|
-
-a, --alias=<value> The management token of the destination stack where you will import the
|
|
2355
|
-
content.
|
|
2356
|
-
-b, --backup-dir=<value> [optional] Backup directory name when using specific module.
|
|
2357
|
-
-c, --config=<value> [optional] The path of the configuration JSON file containing all the options
|
|
2358
|
-
for a single run.
|
|
2359
|
-
-d, --data-dir=<value> The path or the location in your file system where the content, you intend to
|
|
2360
|
-
import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
|
|
2361
|
-
export folder has branches involved, then the path should point till the
|
|
2362
|
-
particular branch. For example, “-d
|
|
2363
|
-
"C:\Users\Name\Desktop\cli\content\branch_name"
|
|
2364
|
-
-k, --stack-api-key=<value> API Key of the target stack
|
|
2365
|
-
-m, --module=<value> [optional] Specify the module to import into the target stack. If not
|
|
2366
|
-
specified, the import command will import all the modules into the stack. The
|
|
2367
|
-
available modules are assets, content-types, entries, environments,
|
|
2368
|
-
extensions, marketplace-apps, global-fields, labels, locales, webhooks,
|
|
2369
|
-
workflows, custom-roles, personalize projects, and taxonomies.
|
|
2370
|
-
-y, --yes [optional] Force override all Marketplace prompts.
|
|
2371
|
-
--branch-alias=<value> Specify the branch alias where you want to import your content. If not
|
|
2372
|
-
specified, the content is imported into the main branch by default.
|
|
2373
|
-
--exclude-global-modules Excludes the branch-independent module from the import operation.
|
|
2374
|
-
--import-webhook-status=<option> [default: disable] [default: disable] (optional) This webhook state keeps the
|
|
2375
|
-
same state of webhooks as the source stack. <options: disable|current>
|
|
2376
|
-
<options: disable|current>
|
|
2377
|
-
--personalize-project-name=<value> (optional) Provide a unique name for the Personalize project.
|
|
2378
|
-
--replace-existing Replaces the existing module in the target stack.
|
|
2379
|
-
--skip-app-recreation (optional) Skips the recreation of private apps if they already exist.
|
|
2380
|
-
--skip-assets-publish Skips asset publishing during the import process.
|
|
2381
|
-
--skip-audit Skips the audit fix that occurs during an import operation.
|
|
2382
|
-
--skip-entries-publish Skips entry publishing during the import process
|
|
2383
|
-
--skip-existing Skips the module exists warning messages.
|
|
2384
|
-
|
|
2385
|
-
DESCRIPTION
|
|
2386
|
-
Import content from a stack
|
|
2387
|
-
|
|
2388
|
-
ALIASES
|
|
2389
|
-
$ csdx cm:import
|
|
2390
|
-
|
|
2391
|
-
EXAMPLES
|
|
2392
|
-
$ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
2393
|
-
|
|
2394
|
-
$ csdx cm:stacks:import --config <path/of/config/dir>
|
|
2395
|
-
|
|
2396
|
-
$ csdx cm:stacks:import --module <single module name>
|
|
2397
|
-
|
|
2398
|
-
$ csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>
|
|
2399
|
-
|
|
2400
|
-
$ csdx cm:stacks:import --alias <management_token_alias>
|
|
2401
|
-
|
|
2402
|
-
$ csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>
|
|
2403
|
-
|
|
2404
|
-
$ csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
|
|
2405
|
-
|
|
2406
|
-
$ csdx cm:stacks:import --branch <branch name> --yes --skip-audit
|
|
2407
|
-
```
|
|
2408
|
-
|
|
2409
|
-
## `csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]`
|
|
2410
|
-
|
|
2411
|
-
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
2412
|
-
|
|
2413
|
-
```
|
|
2414
|
-
USAGE
|
|
2415
|
-
$ csdx cm:import-setup cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
|
|
2416
|
-
|
|
2417
|
-
FLAGS
|
|
2418
|
-
-B, --branch=<value> The name of the branch where you want to import your content. If you don't mention the
|
|
2419
|
-
branch name, then by default the content will be imported to the main branch.
|
|
2420
|
-
-a, --alias=<value> The management token of the destination stack where you will import the content.
|
|
2421
|
-
-d, --data-dir=<value> The path or the location in your file system where the content, you intend to import, is
|
|
2422
|
-
stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
|
|
2423
|
-
branches involved, then the path should point till the particular branch. For example,
|
|
2424
|
-
“-d "C:\Users\Name\Desktop\cli\content\branch_name"
|
|
2425
|
-
-k, --stack-api-key=<value> API key of the target stack
|
|
2426
|
-
--branch-alias=<value> Specify the branch alias where you want to import your content. If not specified, the
|
|
2427
|
-
content is imported into the main branch by default.
|
|
2428
|
-
--module=<option>... [optional] Specify the modules/module to import into the target stack. currently options
|
|
2429
|
-
are global-fields, content-types, entries
|
|
2430
|
-
<options: global-fields|content-types|entries>
|
|
2431
|
-
|
|
2432
|
-
DESCRIPTION
|
|
2433
|
-
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
2434
|
-
|
|
2435
|
-
ALIASES
|
|
2436
|
-
$ csdx cm:import-setup
|
|
2437
|
-
|
|
2438
|
-
EXAMPLES
|
|
2439
|
-
$ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
|
|
2440
|
-
|
|
2441
|
-
$ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>
|
|
2442
|
-
|
|
2443
|
-
$ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>
|
|
2444
|
-
```
|
|
2445
|
-
|
|
2446
|
-
## `csdx cm:migrate-rte`
|
|
2447
|
-
|
|
2448
|
-
Migration script to migrate content from HTML RTE to JSON RTE
|
|
2449
|
-
|
|
2450
|
-
```
|
|
2451
|
-
USAGE
|
|
2452
|
-
$ csdx cm:migrate-rte [-c <value>] [-a <value>] [--stack-api-key <value>] [--content-type <value>]
|
|
2453
|
-
[--global-field] [-y] [--branch <value>] [--html-path <value> --json-path <value>] [--delay <value>] [--locale
|
|
2454
|
-
<value>] [--batch-limit <value>]
|
|
2455
|
-
|
|
2456
|
-
FLAGS
|
|
2457
|
-
-a, --alias=<value> Enter the alias name. You must use either the --alias flag or the --stack-api-key flag.
|
|
2458
|
-
-c, --config-path=<value> Specify the path where your config file is located.
|
|
2459
|
-
-y, --yes Avoids reconfirmation of your configuration.
|
|
2460
|
-
--batch-limit=<value> [default: 50] Provide batch limit for updating entries (default: 50).
|
|
2461
|
-
--branch=<value> The name of the branch to be used.
|
|
2462
|
-
--content-type=<value> Specify the UID of the content type for which you want to migrate HTML RTE content.
|
|
2463
|
-
--delay=<value> [default: 1000] To set the interval time between the migration of HTML RTE to JSON RTE in
|
|
2464
|
-
subsequent entries of a content type. The default value is 1,000 milliseconds.
|
|
2465
|
-
--global-field Checks whether the specified UID belongs to a content type or a global field. This flag
|
|
2466
|
-
is set to false by default.
|
|
2467
|
-
--html-path=<value> Enter the path to the HTML RTE whose content you want to migrate.
|
|
2468
|
-
--json-path=<value> Enter the path to the JSON RTE to which you want to migrate the HTML RTE content.
|
|
2469
|
-
--locale=<value> The locale from which entries will be migrated.
|
|
2470
|
-
--stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
|
|
2471
|
-
flag.
|
|
2472
|
-
|
|
2473
|
-
DESCRIPTION
|
|
2474
|
-
Migration script to migrate content from HTML RTE to JSON RTE
|
|
2475
|
-
|
|
2476
|
-
ALIASES
|
|
2477
|
-
$ csdx cm:migrate-rte
|
|
2478
|
-
|
|
2479
|
-
EXAMPLES
|
|
2480
|
-
General Usage
|
|
2481
|
-
|
|
2482
|
-
$ csdx cm:entries:migrate-html-rte --config-path path/to/config.json
|
|
2483
|
-
|
|
2484
|
-
|
|
2485
|
-
|
|
2486
|
-
Using Flags
|
|
2487
|
-
|
|
2488
|
-
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path html-path --json-path json-path
|
|
2489
|
-
|
|
2490
|
-
|
|
2491
|
-
|
|
2492
|
-
Nested RTE
|
|
2493
|
-
|
|
2494
|
-
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path modular_block_uid.block_uid.html_rte_uid --json-path modular_block_uid.block_uid.json_rte_uid
|
|
2495
|
-
|
|
2496
|
-
|
|
2497
|
-
|
|
2498
|
-
$ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path group_uid.html_rte_uid --json-path group_uid.json_rte_uid
|
|
2499
|
-
|
|
2500
|
-
|
|
2501
|
-
|
|
2502
|
-
Global Field
|
|
2503
|
-
|
|
2504
|
-
$ csdx cm:entries:migrate-html-rte --alias alias --content-type global_field_uid --global-field --html-path html-path --json-path json-path
|
|
2505
|
-
```
|
|
2506
|
-
|
|
2507
|
-
## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
|
|
2508
|
-
|
|
2509
|
-
Contentstack migration script.
|
|
2510
|
-
|
|
2511
|
-
```
|
|
2512
|
-
USAGE
|
|
2513
|
-
$ csdx cm:migration cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>]
|
|
2514
|
-
[--config-file <value>] [--config <value>] [--multiple]
|
|
2515
|
-
|
|
2516
|
-
FLAGS
|
|
2517
|
-
-B, --branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
|
|
2518
|
-
branch name)
|
|
2519
|
-
-a, --alias=<value> Use this flag to add the management token alias. You must use either the --alias flag or
|
|
2520
|
-
the --stack-api-key flag.
|
|
2521
|
-
-k, --stack-api-key=<value> Use this flag to add the API key of your stack. You must use either the --stack-api-key
|
|
2522
|
-
flag or the --alias flag.
|
|
2523
|
-
--config=<value>... [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
|
|
2524
|
-
the script re-usable.
|
|
2525
|
-
--config-file=<value> [optional] Path of the JSON configuration file.
|
|
2526
|
-
--file-path=<value> Use this flag to provide the path of the file of the migration script.
|
|
2527
|
-
--multiple This flag helps you to migrate multiple content files in a single instance. Mention the
|
|
2528
|
-
folder path where your migration script files are stored.
|
|
2529
|
-
|
|
2530
|
-
DESCRIPTION
|
|
2531
|
-
Contentstack migration script.
|
|
2532
|
-
|
|
2533
|
-
ALIASES
|
|
2534
|
-
$ csdx cm:migration
|
|
2535
|
-
|
|
2536
|
-
EXAMPLES
|
|
2537
|
-
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>
|
|
2538
|
-
|
|
2539
|
-
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>
|
|
2540
|
-
|
|
2541
|
-
$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>
|
|
2542
|
-
|
|
2543
|
-
$ csdx cm:migration --config-file <path/to/json/config/file> --file-path <migration/script/file/path>
|
|
2544
|
-
|
|
2545
|
-
$ csdx cm:migration --multiple --file-path <migration/scripts/dir/path>
|
|
2546
|
-
|
|
2547
|
-
$ csdx cm:migration --alias --file-path <migration/script/file/path> -k <api-key>
|
|
2548
|
-
```
|
|
2549
|
-
|
|
2550
|
-
## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>] [--locale <value>]`
|
|
2551
|
-
|
|
2552
|
-
Create a stack from existing content types, entries, assets, etc
|
|
2553
|
-
|
|
2554
|
-
```
|
|
2555
|
-
USAGE
|
|
2556
|
-
$ csdx cm:seed cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s
|
|
2557
|
-
<value>] [--locale <value>]
|
|
2558
|
-
|
|
2559
|
-
FLAGS
|
|
2560
|
-
-a, --alias=<value> Alias of the management token
|
|
2561
|
-
-k, --stack-api-key=<value> Provide stack API key to seed content to
|
|
2562
|
-
-n, --stack-name=<value> Name of a new stack that needs to be created.
|
|
2563
|
-
-o, --org=<value> Provide Organization UID to create a new stack
|
|
2564
|
-
-r, --repo=<value> GitHub organization name or GitHub user name/repository name.
|
|
2565
|
-
-s, --stack=<value> Provide the stack UID to seed content.
|
|
2566
|
-
-y, --yes=<value> [Optional] Skip the stack confirmation.
|
|
2567
|
-
|
|
2568
|
-
DESCRIPTION
|
|
2569
|
-
Create a stack from existing content types, entries, assets, etc
|
|
2570
|
-
|
|
2571
|
-
ALIASES
|
|
2572
|
-
$ csdx cm:seed
|
|
2573
|
-
|
|
2574
|
-
EXAMPLES
|
|
2575
|
-
$ csdx cm:stacks:seed
|
|
2576
|
-
|
|
2577
|
-
$ csdx cm:stacks:seed --repo "account"
|
|
2578
|
-
|
|
2579
|
-
$ csdx cm:stacks:seed --repo "account/repository"
|
|
2580
|
-
|
|
2581
|
-
$ csdx cm:stacks:seed --repo "account/repository" --stack-api-key "stack-api-key" //seed content into specific stack
|
|
2582
|
-
|
|
2583
|
-
$ csdx cm:stacks:seed --repo "account/repository" --org "your-org-uid" --stack-name "stack-name" //create a new stack in given org uid
|
|
2584
|
-
```
|
|
2585
|
-
|
|
2586
|
-
## `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]`
|
|
2587
|
-
|
|
2588
|
-
Clone data (structure/content or both) of a stack into another stack
|
|
2589
|
-
|
|
2590
|
-
```
|
|
2591
|
-
USAGE
|
|
2592
|
-
$ csdx cm:stack-clone cm:stacks:clone [--source-branch <value>] [--target-branch <value>]
|
|
2593
|
-
[--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b]
|
|
2594
|
-
[--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]
|
|
2595
|
-
|
|
2596
|
-
FLAGS
|
|
2597
|
-
-c, --config=<value> Path for the external configuration
|
|
2598
|
-
-n, --stack-name=<value> Provide a name for the new stack to store the cloned content.
|
|
2599
|
-
-y, --yes Force override all Marketplace prompts.
|
|
2600
|
-
--destination-management-token-alias=<value> Destination management token alias.
|
|
2601
|
-
--destination-stack-api-key=<value> Destination stack API key
|
|
2602
|
-
--import-webhook-status=<option> [default: disable] [default: disable] (optional) The status of the
|
|
2603
|
-
import webhook. <options: disable|current>
|
|
2604
|
-
<options: disable|current>
|
|
2605
|
-
--skip-audit (optional) Skips the audit fix that occurs during an import
|
|
2606
|
-
operation.
|
|
2607
|
-
--source-branch=<value> Branch of the source stack.
|
|
2608
|
-
--source-branch-alias=<value> Alias of Branch of the source stack.
|
|
2609
|
-
--source-management-token-alias=<value> Source management token alias.
|
|
2610
|
-
--source-stack-api-key=<value> Source stack API key
|
|
2611
|
-
--target-branch=<value> Branch of the target stack.
|
|
2612
|
-
--target-branch-alias=<value> Alias of Branch of the target stack.
|
|
2613
|
-
--type=<option> Type of data to clone. You can select option a or b.
|
|
2614
|
-
a) Structure (all modules except entries & assets).
|
|
2615
|
-
b) Structure with content (all modules including entries & assets).
|
|
2616
|
-
|
|
2617
|
-
<options: a|b>
|
|
2618
|
-
|
|
2619
|
-
DESCRIPTION
|
|
2620
|
-
Clone data (structure/content or both) of a stack into another stack
|
|
2621
|
-
Use this plugin to automate the process of cloning a stack in few steps.
|
|
2622
|
-
|
|
2623
|
-
|
|
2624
|
-
ALIASES
|
|
2625
|
-
$ csdx cm:stack-clone
|
|
2626
|
-
|
|
2627
|
-
EXAMPLES
|
|
2628
|
-
$ csdx cm:stacks:clone
|
|
2629
|
-
|
|
2630
|
-
$ csdx cm:stacks:clone --source-branch <source-branch-name> --target-branch <target-branch-name> --yes
|
|
2631
|
-
|
|
2632
|
-
$ csdx cm:stacks:clone --source-stack-api-key <apiKey> --destination-stack-api-key <apiKey>
|
|
2633
|
-
|
|
2634
|
-
$ csdx cm:stacks:clone --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
|
|
2635
|
-
|
|
2636
|
-
$ csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
|
|
2637
|
-
|
|
2638
|
-
$ 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>
|
|
2639
|
-
```
|
|
2640
|
-
|
|
2641
|
-
## `csdx cm:stacks:audit`
|
|
2642
|
-
|
|
2643
|
-
Perform audits and find possible errors in the exported Contentstack data
|
|
2644
|
-
|
|
2645
|
-
```
|
|
2646
|
-
USAGE
|
|
2647
|
-
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
2648
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
|
|
2649
|
-
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
2650
|
-
|
|
2651
|
-
FLAGS
|
|
2652
|
-
--modules=<option>... Provide the list of modules to be audited
|
|
2653
|
-
<options:
|
|
2654
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
2655
|
-
--report-path=<value> Path to store the audit reports
|
|
2656
|
-
|
|
2657
|
-
COMMON FLAGS
|
|
2658
|
-
-c, --config=<value> Path of the external config
|
|
2659
|
-
-d, --data-dir=<value> Path where the data is stored
|
|
2660
|
-
--show-console-output Display the audit and audit fix result for individual modules
|
|
2661
|
-
|
|
2662
|
-
TABLE FLAGS
|
|
2663
|
-
--columns=<value> Specify columns to display, comma-separated.
|
|
2664
|
-
--csv Output results in CSV format.
|
|
2665
|
-
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
2666
|
-
--no-header Hide table headers in output.
|
|
2667
|
-
--no-truncate Prevent truncation of long text in columns.
|
|
2668
|
-
--output=<option> Specify output format: csv, json, or yaml.
|
|
2669
|
-
<options: csv|json|yaml>
|
|
2670
|
-
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
2671
|
-
|
|
2672
|
-
DESCRIPTION
|
|
2673
|
-
Perform audits and find possible errors in the exported Contentstack data
|
|
2674
|
-
|
|
2675
|
-
ALIASES
|
|
2676
|
-
$ csdx audit
|
|
2677
|
-
$ csdx cm:stacks:audit
|
|
2678
|
-
|
|
2679
|
-
EXAMPLES
|
|
2680
|
-
$ csdx cm:stacks:audit
|
|
2681
|
-
|
|
2682
|
-
$ csdx cm:stacks:audit --report-path=<path>
|
|
2683
|
-
|
|
2684
|
-
$ csdx cm:stacks:audit --report-path=<path> --csv
|
|
2685
|
-
|
|
2686
|
-
$ csdx cm:stacks:audit --report-path=<path> --filter="name=<filter-value>"
|
|
2687
|
-
|
|
2688
|
-
$ csdx cm:stacks:audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
|
|
2689
|
-
```
|
|
2690
|
-
|
|
2691
|
-
_See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts)_
|
|
2692
|
-
|
|
2693
|
-
## `csdx cm:stacks:audit:fix`
|
|
2694
|
-
|
|
2695
|
-
Perform audits and fix possible errors in the exported Contentstack data.
|
|
2696
|
-
|
|
2697
|
-
```
|
|
2698
|
-
USAGE
|
|
2699
|
-
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
2700
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
|
|
2701
|
-
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
|
|
2702
|
-
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
2703
|
-
|
|
2704
|
-
FLAGS
|
|
2705
|
-
--copy-dir Create backup from the original data.
|
|
2706
|
-
--copy-path=<value> Provide the path to backup the copied data
|
|
2707
|
-
--fix-only=<option>... Provide the list of fix options
|
|
2708
|
-
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
2709
|
-
--modules=<option>... Provide the list of modules to be audited
|
|
2710
|
-
<options:
|
|
2711
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
2712
|
-
--report-path=<value> Path to store the audit reports
|
|
2713
|
-
|
|
2714
|
-
COMMON FLAGS
|
|
2715
|
-
-c, --config=<value> Path of the external config
|
|
2716
|
-
-d, --data-dir=<value> Path where the data is stored
|
|
2717
|
-
--show-console-output Display the audit and audit fix result for individual modules
|
|
2718
|
-
|
|
2719
|
-
TABLE FLAGS
|
|
2720
|
-
--columns=<value> Specify columns to display, comma-separated.
|
|
2721
|
-
--csv Output results in CSV format.
|
|
2722
|
-
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
2723
|
-
--no-header Hide table headers in output.
|
|
2724
|
-
--no-truncate Prevent truncation of long text in columns.
|
|
2725
|
-
--output=<option> Specify output format: csv, json, or yaml.
|
|
2726
|
-
<options: csv|json|yaml>
|
|
2727
|
-
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
2728
|
-
|
|
2729
|
-
DESCRIPTION
|
|
2730
|
-
Perform audits and fix possible errors in the exported Contentstack data.
|
|
2731
|
-
|
|
2732
|
-
ALIASES
|
|
2733
|
-
$ csdx audit:fix
|
|
2734
|
-
$ csdx cm:stacks:audit:fix
|
|
2735
|
-
|
|
2736
|
-
EXAMPLES
|
|
2737
|
-
$ csdx cm:stacks:audit:fix --copy-dir
|
|
2738
|
-
|
|
2739
|
-
$ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir
|
|
2740
|
-
|
|
2741
|
-
$ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
|
|
2742
|
-
|
|
2743
|
-
$ csdx cm:stacks:audit:fix --fix-only=reference,global_field --copy-dir
|
|
2744
|
-
|
|
2745
|
-
$ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
|
|
2746
|
-
|
|
2747
|
-
$ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
|
|
2748
|
-
```
|
|
2749
|
-
|
|
2750
|
-
_See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
|
|
2751
|
-
|
|
2752
|
-
## `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]`
|
|
2753
|
-
|
|
2754
|
-
Clone data (structure/content or both) of a stack into another stack
|
|
2755
|
-
|
|
2756
|
-
```
|
|
2757
|
-
USAGE
|
|
2758
|
-
$ csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias
|
|
2759
|
-
<value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>]
|
|
2760
|
-
[--destination-stack-api-key <value>] [--import-webhook-status disable|current]
|
|
2761
|
-
|
|
2762
|
-
FLAGS
|
|
2763
|
-
-c, --config=<value> Path for the external configuration
|
|
2764
|
-
-n, --stack-name=<value> Provide a name for the new stack to store the cloned content.
|
|
2765
|
-
-y, --yes Force override all Marketplace prompts.
|
|
2766
|
-
--destination-management-token-alias=<value> Destination management token alias.
|
|
2767
|
-
--destination-stack-api-key=<value> Destination stack API key
|
|
2768
|
-
--import-webhook-status=<option> [default: disable] [default: disable] (optional) The status of the
|
|
2769
|
-
import webhook. <options: disable|current>
|
|
2770
|
-
<options: disable|current>
|
|
2771
|
-
--skip-audit (optional) Skips the audit fix that occurs during an import
|
|
2772
|
-
operation.
|
|
2773
|
-
--source-branch=<value> Branch of the source stack.
|
|
2774
|
-
--source-branch-alias=<value> Alias of Branch of the source stack.
|
|
2775
|
-
--source-management-token-alias=<value> Source management token alias.
|
|
2776
|
-
--source-stack-api-key=<value> Source stack API key
|
|
2777
|
-
--target-branch=<value> Branch of the target stack.
|
|
2778
|
-
--target-branch-alias=<value> Alias of Branch of the target stack.
|
|
2779
|
-
--type=<option> Type of data to clone. You can select option a or b.
|
|
2780
|
-
a) Structure (all modules except entries & assets).
|
|
2781
|
-
b) Structure with content (all modules including entries & assets).
|
|
2782
|
-
|
|
2783
|
-
<options: a|b>
|
|
2784
|
-
|
|
2785
|
-
DESCRIPTION
|
|
2786
|
-
Clone data (structure/content or both) of a stack into another stack
|
|
2787
|
-
Use this plugin to automate the process of cloning a stack in few steps.
|
|
2788
|
-
|
|
2789
|
-
|
|
2790
|
-
ALIASES
|
|
2791
|
-
$ csdx cm:stack-clone
|
|
2792
|
-
|
|
2793
|
-
EXAMPLES
|
|
2794
|
-
$ csdx cm:stacks:clone
|
|
2795
|
-
|
|
2796
|
-
$ csdx cm:stacks:clone --source-branch <source-branch-name> --target-branch <target-branch-name> --yes
|
|
2797
|
-
|
|
2798
|
-
$ csdx cm:stacks:clone --source-stack-api-key <apiKey> --destination-stack-api-key <apiKey>
|
|
2799
|
-
|
|
2800
|
-
$ csdx cm:stacks:clone --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
|
|
2801
|
-
|
|
2802
|
-
$ csdx cm:stacks:clone --source-branch --target-branch --source-management-token-alias <management token alias> --destination-management-token-alias <management token alias>
|
|
2803
|
-
|
|
2804
|
-
$ 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>
|
|
2805
|
-
```
|
|
2806
|
-
|
|
2807
|
-
_See code: [@contentstack/cli-cm-clone](https://github.com/contentstack/cli/blob/main/packages/contentstack-clone/src/commands/cm/stacks/clone.js)_
|
|
2808
|
-
|
|
2809
|
-
## `csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
|
|
2810
|
-
|
|
2811
|
-
Export content from a stack
|
|
2812
|
-
|
|
2813
|
-
```
|
|
2814
|
-
USAGE
|
|
2815
|
-
$ csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types
|
|
2816
|
-
<value>] [--branch <value>] [--secured-assets]
|
|
2817
|
-
|
|
2818
|
-
FLAGS
|
|
2819
|
-
-B, --branch=<value> [optional] The name of the branch where you want to export your content. If you don't
|
|
2820
|
-
mention the branch name, then by default the content will be exported from all the
|
|
2821
|
-
branches of your stack.
|
|
2822
|
-
-a, --alias=<value> The management token alias of the source stack from which you will export content.
|
|
2823
|
-
-c, --config=<value> [optional] Path of the config
|
|
2824
|
-
-d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
|
|
2825
|
-
./content
|
|
2826
|
-
-k, --stack-api-key=<value> API Key of the source stack
|
|
2827
|
-
-m, --module=<value> [optional] Specific module name. If not specified, the export command will export all
|
|
2828
|
-
the modules to the stack. The available modules are assets, content-types, entries,
|
|
2829
|
-
environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
|
|
2830
|
-
workflows, custom-roles, and taxonomies.
|
|
2831
|
-
-t, --content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
|
|
2832
|
-
of multiple content types, specify the IDs separated by spaces.
|
|
2833
|
-
-y, --yes [optional] Force override all Marketplace prompts.
|
|
2834
|
-
--branch-alias=<value> (Optional) The alias of the branch from which you want to export content.
|
|
2835
|
-
--secured-assets [optional] Use this flag for assets that are secured.
|
|
2836
|
-
|
|
2837
|
-
DESCRIPTION
|
|
2838
|
-
Export content from a stack
|
|
2839
|
-
|
|
2840
|
-
ALIASES
|
|
2841
|
-
$ csdx cm:export
|
|
2842
|
-
|
|
2843
|
-
EXAMPLES
|
|
2844
|
-
$ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
2845
|
-
|
|
2846
|
-
$ csdx cm:stacks:export --config <path/to/config/dir>
|
|
2847
|
-
|
|
2848
|
-
$ csdx cm:stacks:export --alias <management_token_alias>
|
|
2849
|
-
|
|
2850
|
-
$ csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>
|
|
2851
|
-
|
|
2852
|
-
$ csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>
|
|
2853
|
-
|
|
2854
|
-
$ csdx cm:stacks:export --module <single module name>
|
|
2855
|
-
|
|
2856
|
-
$ csdx cm:stacks:export --branch [optional] branch name
|
|
2857
|
-
```
|
|
2858
|
-
|
|
2859
|
-
_See code: [@contentstack/cli-cm-export](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/stacks/export.ts)_
|
|
2860
|
-
|
|
2861
|
-
## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
|
|
2862
|
-
|
|
2863
|
-
Import content from a stack
|
|
2864
|
-
|
|
2865
|
-
```
|
|
2866
|
-
USAGE
|
|
2867
|
-
$ csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir
|
|
2868
|
-
<value>] [--branch <value>] [--import-webhook-status disable|current]
|
|
2869
|
-
|
|
2870
|
-
FLAGS
|
|
2871
|
-
-B, --branch=<value> The name of the branch where you want to import your content. If you don't
|
|
2872
|
-
mention the branch name, then by default the content will be imported to the
|
|
2873
|
-
main branch.
|
|
2874
|
-
-a, --alias=<value> The management token of the destination stack where you will import the
|
|
2875
|
-
content.
|
|
2876
|
-
-b, --backup-dir=<value> [optional] Backup directory name when using specific module.
|
|
2877
|
-
-c, --config=<value> [optional] The path of the configuration JSON file containing all the options
|
|
2878
|
-
for a single run.
|
|
2879
|
-
-d, --data-dir=<value> The path or the location in your file system where the content, you intend to
|
|
2880
|
-
import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
|
|
2881
|
-
export folder has branches involved, then the path should point till the
|
|
2882
|
-
particular branch. For example, “-d
|
|
2883
|
-
"C:\Users\Name\Desktop\cli\content\branch_name"
|
|
2884
|
-
-k, --stack-api-key=<value> API Key of the target stack
|
|
2885
|
-
-m, --module=<value> [optional] Specify the module to import into the target stack. If not
|
|
2886
|
-
specified, the import command will import all the modules into the stack. The
|
|
2887
|
-
available modules are assets, content-types, entries, environments,
|
|
2888
|
-
extensions, marketplace-apps, global-fields, labels, locales, webhooks,
|
|
2889
|
-
workflows, custom-roles, personalize projects, and taxonomies.
|
|
2890
|
-
-y, --yes [optional] Force override all Marketplace prompts.
|
|
2891
|
-
--branch-alias=<value> Specify the branch alias where you want to import your content. If not
|
|
2892
|
-
specified, the content is imported into the main branch by default.
|
|
2893
|
-
--exclude-global-modules Excludes the branch-independent module from the import operation.
|
|
2894
|
-
--import-webhook-status=<option> [default: disable] [default: disable] (optional) This webhook state keeps the
|
|
2895
|
-
same state of webhooks as the source stack. <options: disable|current>
|
|
2896
|
-
<options: disable|current>
|
|
2897
|
-
--personalize-project-name=<value> (optional) Provide a unique name for the Personalize project.
|
|
2898
|
-
--replace-existing Replaces the existing module in the target stack.
|
|
2899
|
-
--skip-app-recreation (optional) Skips the recreation of private apps if they already exist.
|
|
2900
|
-
--skip-assets-publish Skips asset publishing during the import process.
|
|
2901
|
-
--skip-audit Skips the audit fix that occurs during an import operation.
|
|
2902
|
-
--skip-entries-publish Skips entry publishing during the import process
|
|
2903
|
-
--skip-existing Skips the module exists warning messages.
|
|
2904
|
-
|
|
2905
|
-
DESCRIPTION
|
|
2906
|
-
Import content from a stack
|
|
2907
|
-
|
|
2908
|
-
ALIASES
|
|
2909
|
-
$ csdx cm:import
|
|
2910
|
-
|
|
2911
|
-
EXAMPLES
|
|
2912
|
-
$ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
2913
|
-
|
|
2914
|
-
$ csdx cm:stacks:import --config <path/of/config/dir>
|
|
2915
|
-
|
|
2916
|
-
$ csdx cm:stacks:import --module <single module name>
|
|
2917
|
-
|
|
2918
|
-
$ csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>
|
|
2919
|
-
|
|
2920
|
-
$ csdx cm:stacks:import --alias <management_token_alias>
|
|
2921
|
-
|
|
2922
|
-
$ csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>
|
|
2923
|
-
|
|
2924
|
-
$ csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
|
|
2925
|
-
|
|
2926
|
-
$ csdx cm:stacks:import --branch <branch name> --yes --skip-audit
|
|
2927
|
-
```
|
|
2928
|
-
|
|
2929
|
-
_See code: [@contentstack/cli-cm-import](https://github.com/contentstack/cli/blob/main/packages/contentstack-import/src/commands/cm/stacks/import.ts)_
|
|
2930
|
-
|
|
2931
|
-
## `csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]`
|
|
2932
|
-
|
|
2933
|
-
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
2934
|
-
|
|
2935
|
-
```
|
|
2936
|
-
USAGE
|
|
2937
|
-
$ csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
|
|
2938
|
-
|
|
2939
|
-
FLAGS
|
|
2940
|
-
-B, --branch=<value> The name of the branch where you want to import your content. If you don't mention the
|
|
2941
|
-
branch name, then by default the content will be imported to the main branch.
|
|
2942
|
-
-a, --alias=<value> The management token of the destination stack where you will import the content.
|
|
2943
|
-
-d, --data-dir=<value> The path or the location in your file system where the content, you intend to import, is
|
|
2944
|
-
stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
|
|
2945
|
-
branches involved, then the path should point till the particular branch. For example,
|
|
2946
|
-
“-d "C:\Users\Name\Desktop\cli\content\branch_name"
|
|
2947
|
-
-k, --stack-api-key=<value> API key of the target stack
|
|
2948
|
-
--branch-alias=<value> Specify the branch alias where you want to import your content. If not specified, the
|
|
2949
|
-
content is imported into the main branch by default.
|
|
2950
|
-
--module=<option>... [optional] Specify the modules/module to import into the target stack. currently options
|
|
2951
|
-
are global-fields, content-types, entries
|
|
2952
|
-
<options: global-fields|content-types|entries>
|
|
2953
|
-
|
|
2954
|
-
DESCRIPTION
|
|
2955
|
-
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
2956
|
-
|
|
2957
|
-
ALIASES
|
|
2958
|
-
$ csdx cm:import-setup
|
|
2959
|
-
|
|
2960
|
-
EXAMPLES
|
|
2961
|
-
$ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
|
|
2962
|
-
|
|
2963
|
-
$ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>
|
|
2964
|
-
|
|
2965
|
-
$ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>
|
|
2966
|
-
```
|
|
2967
|
-
|
|
2968
|
-
_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)_
|
|
2969
|
-
|
|
2970
|
-
## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
|
|
2971
|
-
|
|
2972
|
-
Contentstack migration script.
|
|
2973
|
-
|
|
2974
|
-
```
|
|
2975
|
-
USAGE
|
|
2976
|
-
$ csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>]
|
|
2977
|
-
[--config <value>] [--multiple]
|
|
2978
|
-
|
|
2979
|
-
FLAGS
|
|
2980
|
-
-B, --branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
|
|
2981
|
-
branch name)
|
|
2982
|
-
-a, --alias=<value> Use this flag to add the management token alias. You must use either the --alias flag or
|
|
2983
|
-
the --stack-api-key flag.
|
|
2984
|
-
-k, --stack-api-key=<value> Use this flag to add the API key of your stack. You must use either the --stack-api-key
|
|
2985
|
-
flag or the --alias flag.
|
|
2986
|
-
--config=<value>... [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
|
|
2987
|
-
the script re-usable.
|
|
2988
|
-
--config-file=<value> [optional] Path of the JSON configuration file.
|
|
2989
|
-
--file-path=<value> Use this flag to provide the path of the file of the migration script.
|
|
2990
|
-
--multiple This flag helps you to migrate multiple content files in a single instance. Mention the
|
|
2991
|
-
folder path where your migration script files are stored.
|
|
2992
|
-
|
|
2993
|
-
DESCRIPTION
|
|
2994
|
-
Contentstack migration script.
|
|
432
|
+
$ csdx cm:branches:diff --compare-branch "develop" --format "detailed-text"
|
|
2995
433
|
|
|
2996
|
-
|
|
2997
|
-
$ csdx cm:migration
|
|
434
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main"
|
|
2998
435
|
|
|
2999
|
-
|
|
3000
|
-
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>
|
|
436
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop"
|
|
3001
437
|
|
|
3002
|
-
$ csdx cm:
|
|
438
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --module "content-types"
|
|
3003
439
|
|
|
3004
|
-
$ csdx cm:
|
|
440
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types"
|
|
3005
441
|
|
|
3006
|
-
$ csdx cm:
|
|
442
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text"
|
|
3007
443
|
|
|
3008
|
-
$ csdx cm:
|
|
444
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "compact-text"
|
|
3009
445
|
|
|
3010
|
-
$ csdx cm:
|
|
446
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text" --csv-path "./reports/diff-report.csv"
|
|
3011
447
|
```
|
|
3012
448
|
|
|
3013
|
-
_See code: [@contentstack/cli-
|
|
449
|
+
_See code: [@contentstack/cli-cm-branches](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/diff.ts)_
|
|
3014
450
|
|
|
3015
|
-
## `csdx cm:
|
|
451
|
+
## `csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>] [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]`
|
|
3016
452
|
|
|
3017
|
-
|
|
453
|
+
Merge changes from a branch
|
|
3018
454
|
|
|
3019
455
|
```
|
|
3020
456
|
USAGE
|
|
3021
|
-
$ csdx cm:
|
|
457
|
+
$ csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>]
|
|
458
|
+
[--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]
|
|
3022
459
|
|
|
3023
|
-
|
|
3024
|
-
|
|
3025
|
-
|
|
460
|
+
FLAGS
|
|
461
|
+
-k, --stack-api-key=<value> [optional] Provide stack API key to show the difference between the branches.
|
|
462
|
+
--base-branch=<value> [optional] Base branch (Target branch).
|
|
463
|
+
--comment=<value> [optional] Pass a comment.
|
|
464
|
+
--compare-branch=<value> [optional] Compare branch (Source branch).
|
|
465
|
+
--export-summary-path=<value> [optional] Export summary file path.
|
|
466
|
+
--no-revert [optional] If passed, will not create the new revert branch.
|
|
467
|
+
--use-merge-summary=<value> [optional] Path of merge summary file.
|
|
3026
468
|
|
|
3027
|
-
|
|
3028
|
-
|
|
3029
|
-
But, if retry-failed flag is set, then only a logfile is required
|
|
469
|
+
DESCRIPTION
|
|
470
|
+
Merge changes from a branch
|
|
3030
471
|
|
|
3031
472
|
EXAMPLES
|
|
3032
|
-
|
|
473
|
+
$ csdx cm:branches:merge --stack-api-key bltxxxxxxxx --compare-branch feature-branch
|
|
3033
474
|
|
|
3034
|
-
$ csdx cm:
|
|
475
|
+
$ csdx cm:branches:merge --stack-api-key bltxxxxxxxx --comment "merge comment"
|
|
3035
476
|
|
|
477
|
+
$ csdx cm:branches:merge -k bltxxxxxxxx --base-branch base-branch
|
|
3036
478
|
|
|
479
|
+
$ csdx cm:branches:merge --export-summary-path file/path
|
|
3037
480
|
|
|
3038
|
-
|
|
481
|
+
$ csdx cm:branches:merge --use-merge-summary file-path
|
|
3039
482
|
|
|
3040
|
-
|
|
483
|
+
$ csdx cm:branches:merge -k bltxxxxxxxx --no-revert
|
|
3041
484
|
|
|
3042
|
-
$ csdx cm:
|
|
485
|
+
$ csdx cm:branches:merge -k bltxxxxxxxx --compare-branch feature-branch --no-revert
|
|
486
|
+
```
|
|
3043
487
|
|
|
3044
|
-
|
|
488
|
+
_See code: [@contentstack/cli-cm-branches](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/merge.ts)_
|
|
3045
489
|
|
|
490
|
+
## `csdx cm:stacks:audit`
|
|
3046
491
|
|
|
492
|
+
Perform audits and find possible errors in the exported Contentstack data
|
|
3047
493
|
|
|
3048
|
-
|
|
494
|
+
```
|
|
495
|
+
USAGE
|
|
496
|
+
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
497
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules|composable-studio...]
|
|
498
|
+
[--columns <value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output
|
|
499
|
+
csv|json|yaml]
|
|
3049
500
|
|
|
3050
|
-
|
|
501
|
+
FLAGS
|
|
502
|
+
--modules=<option>... Provide the list of modules to be audited
|
|
503
|
+
<options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-ru
|
|
504
|
+
les|composable-studio>
|
|
505
|
+
--report-path=<value> Path to store the audit reports
|
|
3051
506
|
|
|
507
|
+
COMMON FLAGS
|
|
508
|
+
-c, --config=<value> Path of the external config
|
|
509
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
510
|
+
--show-console-output Display the audit and audit fix result for individual modules
|
|
3052
511
|
|
|
512
|
+
TABLE FLAGS
|
|
513
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
514
|
+
--csv Output results in CSV format.
|
|
515
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
516
|
+
--no-header Hide table headers in output.
|
|
517
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
518
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
519
|
+
<options: csv|json|yaml>
|
|
520
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
3053
521
|
|
|
3054
|
-
|
|
522
|
+
DESCRIPTION
|
|
523
|
+
Perform audits and find possible errors in the exported Contentstack data
|
|
3055
524
|
|
|
3056
|
-
|
|
525
|
+
EXAMPLES
|
|
526
|
+
$ csdx cm:stacks:audit
|
|
3057
527
|
|
|
528
|
+
$ csdx cm:stacks:audit --report-path=<path>
|
|
3058
529
|
|
|
530
|
+
$ csdx cm:stacks:audit --report-path=<path> --csv
|
|
3059
531
|
|
|
3060
|
-
|
|
532
|
+
$ csdx cm:stacks:audit --report-path=<path> --filter="name=<filter-value>"
|
|
3061
533
|
|
|
3062
|
-
$ csdx cm:stacks:
|
|
534
|
+
$ csdx cm:stacks:audit --report-path=<path> --modules=content-types --filter="name="<filter-value>"
|
|
3063
535
|
```
|
|
3064
536
|
|
|
3065
|
-
_See code: [@contentstack/cli-
|
|
537
|
+
_See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/index.ts)_
|
|
3066
538
|
|
|
3067
|
-
## `csdx cm:stacks:
|
|
539
|
+
## `csdx cm:stacks:audit:fix`
|
|
3068
540
|
|
|
3069
|
-
|
|
541
|
+
Perform audits and fix possible errors in the exported Contentstack data.
|
|
3070
542
|
|
|
3071
543
|
```
|
|
3072
544
|
USAGE
|
|
3073
|
-
$ csdx cm:stacks:
|
|
545
|
+
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
546
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules|composable-studio...]
|
|
547
|
+
[--copy-path <value> --copy-dir] [--fix-only
|
|
548
|
+
reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns <value>] [--sort <value>]
|
|
549
|
+
[--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
3074
550
|
|
|
3075
551
|
FLAGS
|
|
3076
|
-
-
|
|
3077
|
-
|
|
552
|
+
--copy-dir Create backup from the original data.
|
|
553
|
+
--copy-path=<value> Provide the path to backup the copied data
|
|
554
|
+
--fix-only=<option>... Provide the list of fix options
|
|
555
|
+
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
556
|
+
--modules=<option>... Provide the list of modules to be audited
|
|
557
|
+
<options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-r
|
|
558
|
+
ules|composable-studio>
|
|
559
|
+
--report-path=<value> Path to store the audit reports
|
|
3078
560
|
|
|
3079
|
-
|
|
3080
|
-
|
|
561
|
+
COMMON FLAGS
|
|
562
|
+
-c, --config=<value> Path of the external config
|
|
563
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
564
|
+
--show-console-output Display the audit and audit fix result for individual modules
|
|
3081
565
|
|
|
3082
|
-
|
|
3083
|
-
|
|
566
|
+
TABLE FLAGS
|
|
567
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
568
|
+
--csv Output results in CSV format.
|
|
569
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
570
|
+
--no-header Hide table headers in output.
|
|
571
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
572
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
573
|
+
<options: csv|json|yaml>
|
|
574
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
575
|
+
|
|
576
|
+
DESCRIPTION
|
|
577
|
+
Perform audits and fix possible errors in the exported Contentstack data.
|
|
3084
578
|
|
|
3085
579
|
EXAMPLES
|
|
3086
|
-
$ csdx cm:stacks:
|
|
580
|
+
$ csdx cm:stacks:audit:fix --copy-dir
|
|
581
|
+
|
|
582
|
+
$ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir
|
|
583
|
+
|
|
584
|
+
$ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
|
|
3087
585
|
|
|
3088
|
-
$ csdx cm:stacks:
|
|
586
|
+
$ csdx cm:stacks:audit:fix --fix-only=reference,global_field --copy-dir
|
|
3089
587
|
|
|
3090
|
-
$ csdx cm:stacks:
|
|
588
|
+
$ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
|
|
3091
589
|
|
|
3092
|
-
$ csdx cm:stacks:
|
|
590
|
+
$ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
|
|
3093
591
|
```
|
|
3094
592
|
|
|
3095
|
-
_See code: [@contentstack/cli-
|
|
593
|
+
_See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
|
|
3096
594
|
|
|
3097
|
-
## `csdx cm:stacks:
|
|
595
|
+
## `csdx cm:stacks:bulk-assets`
|
|
3098
596
|
|
|
3099
|
-
|
|
597
|
+
Bulk operations for assets (publish/unpublish/cross-publish)
|
|
3100
598
|
|
|
3101
599
|
```
|
|
3102
600
|
USAGE
|
|
3103
|
-
$ csdx cm:stacks:
|
|
601
|
+
$ csdx cm:stacks:bulk-assets [-a <value>] [-k <value>] [--operation publish|unpublish] [--environments <value>...]
|
|
602
|
+
[--locales <value>...] [--source-env <value>] [--source-alias <value>] [--publish-mode bulk|single] [--branch
|
|
603
|
+
<value>] [-c <value>] [-y] [--retry-failed <value>] [--revert <value>] [--bulk-operation-file <value>] [--folder-uid
|
|
604
|
+
<value>]
|
|
3104
605
|
|
|
3105
606
|
FLAGS
|
|
3106
|
-
-a, --alias=<value>
|
|
3107
|
-
|
|
3108
|
-
|
|
3109
|
-
|
|
607
|
+
-a, --alias=<value> Uses the name of a saved Management Token to authenticate the command. The command
|
|
608
|
+
can only access the branches allowed for that token. This option can be used as an
|
|
609
|
+
alternative to` --stack-api-key.`
|
|
610
|
+
-c, --config=<value> (optional) Specifies the path to a JSON configuration file that defines the options
|
|
611
|
+
for the command. Use this file instead of passing multiple CLI flags for a single
|
|
612
|
+
run.
|
|
613
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
614
|
+
--alias flag.
|
|
615
|
+
-y, --yes Skips interactive confirmation prompts and runs the command immediately using the
|
|
616
|
+
provided options. Useful for automation and scripts.
|
|
617
|
+
--branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
618
|
+
operation. If you don't mention the branch name, then by default the content from
|
|
619
|
+
main branch will be published.
|
|
620
|
+
--bulk-operation-file=<value> [default: bulk-operation] (optional) Folder path to store operation logs. Creates
|
|
621
|
+
separate files for success and failed operations. Default: bulk-operation
|
|
622
|
+
--environments=<value>... Specifies one or more environments where the entries or assets should be published.
|
|
623
|
+
Separate multiple environments with spaces.
|
|
624
|
+
--folder-uid=<value> (optional) The UID of the Assets' folder from which the assets need to be
|
|
625
|
+
published. The default value is cs_root.
|
|
626
|
+
--locales=<value>... Specifies one or more locale codes for which the entries or assets should be
|
|
627
|
+
published. Separate multiple locales with spaces.
|
|
628
|
+
--operation=<option> Specifies whether to `publish` or `unpublish` content.
|
|
629
|
+
<options: publish|unpublish>
|
|
630
|
+
--publish-mode=<option> [default: bulk] Publish mode: bulk (uses Bulk Publish API) or single (individual
|
|
631
|
+
API calls)
|
|
632
|
+
<options: bulk|single>
|
|
633
|
+
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/assets from the
|
|
634
|
+
logfile. Specify the name of the logfile that lists failed publish calls. If this
|
|
635
|
+
option is used, it will override all other flags.
|
|
636
|
+
--revert=<value> (optional) Revert publish operations from a log folder. Specify the folder path
|
|
637
|
+
containing success logs. Works similar to retry-failed.
|
|
638
|
+
--source-alias=<value> Alias name for source environment delivery token (required for cross-publish). Add
|
|
639
|
+
delivery token using: csdx auth:tokens:add
|
|
640
|
+
--source-env=<value> Source environment for cross-publish
|
|
3110
641
|
|
|
3111
642
|
DESCRIPTION
|
|
3112
|
-
|
|
3113
|
-
|
|
3114
|
-
ALIASES
|
|
3115
|
-
$ csdx cm:bulk-publish:configure
|
|
643
|
+
Bulk operations for assets (publish/unpublish/cross-publish)
|
|
3116
644
|
|
|
3117
645
|
EXAMPLES
|
|
3118
|
-
$ csdx cm:stacks:publish-
|
|
646
|
+
$ csdx cm:stacks:bulk-assets --operation publish --environments dev,staging --locales en-us -k blt123
|
|
3119
647
|
|
|
3120
|
-
$ csdx cm:stacks:
|
|
648
|
+
$ csdx cm:stacks:bulk-assets --operation unpublish --environments prod --locales en-us -a myAlias
|
|
3121
649
|
|
|
3122
|
-
$ csdx cm:stacks:publish-
|
|
650
|
+
$ csdx cm:stacks:bulk-assets --operation publish --folder-uid cs_root --environments prod --locales en-us -k blt123
|
|
3123
651
|
|
|
3124
|
-
$ csdx cm:stacks:publish-
|
|
652
|
+
$ csdx cm:stacks:bulk-assets --operation publish --environments prod --locales en-us --publish-mode bulk -k blt123
|
|
653
|
+
|
|
654
|
+
$ csdx cm:stacks:bulk-assets --operation publish --source-env production --source-alias prod-delivery --environments staging,dev --locales en-us -a myAlias
|
|
655
|
+
|
|
656
|
+
$ csdx cm:stacks:bulk-assets --retry-failed ./bulk-operation -a myAlias
|
|
657
|
+
|
|
658
|
+
$ csdx cm:stacks:bulk-assets --revert ./bulk-operation -a myAlias
|
|
3125
659
|
```
|
|
3126
660
|
|
|
3127
|
-
_See code: [@contentstack/cli-
|
|
661
|
+
_See code: [@contentstack/cli-bulk-operations](https://github.com/contentstack/cli-bulk-operations/blob/v1.0.0-beta/src/commands/cm/stacks/bulk-assets.ts)_
|
|
3128
662
|
|
|
3129
|
-
## `csdx cm:stacks:
|
|
663
|
+
## `csdx cm:stacks:bulk-entries`
|
|
3130
664
|
|
|
3131
|
-
|
|
665
|
+
Bulk operations for entries (publish/unpublish/cross-publish)
|
|
3132
666
|
|
|
3133
667
|
```
|
|
3134
668
|
USAGE
|
|
3135
|
-
$ csdx cm:stacks:
|
|
669
|
+
$ csdx cm:stacks:bulk-entries [-a <value>] [-k <value>] [--operation publish|unpublish] [--environments <value>...]
|
|
670
|
+
[--locales <value>...] [--source-env <value>] [--source-alias <value>] [--publish-mode bulk|single] [--branch
|
|
671
|
+
<value>] [-c <value>] [-y] [--retry-failed <value>] [--revert <value>] [--bulk-operation-file <value>]
|
|
672
|
+
[--content-types <value>...] [--filter draft|modified|non-localized|unpublished] [--include-variants] [--api-version
|
|
673
|
+
<value>]
|
|
3136
674
|
|
|
3137
675
|
FLAGS
|
|
3138
|
-
--
|
|
3139
|
-
|
|
3140
|
-
|
|
3141
|
-
|
|
676
|
+
-a, --alias=<value> Uses the name of a saved Management Token to authenticate the command. The command
|
|
677
|
+
can only access the branches allowed for that token. This option can be used as an
|
|
678
|
+
alternative to` --stack-api-key.`
|
|
679
|
+
-c, --config=<value> (optional) Specifies the path to a JSON configuration file that defines the options
|
|
680
|
+
for the command. Use this file instead of passing multiple CLI flags for a single
|
|
681
|
+
run.
|
|
682
|
+
-k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
|
|
683
|
+
--alias flag.
|
|
684
|
+
-y, --yes Skips interactive confirmation prompts and runs the command immediately using the
|
|
685
|
+
provided options. Useful for automation and scripts.
|
|
686
|
+
--api-version=<value> [default: 3.2] Specifies the Content Management API version used for publishing.
|
|
687
|
+
Use version `3.2` when publishing entries with nested references, otherwise, use
|
|
688
|
+
the default version 3.2
|
|
689
|
+
--branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
|
|
690
|
+
operation. If you don't mention the branch name, then by default the content from
|
|
691
|
+
main branch will be published.
|
|
692
|
+
--bulk-operation-file=<value> [default: bulk-operation] (optional) Folder path to store operation logs. Creates
|
|
693
|
+
separate files for success and failed operations. Default: bulk-operation
|
|
694
|
+
--content-types=<value>... Content type UIDs to perform operation on. If not provided, operates on all content
|
|
695
|
+
types.
|
|
696
|
+
--environments=<value>... Specifies one or more environments where the entries or assets should be published.
|
|
697
|
+
Separate multiple environments with spaces.
|
|
698
|
+
--filter=<option> Filter entries by status
|
|
699
|
+
<options: draft|modified|non-localized|unpublished>
|
|
700
|
+
--include-variants Includes entry variants (alternate versions of a base entry) in the bulk operation.
|
|
701
|
+
By default, only base entries are processed.
|
|
702
|
+
--locales=<value>... Specifies one or more locale codes for which the entries or assets should be
|
|
703
|
+
published. Separate multiple locales with spaces.
|
|
704
|
+
--operation=<option> Specifies whether to `publish` or `unpublish` content.
|
|
705
|
+
<options: publish|unpublish>
|
|
706
|
+
--publish-mode=<option> [default: bulk] Publish mode: bulk (uses Bulk Publish API) or single (individual
|
|
707
|
+
API calls)
|
|
708
|
+
<options: bulk|single>
|
|
709
|
+
--retry-failed=<value> (optional) Use this option to retry publishing the failed entries/assets from the
|
|
710
|
+
logfile. Specify the name of the logfile that lists failed publish calls. If this
|
|
711
|
+
option is used, it will override all other flags.
|
|
712
|
+
--revert=<value> (optional) Revert publish operations from a log folder. Specify the folder path
|
|
713
|
+
containing success logs. Works similar to retry-failed.
|
|
714
|
+
--source-alias=<value> Alias name for source environment delivery token (required for cross-publish). Add
|
|
715
|
+
delivery token using: csdx auth:tokens:add
|
|
716
|
+
--source-env=<value> Source environment for cross-publish
|
|
3142
717
|
|
|
3143
718
|
DESCRIPTION
|
|
3144
|
-
|
|
3145
|
-
The revert command is used to revert all publish operations performed using bulk-publish script.
|
|
3146
|
-
A log file name is required to execute revert command
|
|
719
|
+
Bulk operations for entries (publish/unpublish/cross-publish)
|
|
3147
720
|
|
|
721
|
+
EXAMPLES
|
|
722
|
+
$ csdx cm:stacks:bulk-entries --operation publish --environments dev --locales en-us -k blt123
|
|
3148
723
|
|
|
3149
|
-
|
|
3150
|
-
$ csdx cm:bulk-publish:revert
|
|
724
|
+
$ csdx cm:stacks:bulk-entries --operation publish --content-types blog,article --environments dev --locales en-us -k blt123
|
|
3151
725
|
|
|
3152
|
-
|
|
3153
|
-
|
|
726
|
+
$ csdx cm:stacks:bulk-entries --operation unpublish --content-types blog --environments prod --locales en-us -a myAlias
|
|
727
|
+
|
|
728
|
+
$ csdx cm:stacks:bulk-entries --operation publish --content-types blog --source-env production --source-alias prod-delivery --environments staging --locales en-us -a myAlias
|
|
3154
729
|
|
|
3155
|
-
cm:bulk-publish
|
|
730
|
+
$ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us --publish-mode bulk -k blt123
|
|
3156
731
|
|
|
732
|
+
$ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us --filter modified -k blt123
|
|
3157
733
|
|
|
734
|
+
$ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us --include-variants -k blt123
|
|
3158
735
|
|
|
3159
|
-
|
|
736
|
+
$ csdx cm:stacks:bulk-entries --retry-failed ./bulk-operation
|
|
3160
737
|
|
|
3161
|
-
cm:bulk-
|
|
738
|
+
$ csdx cm:stacks:bulk-entries --revert ./bulk-operation
|
|
3162
739
|
```
|
|
3163
740
|
|
|
3164
|
-
_See code: [@contentstack/cli-
|
|
741
|
+
_See code: [@contentstack/cli-bulk-operations](https://github.com/contentstack/cli-bulk-operations/blob/v1.0.0-beta/src/commands/cm/stacks/bulk-entries.ts)_
|
|
3165
742
|
|
|
3166
|
-
## `csdx cm:stacks:
|
|
743
|
+
## `csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
|
|
3167
744
|
|
|
3168
|
-
|
|
745
|
+
Export content from a stack
|
|
3169
746
|
|
|
3170
747
|
```
|
|
3171
748
|
USAGE
|
|
3172
|
-
$ csdx cm:stacks:
|
|
3173
|
-
[--
|
|
749
|
+
$ csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>]
|
|
750
|
+
[--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]
|
|
3174
751
|
|
|
3175
752
|
FLAGS
|
|
3176
|
-
-a, --alias=<value>
|
|
3177
|
-
-
|
|
3178
|
-
-
|
|
3179
|
-
|
|
3180
|
-
-
|
|
3181
|
-
-
|
|
3182
|
-
|
|
753
|
+
-a, --alias=<value> The management token alias of the source stack from which you will export content.
|
|
754
|
+
-c, --config=<value> [optional] Path of the config
|
|
755
|
+
-d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
|
|
756
|
+
./content
|
|
757
|
+
-k, --stack-api-key=<value> API Key of the source stack
|
|
758
|
+
-y, --yes [optional] Force override all Marketplace prompts.
|
|
759
|
+
--branch=<value> [optional] The name of the branch where you want to export your content. If you don't
|
|
760
|
+
mention the branch name, then by default the content will be exported from all the
|
|
761
|
+
branches of your stack.
|
|
762
|
+
--branch-alias=<value> (Optional) The alias of the branch from which you want to export content.
|
|
763
|
+
--content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
|
|
764
|
+
of multiple content types, specify the IDs separated by spaces.
|
|
765
|
+
--module=<value> [optional] Specific module name. If not specified, the export command will export all
|
|
766
|
+
the modules to the stack. The available modules are assets, content-types, entries,
|
|
767
|
+
environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
|
|
768
|
+
workflows, custom-roles, taxonomies, and studio.
|
|
769
|
+
--secured-assets [optional] Use this flag for assets that are secured.
|
|
3183
770
|
|
|
3184
771
|
DESCRIPTION
|
|
3185
|
-
|
|
3186
|
-
|
|
3187
|
-
ALIASES
|
|
3188
|
-
$ csdx cm:seed
|
|
772
|
+
Export content from a stack
|
|
3189
773
|
|
|
3190
774
|
EXAMPLES
|
|
3191
|
-
$ csdx cm:stacks:
|
|
775
|
+
$ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
3192
776
|
|
|
3193
|
-
$ csdx cm:stacks:
|
|
777
|
+
$ csdx cm:stacks:export --config <path/to/config/dir>
|
|
3194
778
|
|
|
3195
|
-
$ csdx cm:stacks:
|
|
779
|
+
$ csdx cm:stacks:export --alias <management_token_alias>
|
|
3196
780
|
|
|
3197
|
-
$ csdx cm:stacks:
|
|
781
|
+
$ csdx cm:stacks:export --alias <management_token_alias> --data-dir <path/to/export/destination/dir>
|
|
3198
782
|
|
|
3199
|
-
$ csdx cm:stacks:
|
|
783
|
+
$ csdx cm:stacks:export --alias <management_token_alias> --config <path/to/config/file>
|
|
784
|
+
|
|
785
|
+
$ csdx cm:stacks:export --module <single module name>
|
|
786
|
+
|
|
787
|
+
$ csdx cm:stacks:export --branch [optional] branch name
|
|
3200
788
|
```
|
|
3201
789
|
|
|
3202
|
-
_See code: [@contentstack/cli-cm-
|
|
790
|
+
_See code: [@contentstack/cli-cm-export](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/stacks/export.ts)_
|
|
3203
791
|
|
|
3204
|
-
## `csdx
|
|
792
|
+
## `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]`
|
|
3205
793
|
|
|
3206
|
-
|
|
794
|
+
Import content from a stack
|
|
3207
795
|
|
|
3208
796
|
```
|
|
3209
797
|
USAGE
|
|
3210
|
-
$ csdx cm:stacks:
|
|
3211
|
-
[--
|
|
3212
|
-
<value>] [--only-assets] [--only-entries]
|
|
798
|
+
$ csdx cm:stacks:import [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>]
|
|
799
|
+
[--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
|
|
3213
800
|
|
|
3214
801
|
FLAGS
|
|
3215
|
-
-
|
|
3216
|
-
|
|
3217
|
-
-c, --config=<value> Path to the config file
|
|
3218
|
-
-e, --environment=<value> Source Environment
|
|
3219
|
-
-k, --stack-api-key=<value> Stack API key to be used
|
|
3220
|
-
-l, --locale=<value> Locale filter
|
|
3221
|
-
-y, --yes Agree to process the command with the current configuration
|
|
3222
|
-
--api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
3223
|
-
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
3224
|
-
bulkpublish API will be used to unpublish the entries and assets
|
|
3225
|
-
--content-type=<value> Content type filter
|
|
3226
|
-
--delivery-token=<value> The delivery token of the source environment.
|
|
3227
|
-
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
802
|
+
-a, --alias=<value>
|
|
803
|
+
The management token of the destination stack where you will import the content.
|
|
3228
804
|
|
|
3229
|
-
|
|
3230
|
-
|
|
3231
|
-
The unpublish command is used to unpublish entries or assets from given environment
|
|
805
|
+
-c, --config=<value>
|
|
806
|
+
[optional] The path of the configuration JSON file containing all the options for a single run.
|
|
3232
807
|
|
|
3233
|
-
|
|
3234
|
-
|
|
808
|
+
-d, --data-dir=<value>
|
|
809
|
+
The path or the location in your file system where the content, you intend to import, is stored. For example, -d
|
|
810
|
+
"C:\Users\Name\Desktop\cli\content". If the export folder has branches involved, then the path should point till the
|
|
811
|
+
particular branch. For example, “-d "C:\Users\Name\Desktop\cli\content\branch_name"
|
|
3235
812
|
|
|
3236
|
-
|
|
3237
|
-
|
|
3238
|
-
then all entries from all content types will be unpublished from the source environment
|
|
813
|
+
-k, --stack-api-key=<value>
|
|
814
|
+
API Key of the target stack
|
|
3239
815
|
|
|
3240
|
-
|
|
3241
|
-
|
|
816
|
+
-y, --yes
|
|
817
|
+
[optional] Force override all Marketplace prompts.
|
|
3242
818
|
|
|
819
|
+
--backup-dir=<value>
|
|
820
|
+
[optional] Backup directory name when using specific module.
|
|
3243
821
|
|
|
3244
|
-
|
|
3245
|
-
|
|
822
|
+
--branch=<value>
|
|
823
|
+
The name of the branch where you want to import your content. If you don't mention the branch name, then by default
|
|
824
|
+
the content will be imported to the main branch.
|
|
3246
825
|
|
|
3247
|
-
|
|
3248
|
-
|
|
826
|
+
--branch-alias=<value>
|
|
827
|
+
Specify the branch alias where you want to import your content. If not specified, the content is imported into the
|
|
828
|
+
main branch by default.
|
|
829
|
+
|
|
830
|
+
--exclude-global-modules
|
|
831
|
+
Excludes the branch-independent module from the import operation.
|
|
3249
832
|
|
|
3250
|
-
|
|
833
|
+
--import-webhook-status=<option>
|
|
834
|
+
[default: disable] [default: disable] (optional) This webhook state keeps the same state of webhooks as the source
|
|
835
|
+
stack. <options: disable|current>
|
|
836
|
+
<options: disable|current>
|
|
3251
837
|
|
|
838
|
+
--module=<value>
|
|
839
|
+
[optional] Specify the module to import into the target stack. If not specified, the import command will import all
|
|
840
|
+
the modules into the stack. The available modules are assets, content-types, entries, environments, extensions,
|
|
841
|
+
marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, personalize projects,
|
|
842
|
+
taxonomies, and composable-studio.
|
|
3252
843
|
|
|
844
|
+
--personalize-project-name=<value>
|
|
845
|
+
(optional) Provide a unique name for the Personalize project.
|
|
3253
846
|
|
|
3254
|
-
|
|
847
|
+
--replace-existing
|
|
848
|
+
Replaces the existing module in the target stack.
|
|
3255
849
|
|
|
3256
|
-
|
|
850
|
+
--skip-assets-publish
|
|
851
|
+
Skips asset publishing during the import process.
|
|
3257
852
|
|
|
3258
|
-
|
|
853
|
+
--skip-audit
|
|
854
|
+
Skips the audit fix that occurs during an import operation.
|
|
855
|
+
|
|
856
|
+
--skip-entries-publish
|
|
857
|
+
Skips entry publishing during the import process
|
|
858
|
+
|
|
859
|
+
--skip-existing
|
|
860
|
+
Skips the module exists warning messages.
|
|
861
|
+
|
|
862
|
+
DESCRIPTION
|
|
863
|
+
Import content from a stack
|
|
3259
864
|
|
|
3260
|
-
|
|
865
|
+
EXAMPLES
|
|
866
|
+
$ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
|
|
3261
867
|
|
|
868
|
+
$ csdx cm:stacks:import --config <path/of/config/dir>
|
|
3262
869
|
|
|
870
|
+
$ csdx cm:stacks:import --module <single module name>
|
|
3263
871
|
|
|
3264
|
-
|
|
872
|
+
$ csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>
|
|
3265
873
|
|
|
3266
|
-
$ csdx cm:stacks:
|
|
874
|
+
$ csdx cm:stacks:import --alias <management_token_alias>
|
|
3267
875
|
|
|
876
|
+
$ csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>
|
|
3268
877
|
|
|
878
|
+
$ csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
|
|
3269
879
|
|
|
3270
|
-
|
|
880
|
+
$ csdx cm:stacks:import --branch <branch name> --yes --skip-audit
|
|
881
|
+
```
|
|
3271
882
|
|
|
3272
|
-
|
|
883
|
+
_See code: [@contentstack/cli-cm-import](https://github.com/contentstack/cli/blob/main/packages/contentstack-import/src/commands/cm/stacks/import.ts)_
|
|
3273
884
|
|
|
885
|
+
## `csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]`
|
|
3274
886
|
|
|
887
|
+
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
3275
888
|
|
|
3276
|
-
|
|
889
|
+
```
|
|
890
|
+
USAGE
|
|
891
|
+
$ csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
|
|
3277
892
|
|
|
3278
|
-
|
|
893
|
+
FLAGS
|
|
894
|
+
-a, --alias=<value> The management token of the destination stack where you will import the content.
|
|
895
|
+
-d, --data-dir=<value> The path or the location in your file system where the content, you intend to import, is
|
|
896
|
+
stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
|
|
897
|
+
branches involved, then the path should point till the particular branch. For example,
|
|
898
|
+
“-d "C:\Users\Name\Desktop\cli\content\branch_name"
|
|
899
|
+
-k, --stack-api-key=<value> API key of the target stack
|
|
900
|
+
--branch=<value> The name of the branch where you want to import your content. If you don't mention the
|
|
901
|
+
branch name, then by default the content will be imported to the main branch.
|
|
902
|
+
--branch-alias=<value> Specify the branch alias where you want to import your content. If not specified, the
|
|
903
|
+
content is imported into the main branch by default.
|
|
904
|
+
--module=<option>... [optional] Specify the modules/module to import into the target stack. currently options
|
|
905
|
+
are global-fields, content-types, entries
|
|
906
|
+
<options: global-fields|content-types|entries>
|
|
3279
907
|
|
|
908
|
+
DESCRIPTION
|
|
909
|
+
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
3280
910
|
|
|
911
|
+
EXAMPLES
|
|
912
|
+
$ 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>
|
|
913
|
+
```
|
|
3281
914
|
|
|
3282
|
-
|
|
915
|
+
_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)_
|
|
3283
916
|
|
|
3284
|
-
|
|
917
|
+
## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes <value>] [--alias <value>] [--locale <value>]`
|
|
3285
918
|
|
|
3286
|
-
|
|
919
|
+
Create a stack from existing content types, entries, assets, etc
|
|
3287
920
|
|
|
921
|
+
```
|
|
922
|
+
USAGE
|
|
923
|
+
$ csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes
|
|
924
|
+
<value>] [--alias <value>] [--locale <value>]
|
|
3288
925
|
|
|
926
|
+
FLAGS
|
|
927
|
+
-a, --alias=<value> Alias of the management token
|
|
928
|
+
-k, --stack-api-key=<value> Provide stack API key to seed content to
|
|
929
|
+
-n, --stack-name=<value> Name of a new stack that needs to be created.
|
|
930
|
+
-y, --yes=<value> [Optional] Skip the stack confirmation.
|
|
931
|
+
--org=<value> Provide Organization UID to create a new stack
|
|
932
|
+
--repo=<value> GitHub organization name or GitHub user name/repository name.
|
|
3289
933
|
|
|
3290
|
-
|
|
934
|
+
DESCRIPTION
|
|
935
|
+
Create a stack from existing content types, entries, assets, etc
|
|
3291
936
|
|
|
3292
|
-
|
|
937
|
+
EXAMPLES
|
|
938
|
+
$ csdx cm:stacks:seed
|
|
3293
939
|
|
|
940
|
+
$ csdx cm:stacks:seed --repo "account"
|
|
3294
941
|
|
|
942
|
+
$ csdx cm:stacks:seed --repo "account/repository"
|
|
3295
943
|
|
|
3296
|
-
|
|
944
|
+
$ csdx cm:stacks:seed --repo "account/repository" --stack-api-key "stack-api-key" //seed content into specific stack
|
|
3297
945
|
|
|
3298
|
-
$ csdx cm:stacks:
|
|
946
|
+
$ csdx cm:stacks:seed --repo "account/repository" --org "your-org-uid" --stack-name "stack-name" //create a new stack in given org uid
|
|
3299
947
|
```
|
|
3300
948
|
|
|
3301
|
-
_See code: [@contentstack/cli-cm-
|
|
949
|
+
_See code: [@contentstack/cli-cm-seed](https://github.com/contentstack/cli/blob/main/packages/contentstack-seed/src/commands/cm/stacks/seed.ts)_
|
|
3302
950
|
|
|
3303
951
|
## `csdx config:get:base-branch`
|
|
3304
952
|
|
|
@@ -3372,6 +1020,23 @@ EXAMPLES
|
|
|
3372
1020
|
|
|
3373
1021
|
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/log.ts)_
|
|
3374
1022
|
|
|
1023
|
+
## `csdx config:get:proxy`
|
|
1024
|
+
|
|
1025
|
+
Get proxy configuration for CLI
|
|
1026
|
+
|
|
1027
|
+
```
|
|
1028
|
+
USAGE
|
|
1029
|
+
$ csdx config:get:proxy
|
|
1030
|
+
|
|
1031
|
+
DESCRIPTION
|
|
1032
|
+
Get proxy configuration for CLI
|
|
1033
|
+
|
|
1034
|
+
EXAMPLES
|
|
1035
|
+
$ csdx config:get:proxy
|
|
1036
|
+
```
|
|
1037
|
+
|
|
1038
|
+
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/proxy.ts)_
|
|
1039
|
+
|
|
3375
1040
|
## `csdx config:get:rate-limit`
|
|
3376
1041
|
|
|
3377
1042
|
Get rate-limit of organizations
|
|
@@ -3481,6 +1146,23 @@ EXAMPLES
|
|
|
3481
1146
|
|
|
3482
1147
|
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/remove/early-access-header.ts)_
|
|
3483
1148
|
|
|
1149
|
+
## `csdx config:remove:proxy`
|
|
1150
|
+
|
|
1151
|
+
Remove proxy configuration from global config
|
|
1152
|
+
|
|
1153
|
+
```
|
|
1154
|
+
USAGE
|
|
1155
|
+
$ csdx config:remove:proxy
|
|
1156
|
+
|
|
1157
|
+
DESCRIPTION
|
|
1158
|
+
Remove proxy configuration from global config
|
|
1159
|
+
|
|
1160
|
+
EXAMPLES
|
|
1161
|
+
$ csdx config:remove:proxy
|
|
1162
|
+
```
|
|
1163
|
+
|
|
1164
|
+
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/remove/proxy.ts)_
|
|
1165
|
+
|
|
3484
1166
|
## `csdx config:remove:rate-limit`
|
|
3485
1167
|
|
|
3486
1168
|
Remove rate-limit of the organization
|
|
@@ -3612,6 +1294,34 @@ EXAMPLES
|
|
|
3612
1294
|
|
|
3613
1295
|
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/log.ts)_
|
|
3614
1296
|
|
|
1297
|
+
## `csdx config:set:proxy`
|
|
1298
|
+
|
|
1299
|
+
Set proxy configuration for CLI
|
|
1300
|
+
|
|
1301
|
+
```
|
|
1302
|
+
USAGE
|
|
1303
|
+
$ csdx config:set:proxy --host <value> --port <value> --protocol http|https [--username <value>]
|
|
1304
|
+
|
|
1305
|
+
FLAGS
|
|
1306
|
+
--host=<value> (required) Proxy host address
|
|
1307
|
+
--port=<value> (required) Proxy port number
|
|
1308
|
+
--protocol=<option> (required) [default: http] Proxy protocol (http or https)
|
|
1309
|
+
<options: http|https>
|
|
1310
|
+
--username=<value> Proxy username (optional)
|
|
1311
|
+
|
|
1312
|
+
DESCRIPTION
|
|
1313
|
+
Set proxy configuration for CLI
|
|
1314
|
+
|
|
1315
|
+
EXAMPLES
|
|
1316
|
+
$ csdx config:set:proxy --host 127.0.0.1 --port 3128
|
|
1317
|
+
|
|
1318
|
+
$ csdx config:set:proxy --host proxy.example.com --port 8080 --protocol https
|
|
1319
|
+
|
|
1320
|
+
$ csdx config:set:proxy --host proxy.example.com --port 8080 --username user
|
|
1321
|
+
```
|
|
1322
|
+
|
|
1323
|
+
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/proxy.ts)_
|
|
1324
|
+
|
|
3615
1325
|
## `csdx config:set:rate-limit`
|
|
3616
1326
|
|
|
3617
1327
|
Set rate-limit for CLI
|
|
@@ -3645,21 +1355,22 @@ Set region for CLI
|
|
|
3645
1355
|
|
|
3646
1356
|
```
|
|
3647
1357
|
USAGE
|
|
3648
|
-
$ csdx config:set:region [REGION] [
|
|
3649
|
-
[--personalize <value>] [--launch <value>]
|
|
1358
|
+
$ csdx config:set:region [REGION] [--cda <value> --cma <value> --ui-host <value> -n <value>] [--developer-hub
|
|
1359
|
+
<value>] [--personalize <value>] [--launch <value>] [--studio <value>]
|
|
3650
1360
|
|
|
3651
1361
|
ARGUMENTS
|
|
3652
|
-
REGION Name for the region
|
|
1362
|
+
[REGION] Name for the region
|
|
3653
1363
|
|
|
3654
1364
|
FLAGS
|
|
3655
|
-
-
|
|
1365
|
+
-n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are required
|
|
1366
|
+
--cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host and
|
|
3656
1367
|
name flags are required
|
|
3657
|
-
|
|
1368
|
+
--cma=<value> Custom host to set for content management API, , if this flag is added then cda, ui-host
|
|
3658
1369
|
and name flags are required
|
|
3659
|
-
-n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are required
|
|
3660
1370
|
--developer-hub=<value> Custom host to set for Developer hub API
|
|
3661
1371
|
--launch=<value> Custom host to set for Launch API
|
|
3662
1372
|
--personalize=<value> Custom host to set for Personalize API
|
|
1373
|
+
--studio=<value> Custom host to set for Studio API
|
|
3663
1374
|
--ui-host=<value> Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
|
|
3664
1375
|
required
|
|
3665
1376
|
|
|
@@ -3691,7 +1402,9 @@ EXAMPLES
|
|
|
3691
1402
|
|
|
3692
1403
|
$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --launch <custom_launch_url>
|
|
3693
1404
|
|
|
3694
|
-
$ csdx config:set:region --
|
|
1405
|
+
$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --studio <custom_studio_url>
|
|
1406
|
+
|
|
1407
|
+
$ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url> --studio <custom_studio_url>
|
|
3695
1408
|
```
|
|
3696
1409
|
|
|
3697
1410
|
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/region.ts)_
|
|
@@ -3705,7 +1418,7 @@ USAGE
|
|
|
3705
1418
|
$ csdx help [COMMAND...] [-n]
|
|
3706
1419
|
|
|
3707
1420
|
ARGUMENTS
|
|
3708
|
-
COMMAND... Command to show help for.
|
|
1421
|
+
[COMMAND...] Command to show help for.
|
|
3709
1422
|
|
|
3710
1423
|
FLAGS
|
|
3711
1424
|
-n, --nested-commands Include all nested commands in the output.
|
|
@@ -3714,7 +1427,7 @@ DESCRIPTION
|
|
|
3714
1427
|
Display help for csdx.
|
|
3715
1428
|
```
|
|
3716
1429
|
|
|
3717
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.
|
|
1430
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.37/src/commands/help.ts)_
|
|
3718
1431
|
|
|
3719
1432
|
## `csdx launch`
|
|
3720
1433
|
|
|
@@ -3726,33 +1439,33 @@ USAGE
|
|
|
3726
1439
|
React App)|CSR (Client-Side Rendered)|Angular|Nuxt|VueJs|Remix|Other] [--org <value>] [-n <value>] [-e <value>]
|
|
3727
1440
|
[--branch <value>] [--build-command <value>] [--out-dir <value>] [--server-command <value>] [--variable-type Import
|
|
3728
1441
|
variables from a stack|Manually add custom variables to the list|Import variables from the .env.local file|Skip
|
|
3729
|
-
adding environment variables] [-a <value>] [--env-variables <value>] [--redeploy-latest] [--redeploy-last-upload]
|
|
3730
|
-
|
|
3731
|
-
FLAGS
|
|
3732
|
-
-a, --alias=<value>
|
|
3733
|
-
-c, --config=<value>
|
|
3734
|
-
-d, --data-dir=<value>
|
|
3735
|
-
-e, --environment=<value>
|
|
3736
|
-
-n, --name=<value>
|
|
3737
|
-
--branch=<value>
|
|
3738
|
-
--build-command=<value>
|
|
3739
|
-
--env-variables=<value>
|
|
3740
|
-
|
|
3741
|
-
--framework=<option>
|
|
3742
|
-
|
|
3743
|
-
|
|
3744
|
-
--org=<value>
|
|
3745
|
-
--out-dir=<value>
|
|
3746
|
-
--redeploy-last-upload
|
|
3747
|
-
--redeploy-latest
|
|
3748
|
-
--server-command=<value>
|
|
3749
|
-
--type=<option>
|
|
3750
|
-
|
|
3751
|
-
--variable-type=<option
|
|
3752
|
-
|
|
3753
|
-
|
|
3754
|
-
|
|
3755
|
-
|
|
1442
|
+
adding environment variables...] [-a <value>] [--env-variables <value>] [--redeploy-latest] [--redeploy-last-upload]
|
|
1443
|
+
|
|
1444
|
+
FLAGS
|
|
1445
|
+
-a, --alias=<value> [optional] Alias (name) for the delivery token.
|
|
1446
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
1447
|
+
-d, --data-dir=<value> Current working directory
|
|
1448
|
+
-e, --environment=<value> [optional] Environment name for the Launch project.
|
|
1449
|
+
-n, --name=<value> [optional] Name of the project.
|
|
1450
|
+
--branch=<value> [optional] GitHub branch name.
|
|
1451
|
+
--build-command=<value> [optional] Build Command.
|
|
1452
|
+
--env-variables=<value> [optional] Provide the environment variables in the key:value format, separated by
|
|
1453
|
+
comma. For example: APP_ENV:prod, TEST_ENV:testVal.
|
|
1454
|
+
--framework=<option> [optional] Type of framework. <options: Gatsby|NextJS|Other>
|
|
1455
|
+
<options: Gatsby|NextJs|CRA (Create React App)|CSR (Client-Side
|
|
1456
|
+
Rendered)|Angular|Nuxt|VueJs|Remix|Other>
|
|
1457
|
+
--org=<value> [optional] Provide the organization UID to create a new project or deployment.
|
|
1458
|
+
--out-dir=<value> [optional] Output Directory.
|
|
1459
|
+
--redeploy-last-upload [optional] Redeploy with last file upload
|
|
1460
|
+
--redeploy-latest [optional] Redeploy latest commit/code
|
|
1461
|
+
--server-command=<value> [optional] Server Command.
|
|
1462
|
+
--type=<option> [optional] Type of adapters. <options: GitHub|FileUpload>
|
|
1463
|
+
<options: GitHub|FileUpload>
|
|
1464
|
+
--variable-type=<option>... [optional] Provide a variable type (can specify multiple times). <options: Import
|
|
1465
|
+
variables from a stack|Manually add custom variables to the list|Import variables
|
|
1466
|
+
from the .env.local file|Skip adding environment variables>
|
|
1467
|
+
<options: Import variables from a stack|Manually add custom variables to the
|
|
1468
|
+
list|Import variables from the .env.local file|Skip adding environment variables>
|
|
3756
1469
|
|
|
3757
1470
|
DESCRIPTION
|
|
3758
1471
|
Launch related operations
|
|
@@ -3783,6 +1496,8 @@ EXAMPLES
|
|
|
3783
1496
|
$ 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>
|
|
3784
1497
|
|
|
3785
1498
|
$ 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"
|
|
1499
|
+
|
|
1500
|
+
$ 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>
|
|
3786
1501
|
```
|
|
3787
1502
|
|
|
3788
1503
|
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/index.ts)_
|
|
@@ -3855,7 +1570,7 @@ USAGE
|
|
|
3855
1570
|
$ csdx launch:functions [-p <value>] [-d <value>]
|
|
3856
1571
|
|
|
3857
1572
|
FLAGS
|
|
3858
|
-
-d, --data-dir=<value>
|
|
1573
|
+
-d, --data-dir=<value> Current working directory
|
|
3859
1574
|
-p, --port=<value> [default: 3000] Port number
|
|
3860
1575
|
|
|
3861
1576
|
DESCRIPTION
|
|
@@ -4031,7 +1746,7 @@ EXAMPLES
|
|
|
4031
1746
|
$ csdx plugins
|
|
4032
1747
|
```
|
|
4033
1748
|
|
|
4034
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
1749
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/index.ts)_
|
|
4035
1750
|
|
|
4036
1751
|
## `csdx plugins:add PLUGIN`
|
|
4037
1752
|
|
|
@@ -4105,7 +1820,7 @@ EXAMPLES
|
|
|
4105
1820
|
$ csdx plugins:inspect myplugin
|
|
4106
1821
|
```
|
|
4107
1822
|
|
|
4108
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
1823
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/inspect.ts)_
|
|
4109
1824
|
|
|
4110
1825
|
## `csdx plugins:install PLUGIN`
|
|
4111
1826
|
|
|
@@ -4154,7 +1869,7 @@ EXAMPLES
|
|
|
4154
1869
|
$ csdx plugins:install someuser/someplugin
|
|
4155
1870
|
```
|
|
4156
1871
|
|
|
4157
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
1872
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/install.ts)_
|
|
4158
1873
|
|
|
4159
1874
|
## `csdx plugins:link PATH`
|
|
4160
1875
|
|
|
@@ -4185,7 +1900,7 @@ EXAMPLES
|
|
|
4185
1900
|
$ csdx plugins:link myplugin
|
|
4186
1901
|
```
|
|
4187
1902
|
|
|
4188
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
1903
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/link.ts)_
|
|
4189
1904
|
|
|
4190
1905
|
## `csdx plugins:remove [PLUGIN]`
|
|
4191
1906
|
|
|
@@ -4196,7 +1911,7 @@ USAGE
|
|
|
4196
1911
|
$ csdx plugins:remove [PLUGIN...] [-h] [-v]
|
|
4197
1912
|
|
|
4198
1913
|
ARGUMENTS
|
|
4199
|
-
PLUGIN... plugin to uninstall
|
|
1914
|
+
[PLUGIN...] plugin to uninstall
|
|
4200
1915
|
|
|
4201
1916
|
FLAGS
|
|
4202
1917
|
-h, --help Show CLI help.
|
|
@@ -4226,7 +1941,7 @@ FLAGS
|
|
|
4226
1941
|
--reinstall Reinstall all plugins after uninstalling.
|
|
4227
1942
|
```
|
|
4228
1943
|
|
|
4229
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
1944
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/reset.ts)_
|
|
4230
1945
|
|
|
4231
1946
|
## `csdx plugins:uninstall [PLUGIN]`
|
|
4232
1947
|
|
|
@@ -4237,7 +1952,7 @@ USAGE
|
|
|
4237
1952
|
$ csdx plugins:uninstall [PLUGIN...] [-h] [-v]
|
|
4238
1953
|
|
|
4239
1954
|
ARGUMENTS
|
|
4240
|
-
PLUGIN... plugin to uninstall
|
|
1955
|
+
[PLUGIN...] plugin to uninstall
|
|
4241
1956
|
|
|
4242
1957
|
FLAGS
|
|
4243
1958
|
-h, --help Show CLI help.
|
|
@@ -4254,7 +1969,7 @@ EXAMPLES
|
|
|
4254
1969
|
$ csdx plugins:uninstall myplugin
|
|
4255
1970
|
```
|
|
4256
1971
|
|
|
4257
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
1972
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/uninstall.ts)_
|
|
4258
1973
|
|
|
4259
1974
|
## `csdx plugins:unlink [PLUGIN]`
|
|
4260
1975
|
|
|
@@ -4265,7 +1980,7 @@ USAGE
|
|
|
4265
1980
|
$ csdx plugins:unlink [PLUGIN...] [-h] [-v]
|
|
4266
1981
|
|
|
4267
1982
|
ARGUMENTS
|
|
4268
|
-
PLUGIN... plugin to uninstall
|
|
1983
|
+
[PLUGIN...] plugin to uninstall
|
|
4269
1984
|
|
|
4270
1985
|
FLAGS
|
|
4271
1986
|
-h, --help Show CLI help.
|
|
@@ -4298,7 +2013,7 @@ DESCRIPTION
|
|
|
4298
2013
|
Update installed plugins.
|
|
4299
2014
|
```
|
|
4300
2015
|
|
|
4301
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
2016
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/update.ts)_
|
|
4302
2017
|
|
|
4303
2018
|
## `csdx tokens`
|
|
4304
2019
|
|