@contentstack/cli 2.0.0-beta.2 → 2.0.0-beta.21

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.
Files changed (14) hide show
  1. package/LICENSE +1 -1
  2. package/README.md +491 -2491
  3. package/lib/hooks/init/context-init.js +5 -0
  4. package/lib/hooks/init/utils-init.d.ts +1 -1
  5. package/lib/hooks/init/utils-init.js +2 -1
  6. package/lib/hooks/prerun/auth-guard.js +8 -10
  7. package/lib/hooks/prerun/init-context-for-command.d.ts +11 -0
  8. package/lib/hooks/prerun/init-context-for-command.js +22 -0
  9. package/lib/hooks/prerun/latest-version-warning.js +7 -4
  10. package/lib/interfaces/index.d.ts +1 -1
  11. package/oclif.manifest.json +1 -1
  12. package/package.json +49 -48
  13. package/lib/hooks/prerun/command-deprecation-check.d.ts +0 -1
  14. 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.2 linux-x64 node-v22.21.1
21
+ @contentstack/cli/2.0.0-beta.21 linux-x64 node-v22.22.2
22
22
  $ csdx --help [COMMAND]
23
23
  USAGE
24
24
  $ csdx COMMAND
@@ -29,76 +29,48 @@ 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
44
  * [`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
45
  * [`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
46
  * [`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
47
  * [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
76
48
  * [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
49
+ * [`csdx cm:stacks:bulk-assets`](#csdx-cmstacksbulk-assets)
50
+ * [`csdx cm:stacks:bulk-entries`](#csdx-cmstacksbulk-entries)
77
51
  * [`csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent)
78
- * [`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)
79
- * [`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)
52
+ * [`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)
53
+ * [`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
54
  * [`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
55
  * [`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)
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)
56
+ * [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [-y] [--alias <value>] [--locale <value>]`](#csdx-cmstacksseed---repo-value---org-value---stack-api-key-value---stack-name-value--y---alias-value---locale-value)
88
57
  * [`csdx config:get:base-branch`](#csdx-configgetbase-branch)
89
58
  * [`csdx config:get:ea-header`](#csdx-configgetea-header)
90
59
  * [`csdx config:get:early-access-header`](#csdx-configgetearly-access-header)
91
60
  * [`csdx config:get:log`](#csdx-configgetlog)
61
+ * [`csdx config:get:proxy`](#csdx-configgetproxy)
92
62
  * [`csdx config:get:rate-limit`](#csdx-configgetrate-limit)
93
63
  * [`csdx config:get:region`](#csdx-configgetregion)
94
64
  * [`csdx config:remove:base-branch`](#csdx-configremovebase-branch)
95
65
  * [`csdx config:remove:ea-header`](#csdx-configremoveea-header)
96
66
  * [`csdx config:remove:early-access-header`](#csdx-configremoveearly-access-header)
67
+ * [`csdx config:remove:proxy`](#csdx-configremoveproxy)
97
68
  * [`csdx config:remove:rate-limit`](#csdx-configremoverate-limit)
98
69
  * [`csdx config:set:base-branch`](#csdx-configsetbase-branch)
99
70
  * [`csdx config:set:ea-header`](#csdx-configsetea-header)
100
71
  * [`csdx config:set:early-access-header`](#csdx-configsetearly-access-header)
101
72
  * [`csdx config:set:log`](#csdx-configsetlog)
73
+ * [`csdx config:set:proxy`](#csdx-configsetproxy)
102
74
  * [`csdx config:set:rate-limit`](#csdx-configsetrate-limit)
103
75
  * [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
104
76
  * [`csdx help [COMMAND]`](#csdx-help-command)
@@ -123,113 +95,6 @@ USAGE
123
95
  * [`csdx tokens`](#csdx-tokens)
124
96
  * [`csdx whoami`](#csdx-whoami)
125
97
 
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
98
  ## `csdx auth:login`
234
99
 
235
100
  User sessions login
@@ -331,12 +196,12 @@ USAGE
331
196
 
332
197
  FLAGS
333
198
  -a, --alias=<value> Alias (name) you want to assign to the token
334
- -d, --delivery Set this flag to save delivery token
335
199
  -e, --environment=<value> Environment name for delivery token
336
200
  -k, --stack-api-key=<value> Stack API Key
337
- -m, --management Set this flag to save management token
338
- -t, --token=<value> [env: TOKEN] Add the token name
339
201
  -y, --yes Use this flag to skip confirmation
202
+ --delivery Set this flag to save delivery token
203
+ --management Set this flag to save management token
204
+ --token=<value> [env: TOKEN] Add the token name
340
205
 
341
206
  DESCRIPTION
342
207
  Adds management/delivery tokens to your session to use it with other CLI commands
@@ -410,181 +275,20 @@ EXAMPLES
410
275
 
411
276
  _See code: [@contentstack/cli-auth](https://github.com/contentstack/cli/blob/main/packages/contentstack-auth/src/commands/auth/whoami.ts)_
412
277
 
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
278
  ## `csdx cm:bootstrap`
575
279
 
576
280
  Bootstrap contentstack apps
577
281
 
578
282
  ```
579
283
  USAGE
580
- $ csdx cm:bootstrap [--app-name <value>] [--project-dir <value>] [-k <value> | --org <value> | -n <value>] [-y
581
- <value>] [--run-dev-server] [-a <value>]
284
+ $ csdx cm:bootstrap [--app-name <value>] [--project-dir <value>] [-k <value> | --org <value> | -n <value>] [-y]
285
+ [--run-dev-server] [-a <value>]
582
286
 
583
287
  FLAGS
584
288
  -a, --alias=<value> Alias of the management token
585
289
  -k, --stack-api-key=<value> Provide stack API key to seed content
586
290
  -n, --stack-name=<value> Name of the new stack that will be created.
587
- -y, --yes=<value> [Optional] Skip stack confirmation
291
+ -y, --yes [Optional] Skip stack confirmation
588
292
  --app-name=<value> App name, kickstart-next, kickstart-next-ssr, kickstart-next-ssg, kickstart-next-graphql,
589
293
  kickstart-next-middleware, kickstart-nuxt, kickstart-nuxt-ssr
590
294
  --org=<value> Provide organization UID to create a new stack
@@ -788,1834 +492,151 @@ EXAMPLES
788
492
 
789
493
  _See code: [@contentstack/cli-cm-branches](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/merge.ts)_
790
494
 
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>]`
495
+ ## `csdx cm:export-to-csv`
806
496
 
807
- Add fields from updated content types to their respective entries
497
+ Export entries, taxonomies, terms or organization users to csv using this command
808
498
 
809
499
  ```
810
500
  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>]
501
+ $ csdx cm:export-to-csv [--action entries|users|teams|taxonomies] [-a <value>] [--org <value>] [-n <value>] [-k
502
+ <value>] [--org-name <value>] [--locale <value>] [--content-type <value>] [--branch <value>] [--team-uid <value>]
503
+ [--taxonomy-uid <value>] [--include-fallback] [--fallback-locale <value>] [--delimiter <value>]
813
504
 
814
505
  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.
506
+ -a, --alias=<value> Alias of the management token.
507
+ -k, --stack-api-key=<value> API Key of the source stack.
508
+ -n, --stack-name=<value> Name of the stack that needs to be created as CSV filename.
509
+ --action=<option> Option to export data (entries, users, teams, taxonomies). <options:
510
+ entries|users|teams|taxonomies>
511
+ <options: entries|users|teams|taxonomies>
512
+ --branch=<value> Branch from which entries will be exported.
513
+ --content-type=<value> Content type of entries that will be exported.
514
+ --delimiter=<value> [default: ,] [optional] Provide a delimiter to separate individual data fields within
515
+ the CSV file. For example: cm:export-to-csv --delimiter '|'
516
+ --fallback-locale=<value> [Optional] Specify a specific fallback locale for taxonomy export. This locale will be
517
+ used when a taxonomy term doesn't exist in the primary locale. Takes priority over
518
+ branch fallback hierarchy when both are specified.
519
+ --include-fallback [Optional] Include fallback locale data when exporting taxonomies. When enabled, if a
520
+ taxonomy term doesn't exist in the specified locale, it will fallback to the hierarchy
521
+ defined in the branch settings.
522
+ --locale=<value> Locale of entries that will be exported.
523
+ --org=<value> Provide organization UID to clone org users.
524
+ --org-name=<value> Name of the organization that needs to be created as CSV filename.
525
+ --taxonomy-uid=<value> Provide the taxonomy UID of the related terms you want to export.
526
+ --team-uid=<value> Provide the UID of a specific team in an organization.
839
527
 
840
528
  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
-
529
+ Export entries, taxonomies, terms or organization users to csv using this command
848
530
 
849
531
  ALIASES
850
- $ csdx cm:bulk-publish:add-fields
532
+ $ csdx cm:export-to-csv
851
533
 
852
534
  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
