@contentstack/cli 1.37.0 → 1.39.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 +138 -98
- package/oclif.manifest.json +2 -2
- package/package.json +30 -30
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.39.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,29 @@ 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>] [--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
|
+
|
|
139
144
|
TABLE FLAGS
|
|
140
|
-
--columns=<value>
|
|
141
|
-
--csv
|
|
142
|
-
--filter=<value> Filter
|
|
143
|
-
--no-
|
|
144
|
-
--
|
|
145
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
146
|
+
--csv Output results in CSV format.
|
|
147
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
148
|
+
--no-header Hide table headers in output.
|
|
149
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
150
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
151
|
+
<options: csv|json|yaml>
|
|
152
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
145
153
|
|
|
146
154
|
DESCRIPTION
|
|
147
155
|
Perform audits and find possible errors in the exported Contentstack data
|
|
@@ -168,10 +176,10 @@ Perform audits and fix possible errors in the exported Contentstack data.
|
|
|
168
176
|
|
|
169
177
|
```
|
|
170
178
|
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
|
|
179
|
+
$ csdx audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
|
|
180
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
|
|
181
|
+
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
|
|
182
|
+
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
175
183
|
|
|
176
184
|
FLAGS
|
|
177
185
|
--copy-dir Create backup from the original data.
|
|
@@ -179,15 +187,23 @@ FLAGS
|
|
|
179
187
|
--fix-only=<option>... Provide the list of fix options
|
|
180
188
|
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
181
189
|
--modules=<option>... Provide the list of modules to be audited
|
|
182
|
-
<options:
|
|
190
|
+
<options:
|
|
191
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
183
192
|
--report-path=<value> Path to store the audit reports
|
|
184
193
|
|
|
194
|
+
COMMON FLAGS
|
|
195
|
+
-c, --config=<value> Path of the external config
|
|
196
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
197
|
+
|
|
185
198
|
TABLE FLAGS
|
|
186
|
-
--columns=<value>
|
|
187
|
-
--csv
|
|
188
|
-
--filter=<value> Filter
|
|
189
|
-
--no-
|
|
190
|
-
--
|
|
199
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
200
|
+
--csv Output results in CSV format.
|
|
201
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
202
|
+
--no-header Hide table headers in output.
|
|
203
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
204
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
205
|
+
<options: csv|json|yaml>
|
|
206
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
191
207
|
|
|
192
208
|
DESCRIPTION
|
|
193
209
|
Perform audits and fix possible errors in the exported Contentstack data.
|
|
@@ -276,19 +292,18 @@ Lists all existing tokens added to the session
|
|
|
276
292
|
|
|
277
293
|
```
|
|
278
294
|
USAGE
|
|
279
|
-
$ csdx auth:tokens [--columns <value>
|
|
280
|
-
[--output csv|json|yaml
|
|
295
|
+
$ csdx auth:tokens [--columns <value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate]
|
|
296
|
+
[--no-header] [--output csv|json|yaml]
|
|
281
297
|
|
|
282
|
-
FLAGS
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
298
|
+
TABLE FLAGS
|
|
299
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
300
|
+
--csv Output results in CSV format.
|
|
301
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
302
|
+
--no-header Hide table headers in output.
|
|
303
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
304
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
305
|
+
<options: csv|json|yaml>
|
|
306
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
292
307
|
|
|
293
308
|
DESCRIPTION
|
|
294
309
|
Lists all existing tokens added to the session
|
|
@@ -2608,21 +2623,29 @@ Perform audits and find possible errors in the exported Contentstack data
|
|
|
2608
2623
|
|
|
2609
2624
|
```
|
|
2610
2625
|
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
|
|
2626
|
+
$ csdx cm:stacks:audit [-c <value>] [-d <value>] [--report-path <value>] [--modules
|
|
2627
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--columns <value>]
|
|
2628
|
+
[--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
2614
2629
|
|
|
2615
2630
|
FLAGS
|
|
2616
2631
|
--modules=<option>... Provide the list of modules to be audited
|
|
2617
|
-
<options:
|
|
2632
|
+
<options:
|
|
2633
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
2618
2634
|
--report-path=<value> Path to store the audit reports
|
|
2619
2635
|
|
|
2636
|
+
COMMON FLAGS
|
|
2637
|
+
-c, --config=<value> Path of the external config
|
|
2638
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
2639
|
+
|
|
2620
2640
|
TABLE FLAGS
|
|
2621
|
-
--columns=<value>
|
|
2622
|
-
--csv
|
|
2623
|
-
--filter=<value> Filter
|
|
2624
|
-
--no-
|
|
2625
|
-
--
|
|
2641
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
2642
|
+
--csv Output results in CSV format.
|
|
2643
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
2644
|
+
--no-header Hide table headers in output.
|
|
2645
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
2646
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
2647
|
+
<options: csv|json|yaml>
|
|
2648
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
2626
2649
|
|
|
2627
2650
|
DESCRIPTION
|
|
2628
2651
|
Perform audits and find possible errors in the exported Contentstack data
|
|
@@ -2651,10 +2674,10 @@ Perform audits and fix possible errors in the exported Contentstack data.
|
|
|
2651
2674
|
|
|
2652
2675
|
```
|
|
2653
2676
|
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
|
|
2677
|
+
$ csdx cm:stacks:audit:fix [-c <value>] [-d <value>] [--report-path <value>] [--modules
|
|
2678
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules...] [--copy-path <value>
|
|
2679
|
+
--copy-dir] [--fix-only reference|global_field|json:rte|json:extension|blocks|group|content_types...] [--columns
|
|
2680
|
+
<value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate] [--no-header] [--output csv|json|yaml]
|
|
2658
2681
|
|
|
2659
2682
|
FLAGS
|
|
2660
2683
|
--copy-dir Create backup from the original data.
|
|
@@ -2662,15 +2685,23 @@ FLAGS
|
|
|
2662
2685
|
--fix-only=<option>... Provide the list of fix options
|
|
2663
2686
|
<options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
|
|
2664
2687
|
--modules=<option>... Provide the list of modules to be audited
|
|
2665
|
-
<options:
|
|
2688
|
+
<options:
|
|
2689
|
+
content-types|global-fields|entries|extensions|workflows|custom-roles|assets|field-rules>
|
|
2666
2690
|
--report-path=<value> Path to store the audit reports
|
|
2667
2691
|
|
|
2692
|
+
COMMON FLAGS
|
|
2693
|
+
-c, --config=<value> Path of the external config
|
|
2694
|
+
-d, --data-dir=<value> Path where the data is stored
|
|
2695
|
+
|
|
2668
2696
|
TABLE FLAGS
|
|
2669
|
-
--columns=<value>
|
|
2670
|
-
--csv
|
|
2671
|
-
--filter=<value> Filter
|
|
2672
|
-
--no-
|
|
2673
|
-
--
|
|
2697
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
2698
|
+
--csv Output results in CSV format.
|
|
2699
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
2700
|
+
--no-header Hide table headers in output.
|
|
2701
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
2702
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
2703
|
+
<options: csv|json|yaml>
|
|
2704
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
2674
2705
|
|
|
2675
2706
|
DESCRIPTION
|
|
2676
2707
|
Perform audits and fix possible errors in the exported Contentstack data.
|
|
@@ -3578,16 +3609,16 @@ EXAMPLES
|
|
|
3578
3609
|
|
|
3579
3610
|
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/region.ts)_
|
|
3580
3611
|
|
|
3581
|
-
## `csdx help [
|
|
3612
|
+
## `csdx help [COMMAND]`
|
|
3582
3613
|
|
|
3583
3614
|
Display help for csdx.
|
|
3584
3615
|
|
|
3585
3616
|
```
|
|
3586
3617
|
USAGE
|
|
3587
|
-
$ csdx help [
|
|
3618
|
+
$ csdx help [COMMAND...] [-n]
|
|
3588
3619
|
|
|
3589
3620
|
ARGUMENTS
|
|
3590
|
-
|
|
3621
|
+
COMMAND... Command to show help for.
|
|
3591
3622
|
|
|
3592
3623
|
FLAGS
|
|
3593
3624
|
-n, --nested-commands Include all nested commands in the output.
|
|
@@ -3596,7 +3627,7 @@ DESCRIPTION
|
|
|
3596
3627
|
Display help for csdx.
|
|
3597
3628
|
```
|
|
3598
3629
|
|
|
3599
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/
|
|
3630
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.27/src/commands/help.ts)_
|
|
3600
3631
|
|
|
3601
3632
|
## `csdx launch`
|
|
3602
3633
|
|
|
@@ -3604,14 +3635,16 @@ Launch related operations
|
|
|
3604
3635
|
|
|
3605
3636
|
```
|
|
3606
3637
|
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>]
|
|
3638
|
+
$ csdx launch [-d <value>] [-c <value>] [--type GitHub|FileUpload] [--framework Gatsby|NextJs|CRA (Create
|
|
3639
|
+
React App)|CSR (Client-Side Rendered)|Angular|VueJs|Other] [--org <value>] [-n <value>] [-e <value>] [--branch
|
|
3640
|
+
<value>] [--build-command <value>] [--out-dir <value>] [--server-command <value>] [--variable-type Import variables
|
|
3641
|
+
from a stack|Manually add custom variables to the list|Import variables from the local env file] [-a <value>]
|
|
3611
3642
|
[--env-variables <value>] [--redeploy-latest] [--redeploy-last-upload]
|
|
3612
3643
|
|
|
3613
3644
|
FLAGS
|
|
3614
3645
|
-a, --alias=<value> [optional] Alias (name) for the delivery token.
|
|
3646
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
3647
|
+
-d, --data-dir=<value> Current working directory
|
|
3615
3648
|
-e, --environment=<value> [optional] Environment name for the Launch project.
|
|
3616
3649
|
-n, --name=<value> [optional] Name of the project.
|
|
3617
3650
|
--branch=<value> [optional] GitHub branch name.
|
|
@@ -3649,10 +3682,12 @@ EXAMPLES
|
|
|
3649
3682
|
|
|
3650
3683
|
$ csdx launch --data-dir <path/of/current/working/dir> --redeploy-latest
|
|
3651
3684
|
|
|
3652
|
-
$ csdx launch --data-dir <path/of/current/working/dir> --redeploy-
|
|
3685
|
+
$ csdx launch --data-dir <path/of/current/working/dir> --redeploy-last-upload
|
|
3653
3686
|
|
|
3654
3687
|
$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload>
|
|
3655
3688
|
|
|
3689
|
+
$ csdx launch --environment=<value> --redeploy-latest
|
|
3690
|
+
|
|
3656
3691
|
$ 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>
|
|
3657
3692
|
|
|
3658
3693
|
$ 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> --server-command=<value>
|
|
@@ -3670,9 +3705,11 @@ Show list of deployments for an environment
|
|
|
3670
3705
|
|
|
3671
3706
|
```
|
|
3672
3707
|
USAGE
|
|
3673
|
-
$ csdx launch:deployments [--org <value>] [--project <value>] [-e <value>]
|
|
3708
|
+
$ csdx launch:deployments [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]
|
|
3674
3709
|
|
|
3675
3710
|
FLAGS
|
|
3711
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
3712
|
+
-d, --data-dir=<value> Current working directory
|
|
3676
3713
|
-e, --environment=<value> Environment name or UID
|
|
3677
3714
|
--org=<value> [Optional] Provide the organization UID
|
|
3678
3715
|
--project=<value> [Optional] Provide the project UID
|
|
@@ -3698,11 +3735,13 @@ Show list of environments for a project
|
|
|
3698
3735
|
|
|
3699
3736
|
```
|
|
3700
3737
|
USAGE
|
|
3701
|
-
$ csdx launch:environments [--org <value>] [--project <value>]
|
|
3738
|
+
$ csdx launch:environments [-d <value>] [-c <value>] [--org <value>] [--project <value>]
|
|
3702
3739
|
|
|
3703
3740
|
FLAGS
|
|
3704
|
-
--
|
|
3705
|
-
--
|
|
3741
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
3742
|
+
-d, --data-dir=<value> Current working directory
|
|
3743
|
+
--org=<value> [Optional] Provide the organization UID
|
|
3744
|
+
--project=<value> [Optional] Provide the project UID
|
|
3706
3745
|
|
|
3707
3746
|
DESCRIPTION
|
|
3708
3747
|
Show list of environments for a project
|
|
@@ -3725,10 +3764,11 @@ Serve cloud functions
|
|
|
3725
3764
|
|
|
3726
3765
|
```
|
|
3727
3766
|
USAGE
|
|
3728
|
-
$ csdx launch:functions [-p <value>]
|
|
3767
|
+
$ csdx launch:functions [-p <value>] [-d <value>]
|
|
3729
3768
|
|
|
3730
3769
|
FLAGS
|
|
3731
|
-
-
|
|
3770
|
+
-d, --data-dir=<value> [default: /home/runner/work/cli/cli/packages/contentstack] Current working directory
|
|
3771
|
+
-p, --port=<value> [default: 3000] Port number
|
|
3732
3772
|
|
|
3733
3773
|
DESCRIPTION
|
|
3734
3774
|
Serve cloud functions
|
|
@@ -3740,11 +3780,7 @@ EXAMPLES
|
|
|
3740
3780
|
|
|
3741
3781
|
$ csdx launch:functions --data-dir <path/of/current/working/dir>
|
|
3742
3782
|
|
|
3743
|
-
$ csdx launch:functions --config <path/to/launch/config/file>
|
|
3744
|
-
|
|
3745
3783
|
$ csdx launch:functions --data-dir <path/of/current/working/dir> -p "port number"
|
|
3746
|
-
|
|
3747
|
-
$ csdx launch:functions --config <path/to/launch/config/file> --port=port
|
|
3748
3784
|
```
|
|
3749
3785
|
|
|
3750
3786
|
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/functions.ts)_
|
|
@@ -3755,9 +3791,12 @@ Show deployment or server logs
|
|
|
3755
3791
|
|
|
3756
3792
|
```
|
|
3757
3793
|
USAGE
|
|
3758
|
-
$ csdx launch:logs [-e <value>] [--deployment <value>] [--type d|s] [--org <value>]
|
|
3794
|
+
$ csdx launch:logs [-d <value>] [-c <value>] [-e <value>] [--deployment <value>] [--type d|s] [--org <value>]
|
|
3795
|
+
[--project <value>]
|
|
3759
3796
|
|
|
3760
3797
|
FLAGS
|
|
3798
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
3799
|
+
-d, --data-dir=<value> Current working directory
|
|
3761
3800
|
-e, --environment=<value> Environment name or UID
|
|
3762
3801
|
--deployment=<value> Deployment number or UID
|
|
3763
3802
|
--org=<value> [Optional] Provide the organization UID
|
|
@@ -3799,9 +3838,11 @@ Open a website for an environment
|
|
|
3799
3838
|
|
|
3800
3839
|
```
|
|
3801
3840
|
USAGE
|
|
3802
|
-
$ csdx launch:open [--org <value>] [--project <value>] [-e <value>]
|
|
3841
|
+
$ csdx launch:open [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]
|
|
3803
3842
|
|
|
3804
3843
|
FLAGS
|
|
3844
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
3845
|
+
-d, --data-dir=<value> Current working directory
|
|
3805
3846
|
-e, --environment=<value> Environment name or UID
|
|
3806
3847
|
--org=<value> [Optional] Provide the organization UID
|
|
3807
3848
|
--project=<value> [Optional] Provide the project UID
|
|
@@ -4177,19 +4218,18 @@ Lists all existing tokens added to the session
|
|
|
4177
4218
|
|
|
4178
4219
|
```
|
|
4179
4220
|
USAGE
|
|
4180
|
-
$ csdx tokens [--columns <value>
|
|
4181
|
-
[--output csv|json|yaml
|
|
4221
|
+
$ csdx tokens [--columns <value>] [--sort <value>] [--filter <value>] [--csv] [--no-truncate]
|
|
4222
|
+
[--no-header] [--output csv|json|yaml]
|
|
4182
4223
|
|
|
4183
|
-
FLAGS
|
|
4184
|
-
|
|
4185
|
-
|
|
4186
|
-
|
|
4187
|
-
|
|
4188
|
-
|
|
4189
|
-
|
|
4190
|
-
|
|
4191
|
-
|
|
4192
|
-
--sort=<value> property to sort by (prepend '-' for descending)
|
|
4224
|
+
TABLE FLAGS
|
|
4225
|
+
--columns=<value> Specify columns to display, comma-separated.
|
|
4226
|
+
--csv Output results in CSV format.
|
|
4227
|
+
--filter=<value> Filter rows by a column value (e.g., name=foo).
|
|
4228
|
+
--no-header Hide table headers in output.
|
|
4229
|
+
--no-truncate Prevent truncation of long text in columns.
|
|
4230
|
+
--output=<option> Specify output format: csv, json, or yaml.
|
|
4231
|
+
<options: csv|json|yaml>
|
|
4232
|
+
--sort=<value> Sort the table by a column. Use "-" for descending.
|
|
4193
4233
|
|
|
4194
4234
|
DESCRIPTION
|
|
4195
4235
|
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.39.0",
|
|
5
5
|
"author": "Contentstack",
|
|
6
6
|
"bin": {
|
|
7
7
|
"csdx": "./bin/run.js"
|
|
@@ -22,28 +22,28 @@
|
|
|
22
22
|
"prepack": "pnpm compile && oclif manifest && oclif readme"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@contentstack/cli-audit": "~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": "1.
|
|
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.11.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.0",
|
|
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.11.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.1",
|
|
44
|
+
"@oclif/core": "^4.2.7",
|
|
45
|
+
"@oclif/plugin-help": "^6.2.25",
|
|
46
|
+
"@oclif/plugin-not-found": "^3.2.42",
|
|
47
47
|
"@oclif/plugin-plugins": "^5.4.24",
|
|
48
48
|
"chalk": "^4.1.2",
|
|
49
49
|
"debug": "^4.4.0",
|
|
@@ -67,15 +67,15 @@
|
|
|
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.15",
|
|
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": "^
|
|
77
|
-
"rimraf": "^
|
|
78
|
-
"shelljs": "^0.
|
|
76
|
+
"oclif": "^4.17.30",
|
|
77
|
+
"rimraf": "^5.0.10",
|
|
78
|
+
"shelljs": "^0.9.2",
|
|
79
79
|
"sinon": "^19.0.2",
|
|
80
80
|
"tmp": "^0.2.3",
|
|
81
81
|
"ts-node": "^10.9.2",
|
|
@@ -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": [
|