@contentstack/cli 1.38.0 → 1.40.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +141 -92
- package/oclif.manifest.json +2 -2
- package/package.json +29 -29
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/1.
|
|
21
|
+
@contentstack/cli/1.40.0 linux-x64 node-v22.14.0
|
|
22
22
|
$ csdx --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ csdx COMMAND
|
|
@@ -47,7 +47,7 @@ USAGE
|
|
|
47
47
|
* [`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
48
|
* [`csdx cm:bulk-publish`](#csdx-cmbulk-publish)
|
|
49
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
|
|
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
51
|
* [`csdx cm:bulk-publish:clear`](#csdx-cmbulk-publishclear)
|
|
52
52
|
* [`csdx cm:bulk-publish:configure`](#csdx-cmbulk-publishconfigure)
|
|
53
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)
|
|
@@ -58,12 +58,12 @@ USAGE
|
|
|
58
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
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
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
|
|
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
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
|
|
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
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
68
|
* [`csdx cm:export-to-csv`](#csdx-cmexport-to-csv)
|
|
69
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)
|
|
@@ -74,17 +74,17 @@ USAGE
|
|
|
74
74
|
* [`csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent)
|
|
75
75
|
* [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
|
|
76
76
|
* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
|
|
77
|
-
* [`csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent
|
|
78
|
-
* [`csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets
|
|
79
|
-
* [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent
|
|
80
|
-
* [`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: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
|
|
77
|
+
* [`csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent)
|
|
78
|
+
* [`csdx cm:stacks:export [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets)
|
|
79
|
+
* [`csdx cm:stacks:import [-c <value>] [-k <value>] [-d <value>] [-a <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent)
|
|
80
|
+
* [`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:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple)
|
|
82
82
|
* [`csdx cm:stacks:publish`](#csdx-cmstackspublish)
|
|
83
83
|
* [`csdx cm:stacks:publish-clear-logs`](#csdx-cmstackspublish-clear-logs)
|
|
84
84
|
* [`csdx cm:stacks:publish-configure`](#csdx-cmstackspublish-configure)
|
|
85
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
|
|
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)
|
|
88
88
|
* [`csdx config:get:base-branch`](#csdx-configgetbase-branch)
|
|
89
89
|
* [`csdx config:get:ea-header`](#csdx-configgetea-header)
|
|
90
90
|
* [`csdx config:get:early-access-header`](#csdx-configgetearly-access-header)
|
|
@@ -99,7 +99,7 @@ USAGE
|
|
|
99
99
|
* [`csdx config:set:early-access-header`](#csdx-configsetearly-access-header)
|
|
100
100
|
* [`csdx config:set:rate-limit`](#csdx-configsetrate-limit)
|
|
101
101
|
* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
|
|
102
|
-
* [`csdx help [
|
|
102
|
+
* [`csdx help [COMMAND]`](#csdx-help-command)
|
|
103
103
|
* [`csdx launch`](#csdx-launch)
|
|
104
104
|
* [`csdx launch:deployments`](#csdx-launchdeployments)
|
|
105
105
|
* [`csdx launch:environments`](#csdx-launchenvironments)
|
|
@@ -127,21 +127,30 @@ Perform audits and find possible errors in the exported Contentstack data
|
|
|
127
127
|
|
|
128
128
|
```
|
|
129
129
|
USAGE
|
|
130
|
-
$ csdx audit [--report-path <value>] [--modules
|
|
131
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets...] [--columns <value>
|
|
132
|
-
<value>] [--filter <value>] [--csv
|
|
130
|
+
$ csdx audit [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
131
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
|
|
132
|
+
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
133
133
|
|
|
134
134
|
FLAGS
|
|
135
135
|
--modules=<option>... Provide the list of modules to be audited
|
|
136
|
-
<options:
|
|
136
|
+
<options:
|
|
137
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
137
138
|
--report-path=<value> Path to store the audit reports
|
|
138
139
|
|
|
140
|
+
COMMON FLAGS
|
|
141
|
+
-c, --config=<value> Path of the external config
|
|
142
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
143
|
+
--show-console-output Display the audit and audit fix result for individual modules
|
|
144
|
+
|
|
139
145
|
TABLE FLAGS
|
|
140
|
-
--columns=<value>
|
|
141
|
-
--csv
|
|
142
|
-
--filter=<value> Filter
|
|
143
|
-
--no-
|
|
144
|
-
--
|
|
146
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
147
|
+
--csv Output results in CSV format.
|
|
148
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
149
|
+
--no-header Hide table headers in output.
|
|
150
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
151
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
152
|
+
<options: csv|json|yaml>
|
|
153
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
145
154
|
|
|
146
155
|
DESCRIPTION
|
|
147
156
|
Perform audits and find possible errors in the exported Contentstack data
|
|
@@ -168,10 +177,10 @@ Perform audits and fix possible errors in the exported Contentstack data.
|
|
|
168
177
|
|
|
169
178
|
```
|
|
170
179
|
USAGE
|
|
171
|
-
$ csdx audit:fix [--report-path <value>] [--modules
|
|
172
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets...] [--copy-path <value>
|
|
173
|
-
[--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
|
|
174
|
-
[--sort <value>] [--filter <value>] [--csv
|
|
180
|
+
$ csdx audit:fix [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
181
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
|
|
182
|
+
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
|
|
183
|
+
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
175
184
|
|
|
176
185
|
FLAGS
|
|
177
186
|
--copy-dir Create backup from the original data.
|
|
@@ -179,15 +188,24 @@ FLAGS
|
|
|
179
188
|
--fix-only=<option>... Provide the list of fix options
|
|
180
189
|
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
181
190
|
--modules=<option>... Provide the list of modules to be audited
|
|
182
|
-
<options:
|
|
191
|
+
<options:
|
|
192
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
183
193
|
--report-path=<value> Path to store the audit reports
|
|
184
194
|
|
|
195
|
+
COMMON FLAGS
|
|
196
|
+
-c, --config=<value> Path of the external config
|
|
197
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
198
|
+
--show-console-output Display the audit and audit fix result for individual modules
|
|
199
|
+
|
|
185
200
|
TABLE FLAGS
|
|
186
|
-
--columns=<value>
|
|
187
|
-
--csv
|
|
188
|
-
--filter=<value> Filter
|
|
189
|
-
--no-
|
|
190
|
-
--
|
|
201
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
202
|
+
--csv Output results in CSV format.
|
|
203
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
204
|
+
--no-header Hide table headers in output.
|
|
205
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
206
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
207
|
+
<options: csv|json|yaml>
|
|
208
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
191
209
|
|
|
192
210
|
DESCRIPTION
|
|
193
211
|
Perform audits and fix possible errors in the exported Contentstack data.
|
|
@@ -276,19 +294,18 @@ Lists all existing tokens added to the session
|
|
|
276
294
|
|
|
277
295
|
```
|
|
278
296
|
USAGE
|
|
279
|
-
$ csdx auth:tokens [--columns <value>
|
|
280
|
-
[--output csv|json|yaml
|
|
297
|
+
$ csdx auth:tokens [--columns <value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate]
|
|
298
|
+
[--no-header] [--output csv|json|yaml]
|
|
281
299
|
|
|
282
|
-
FLAGS
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
300
|
+
TABLE FLAGS
|
|
301
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
302
|
+
--csv Output results in CSV format.
|
|
303
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
304
|
+
--no-header Hide table headers in output.
|
|
305
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
306
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
307
|
+
<options: csv|json|yaml>
|
|
308
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
292
309
|
|
|
293
310
|
DESCRIPTION
|
|
294
311
|
Lists all existing tokens added to the session
|
|
@@ -2608,21 +2625,30 @@ Perform audits and find possible errors in the exported Contentstack data
|
|
|
2608
2625
|
|
|
2609
2626
|
```
|
|
2610
2627
|
USAGE
|
|
2611
|
-
$ csdx cm:stacks:audit [--report-path <value>] [--modules
|
|
2612
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets...] [--columns <value>
|
|
2613
|
-
<value>] [--filter <value>] [--csv
|
|
2628
|
+
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
2629
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
|
|
2630
|
+
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
2614
2631
|
|
|
2615
2632
|
FLAGS
|
|
2616
2633
|
--modules=<option>... Provide the list of modules to be audited
|
|
2617
|
-
<options:
|
|
2634
|
+
<options:
|
|
2635
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
2618
2636
|
--report-path=<value> Path to store the audit reports
|
|
2619
2637
|
|
|
2638
|
+
COMMON FLAGS
|
|
2639
|
+
-c, --config=<value> Path of the external config
|
|
2640
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
2641
|
+
--show-console-output Display the audit and audit fix result for individual modules
|
|
2642
|
+
|
|
2620
2643
|
TABLE FLAGS
|
|
2621
|
-
--columns=<value>
|
|
2622
|
-
--csv
|
|
2623
|
-
--filter=<value> Filter
|
|
2624
|
-
--no-
|
|
2625
|
-
--
|
|
2644
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
2645
|
+
--csv Output results in CSV format.
|
|
2646
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
2647
|
+
--no-header Hide table headers in output.
|
|
2648
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
2649
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
2650
|
+
<options: csv|json|yaml>
|
|
2651
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
2626
2652
|
|
|
2627
2653
|
DESCRIPTION
|
|
2628
2654
|
Perform audits and find possible errors in the exported Contentstack data
|
|
@@ -2651,10 +2677,10 @@ Perform audits and fix possible errors in the exported Contentstack data.
|
|
|
2651
2677
|
|
|
2652
2678
|
```
|
|
2653
2679
|
USAGE
|
|
2654
|
-
$ csdx cm:stacks:audit:fix [--report-path <value>] [--modules
|
|
2655
|
-
content-types|global-fields|entries|extensions|workflows|custom-roles|assets...] [--copy-path <value>
|
|
2656
|
-
[--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
|
|
2657
|
-
[--sort <value>] [--filter <value>] [--csv
|
|
2680
|
+
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--show-console-output] [--report-path <value>] [--modules
|
|
2681
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
|
|
2682
|
+
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
|
|
2683
|
+
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
2658
2684
|
|
|
2659
2685
|
FLAGS
|
|
2660
2686
|
--copy-dir Create backup from the original data.
|
|
@@ -2662,15 +2688,24 @@ FLAGS
|
|
|
2662
2688
|
--fix-only=<option>... Provide the list of fix options
|
|
2663
2689
|
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
2664
2690
|
--modules=<option>... Provide the list of modules to be audited
|
|
2665
|
-
<options:
|
|
2691
|
+
<options:
|
|
2692
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
2666
2693
|
--report-path=<value> Path to store the audit reports
|
|
2667
2694
|
|
|
2695
|
+
COMMON FLAGS
|
|
2696
|
+
-c, --config=<value> Path of the external config
|
|
2697
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
2698
|
+
--show-console-output Display the audit and audit fix result for individual modules
|
|
2699
|
+
|
|
2668
2700
|
TABLE FLAGS
|
|
2669
|
-
--columns=<value>
|
|
2670
|
-
--csv
|
|
2671
|
-
--filter=<value> Filter
|
|
2672
|
-
--no-
|
|
2673
|
-
--
|
|
2701
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
2702
|
+
--csv Output results in CSV format.
|
|
2703
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
2704
|
+
--no-header Hide table headers in output.
|
|
2705
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
2706
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
2707
|
+
<options: csv|json|yaml>
|
|
2708
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
2674
2709
|
|
|
2675
2710
|
DESCRIPTION
|
|
2676
2711
|
Perform audits and fix possible errors in the exported Contentstack data.
|
|
@@ -3557,6 +3592,10 @@ EXAMPLES
|
|
|
3557
3592
|
|
|
3558
3593
|
$ csdx config:set:region EU
|
|
3559
3594
|
|
|
3595
|
+
$ csdx config:set:region AWS-NA
|
|
3596
|
+
|
|
3597
|
+
$ csdx config:set:region AWS-EU
|
|
3598
|
+
|
|
3560
3599
|
$ csdx config:set:region AZURE-NA
|
|
3561
3600
|
|
|
3562
3601
|
$ csdx config:set:region AZURE-EU
|
|
@@ -3578,16 +3617,16 @@ EXAMPLES
|
|
|
3578
3617
|
|
|
3579
3618
|
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/region.ts)_
|
|
3580
3619
|
|
|
3581
|
-
## `csdx help [
|
|
3620
|
+
## `csdx help [COMMAND]`
|
|
3582
3621
|
|
|
3583
3622
|
Display help for csdx.
|
|
3584
3623
|
|
|
3585
3624
|
```
|
|
3586
3625
|
USAGE
|
|
3587
|
-
$ csdx help [
|
|
3626
|
+
$ csdx help [COMMAND...] [-n]
|
|
3588
3627
|
|
|
3589
3628
|
ARGUMENTS
|
|
3590
|
-
|
|
3629
|
+
COMMAND... Command to show help for.
|
|
3591
3630
|
|
|
3592
3631
|
FLAGS
|
|
3593
3632
|
-n, --nested-commands Include all nested commands in the output.
|
|
@@ -3596,7 +3635,7 @@ DESCRIPTION
|
|
|
3596
3635
|
Display help for csdx.
|
|
3597
3636
|
```
|
|
3598
3637
|
|
|
3599
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/
|
|
3638
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.27/src/commands/help.ts)_
|
|
3600
3639
|
|
|
3601
3640
|
## `csdx launch`
|
|
3602
3641
|
|
|
@@ -3604,14 +3643,16 @@ Launch related operations
|
|
|
3604
3643
|
|
|
3605
3644
|
```
|
|
3606
3645
|
USAGE
|
|
3607
|
-
$ csdx launch [--type GitHub|FileUpload] [--framework Gatsby|NextJs|CRA (Create
|
|
3608
|
-
(Client-Side Rendered)|Angular|VueJs|Other] [--org <value>] [-n <value>] [-e <value>] [--branch
|
|
3609
|
-
[--build-command <value>] [--out-dir <value>] [--server-command <value>] [--variable-type Import variables
|
|
3610
|
-
stack|Manually add custom variables to the list|Import variables from the local env file] [-a <value>]
|
|
3646
|
+
$ csdx launch [-d <value>] [-c <value>] [--type GitHub|FileUpload] [--framework Gatsby|NextJs|CRA (Create
|
|
3647
|
+
React App)|CSR (Client-Side Rendered)|Angular|VueJs|Other] [--org <value>] [-n <value>] [-e <value>] [--branch
|
|
3648
|
+
<value>] [--build-command <value>] [--out-dir <value>] [--server-command <value>] [--variable-type Import variables
|
|
3649
|
+
from a stack|Manually add custom variables to the list|Import variables from the local env file] [-a <value>]
|
|
3611
3650
|
[--env-variables <value>] [--redeploy-latest] [--redeploy-last-upload]
|
|
3612
3651
|
|
|
3613
3652
|
FLAGS
|
|
3614
3653
|
-a, --alias=<value> [optional] Alias (name) for the delivery token.
|
|
3654
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
3655
|
+
-d, --data-dir=<value> Current working directory
|
|
3615
3656
|
-e, --environment=<value> [optional] Environment name for the Launch project.
|
|
3616
3657
|
-n, --name=<value> [optional] Name of the project.
|
|
3617
3658
|
--branch=<value> [optional] GitHub branch name.
|
|
@@ -3672,9 +3713,11 @@ Show list of deployments for an environment
|
|
|
3672
3713
|
|
|
3673
3714
|
```
|
|
3674
3715
|
USAGE
|
|
3675
|
-
$ csdx launch:deployments [--org <value>] [--project <value>] [-e <value>]
|
|
3716
|
+
$ csdx launch:deployments [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]
|
|
3676
3717
|
|
|
3677
3718
|
FLAGS
|
|
3719
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
3720
|
+
-d, --data-dir=<value> Current working directory
|
|
3678
3721
|
-e, --environment=<value> Environment name or UID
|
|
3679
3722
|
--org=<value> [Optional] Provide the organization UID
|
|
3680
3723
|
--project=<value> [Optional] Provide the project UID
|
|
@@ -3700,11 +3743,13 @@ Show list of environments for a project
|
|
|
3700
3743
|
|
|
3701
3744
|
```
|
|
3702
3745
|
USAGE
|
|
3703
|
-
$ csdx launch:environments [--org <value>] [--project <value>]
|
|
3746
|
+
$ csdx launch:environments [-d <value>] [-c <value>] [--org <value>] [--project <value>]
|
|
3704
3747
|
|
|
3705
3748
|
FLAGS
|
|
3706
|
-
--
|
|
3707
|
-
--
|
|
3749
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
3750
|
+
-d, --data-dir=<value> Current working directory
|
|
3751
|
+
--org=<value> [Optional] Provide the organization UID
|
|
3752
|
+
--project=<value> [Optional] Provide the project UID
|
|
3708
3753
|
|
|
3709
3754
|
DESCRIPTION
|
|
3710
3755
|
Show list of environments for a project
|
|
@@ -3730,7 +3775,7 @@ USAGE
|
|
|
3730
3775
|
$ csdx launch:functions [-p <value>] [-d <value>]
|
|
3731
3776
|
|
|
3732
3777
|
FLAGS
|
|
3733
|
-
-d, --data-dir=<value> Current working directory
|
|
3778
|
+
-d, --data-dir=<value> [default: /home/runner/work/cli/cli/packages/contentstack] Current working directory
|
|
3734
3779
|
-p, --port=<value> [default: 3000] Port number
|
|
3735
3780
|
|
|
3736
3781
|
DESCRIPTION
|
|
@@ -3754,9 +3799,12 @@ Show deployment or server logs
|
|
|
3754
3799
|
|
|
3755
3800
|
```
|
|
3756
3801
|
USAGE
|
|
3757
|
-
$ csdx launch:logs [-e <value>] [--deployment <value>] [--type d|s] [--org <value>]
|
|
3802
|
+
$ csdx launch:logs [-d <value>] [-c <value>] [-e <value>] [--deployment <value>] [--type d|s] [--org <value>]
|
|
3803
|
+
[--project <value>]
|
|
3758
3804
|
|
|
3759
3805
|
FLAGS
|
|
3806
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
3807
|
+
-d, --data-dir=<value> Current working directory
|
|
3760
3808
|
-e, --environment=<value> Environment name or UID
|
|
3761
3809
|
--deployment=<value> Deployment number or UID
|
|
3762
3810
|
--org=<value> [Optional] Provide the organization UID
|
|
@@ -3798,9 +3846,11 @@ Open a website for an environment
|
|
|
3798
3846
|
|
|
3799
3847
|
```
|
|
3800
3848
|
USAGE
|
|
3801
|
-
$ csdx launch:open [--org <value>] [--project <value>] [-e <value>]
|
|
3849
|
+
$ csdx launch:open [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]
|
|
3802
3850
|
|
|
3803
3851
|
FLAGS
|
|
3852
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
3853
|
+
-d, --data-dir=<value> Current working directory
|
|
3804
3854
|
-e, --environment=<value> Environment name or UID
|
|
3805
3855
|
--org=<value> [Optional] Provide the organization UID
|
|
3806
3856
|
--project=<value> [Optional] Provide the project UID
|
|
@@ -4176,19 +4226,18 @@ Lists all existing tokens added to the session
|
|
|
4176
4226
|
|
|
4177
4227
|
```
|
|
4178
4228
|
USAGE
|
|
4179
|
-
$ csdx tokens [--columns <value>
|
|
4180
|
-
[--output csv|json|yaml
|
|
4229
|
+
$ csdx tokens [--columns <value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate]
|
|
4230
|
+
[--no-header] [--output csv|json|yaml]
|
|
4181
4231
|
|
|
4182
|
-
FLAGS
|
|
4183
|
-
|
|
4184
|
-
|
|
4185
|
-
|
|
4186
|
-
|
|
4187
|
-
|
|
4188
|
-
|
|
4189
|
-
|
|
4190
|
-
|
|
4191
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4232
|
+
TABLE FLAGS
|
|
4233
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
4234
|
+
--csv Output results in CSV format.
|
|
4235
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
4236
|
+
--no-header Hide table headers in output.
|
|
4237
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
4238
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
4239
|
+
<options: csv|json|yaml>
|
|
4240
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
4192
4241
|
|
|
4193
4242
|
DESCRIPTION
|
|
4194
4243
|
Lists all existing tokens added to the session
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentstack/cli",
|
|
3
3
|
"description": "Command-line tool (CLI) to interact with Contentstack",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.40.0",
|
|
5
5
|
"author": "Contentstack",
|
|
6
6
|
"bin": {
|
|
7
7
|
"csdx": "./bin/run.js"
|
|
@@ -22,32 +22,32 @@
|
|
|
22
22
|
"prepack": "pnpm compile && oclif manifest && oclif readme"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@contentstack/cli-audit": "~1.
|
|
26
|
-
"@contentstack/cli-auth": "~1.
|
|
27
|
-
"@contentstack/cli-cm-bootstrap": "~1.
|
|
28
|
-
"@contentstack/cli-cm-branches": "~1.
|
|
29
|
-
"@contentstack/cli-cm-bulk-publish": "~1.
|
|
30
|
-
"@contentstack/cli-cm-clone": "~1.
|
|
31
|
-
"@contentstack/cli-cm-export": "~1.
|
|
32
|
-
"@contentstack/cli-cm-export-to-csv": "~1.
|
|
33
|
-
"@contentstack/cli-cm-import": "~1.
|
|
34
|
-
"@contentstack/cli-cm-import-setup": "
|
|
35
|
-
"@contentstack/cli-cm-migrate-rte": "~1.
|
|
36
|
-
"@contentstack/cli-cm-seed": "~1.
|
|
37
|
-
"@contentstack/cli-command": "~1.
|
|
38
|
-
"@contentstack/cli-config": "~1.
|
|
39
|
-
"@contentstack/cli-launch": "^1.
|
|
40
|
-
"@contentstack/cli-migration": "~1.
|
|
41
|
-
"@contentstack/cli-utilities": "~1.
|
|
42
|
-
"@contentstack/cli-variants": "~1.
|
|
43
|
-
"@contentstack/management": "~1.
|
|
44
|
-
"@oclif/core": "^
|
|
45
|
-
"@oclif/plugin-help": "^
|
|
46
|
-
"@oclif/plugin-not-found": "^2.
|
|
25
|
+
"@contentstack/cli-audit": "~1.12.0",
|
|
26
|
+
"@contentstack/cli-auth": "~1.4.0",
|
|
27
|
+
"@contentstack/cli-cm-bootstrap": "~1.14.0",
|
|
28
|
+
"@contentstack/cli-cm-branches": "~1.4.0",
|
|
29
|
+
"@contentstack/cli-cm-bulk-publish": "~1.8.0",
|
|
30
|
+
"@contentstack/cli-cm-clone": "~1.14.0",
|
|
31
|
+
"@contentstack/cli-cm-export": "~1.16.0",
|
|
32
|
+
"@contentstack/cli-cm-export-to-csv": "~1.8.0",
|
|
33
|
+
"@contentstack/cli-cm-import": "~1.21.1",
|
|
34
|
+
"@contentstack/cli-cm-import-setup": "1.2.0",
|
|
35
|
+
"@contentstack/cli-cm-migrate-rte": "~1.5.0",
|
|
36
|
+
"@contentstack/cli-cm-seed": "~1.11.0",
|
|
37
|
+
"@contentstack/cli-command": "~1.5.0",
|
|
38
|
+
"@contentstack/cli-config": "~1.12.0",
|
|
39
|
+
"@contentstack/cli-launch": "^1.8.0",
|
|
40
|
+
"@contentstack/cli-migration": "~1.7.0",
|
|
41
|
+
"@contentstack/cli-utilities": "~1.11.0",
|
|
42
|
+
"@contentstack/cli-variants": "~1.2.0",
|
|
43
|
+
"@contentstack/management": "~1.20.2",
|
|
44
|
+
"@oclif/core": "^4.2.10",
|
|
45
|
+
"@oclif/plugin-help": "^6.2.27",
|
|
46
|
+
"@oclif/plugin-not-found": "^3.2.49",
|
|
47
47
|
"@oclif/plugin-plugins": "^5.4.36",
|
|
48
48
|
"chalk": "^4.1.2",
|
|
49
49
|
"debug": "^4.4.0",
|
|
50
|
-
"figlet": "^1.8.
|
|
50
|
+
"figlet": "^1.8.1",
|
|
51
51
|
"inquirer": "8.2.6",
|
|
52
52
|
"node-machine-id": "^1.1.12",
|
|
53
53
|
"open": "^8.4.2",
|
|
@@ -67,13 +67,13 @@
|
|
|
67
67
|
"@types/sinon": "^10.0.20",
|
|
68
68
|
"chai": "^4.5.0",
|
|
69
69
|
"eslint": "^8.57.1",
|
|
70
|
-
"eslint-config-oclif": "^
|
|
71
|
-
"eslint-config-oclif-typescript": "^3.1.
|
|
70
|
+
"eslint-config-oclif": "^6.0.44",
|
|
71
|
+
"eslint-config-oclif-typescript": "^3.1.13",
|
|
72
72
|
"globby": "^10.0.2",
|
|
73
73
|
"mocha": "10.8.2",
|
|
74
74
|
"nock": "^13.5.6",
|
|
75
75
|
"nyc": "^15.1.0",
|
|
76
|
-
"oclif": "^
|
|
76
|
+
"oclif": "^4.17.44",
|
|
77
77
|
"rimraf": "^5.0.10",
|
|
78
78
|
"shelljs": "^0.9.2",
|
|
79
79
|
"sinon": "^19.0.5",
|
|
@@ -150,9 +150,9 @@
|
|
|
150
150
|
"@contentstack/cli-migration",
|
|
151
151
|
"@contentstack/cli-cm-bulk-publish",
|
|
152
152
|
"@contentstack/cli-cm-branches",
|
|
153
|
-
"@contentstack/cli-launch",
|
|
154
153
|
"@contentstack/cli-audit",
|
|
155
|
-
"@contentstack/cli-cm-import-setup"
|
|
154
|
+
"@contentstack/cli-cm-import-setup",
|
|
155
|
+
"@contentstack/cli-launch"
|
|
156
156
|
],
|
|
157
157
|
"hooks": {
|
|
158
158
|
"prerun": [
|