- ```
535
+ $ csdx cm:export-to-csv
885
536
 
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
537
 
888
- Publish assets to the specified environments
889
538
 
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>]
539
+ Exporting entries to CSV
895
540
 
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
541
+ $ csdx cm:export-to-csv --action entries --locale <locale> --alias <management-token-alias> --content-type <content-type>
921
542
 
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
543
 
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
544
 
545
+ Exporting entries to CSV with stack name and branch
929
546
 
930
- ALIASES
931
- $ csdx cm:bulk-publish:assets
547
+ $ csdx cm:export-to-csv --action entries --locale <locale> --alias <management-token-alias> --content-type <content-type> --stack-name <stack-name> --branch <branch-name>
932
548
 
933
- EXAMPLES
934
- General Usage
935
549
 
936
- $ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]
937
550
 
551
+ Exporting organization users to CSV
938
552
 
553
+ $ csdx cm:export-to-csv --action users --org <org-uid>
939
554
 
940
- Using --config or -c flag
941
555
 
942
- Generate a config file at the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
943
556
 
944
- $ csdx cm:assets:publish --config [PATH TO CONFIG FILE]
557
+ Exporting organization teams to CSV
945
558
 
946
- $ csdx cm:assets:publish -c [PATH TO CONFIG FILE]
559
+ $ csdx cm:export-to-csv --action teams --org <org-uid>
947
560
 
948
561
 
949
562
 
950
- Using --retry-failed flag
563
+ Exporting teams with specific team UID
951
564
 
952
- $ csdx cm:assets:publish --retry-failed [LOG FILE NAME]
565
+ $ csdx cm:export-to-csv --action teams --org <org-uid> --team-uid <team-uid>
953
566
 
954
567
 
955
568
 
956
- Using --branch flag
569
+ Exporting taxonomies to CSV
957
570
 
958
- $ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
571
+ $ csdx cm:export-to-csv --action taxonomies --alias <management-token-alias>
959
572
 
960
573
 
961
574
 
962
- Using --source-env
575
+ Exporting specific taxonomy with locale
963
576
 
964
- $ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN]
577
+ $ csdx cm:export-to-csv --action taxonomies --alias <management-token-alias> --taxonomy-uid <taxonomy-uid> --locale <locale>
965
578
 
966
579
 
967
580
 
968
- Using --stack-api-key flag
581
+ Exporting taxonomies with fallback locale
969
582
 
970
- $ csdx cm:assets:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --stack-api-key [STACK API KEY]
583
+ $ csdx cm:export-to-csv --action taxonomies --alias <management-token-alias> --locale <locale> --include-fallback --fallback-locale <fallback-locale>
971
584
  ```
972
585
 
973
- ## `csdx cm:bulk-publish:clear`
586
+ _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.ts)_
587
+
588
+ ## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
974
589
 
975
- Clear the log folder
590
+ Contentstack migration script.
976
591
 
977
592
  ```
978
593
  USAGE
979
- $ csdx cm:bulk-publish:clear [--log-files-count] [-y]
594
+ $ csdx cm:migration cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>]
595
+ [--config-file <value>] [--config <value>] [--multiple]
980
596
 
981
597
  FLAGS
982
- -y, --yes Delete all files without asking for confirmation
983
- --log-files-count List number of log files
598
+ -a, --alias=<value> Use this flag to add the management token alias. You must use either the --alias flag or
599
+ the --stack-api-key flag.
600
+ -k, --stack-api-key=<value> Use this flag to add the API key of your stack. You must use either the --stack-api-key
601
+ flag or the --alias flag.
602
+ --branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
603
+ branch name)
604
+ --config=<value>... [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
605
+ the script re-usable.
606
+ --config-file=<value> [optional] Path of the JSON configuration file.
607
+ --file-path=<value> Use this flag to provide the path of the file of the migration script.
608
+ --multiple This flag helps you to migrate multiple content files in a single instance. Mention the
609
+ folder path where your migration script files are stored.
984
610
 
985
611
  DESCRIPTION
986
- Clear the log folder
612
+ Contentstack migration script.
987
613
 
988
614
  ALIASES
989
- $ csdx cm:bulk-publish:clear
615
+ $ csdx cm:migration
990
616
 
991
617
  EXAMPLES
992
- $ csdx cm:stacks:publish-clear-logs
618
+ $ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>
619
+
620
+ $ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>
993
621
 
994
- $ csdx cm:stacks:publish-clear-logs --log-files-count
622
+ $ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>
623
+
624
+ $ csdx cm:migration --config-file <path/to/json/config/file> --file-path <migration/script/file/path>
995
625
 
996
- $ csdx cm:stacks:publish-clear-logs --yes
626
+ $ csdx cm:migration --multiple --file-path <migration/scripts/dir/path>
997
627
 
998
- $ csdx cm:stacks:publish-clear-logs -y
628
+ $ csdx cm:migration --alias <management-token-alias> --file-path <migration/script/file/path>
999
629
  ```
1000
630
 
1001
- ## `csdx cm:bulk-publish:configure`
631
+ ## `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]`
1002
632
 
1003
- The configure command is used to generate a configuration file for publish scripts.
633
+ Clone data (structure/content or both) of a stack into another stack
1004
634
 
