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