1005
635
  ```
1006
636
  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>] [--include-fallback] [--fallback-locale <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
2253
- the CSV file. For example: cm:export-to-csv --delimiter '|'
2254
- --fallback-locale=<value> [Optional] Specify a specific fallback locale for taxonomy export. This locale will be
2255
- used when a taxonomy term doesn't exist in the primary locale. Takes priority over
2256
- branch fallback hierarchy when both are specified.
2257
- --include-fallback [Optional] Include fallback locale data when exporting taxonomies. When enabled, if a
2258
- taxonomy term doesn't exist in the specified locale, it will fallback to the hierarchy
2259
- defined in the branch settings.
2260
- --locale=<value> Locale of entries that will be exported.
2261
- --org=<value> Provide organization UID to clone org users.
2262
- --org-name=<value> Name of the organization that needs to be created as CSV filename.
2263
- --taxonomy-uid=<value> Provide the taxonomy UID of the related terms you want to export.
2264
- --team-uid=<value> Provide the UID of a specific team in an organization.
2265
-
2266
- DESCRIPTION
2267
- Export entries, taxonomies, terms or organization users to csv using this command
2268
-
2269
- EXAMPLES
2270
- $ csdx cm:export-to-csv
2271
-
2272
-
2273
-
2274
- Exporting entries to CSV
2275
-
2276
- $ csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type>
2277
-
2278
-
2279
-
2280
- Exporting entries to CSV with stack name provided and branch name provided
2281
-
2282
- $ csdx cm:export-to-csv --action <entries> --locale <locale> --alias <management-token-alias> --content-type <content-type> --stack-name <stack-name> --branch <branch-name>
2283
-
2284
-
2285
-
2286
- Exporting organization users to CSV
2287
-
2288
- $ csdx cm:export-to-csv --action <users> --org <org-uid>
2289
-
2290
-
2291
-
2292
- Exporting organization users to CSV with organization name provided
2293
-
2294
- $ csdx cm:export-to-csv --action <users> --org <org-uid> --org-name <org-name>
2295
-
2296
-
2297
-
2298
- Exporting organization teams to CSV
2299
-
2300
- $ csdx cm:export-to-csv --action <teams>
2301
-
2302
-
2303
-
2304
- Exporting organization teams to CSV with org UID
2305
-
2306
- $ csdx cm:export-to-csv --action <teams> --org <org-uid>
2307
-
2308
-
2309
-
2310
- Exporting organization teams to CSV with team UID
2311
-
2312
- $ csdx cm:export-to-csv --action <teams> --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>
2319
-
2320
-
2321
-
2322
- Exporting organization teams to CSV with org UID and team UID
2323
-
2324
- $ csdx cm:export-to-csv --action <teams> --org <org-uid> --team-uid <team-uid> --org-name <org-name>
2325
-
2326
-
2327
-
2328
- Exporting taxonomies and related terms to a .CSV file with the provided taxonomy UID
2329
-
2330
- $ csdx cm:export-to-csv --action <taxonomies> --alias <management-token-alias> --taxonomy-uid <taxonomy-uid>
2331
-
2332
-
2333
-
2334
- Exporting taxonomies and respective terms to a .CSV file
2335
-
2336
- $ csdx cm:export-to-csv --action <taxonomies> --alias <management-token-alias>
2337
-
2338
-
2339
-
2340
- Exporting taxonomies and respective terms to a .CSV file with a delimiter
2341
-
2342
- $ csdx cm:export-to-csv --action <taxonomies> --alias <management-token-alias> --delimiter <delimiter>
2343
-
2344
-
2345
-
2346
- Exporting taxonomies with specific locale
2347
-
2348
- $ csdx cm:export-to-csv --action <taxonomies> --alias <management-token-alias> --locale <locale>
2349
-
2350
-
2351
-
2352
- Exporting taxonomies with fallback locale support
2353
-
2354
- $ csdx cm:export-to-csv --action <taxonomies> --alias <management-token-alias> --locale <locale> --include-fallback
2355
-
2356
-
2357
-
2358
- Exporting taxonomies with custom fallback locale
2359
-
2360
- $ csdx cm:export-to-csv --action <taxonomies> --alias <management-token-alias> --locale <locale> --include-fallback --fallback-locale <fallback-locale>
2361
- ```
2362
-
2363
- _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)_
2364
-
2365
- ## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
2366
-
2367
- Import content from a stack
2368
-
2369
- ```
2370
- USAGE
2371
- $ csdx cm:import cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>]
2372
- [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
2373
-
2374
- FLAGS
2375
- -B, --branch=<value> The name of the branch where you want to import your content. If you don't
2376
- mention the branch name, then by default the content will be imported to the
2377
- main branch.
2378
- -a, --alias=<value> The management token of the destination stack where you will import the
2379
- content.
2380
- -b, --backup-dir=<value> [optional] Backup directory name when using specific module.
2381
- -c, --config=<value> [optional] The path of the configuration JSON file containing all the options
2382
- for a single run.
2383
- -d, --data-dir=<value> The path or the location in your file system where the content, you intend to
2384
- import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
2385
- export folder has branches involved, then the path should point till the
2386
- particular branch. For example, “-d
2387
- "C:\Users\Name\Desktop\cli\content\branch_name"
2388
- -k, --stack-api-key=<value> API Key of the target stack
2389
- -m, --module=<value> [optional] Specify the module to import into the target stack. If not
2390
- specified, the import command will import all the modules into the stack. The
2391
- available modules are assets, content-types, entries, environments,
2392
- extensions, marketplace-apps, global-fields, labels, locales, webhooks,
2393
- workflows, custom-roles, personalize projects, and taxonomies.
2394
- -y, --yes [optional] Force override all Marketplace prompts.
2395
- --branch-alias=<value> Specify the branch alias where you want to import your content. If not
2396
- specified, the content is imported into the main branch by default.
2397
- --exclude-global-modules Excludes the branch-independent module from the import operation.
2398
- --import-webhook-status=<option> [default: disable] [default: disable] (optional) This webhook state keeps the
2399
- same state of webhooks as the source stack. <options: disable|current>
2400
- <options: disable|current>
2401
- --personalize-project-name=<value> (optional) Provide a unique name for the Personalize project.
2402
- --replace-existing Replaces the existing module in the target stack.
2403
- --skip-app-recreation (optional) Skips the recreation of private apps if they already exist.
2404
- --skip-assets-publish Skips asset publishing during the import process.
2405
- --skip-audit Skips the audit fix that occurs during an import operation.
2406
- --skip-entries-publish Skips entry publishing during the import process
2407
- --skip-existing Skips the module exists warning messages.
2408
-
2409
- DESCRIPTION
2410
- Import content from a stack
2411
-
2412
- ALIASES
2413
- $ csdx cm:import
2414
-
2415
- EXAMPLES
2416
- $ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
2417
-
2418
- $ csdx cm:stacks:import --config <path/of/config/dir>
2419
-
2420
- $ csdx cm:stacks:import --module <single module name>
2421
-
2422
- $ csdx cm:stacks:import --module <single module name> --backup-dir <backup dir>
2423
-
2424
- $ csdx cm:stacks:import --alias <management_token_alias>
2425
-
2426
- $ csdx cm:stacks:import --alias <management_token_alias> --data-dir <path/of/export/destination/dir>
2427
-
2428
- $ csdx cm:stacks:import --alias <management_token_alias> --config <path/of/config/file>
2429
-
2430
- $ csdx cm:stacks:import --branch <branch name> --yes --skip-audit
2431
- ```
2432
-
2433
- ## `csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]`
2434
-
2435
- Helps to generate mappers and backup folder for importing (overwriting) specific modules
2436
-
2437
- ```
2438
- USAGE
2439
- $ csdx cm:import-setup cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
2440
-
2441
- FLAGS
2442
- -B, --branch=<value> The name of the branch where you want to import your content. If you don't mention the
2443
- branch name, then by default the content will be imported to the main branch.
2444
- -a, --alias=<value> The management token of the destination stack where you will import the content.
2445
- -d, --data-dir=<value> The path or the location in your file system where the content, you intend to import, is
2446
- stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
2447
- branches involved, then the path should point till the particular branch. For example,
2448
- “-d "C:\Users\Name\Desktop\cli\content\branch_name"
2449
- -k, --stack-api-key=<value> API key of the target stack
2450
- --branch-alias=<value> Specify the branch alias where you want to import your content. If not specified, the
2451
- content is imported into the main branch by default.
2452
- --module=<option>... [optional] Specify the modules/module to import into the target stack. currently options
2453
- are global-fields, content-types, entries
2454
- <options: global-fields|content-types|entries>
2455
-
2456
- DESCRIPTION
2457
- Helps to generate mappers and backup folder for importing (overwriting) specific modules
2458
-
2459
- ALIASES
2460
- $ csdx cm:import-setup
2461
-
2462
- EXAMPLES
2463
- $ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
2464
-
2465
- $ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>
2466
-
2467
- $ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>
2468
- ```
2469
-
2470
- ## `csdx cm:migrate-rte`
2471
-
2472
- Migration script to migrate content from HTML RTE to JSON RTE
2473
-
2474
- ```
2475
- USAGE
2476
- $ csdx cm:migrate-rte [-c <value>] [-a <value>] [--stack-api-key <value>] [--content-type <value>]
2477
- [--global-field] [-y] [--branch <value>] [--html-path <value> --json-path <value>] [--delay <value>] [--locale
2478
- <value>] [--batch-limit <value>]
2479
-
2480
- FLAGS
2481
- -a, --alias=<value> Enter the alias name. You must use either the --alias flag or the --stack-api-key flag.
2482
- -c, --config-path=<value> Specify the path where your config file is located.
2483
- -y, --yes Avoids reconfirmation of your configuration.
2484
- --batch-limit=<value> [default: 50] Provide batch limit for updating entries (default: 50).
2485
- --branch=<value> The name of the branch to be used.
2486
- --content-type=<value> Specify the UID of the content type for which you want to migrate HTML RTE content.
2487
- --delay=<value> [default: 1000] To set the interval time between the migration of HTML RTE to JSON RTE in
2488
- subsequent entries of a content type. The default value is 1,000 milliseconds.
2489
- --global-field Checks whether the specified UID belongs to a content type or a global field. This flag
2490
- is set to false by default.
2491
- --html-path=<value> Enter the path to the HTML RTE whose content you want to migrate.
2492
- --json-path=<value> Enter the path to the JSON RTE to which you want to migrate the HTML RTE content.
2493
- --locale=<value> The locale from which entries will be migrated.
2494
- --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
2495
- flag.
2496
-
2497
- DESCRIPTION
2498
- Migration script to migrate content from HTML RTE to JSON RTE
2499
-
2500
- ALIASES
2501
- $ csdx cm:migrate-rte
2502
-
2503
- EXAMPLES
2504
- General Usage
2505
-
2506
- $ csdx cm:entries:migrate-html-rte --config-path path/to/config.json
2507
-
2508
-
2509
-
2510
- Using Flags
2511
-
2512
- $ csdx cm:entries:migrate-html-rte --alias alias --content-type content_type_uid --html-path html-path --json-path json-path
2513
-
2514
-
2515
-
2516
- Nested RTE
2517
-
2518
- $ 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
2519
-
2520
-
2521
-
2522
- $ 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
2523
-
2524
-
2525
-
2526
- Global Field
2527
-
2528
- $ csdx cm:entries:migrate-html-rte --alias alias --content-type global_field_uid --global-field --html-path html-path --json-path json-path
2529
- ```
2530
-
2531
- ## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
2532
-
2533
- Contentstack migration script.
2534
-
2535
- ```
2536
- USAGE
2537
- $ csdx cm:migration cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>]
2538
- [--config-file <value>] [--config <value>] [--multiple]
2539
-
2540
- FLAGS
2541
- -B, --branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
2542
- branch name)
2543
- -a, --alias=<value> Use this flag to add the management token alias. You must use either the --alias flag or
2544
- the --stack-api-key flag.
2545
- -k, --stack-api-key=<value> Use this flag to add the API key of your stack. You must use either the --stack-api-key
2546
- flag or the --alias flag.
2547
- --config=<value>... [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
2548
- the script re-usable.
2549
- --config-file=<value> [optional] Path of the JSON configuration file.
2550
- --file-path=<value> Use this flag to provide the path of the file of the migration script.
2551
- --multiple This flag helps you to migrate multiple content files in a single instance. Mention the
2552
- folder path where your migration script files are stored.
2553
-
2554
- DESCRIPTION
2555
- Contentstack migration script.
2556
-
2557
- ALIASES
2558
- $ csdx cm:migration
2559
-
2560
- EXAMPLES
2561
- $ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>
2562
-
2563
- $ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>
2564
-
2565
- $ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>
2566
-
2567
- $ csdx cm:migration --config-file <path/to/json/config/file> --file-path <migration/script/file/path>
2568
-
2569
- $ csdx cm:migration --multiple --file-path <migration/scripts/dir/path>
2570
-
2571
- $ csdx cm:migration --alias --file-path <migration/script/file/path> -k <api-key>
2572
- ```
2573
-
2574
- ## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>] [--locale <value>]`
2575
-
2576
- Create a stack from existing content types, entries, assets, etc
2577
-
2578
- ```
2579
- USAGE
2580
- $ csdx cm:seed cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s
2581
- <value>] [--locale <value>]
2582
-
2583
- FLAGS
2584
- -a, --alias=<value> Alias of the management token
2585
- -k, --stack-api-key=<value> Provide stack API key to seed content to
2586
- -n, --stack-name=<value> Name of a new stack that needs to be created.
2587
- -o, --org=<value> Provide Organization UID to create a new stack
2588
- -r, --repo=<value> GitHub organization name or GitHub user name/repository name.
2589
- -s, --stack=<value> Provide the stack UID to seed content.
2590
- -y, --yes=<value> [Optional] Skip the stack confirmation.
2591
-
2592
- DESCRIPTION
2593
- Create a stack from existing content types, entries, assets, etc
2594
-
2595
- ALIASES
2596
- $ csdx cm:seed
2597
-
2598
- EXAMPLES
2599
- $ csdx cm:stacks:seed
2600
-
2601
- $ csdx cm:stacks:seed --repo "account"
2602
-
2603
- $ csdx cm:stacks:seed --repo "account/repository"
2604
-
2605
- $ csdx cm:stacks:seed --repo "account/repository" --stack-api-key "stack-api-key" //seed content into specific stack
2606
-
2607
- $ csdx cm:stacks:seed --repo "account/repository" --org "your-org-uid" --stack-name "stack-name" //create a new stack in given org uid
2608
- ```
2609
-
2610
- ## `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]`
2611
-
2612
- Clone data (structure/content or both) of a stack into another stack
2613
-
2614
- ```
2615
- USAGE
2616
- $ csdx cm:stack-clone cm:stacks:clone [--source-branch <value>] [--target-branch <value>]
2617
- [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b]
2618
- [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]
637
+ $ csdx cm:stack-clone cm:stacks:clone [--source-branch <value>] [--target-branch <value>]
638
+ [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b]
639
+ [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]
2619
640
 
2620
641
  FLAGS
2621
642
  -c, --config=<value> Path for the external configuration
@@ -2669,13 +690,14 @@ Perform audits and find possible errors in the exported Contentstack data
2669
690
  ```
2670
691
  USAGE
2671
692
  $ csdx cm:stacks:audit [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
2672
- content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
2673
- [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
693
+ content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules|composable-studio...]
694
+ [--columns <value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output
695
+ csv|json|yaml]
2674
696
 
2675
697
  FLAGS
2676
698
  --modules=<option>... Provide the list of modules to be audited
2677
- <options:
2678
- content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
699
+ <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-ru
700
+ les|composable-studio>
2679
701
  --report-path=<value> Path to store the audit reports
2680
702
 
2681
703
  COMMON FLAGS
@@ -2696,10 +718,6 @@ TABLE FLAGS
2696
718
  DESCRIPTION
2697
719
  Perform audits and find possible errors in the exported Contentstack data
2698
720
 
2699
- ALIASES
2700
- $ csdx audit
2701
- $ csdx cm:stacks:audit
2702
-
2703
721
  EXAMPLES
2704
722
  $ csdx cm:stacks:audit
2705
723
 
@@ -2721,9 +739,10 @@ Perform audits and fix possible errors in the exported Contentstack data.
2721
739
  ```
2722
740
  USAGE
2723
741
  $ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
2724
- content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
2725
- --copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
2726
- <value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
742
+ content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules|composable-studio...]
743
+ [--copy-path <value> --copy-dir] [--fix-only
744
+ reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns <value>] [--sort <value>]
745
+ [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
2727
746
 
2728
747
  FLAGS
2729
748
  --copy-dir Create backup from the original data.
@@ -2731,47 +750,197 @@ FLAGS
2731
750
  --fix-only=<option>... Provide the list of fix options
2732
751
  <options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
2733
752
  --modules=<option>... Provide the list of modules to be audited
2734
- <options:
2735
- content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
753
+ <options: content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-r
754
+ ules|composable-studio>
2736
755
  --report-path=<value> Path to store the audit reports
2737
756
 
2738
- COMMON FLAGS
2739
- -c, --config=<value> Path of the external config
2740
- -d, --data-dir=<value> Path where the data is stored
2741
- --show-console-output Display the audit and audit fix result for individual modules
757
+ COMMON FLAGS
758
+ -c, --config=<value> Path of the external config
759
+ -d, --data-dir=<value> Path where the data is stored
760
+ --show-console-output Display the audit and audit fix result for individual modules
761
+
762
+ TABLE FLAGS
763
+ --columns=<value> Specify columns to display, comma-separated.
764
+ --csv Output results in CSV format.
765
+ --filter=<value> Filter rows by a column value (e.g., name=foo).
766
+ --no-header Hide table headers in output.
767
+ --no-truncate Prevent truncation of long text in columns.
768
+ --output=<option> Specify output format: csv, json, or yaml.
769
+ <options: csv|json|yaml>
770
+ --sort=<value> Sort the table by a column. Use "-" for descending.
771
+
772
+ DESCRIPTION
773
+ Perform audits and fix possible errors in the exported Contentstack data.
774
+
775
+ EXAMPLES
776
+ $ csdx cm:stacks:audit:fix --copy-dir
777
+
778
+ $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir
779
+
780
+ $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
781
+
782
+ $ csdx cm:stacks:audit:fix --fix-only=reference,global_field --copy-dir
783
+
784
+ $ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
785
+
786
+ $ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
787
+ ```
788
+
789
+ _See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
790
+
791
+ ## `csdx cm:stacks:bulk-assets`
792
+
793
+ Bulk operations for assets (publish/unpublish/cross-publish)
794
+
795
+ ```
796
+ USAGE
797
+ $ csdx cm:stacks:bulk-assets [-a <value>] [-k <value>] [--operation publish|unpublish] [--environments <value>...]
798
+ [--locales <value>...] [--source-env <value>] [--source-alias <value>] [--publish-mode bulk|single] [--branch
799
+ <value>] [-c <value>] [-y] [--retry-failed <value>] [--revert <value>] [--bulk-operation-file <value>] [--folder-uid
800
+ <value>]
801
+
802
+ FLAGS
803
+ -a, --alias=<value> Uses the name of a saved Management Token to authenticate the command. The command
804
+ can only access the branches allowed for that token. This option can be used as an
805
+ alternative to` --stack-api-key.`
806
+ -c, --config=<value> (optional) Specifies the path to a JSON configuration file that defines the options
807
+ for the command. Use this file instead of passing multiple CLI flags for a single
808
+ run.
809
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
810
+ --alias flag.
811
+ -y, --yes Skips interactive confirmation prompts and runs the command immediately using the
812
+ provided options. Useful for automation and scripts.
813
+ --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
814
+ operation. If you don't mention the branch name, then by default the content from
815
+ main branch will be published.
816
+ --bulk-operation-file=<value> [default: bulk-operation] (optional) Folder path to store operation logs. Creates
817
+ separate files for success and failed operations. Default: bulk-operation
818
+ --environments=<value>... Specifies one or more environments where the entries or assets should be published.
819
+ Separate multiple environments with spaces.
820
+ --folder-uid=<value> (optional) The UID of the Assets' folder from which the assets need to be
821
+ published. The default value is cs_root.
822
+ --locales=<value>... Specifies one or more locale codes for which the entries or assets should be
823
+ published. Separate multiple locales with spaces.
824
+ --operation=<option> Specifies whether to `publish` or `unpublish` content.
825
+ <options: publish|unpublish>
826
+ --publish-mode=<option> [default: bulk] Publish mode: bulk (uses Bulk Publish API) or single (individual
827
+ API calls)
828
+ <options: bulk|single>
829
+ --retry-failed=<value> (optional) Use this option to retry publishing the failed entries/assets from the
830
+ logfile. Specify the name of the logfile that lists failed publish calls. If this
831
+ option is used, it will override all other flags.
832
+ --revert=<value> (optional) Revert publish operations from a log folder. Specify the folder path
833
+ containing success logs. Works similar to retry-failed.
834
+ --source-alias=<value> Alias name for source environment delivery token (required for cross-publish). Add
835
+ delivery token using: csdx auth:tokens:add
836
+ --source-env=<value> Source environment for cross-publish
837
+
838
+ DESCRIPTION
839
+ Bulk operations for assets (publish/unpublish/cross-publish)
840
+
841
+ EXAMPLES
842
+ $ csdx cm:stacks:bulk-assets --operation publish --environments dev,staging --locales en-us -k blt123
843
+
844
+ $ csdx cm:stacks:bulk-assets --operation unpublish --environments prod --locales en-us -a myAlias
845
+
846
+ $ csdx cm:stacks:bulk-assets --operation publish --folder-uid cs_root --environments prod --locales en-us -k blt123
847
+
848
+ $ csdx cm:stacks:bulk-assets --operation publish --environments prod --locales en-us --publish-mode bulk -k blt123
849
+
850
+ $ csdx cm:stacks:bulk-assets --operation publish --source-env production --source-alias prod-delivery --environments staging,dev --locales en-us -a myAlias
851
+
852
+ $ csdx cm:stacks:bulk-assets --retry-failed ./bulk-operation -a myAlias
853
+
854
+ $ csdx cm:stacks:bulk-assets --revert ./bulk-operation -a myAlias
855
+ ```
856
+
857
+ _See code: [@contentstack/cli-bulk-operations](https://github.com/contentstack/cli-bulk-operations/blob/v1.0.1/src/commands/cm/stacks/bulk-assets.ts)_
858
+
859
+ ## `csdx cm:stacks:bulk-entries`
860
+
861
+ Bulk operations for entries (publish/unpublish/cross-publish)
2742
862
 
2743
- TABLE FLAGS
2744
- --columns=<value> Specify columns to display, comma-separated.
2745
- --csv Output results in CSV format.
2746
- --filter=<value> Filter rows by a column value (e.g., name=foo).
2747
- --no-header Hide table headers in output.
2748
- --no-truncate Prevent truncation of long text in columns.
2749
- --output=<option> Specify output format: csv, json, or yaml.
2750
- <options: csv|json|yaml>
2751
- --sort=<value> Sort the table by a column. Use "-" for descending.
863
+ ```
864
+ USAGE
865
+ $ csdx cm:stacks:bulk-entries [-a <value>] [-k <value>] [--operation publish|unpublish] [--environments <value>...]
866
+ [--locales <value>...] [--source-env <value>] [--source-alias <value>] [--publish-mode bulk|single] [--branch
867
+ <value>] [-c <value>] [-y] [--retry-failed <value>] [--revert <value>] [--bulk-operation-file <value>]
868
+ [--content-types <value>...] [--filter draft|modified|non-localized|unpublished] [--include-variants] [--api-version
869
+ <value>]
2752
870
 
2753
- DESCRIPTION
2754
- Perform audits and fix possible errors in the exported Contentstack data.
871
+ FLAGS
872
+ -a, --alias=<value> Uses the name of a saved Management Token to authenticate the command. The command
873
+ can only access the branches allowed for that token. This option can be used as an
874
+ alternative to` --stack-api-key.`
875
+ -c, --config=<value> (optional) Specifies the path to a JSON configuration file that defines the options
876
+ for the command. Use this file instead of passing multiple CLI flags for a single
877
+ run.
878
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
879
+ --alias flag.
880
+ -y, --yes Skips interactive confirmation prompts and runs the command immediately using the
881
+ provided options. Useful for automation and scripts.
882
+ --api-version=<value> [default: 3.2] Specifies the Content Management API version used for publishing.
883
+ Use version `3.2` when publishing entries with nested references, otherwise, use
884
+ the default version 3.2
885
+ --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
886
+ operation. If you don't mention the branch name, then by default the content from
887
+ main branch will be published.
888
+ --bulk-operation-file=<value> [default: bulk-operation] (optional) Folder path to store operation logs. Creates
889
+ separate files for success and failed operations. Default: bulk-operation
890
+ --content-types=<value>... Content type UIDs to perform operation on. If not provided, operates on all content
891
+ types.
892
+ --environments=<value>... Specifies one or more environments where the entries or assets should be published.
893
+ Separate multiple environments with spaces.
894
+ --filter=<option> Filter entries by status
895
+ <options: draft|modified|non-localized|unpublished>
896
+ --include-variants Includes entry variants (alternate versions of a base entry) in the bulk operation.
897
+ By default, only base entries are processed.
898
+ --locales=<value>... Specifies one or more locale codes for which the entries or assets should be
899
+ published. Separate multiple locales with spaces.
900
+ --operation=<option> Specifies whether to `publish` or `unpublish` content.
901
+ <options: publish|unpublish>
902
+ --publish-mode=<option> [default: bulk] Publish mode: bulk (uses Bulk Publish API) or single (individual
903
+ API calls)
904
+ <options: bulk|single>
905
+ --retry-failed=<value> (optional) Use this option to retry publishing the failed entries/assets from the
906
+ logfile. Specify the name of the logfile that lists failed publish calls. If this
907
+ option is used, it will override all other flags.
908
+ --revert=<value> (optional) Revert publish operations from a log folder. Specify the folder path
909
+ containing success logs. Works similar to retry-failed.
910
+ --source-alias=<value> Alias name for source environment delivery token (required for cross-publish). Add
911
+ delivery token using: csdx auth:tokens:add
912
+ --source-env=<value> Source environment for cross-publish
2755
913
 
2756
- ALIASES
2757
- $ csdx audit:fix
2758
- $ csdx cm:stacks:audit:fix
914
+ DESCRIPTION
915
+ Bulk operations for entries (publish/unpublish/cross-publish)
2759
916
 
2760
917
  EXAMPLES
2761
- $ csdx cm:stacks:audit:fix --copy-dir
918
+ $ csdx cm:stacks:bulk-entries --operation publish --environments dev --locales en-us -k blt123
2762
919
 
2763
- $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir
920
+ $ csdx cm:stacks:bulk-entries --operation publish --content-types blog,article --environments dev --locales en-us -k blt123
2764
921
 
2765
- $ csdx cm:stacks:audit:fix --report-path=<path> --copy-dir --csv
922
+ $ csdx cm:stacks:bulk-entries --operation unpublish --content-types blog --environments prod --locales en-us -a myAlias
2766
923
 
2767
- $ csdx cm:stacks:audit:fix --fix-only=reference,global_field --copy-dir
924
+ $ csdx cm:stacks:bulk-entries --operation publish --content-types blog --source-env production --source-alias prod-delivery --environments staging --locales en-us -a myAlias
2768
925
 
2769
- $ csdx cm:stacks:audit:fix --report-path=<path> --filter="name=<filter-value>"
926
+ $ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us --publish-mode bulk -k blt123
2770
927
 
2771
- $ csdx cm:stacks:audit:fix --report-path=<path> --modules=content-types --filter="name="<filter-value>" --copy-dir --copy-path=<path>
928
+ $ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us --filter modified -k blt123
929
+
930
+ $ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us --filter draft -k blt123
931
+
932
+ $ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us --filter unpublished -k blt123
933
+
934
+ $ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --filter non-localized -k blt123
935
+
936
+ $ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us --include-variants -k blt123
937
+
938
+ $ csdx cm:stacks:bulk-entries --retry-failed ./bulk-operation
939
+
940
+ $ csdx cm:stacks:bulk-entries --revert ./bulk-operation
2772
941
  ```
2773
942
 
2774
- _See code: [@contentstack/cli-audit](https://github.com/contentstack/audit/blob/main/packages/contentstack-audit/src/commands/cm/stacks/audit/fix.ts)_
943
+ _See code: [@contentstack/cli-bulk-operations](https://github.com/contentstack/cli-bulk-operations/blob/v1.0.1/src/commands/cm/stacks/bulk-entries.ts)_
2775
944
 
2776
945
  ## `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]`
2777
946
 
@@ -2828,42 +997,39 @@ EXAMPLES
2828
997
  $ 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>
2829
998
  ```
2830
999
 
2831
- _See code: [@contentstack/cli-cm-clone](https://github.com/contentstack/cli/blob/main/packages/contentstack-clone/src/commands/cm/stacks/clone.js)_
1000
+ _See code: [@contentstack/cli-cm-clone](https://github.com/contentstack/cli/blob/main/packages/contentstack-clone/src/commands/cm/stacks/clone.ts)_
2832
1001
 
2833
- ## `csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
1002
+ ## `csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`
2834
1003
 
2835
1004
  Export content from a stack
2836
1005
 
2837
1006
  ```
2838
1007
  USAGE
2839
- $ csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types
2840
- <value>] [--branch <value>] [--secured-assets]
1008
+ $ csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>]
1009
+ [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]
2841
1010
 
2842
1011
  FLAGS
2843
- -B, --branch=<value> [optional] The name of the branch where you want to export your content. If you don't
2844
- mention the branch name, then by default the content will be exported from all the
2845
- branches of your stack.
2846
1012
  -a, --alias=<value> The management token alias of the source stack from which you will export content.
2847
1013
  -c, --config=<value> [optional] Path of the config
2848
1014
  -d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
2849
1015
  ./content
2850
1016
  -k, --stack-api-key=<value> API Key of the source stack
2851
- -m, --module=<value> [optional] Specific module name. If not specified, the export command will export all
2852
- the modules to the stack. The available modules are assets, content-types, entries,
2853
- environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
2854
- workflows, custom-roles, and taxonomies.
2855
- -t, --content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
2856
- of multiple content types, specify the IDs separated by spaces.
2857
1017
  -y, --yes [optional] Force override all Marketplace prompts.
1018
+ --branch=<value> [optional] The name of the branch where you want to export your content. If you don't
1019
+ mention the branch name, then by default the content will be exported from all the
1020
+ branches of your stack.
2858
1021
  --branch-alias=<value> (Optional) The alias of the branch from which you want to export content.
1022
+ --content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
1023
+ of multiple content types, specify the IDs separated by spaces.
1024
+ --module=<value> [optional] Specific module name. If not specified, the export command will export all
1025
+ the modules to the stack. The available modules are assets, content-types, entries,
1026
+ environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
1027
+ workflows, custom-roles, taxonomies, and studio.
2859
1028
  --secured-assets [optional] Use this flag for assets that are secured.
2860
1029
 
2861
1030
  DESCRIPTION
2862
1031
  Export content from a stack
2863
1032
 
2864
- ALIASES
2865
- $ csdx cm:export
2866
-
2867
1033
  EXAMPLES
2868
1034
  $ csdx cm:stacks:export --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
2869
1035
 
@@ -2882,56 +1048,79 @@ EXAMPLES
2882
1048
 
2883
1049
  _See code: [@contentstack/cli-cm-export](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/stacks/export.ts)_
2884
1050
 
2885
- ## `csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`
1051
+ ## `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]`
2886
1052
 
2887
1053
  Import content from a stack
2888
1054
 
2889
1055
  ```
2890
1056
  USAGE
2891
- $ csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir
2892
- <value>] [--branch <value>] [--import-webhook-status disable|current]
1057
+ $ csdx cm:stacks:import [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>]
1058
+ [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
2893
1059
 
2894
1060
  FLAGS
2895
- -B, --branch=<value> The name of the branch where you want to import your content. If you don't
2896
- mention the branch name, then by default the content will be imported to the
2897
- main branch.
2898
- -a, --alias=<value> The management token of the destination stack where you will import the
2899
- content.
2900
- -b, --backup-dir=<value> [optional] Backup directory name when using specific module.
2901
- -c, --config=<value> [optional] The path of the configuration JSON file containing all the options
2902
- for a single run.
2903
- -d, --data-dir=<value> The path or the location in your file system where the content, you intend to
2904
- import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
2905
- export folder has branches involved, then the path should point till the
2906
- particular branch. For example, “-d
2907
- "C:\Users\Name\Desktop\cli\content\branch_name"
2908
- -k, --stack-api-key=<value> API Key of the target stack
2909
- -m, --module=<value> [optional] Specify the module to import into the target stack. If not
2910
- specified, the import command will import all the modules into the stack. The
2911
- available modules are assets, content-types, entries, environments,
2912
- extensions, marketplace-apps, global-fields, labels, locales, webhooks,
2913
- workflows, custom-roles, personalize projects, and taxonomies.
2914
- -y, --yes [optional] Force override all Marketplace prompts.
2915
- --branch-alias=<value> Specify the branch alias where you want to import your content. If not
2916
- specified, the content is imported into the main branch by default.
2917
- --exclude-global-modules Excludes the branch-independent module from the import operation.
2918
- --import-webhook-status=<option> [default: disable] [default: disable] (optional) This webhook state keeps the
2919
- same state of webhooks as the source stack. <options: disable|current>
2920
- <options: disable|current>
2921
- --personalize-project-name=<value> (optional) Provide a unique name for the Personalize project.
2922
- --replace-existing Replaces the existing module in the target stack.
2923
- --skip-app-recreation (optional) Skips the recreation of private apps if they already exist.
2924
- --skip-assets-publish Skips asset publishing during the import process.
2925
- --skip-audit Skips the audit fix that occurs during an import operation.
2926
- --skip-entries-publish Skips entry publishing during the import process
2927
- --skip-existing Skips the module exists warning messages.
1061
+ -a, --alias=<value>
1062
+ The management token of the destination stack where you will import the content.
1063
+
1064
+ -c, --config=<value>
1065
+ [optional] The path of the configuration JSON file containing all the options for a single run.
1066
+
1067
+ -d, --data-dir=<value>
1068
+ The path or the location in your file system where the content, you intend to import, is stored. For example, -d
1069
+ "C:\Users\Name\Desktop\cli\content". If the export folder has branches involved, then the path should point till the
1070
+ particular branch. For example, “-d "C:\Users\Name\Desktop\cli\content\branch_name"
1071
+
1072
+ -k, --stack-api-key=<value>
1073
+ API Key of the target stack
1074
+
1075
+ -y, --yes
1076
+ [optional] Force override all Marketplace prompts.
1077
+
1078
+ --backup-dir=<value>
1079
+ [optional] Backup directory name when using specific module.
1080
+
1081
+ --branch=<value>
1082
+ The name of the branch where you want to import your content. If you don't mention the branch name, then by default
1083
+ the content will be imported to the main branch.
1084
+
1085
+ --branch-alias=<value>
1086
+ Specify the branch alias where you want to import your content. If not specified, the content is imported into the
1087
+ main branch by default.
1088
+
1089
+ --exclude-global-modules
1090
+ Excludes the branch-independent module from the import operation.
1091
+
1092
+ --import-webhook-status=<option>
1093
+ [default: disable] [default: disable] (optional) This webhook state keeps the same state of webhooks as the source
1094
+ stack. <options: disable|current>
1095
+ <options: disable|current>
1096
+
1097
+ --module=<value>
1098
+ [optional] Specify the module to import into the target stack. If not specified, the import command will import all
1099
+ the modules into the stack. The available modules are assets, content-types, entries, environments, extensions,
1100
+ marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, personalize projects,
1101
+ taxonomies, and composable-studio.
1102
+
1103
+ --personalize-project-name=<value>
1104
+ (optional) Provide a unique name for the Personalize project.
1105
+
1106
+ --replace-existing
1107
+ Replaces the existing module in the target stack.
1108
+
1109
+ --skip-assets-publish
1110
+ Skips asset publishing during the import process.
1111
+
1112
+ --skip-audit
1113
+ Skips the audit fix that occurs during an import operation.
1114
+
1115
+ --skip-entries-publish
1116
+ Skips entry publishing during the import process
1117
+
1118
+ --skip-existing
1119
+ Skips the module exists warning messages.
2928
1120
 
2929
1121
  DESCRIPTION
2930
1122
  Import content from a stack
2931
1123
 
2932
- ALIASES
2933
- $ csdx cm:import
2934
-
2935
1124
  EXAMPLES
2936
1125
  $ csdx cm:stacks:import --stack-api-key <stack_api_key> --data-dir <path/of/export/destination/dir>
2937
1126
 
@@ -2961,14 +1150,14 @@ USAGE
2961
1150
  $ csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
2962
1151
 
2963
1152
  FLAGS
2964
- -B, --branch=<value> The name of the branch where you want to import your content. If you don't mention the
2965
- branch name, then by default the content will be imported to the main branch.
2966
1153
  -a, --alias=<value> The management token of the destination stack where you will import the content.
2967
1154
  -d, --data-dir=<value> The path or the location in your file system where the content, you intend to import, is
2968
1155
  stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
2969
1156
  branches involved, then the path should point till the particular branch. For example,
2970
1157
  “-d "C:\Users\Name\Desktop\cli\content\branch_name"
2971
1158
  -k, --stack-api-key=<value> API key of the target stack
1159
+ --branch=<value> The name of the branch where you want to import your content. If you don't mention the
1160
+ branch name, then by default the content will be imported to the main branch.
2972
1161
  --branch-alias=<value> Specify the branch alias where you want to import your content. If not specified, the
2973
1162
  content is imported into the main branch by default.
2974
1163
  --module=<option>... [optional] Specify the modules/module to import into the target stack. currently options
@@ -2978,15 +1167,8 @@ FLAGS
2978
1167
  DESCRIPTION
2979
1168
  Helps to generate mappers and backup folder for importing (overwriting) specific modules
2980
1169
 
2981
- ALIASES
2982
- $ csdx cm:import-setup
2983
-
2984
1170
  EXAMPLES
2985
- $ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
2986
-
2987
- $ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>
2988
-
2989
- $ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>
1171
+ $ 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>
2990
1172
  ```
2991
1173
 
2992
1174
  _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)_
@@ -3001,12 +1183,12 @@ USAGE
3001
1183
  [--config <value>] [--multiple]
3002
1184
 
3003
1185
  FLAGS
3004
- -B, --branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
3005
- branch name)
3006
1186
  -a, --alias=<value> Use this flag to add the management token alias. You must use either the --alias flag or
3007
1187
  the --stack-api-key flag.
3008
1188
  -k, --stack-api-key=<value> Use this flag to add the API key of your stack. You must use either the --stack-api-key
3009
1189
  flag or the --alias flag.
1190
+ --branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
1191
+ branch name)
3010
1192
  --config=<value>... [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
3011
1193
  the script re-usable.
3012
1194
  --config-file=<value> [optional] Path of the JSON configuration file.
@@ -3031,186 +1213,31 @@ EXAMPLES
3031
1213
 
3032
1214
  $ csdx cm:migration --multiple --file-path <migration/scripts/dir/path>
3033
1215
 
3034
- $ csdx cm:migration --alias --file-path <migration/script/file/path> -k <api-key>
3035
- ```
3036
-
3037
- _See code: [@contentstack/cli-migration](https://github.com/contentstack/cli/blob/main/packages/contentstack-migration/src/commands/cm/stacks/migration.js)_
3038
-
3039
- ## `csdx cm:stacks:publish`
3040
-
3041
- Publish entries and assets to multiple environments and locales
3042
-
3043
- ```
3044
- USAGE
3045
- $ csdx cm:stacks:publish
3046
-
3047
- DESCRIPTION
3048
- Publish entries and assets to multiple environments and locales
3049
- The publish command is used to publish entries and assets, to the specified environments and locales.
3050
-
3051
- Note: Content types, Environments and Locales are required to execute the publish entries command successfully.
3052
- Note: Environments and Locales are required to execute the publish assets command successfully.
3053
- But, if retry-failed flag is set, then only a logfile is required
3054
-
3055
- EXAMPLES
3056
- General Usage
3057
-
3058
- $ csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS]
3059
-
3060
-
3061
-
3062
- Using --config or -c flag
3063
-
3064
- Generate a config file in the current working directory using `csdx cm:stacks:publish-configure -a [ALIAS]`
3065
-
3066
- $ csdx cm:stacks:publish --config [PATH TO CONFIG FILE]
3067
-
3068
- $ csdx cm:stacks:publish -c [PATH TO CONFIG FILE]
3069
-
3070
-
3071
-
3072
- Using --retry-failed flag
3073
-
3074
- $ csdx cm:stacks:publish --retry-failed [LOG FILE NAME]
3075
-
3076
-
3077
-
3078
- Using --branch flag
3079
-
3080
- $ csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --branch [BRANCH NAME]
3081
-
3082
-
3083
-
3084
- Using --api-version flag
3085
-
3086
- $ csdx cm:stacks:publish --environments [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] --api-version [API VERSION]
3087
- ```
3088
-
3089
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish.js)_
3090
-
3091
- ## `csdx cm:stacks:publish-clear-logs`
3092
-
3093
- Clear the log folder
3094
-
3095
- ```
3096
- USAGE
3097
- $ csdx cm:stacks:publish-clear-logs [--log-files-count] [-y]
3098
-
3099
- FLAGS
3100
- -y, --yes Delete all files without asking for confirmation
3101
- --log-files-count List number of log files
3102
-
3103
- DESCRIPTION
3104
- Clear the log folder
3105
-
3106
- ALIASES
3107
- $ csdx cm:bulk-publish:clear
3108
-
3109
- EXAMPLES
3110
- $ csdx cm:stacks:publish-clear-logs
3111
-
3112
- $ csdx cm:stacks:publish-clear-logs --log-files-count
3113
-
3114
- $ csdx cm:stacks:publish-clear-logs --yes
3115
-
3116
- $ csdx cm:stacks:publish-clear-logs -y
3117
- ```
3118
-
3119
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-clear-logs.js)_
3120
-
3121
- ## `csdx cm:stacks:publish-configure`
3122
-
3123
- The configure command is used to generate a configuration file for publish scripts.
3124
-
3125
- ```
3126
- USAGE
3127
- $ csdx cm:stacks:publish-configure [-a <value>] [-k <value>]
3128
-
3129
- FLAGS
3130
- -a, --alias=<value> Name (alias) of the management token you want to use. You must use either the --alias
3131
- flag or the --stack-api-key flag.
3132
- -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
3133
- flag.
3134
-
3135
- DESCRIPTION
3136
- The configure command is used to generate a configuration file for publish scripts.
3137
-
3138
- ALIASES
3139
- $ csdx cm:bulk-publish:configure
3140
-
3141
- EXAMPLES
3142
- $ csdx cm:stacks:publish-configure
3143
-
3144
- $ csdx cm:stacks:publish-configure -a <management_token_alias>
3145
-
3146
- $ csdx cm:stacks:publish-configure --alias <management_token_alias>
3147
-
3148
- $ csdx cm:stacks:publish-configure --stack-api-key <stack_api_key>
3149
- ```
3150
-
3151
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-configure.js)_
3152
-
3153
- ## `csdx cm:stacks:publish-revert`
3154
-
3155
- Revert publish operations by using a log file
3156
-
3157
- ```
3158
- USAGE
3159
- $ csdx cm:stacks:publish-revert [--retry-failed <value>] [--log-file <value>]
3160
-
3161
- FLAGS
3162
- --log-file=<value> Path of the success logfile of a particular publish action.
3163
- --retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. Specify
3164
- the name of the logfile that lists failed publish calls. If this option is used, it will
3165
- override all other flags.
3166
-
3167
- DESCRIPTION
3168
- Revert publish operations by using a log file
3169
- The revert command is used to revert all publish operations performed using bulk-publish script.
3170
- A log file name is required to execute revert command
3171
-
3172
-
3173
- ALIASES
3174
- $ csdx cm:bulk-publish:revert
3175
-
3176
- EXAMPLES
3177
- Using --log-file
3178
-
3179
- cm:bulk-publish:revert --log-file [LOG FILE NAME]
3180
-
3181
-
3182
-
3183
- Using --retry-failed
3184
-
3185
- cm:bulk-publish:revert --retry-failed [LOG FILE NAME]
1216
+ $ csdx cm:migration --alias <management-token-alias> --file-path <migration/script/file/path>
3186
1217
  ```
3187
1218
 
3188
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-revert.js)_
1219
+ _See code: [@contentstack/cli-migration](https://github.com/contentstack/cli/blob/main/packages/contentstack-migration/src/commands/cm/stacks/migration.ts)_
3189
1220
 
3190
- ## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>] [--locale <value>]`
1221
+ ## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [-y] [--alias <value>] [--locale <value>]`
3191
1222
 
3192
1223
  Create a stack from existing content types, entries, assets, etc
3193
1224
 
3194
1225
  ```
3195
1226
  USAGE
3196
- $ csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]
3197
- [--locale <value>]
1227
+ $ csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [-y]
1228
+ [--alias <value>] [--locale <value>]
3198
1229
 
3199
1230
  FLAGS
3200
1231
  -a, --alias=<value> Alias of the management token
3201
1232
  -k, --stack-api-key=<value> Provide stack API key to seed content to
3202
1233
  -n, --stack-name=<value> Name of a new stack that needs to be created.
3203
- -o, --org=<value> Provide Organization UID to create a new stack
3204
- -r, --repo=<value> GitHub organization name or GitHub user name/repository name.
3205
- -s, --stack=<value> Provide the stack UID to seed content.
3206
- -y, --yes=<value> [Optional] Skip the stack confirmation.
1234
+ -y, --yes [Optional] Skip the stack confirmation.
1235
+ --org=<value> Provide Organization UID to create a new stack
1236
+ --repo=<value> GitHub organization name or GitHub user name/repository name.
3207
1237
 
3208
1238
  DESCRIPTION
3209
1239
  Create a stack from existing content types, entries, assets, etc
3210
1240
 
3211
- ALIASES
3212
- $ csdx cm:seed
3213
-
3214
1241
  EXAMPLES
3215
1242
  $ csdx cm:stacks:seed
3216
1243
 
@@ -3225,105 +1252,6 @@ EXAMPLES
3225
1252
 
3226
1253
  _See code: [@contentstack/cli-cm-seed](https://github.com/contentstack/cli/blob/main/packages/contentstack-seed/src/commands/cm/stacks/seed.ts)_
3227
1254
 
3228
- ## `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]`
3229
-
3230
- Unpublish entries or assets of given content types from the specified environment
3231
-
3232
- ```
3233
- USAGE
3234
- $ csdx cm:stacks:unpublish csdx cm:stacks:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>]
3235
- [--branch <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--content-type <value>] [--delivery-token
3236
- <value>] [--only-assets] [--only-entries]
3237
-
3238
- FLAGS
3239
- -B, --branch=<value> [default: main] Specify the branch to fetch the content from (default is main branch)
3240
- -a, --alias=<value> Alias(name) for the management token
3241
- -c, --config=<value> Path to the config file
3242
- -e, --environment=<value> Source Environment
3243
- -k, --stack-api-key=<value> Stack API key to be used
3244
- -l, --locale=<value> Locale filter
3245
- -y, --yes Agree to process the command with the current configuration
3246
- --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
3247
- --bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
3248
- bulkpublish API will be used to unpublish the entries and assets
3249
- --content-type=<value> Content type filter
3250
- --delivery-token=<value> The delivery token of the source environment.
3251
- --retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
3252
-
3253
- DESCRIPTION
3254
- Unpublish entries or assets of given content types from the specified environment
3255
- The unpublish command is used to unpublish entries or assets from given environment
3256
-
3257
- Environment (Source Environment) and Locale are required to execute the command successfully
3258
- But, if retry-failed flag is set, then only a logfile is required
3259
-
3260
- A content type can be specified for unpublishing entries, but if no content-type(s) is/are specified and --only-assets
3261
- is not used,
3262
- then all entries from all content types will be unpublished from the source environment
3263
-
3264
- Note: --only-assets can be used to unpublish only assets and --only-entries can be used to unpublish only entries.
3265
- (--only-assets and --only-entries cannot be used together at the same time)
3266
-
3267
-
3268
- ALIASES
3269
- $ csdx cm:bulk-publish:unpublish
3270
-
3271
- EXAMPLES
3272
- General Usage
3273
-
3274
- $ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --alias [MANAGEMENT TOKEN ALIAS] ----delivery-token [DELIVERY TOKEN]
3275
-
3276
-
3277
-
3278
- Using --config or -c flag
3279
-
3280
- Generate a config file at the current working directory using `csdx cm:bulk-publish:configure --alias [ALIAS]`
3281
-
3282
- $ csdx cm:stacks:unpublish --config [PATH TO CONFIG FILE]
3283
-
3284
- $ csdx cm:stacks:unpublish -c [PATH TO CONFIG FILE]
3285
-
3286
-
3287
-
3288
- Using --retry-failed flag
3289
-
3290
- $ csdx cm:stacks:unpublish --retry-failed [LOG FILE NAME]
3291
-
3292
-
3293
-
3294
- No content type
3295
-
3296
- $ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] (Will unpublish all entries from all content types and assets from the source environment)
3297
-
3298
-
3299
-
3300
- Using --only-assets
3301
-
3302
- $ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-assets (Will unpublish only assets from the source environment)
3303
-
3304
-
3305
-
3306
- Using --only-entries
3307
-
3308
- $ csdx cm:stacks:unpublish --environment [SOURCE ENV] --locale [LOCALE] --only-entries (Will unpublish only entries, all entries, from the source environment)
3309
-
3310
- $ 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)
3311
-
3312
-
3313
-
3314
- Using --branch flag
3315
-
3316
- $ 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]
3317
-
3318
-
3319
-
3320
- Using --stack-api-key flag
3321
-
3322
- $ 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]
3323
- ```
3324
-
3325
- _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/stacks/unpublish.js)_
3326
-
3327
1255
  ## `csdx config:get:base-branch`
3328
1256
 
3329
1257
  Get current branch set for CLI
@@ -3396,6 +1324,23 @@ EXAMPLES
3396
1324
 
3397
1325
  _See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/log.ts)_
3398
1326
 
1327
+ ## `csdx config:get:proxy`
1328
+
1329
+ Get proxy configuration for CLI
1330
+
1331
+ ```
1332
+ USAGE
1333
+ $ csdx config:get:proxy
1334
+
1335
+ DESCRIPTION
1336
+ Get proxy configuration for CLI
1337
+
1338
+ EXAMPLES
1339
+ $ csdx config:get:proxy
1340
+ ```
1341
+
1342
+ _See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/proxy.ts)_
1343
+
3399
1344
  ## `csdx config:get:rate-limit`
3400
1345
 
3401
1346
  Get rate-limit of organizations
@@ -3505,6 +1450,23 @@ EXAMPLES
3505
1450
 
3506
1451
  _See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/remove/early-access-header.ts)_
3507
1452
 
1453
+ ## `csdx config:remove:proxy`
1454
+
1455
+ Remove proxy configuration from global config
1456
+
1457
+ ```
1458
+ USAGE
1459
+ $ csdx config:remove:proxy
1460
+
1461
+ DESCRIPTION
1462
+ Remove proxy configuration from global config
1463
+
1464
+ EXAMPLES
1465
+ $ csdx config:remove:proxy
1466
+ ```
1467
+
1468
+ _See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/remove/proxy.ts)_
1469
+
3508
1470
  ## `csdx config:remove:rate-limit`
3509
1471
 
3510
1472
  Remove rate-limit of the organization
@@ -3636,6 +1598,34 @@ EXAMPLES
3636
1598
 
3637
1599
  _See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/log.ts)_
3638
1600
 
1601
+ ## `csdx config:set:proxy`
1602
+
1603
+ Set proxy configuration for CLI
1604
+
1605
+ ```
1606
+ USAGE
1607
+ $ csdx config:set:proxy --host <value> --port <value> --protocol http|https [--username <value>]
1608
+
1609
+ FLAGS
1610
+ --host=<value> (required) Proxy host address
1611
+ --port=<value> (required) Proxy port number
1612
+ --protocol=<option> (required) [default: http] Proxy protocol (http or https)
1613
+ <options: http|https>
1614
+ --username=<value> Proxy username (optional)
1615
+
1616
+ DESCRIPTION
1617
+ Set proxy configuration for CLI
1618
+
1619
+ EXAMPLES
1620
+ $ csdx config:set:proxy --host 127.0.0.1 --port 3128
1621
+
1622
+ $ csdx config:set:proxy --host proxy.example.com --port 8080 --protocol https
1623
+
1624
+ $ csdx config:set:proxy --host proxy.example.com --port 8080 --username user
1625
+ ```
1626
+
1627
+ _See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/proxy.ts)_
1628
+
3639
1629
  ## `csdx config:set:rate-limit`
3640
1630
 
3641
1631
  Set rate-limit for CLI
@@ -3669,23 +1659,26 @@ Set region for CLI
3669
1659
 
3670
1660
  ```
3671
1661
  USAGE
3672
- $ csdx config:set:region [REGION] [-d <value> -m <value> --ui-host <value> -n <value>] [--developer-hub <value>]
3673
- [--personalize <value>] [--launch <value>]
1662
+ $ csdx config:set:region [REGION] [--cda <value> --cma <value> --ui-host <value> -n <value>] [--developer-hub
1663
+ <value>] [--personalize <value>] [--launch <value>] [--studio <value>] [--asset-management <value>]
3674
1664
 
3675
1665
  ARGUMENTS
3676
1666
  [REGION] Name for the region
3677
1667
 
3678
1668
  FLAGS
3679
- -d, --cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host and
3680
- name flags are required
3681
- -m, --cma=<value> Custom host to set for content management API, , if this flag is added then cda, ui-host
3682
- and name flags are required
3683
- -n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are required
3684
- --developer-hub=<value> Custom host to set for Developer hub API
3685
- --launch=<value> Custom host to set for Launch API
3686
- --personalize=<value> Custom host to set for Personalize API
3687
- --ui-host=<value> Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
3688
- required
1669
+ -n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are
1670
+ required
1671
+ --asset-management=<value> Custom host to set for Asset Management API
1672
+ --cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host
1673
+ and name flags are required
1674
+ --cma=<value> Custom host to set for content management API, , if this flag is added then cda,
1675
+ ui-host and name flags are required
1676
+ --developer-hub=<value> Custom host to set for Developer hub API
1677
+ --launch=<value> Custom host to set for Launch API
1678
+ --personalize=<value> Custom host to set for Personalize API
1679
+ --studio=<value> Custom host to set for Studio API
1680
+ --ui-host=<value> Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
1681
+ required
3689
1682
 
3690
1683
  DESCRIPTION
3691
1684
  Set region for CLI
@@ -3715,7 +1708,11 @@ EXAMPLES
3715
1708
 
3716
1709
  $ 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>
3717
1710
 
3718
- $ 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>
1711
+ $ 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>
1712
+
1713
+ $ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --asset-management <asset_management_url>
1714
+
1715
+ $ 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>
3719
1716
  ```
3720
1717
 
3721
1718
  _See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/region.ts)_
@@ -3738,7 +1735,7 @@ DESCRIPTION
3738
1735
  Display help for csdx.
3739
1736
  ```
3740
1737
 
3741
- _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.35/src/commands/help.ts)_
1738
+ _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/6.2.44/src/commands/help.ts)_
3742
1739
 
3743
1740
  ## `csdx launch`
3744
1741
 
@@ -3747,36 +1744,37 @@ Launch related operations
3747
1744
  ```
3748
1745
  USAGE
3749
1746
  $ csdx launch [-d <value>] [-c <value>] [--type GitHub|FileUpload] [--framework Gatsby|NextJs|CRA (Create
3750
- React App)|CSR (Client-Side Rendered)|Angular|Nuxt|VueJs|Remix|Other] [--org <value>] [-n <value>] [-e <value>]
3751
- [--branch <value>] [--build-command <value>] [--out-dir <value>] [--server-command <value>] [--variable-type Import
3752
- variables from a stack|Manually add custom variables to the list|Import variables from the .env.local file|Skip
3753
- adding environment variables] [-a <value>] [--env-variables <value>] [--redeploy-latest] [--redeploy-last-upload]
3754
-
3755
- FLAGS
3756
- -a, --alias=<value> [optional] Alias (name) for the delivery token.
3757
- -c, --config=<value> Path to the local '.cs-launch.json' file
3758
- -d, --data-dir=<value> Current working directory
3759
- -e, --environment=<value> [optional] Environment name for the Launch project.
3760
- -n, --name=<value> [optional] Name of the project.
3761
- --branch=<value> [optional] GitHub branch name.
3762
- --build-command=<value> [optional] Build Command.
3763
- --env-variables=<value> [optional] Provide the environment variables in the key:value format, separated by
3764
- comma. For example: APP_ENV:prod, TEST_ENV:testVal.
3765
- --framework=<option> [optional] Type of framework. <options: Gatsby|NextJS|Other>
3766
- <options: Gatsby|NextJs|CRA (Create React App)|CSR (Client-Side
3767
- Rendered)|Angular|Nuxt|VueJs|Remix|Other>
3768
- --org=<value> [optional] Provide the organization UID to create a new project or deployment.
3769
- --out-dir=<value> [optional] Output Directory.
3770
- --redeploy-last-upload [optional] Redeploy with last file upload
3771
- --redeploy-latest [optional] Redeploy latest commit/code
3772
- --server-command=<value> [optional] Server Command.
3773
- --type=<option> [optional] Type of adapters. <options: GitHub|FileUpload>
3774
- <options: GitHub|FileUpload>
3775
- --variable-type=<option> [optional] Provide a variable type. <options: Import variables from a stack|Manually add
3776
- custom variables to the list|Import variables from the .env.local file|Skip adding
3777
- environment variables>
3778
- <options: Import variables from a stack|Manually add custom variables to the list|Import
3779
- variables from the .env.local file|Skip adding environment variables>
1747
+ React App)|CSR (Client-Side Rendered)|Analog|Angular|Nuxt|Astro|VueJs|Remix|Other] [--org <value>] [-n <value>] [-e
1748
+ <value>] [--branch <value>] [--build-command <value>] [--out-dir <value>] [--server-command <value>]
1749
+ [--variable-type Import variables from a stack|Manually add custom variables to the list|Import variables from the
1750
+ .env.local file|Skip adding environment variables...] [-a <value>] [--env-variables <value>] [--redeploy-latest]
1751
+ [--redeploy-last-upload]
1752
+
1753
+ FLAGS
1754
+ -a, --alias=<value> [optional] Alias (name) for the delivery token.
1755
+ -c, --config=<value> Path to the local '.cs-launch.json' file
1756
+ -d, --data-dir=<value> Current working directory
1757
+ -e, --environment=<value> [optional] Environment name for the Launch project.
1758
+ -n, --name=<value> [optional] Name of the project.
1759
+ --branch=<value> [optional] GitHub branch name.
1760
+ --build-command=<value> [optional] Build Command.
1761
+ --env-variables=<value> [optional] Provide the environment variables in the key:value format, separated by
1762
+ comma. For example: APP_ENV:prod, TEST_ENV:testVal.
1763
+ --framework=<option> [optional] Type of framework. <options: Gatsby|NextJS|Other>
1764
+ <options: Gatsby|NextJs|CRA (Create React App)|CSR (Client-Side
1765
+ Rendered)|Analog|Angular|Nuxt|Astro|VueJs|Remix|Other>
1766
+ --org=<value> [optional] Provide the organization UID to create a new project or deployment.
1767
+ --out-dir=<value> [optional] Output Directory.
1768
+ --redeploy-last-upload [optional] Redeploy with last file upload
1769
+ --redeploy-latest [optional] Redeploy latest commit/code
1770
+ --server-command=<value> [optional] Server Command.
1771
+ --type=<option> [optional] Type of adapters. <options: GitHub|FileUpload>
1772
+ <options: GitHub|FileUpload>
1773
+ --variable-type=<option>... [optional] Provide a variable type (can specify multiple times). <options: Import
1774
+ variables from a stack|Manually add custom variables to the list|Import variables
1775
+ from the .env.local file|Skip adding environment variables>
1776
+ <options: Import variables from a stack|Manually add custom variables to the
1777
+ list|Import variables from the .env.local file|Skip adding environment variables>
3780
1778
 
3781
1779
  DESCRIPTION
3782
1780
  Launch related operations
@@ -3807,6 +1805,8 @@ EXAMPLES
3807
1805
  $ 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>
3808
1806
 
3809
1807
  $ 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"
1808
+
1809
+ $ 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>
3810
1810
  ```
3811
1811
 
3812
1812
  _See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/index.ts)_
@@ -3879,7 +1879,7 @@ USAGE
3879
1879
  $ csdx launch:functions [-p <value>] [-d <value>]
3880
1880
 
3881
1881
  FLAGS
3882
- -d, --data-dir=<value> [default: /home/runner/work/cli/cli/packages/contentstack] Current working directory
1882
+ -d, --data-dir=<value> Current working directory
3883
1883
  -p, --port=<value> [default: 3000] Port number
3884
1884
 
3885
1885
  DESCRIPTION
@@ -4055,7 +2055,7 @@ EXAMPLES
4055
2055
  $ csdx plugins
4056
2056
  ```
4057
2057
 
4058
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.53/src/commands/plugins/index.ts)_
2058
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.61/src/commands/plugins/index.ts)_
4059
2059
 
4060
2060
  ## `csdx plugins:add PLUGIN`
4061
2061
 
@@ -4129,7 +2129,7 @@ EXAMPLES
4129
2129
  $ csdx plugins:inspect myplugin
4130
2130
  ```
4131
2131
 
4132
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.53/src/commands/plugins/inspect.ts)_
2132
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.61/src/commands/plugins/inspect.ts)_
4133
2133
 
4134
2134
  ## `csdx plugins:install PLUGIN`
4135
2135
 
@@ -4178,7 +2178,7 @@ EXAMPLES
4178
2178
  $ csdx plugins:install someuser/someplugin
4179
2179
  ```
4180
2180
 
4181
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.53/src/commands/plugins/install.ts)_
2181
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.61/src/commands/plugins/install.ts)_
4182
2182
 
4183
2183
  ## `csdx plugins:link PATH`
4184
2184
 
@@ -4209,7 +2209,7 @@ EXAMPLES
4209
2209
  $ csdx plugins:link myplugin
4210
2210
  ```
4211
2211
 
4212
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.53/src/commands/plugins/link.ts)_
2212
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.61/src/commands/plugins/link.ts)_
4213
2213
 
4214
2214
  ## `csdx plugins:remove [PLUGIN]`
4215
2215
 
@@ -4250,7 +2250,7 @@ FLAGS
4250
2250
  --reinstall Reinstall all plugins after uninstalling.
4251
2251
  ```
4252
2252
 
4253
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.53/src/commands/plugins/reset.ts)_
2253
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.61/src/commands/plugins/reset.ts)_
4254
2254
 
4255
2255
  ## `csdx plugins:uninstall [PLUGIN]`
4256
2256
 
@@ -4278,7 +2278,7 @@ EXAMPLES
4278
2278
  $ csdx plugins:uninstall myplugin
4279
2279
  ```
4280
2280
 
4281
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.53/src/commands/plugins/uninstall.ts)_
2281
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.61/src/commands/plugins/uninstall.ts)_
4282
2282
 
4283
2283
  ## `csdx plugins:unlink [PLUGIN]`
4284
2284
 
@@ -4322,7 +2322,7 @@ DESCRIPTION
4322
2322
  Update installed plugins.
4323
2323
  ```
4324
2324
 
4325
- _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.53/src/commands/plugins/update.ts)_
2325
+ _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/5.4.61/src/commands/plugins/update.ts)_
4326
2326
 
4327
2327
  ## `csdx tokens`
4328
2328