@contentstack/cli 1.7.10 → 1.7.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/README.md +150 -52
- package/oclif.manifest.json +1 -1
- package/package.json +18 -18
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.7.
|
|
21
|
+
@contentstack/cli/1.7.11 linux-x64 node-v18.17.0
|
|
22
22
|
$ csdx --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ csdx COMMAND
|
|
@@ -440,9 +440,10 @@ Bootstrap contentstack apps
|
|
|
440
440
|
```
|
|
441
441
|
USAGE
|
|
442
442
|
$ csdx cm:bootstrap [--app-name <value>] [--project-dir <value>] [-k <value> | --org <value> | -n <value>] [-y
|
|
443
|
-
<value>]
|
|
443
|
+
<value>] [-a <value>]
|
|
444
444
|
|
|
445
445
|
FLAGS
|
|
446
|
+
-a, --alias=<value> Alias of the management token
|
|
446
447
|
-k, --stack-api-key=<value> Provide stack API key to seed content
|
|
447
448
|
-n, --stack-name=<value> Name of a new stack that will be created.
|
|
448
449
|
-y, --yes=<value> [Optional] Skip stack confirmation
|
|
@@ -667,6 +668,7 @@ FLAGS
|
|
|
667
668
|
-a, --alias=<value> Alias(name) for the management token
|
|
668
669
|
-c, --config=<value> Path to the config file
|
|
669
670
|
-e, --environments=<value>... Environments where entries will be published
|
|
671
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
670
672
|
-l, --locales=<value>... Locales where entries will be published
|
|
671
673
|
-t, --contentTypes=<value>... The Contenttypes from which entries will be published
|
|
672
674
|
-y, --yes Agree to process the command with the current configuration
|
|
@@ -692,7 +694,7 @@ ALIASES
|
|
|
692
694
|
EXAMPLES
|
|
693
695
|
General Usage
|
|
694
696
|
|
|
695
|
-
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --
|
|
697
|
+
$ 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]
|
|
696
698
|
|
|
697
699
|
|
|
698
700
|
|
|
@@ -714,7 +716,13 @@ EXAMPLES
|
|
|
714
716
|
|
|
715
717
|
Using --branch
|
|
716
718
|
|
|
717
|
-
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --
|
|
719
|
+
$ 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]
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
Using --stack-api-key
|
|
724
|
+
|
|
725
|
+
$ 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]
|
|
718
726
|
```
|
|
719
727
|
|
|
720
728
|
## `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>]`
|
|
@@ -829,10 +837,11 @@ The configure command is used to generate a configuration file for publish scrip
|
|
|
829
837
|
|
|
830
838
|
```
|
|
831
839
|
USAGE
|
|
832
|
-
$ csdx cm:bulk-publish:configure [-a <value>]
|
|
840
|
+
$ csdx cm:bulk-publish:configure [-a <value>] [-k <value>]
|
|
833
841
|
|
|
834
842
|
FLAGS
|
|
835
|
-
-a, --alias=<value>
|
|
843
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
844
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
836
845
|
|
|
837
846
|
DESCRIPTION
|
|
838
847
|
The configure command is used to generate a configuration file for publish scripts.
|
|
@@ -846,6 +855,8 @@ EXAMPLES
|
|
|
846
855
|
$ csdx cm:stacks:publish-configure -a <management_token_alias>
|
|
847
856
|
|
|
848
857
|
$ csdx cm:stacks:publish-configure --alias <management_token_alias>
|
|
858
|
+
|
|
859
|
+
$ csdx cm:stacks:publish-configure --stack-api-key <stack_api_key>
|
|
849
860
|
```
|
|
850
861
|
|
|
851
862
|
## `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]`
|
|
@@ -942,6 +953,7 @@ FLAGS
|
|
|
942
953
|
-c, --config=<value> Path for the external config file (A new config file can be generated at the current
|
|
943
954
|
working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
|
|
944
955
|
-e, --environments=<value>... Environments where entries will be published
|
|
956
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
945
957
|
-l, --locales=<value>... Locales where entries will be published
|
|
946
958
|
-y, --yes Agree to process the command with the current configuration
|
|
947
959
|
--api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
@@ -1001,6 +1013,12 @@ EXAMPLES
|
|
|
1001
1013
|
Using --source-env
|
|
1002
1014
|
|
|
1003
1015
|
$ 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]
|
|
1016
|
+
|
|
1017
|
+
|
|
1018
|
+
|
|
1019
|
+
Using --stack-api-key
|
|
1020
|
+
|
|
1021
|
+
$ 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]
|
|
1004
1022
|
```
|
|
1005
1023
|
|
|
1006
1024
|
## `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>]`
|
|
@@ -1018,6 +1036,7 @@ FLAGS
|
|
|
1018
1036
|
-a, --alias=<value> Alias(name) for the management token
|
|
1019
1037
|
-c, --config=<value> Path to the config file
|
|
1020
1038
|
-e, --environments=<value>... Destination environments
|
|
1039
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
1021
1040
|
-l, --locales=<value>... Locales where edited entries will be published
|
|
1022
1041
|
-y, --yes Agree to process the command with the current configuration
|
|
1023
1042
|
--api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
@@ -1068,6 +1087,12 @@ EXAMPLES
|
|
|
1068
1087
|
Using --branch
|
|
1069
1088
|
|
|
1070
1089
|
$ 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]
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
Using --stack-api-key
|
|
1094
|
+
|
|
1095
|
+
$ 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]
|
|
1071
1096
|
```
|
|
1072
1097
|
|
|
1073
1098
|
## `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>]`
|
|
@@ -1085,6 +1110,7 @@ FLAGS
|
|
|
1085
1110
|
-a, --alias=<value> Alias(name) for the management token
|
|
1086
1111
|
-c, --config=<value> Path to the config file
|
|
1087
1112
|
-e, --environments=<value>... Destination environments
|
|
1113
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
1088
1114
|
-y, --yes Agree to process the command with the current configuration
|
|
1089
1115
|
--api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1090
1116
|
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
@@ -1131,6 +1157,12 @@ EXAMPLES
|
|
|
1131
1157
|
Using --branch flag
|
|
1132
1158
|
|
|
1133
1159
|
$ 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]
|
|
1160
|
+
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
Using --stack-api-key flag
|
|
1164
|
+
|
|
1165
|
+
$ 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]
|
|
1134
1166
|
```
|
|
1135
1167
|
|
|
1136
1168
|
## `csdx cm:bulk-publish:revert`
|
|
@@ -1177,18 +1209,19 @@ USAGE
|
|
|
1177
1209
|
[--only-assets] [--only-entries]
|
|
1178
1210
|
|
|
1179
1211
|
FLAGS
|
|
1180
|
-
-B, --branch=<value>
|
|
1181
|
-
-a, --alias=<value>
|
|
1182
|
-
-c, --config=<value>
|
|
1183
|
-
-e, --environment=<value>
|
|
1184
|
-
-
|
|
1185
|
-
-
|
|
1186
|
-
|
|
1187
|
-
--
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
--
|
|
1191
|
-
--
|
|
1212
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content from (default is main branch)
|
|
1213
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
1214
|
+
-c, --config=<value> Path to the config file
|
|
1215
|
+
-e, --environment=<value> Source Environment
|
|
1216
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
1217
|
+
-l, --locale=<value> Locale filter
|
|
1218
|
+
-y, --yes Agree to process the command with the current configuration
|
|
1219
|
+
--api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1220
|
+
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
1221
|
+
bulkpublish API will be used to unpublish the entries and assets
|
|
1222
|
+
--content-type=<value> Content type filter
|
|
1223
|
+
--delivery-token=<value> Delivery token for source environment
|
|
1224
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
1192
1225
|
|
|
1193
1226
|
DESCRIPTION
|
|
1194
1227
|
Unpublish entries or assets of given content types from the specified environment
|
|
@@ -1254,6 +1287,12 @@ EXAMPLES
|
|
|
1254
1287
|
Using --branch flag
|
|
1255
1288
|
|
|
1256
1289
|
$ 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]
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
|
|
1293
|
+
Using --stack-api-key flag
|
|
1294
|
+
|
|
1295
|
+
$ 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]
|
|
1257
1296
|
```
|
|
1258
1297
|
|
|
1259
1298
|
## `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>]`
|
|
@@ -1274,6 +1313,7 @@ FLAGS
|
|
|
1274
1313
|
bulkpublish API will be used to publish the entries
|
|
1275
1314
|
-c, --config=<value> Path to the config file
|
|
1276
1315
|
-e, --environments=<value>... Destination environments
|
|
1316
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
1277
1317
|
-y, --yes Agree to process the command with the current configuration
|
|
1278
1318
|
--api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1279
1319
|
--content-types=<value>... The Contenttypes from which entries will be published
|
|
@@ -1320,6 +1360,12 @@ EXAMPLES
|
|
|
1320
1360
|
Using --branch
|
|
1321
1361
|
|
|
1322
1362
|
$ 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]
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
Using --stack-api-key
|
|
1367
|
+
|
|
1368
|
+
$ 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]
|
|
1323
1369
|
```
|
|
1324
1370
|
|
|
1325
1371
|
## `csdx cm:entries:migrate-html-rte`
|
|
@@ -1400,6 +1446,7 @@ FLAGS
|
|
|
1400
1446
|
-c, --config=<value> Path for the external config file (A new config file can be generated at the current
|
|
1401
1447
|
working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
|
|
1402
1448
|
-e, --environments=<value>... Environments where entries will be published
|
|
1449
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
1403
1450
|
-l, --locales=<value>... Locales where entries will be published
|
|
1404
1451
|
-y, --yes Agree to process the command with the current configuration
|
|
1405
1452
|
--api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
@@ -1459,6 +1506,12 @@ EXAMPLES
|
|
|
1459
1506
|
Using --source-env
|
|
1460
1507
|
|
|
1461
1508
|
$ 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]
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
|
|
1512
|
+
Using --stack-api-key
|
|
1513
|
+
|
|
1514
|
+
$ 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]
|
|
1462
1515
|
```
|
|
1463
1516
|
|
|
1464
1517
|
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js)_
|
|
@@ -1478,6 +1531,7 @@ FLAGS
|
|
|
1478
1531
|
-a, --alias=<value> Alias(name) for the management token
|
|
1479
1532
|
-c, --config=<value> Path to the config file
|
|
1480
1533
|
-e, --environments=<value>... Destination environments
|
|
1534
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
1481
1535
|
-l, --locales=<value>... Locales where edited entries will be published
|
|
1482
1536
|
-y, --yes Agree to process the command with the current configuration
|
|
1483
1537
|
--api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
@@ -1528,6 +1582,12 @@ EXAMPLES
|
|
|
1528
1582
|
Using --branch
|
|
1529
1583
|
|
|
1530
1584
|
$ 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]
|
|
1585
|
+
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
Using --stack-api-key
|
|
1589
|
+
|
|
1590
|
+
$ 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]
|
|
1531
1591
|
```
|
|
1532
1592
|
|
|
1533
1593
|
_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)_
|
|
@@ -1547,6 +1607,7 @@ FLAGS
|
|
|
1547
1607
|
-a, --alias=<value> Alias(name) for the management token
|
|
1548
1608
|
-c, --config=<value> Path to the config file
|
|
1549
1609
|
-e, --environments=<value>... Destination environments
|
|
1610
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
1550
1611
|
-y, --yes Agree to process the command with the current configuration
|
|
1551
1612
|
--api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1552
1613
|
--bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
@@ -1593,6 +1654,12 @@ EXAMPLES
|
|
|
1593
1654
|
Using --branch flag
|
|
1594
1655
|
|
|
1595
1656
|
$ 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]
|
|
1657
|
+
|
|
1658
|
+
|
|
1659
|
+
|
|
1660
|
+
Using --stack-api-key flag
|
|
1661
|
+
|
|
1662
|
+
$ 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]
|
|
1596
1663
|
```
|
|
1597
1664
|
|
|
1598
1665
|
_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)_
|
|
@@ -1615,6 +1682,7 @@ FLAGS
|
|
|
1615
1682
|
bulkpublish API will be used to publish the entries
|
|
1616
1683
|
-c, --config=<value> Path to the config file
|
|
1617
1684
|
-e, --environments=<value>... Destination environments
|
|
1685
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
1618
1686
|
-y, --yes Agree to process the command with the current configuration
|
|
1619
1687
|
--api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1620
1688
|
--content-types=<value>... The Contenttypes from which entries will be published
|
|
@@ -1661,6 +1729,12 @@ EXAMPLES
|
|
|
1661
1729
|
Using --branch
|
|
1662
1730
|
|
|
1663
1731
|
$ 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]
|
|
1732
|
+
|
|
1733
|
+
|
|
1734
|
+
|
|
1735
|
+
Using --stack-api-key
|
|
1736
|
+
|
|
1737
|
+
$ 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]
|
|
1664
1738
|
```
|
|
1665
1739
|
|
|
1666
1740
|
_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)_
|
|
@@ -1671,24 +1745,25 @@ Unpublish entries from the given environment
|
|
|
1671
1745
|
|
|
1672
1746
|
```
|
|
1673
1747
|
USAGE
|
|
1674
|
-
$ csdx cm:entries:unpublish [-a <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch
|
|
1675
|
-
[--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--content-type <value>]
|
|
1748
|
+
$ csdx cm:entries:unpublish [-a <value>] [-k <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch
|
|
1749
|
+
<value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--content-type <value>]
|
|
1676
1750
|
[--delivery-token <value>]
|
|
1677
1751
|
|
|
1678
1752
|
FLAGS
|
|
1679
|
-
-a, --alias=<value>
|
|
1680
|
-
-c, --config=<value>
|
|
1681
|
-
-e, --environment=<value>
|
|
1682
|
-
-
|
|
1683
|
-
|
|
1684
|
-
--
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
--
|
|
1690
|
-
--
|
|
1691
|
-
--
|
|
1753
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
1754
|
+
-c, --config=<value> Path to the config file
|
|
1755
|
+
-e, --environment=<value> Source Environment
|
|
1756
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
1757
|
+
-y, --yes Agree to process the command with the current configuration
|
|
1758
|
+
--api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
1759
|
+
--branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
|
|
1760
|
+
selected)
|
|
1761
|
+
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
1762
|
+
bulkpublish API will be used to unpublish the entries
|
|
1763
|
+
--content-type=<value> Content type filter
|
|
1764
|
+
--delivery-token=<value> Delivery token for source environment
|
|
1765
|
+
--locale=<value> Locale filter
|
|
1766
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile
|
|
1692
1767
|
|
|
1693
1768
|
DESCRIPTION
|
|
1694
1769
|
Unpublish entries from the given environment
|
|
@@ -1720,11 +1795,15 @@ EXAMPLES
|
|
|
1720
1795
|
|
|
1721
1796
|
|
|
1722
1797
|
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
1798
|
Using --branch flag
|
|
1726
1799
|
|
|
1727
1800
|
$ 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]
|
|
1801
|
+
|
|
1802
|
+
|
|
1803
|
+
|
|
1804
|
+
Using --stack-api-key flag
|
|
1805
|
+
|
|
1806
|
+
$ 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]
|
|
1728
1807
|
```
|
|
1729
1808
|
|
|
1730
1809
|
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/unpublish.js)_
|
|
@@ -1744,6 +1823,7 @@ FLAGS
|
|
|
1744
1823
|
-a, --alias=<value> Alias(name) for the management token
|
|
1745
1824
|
-c, --config=<value> Path to the config file
|
|
1746
1825
|
-e, --environments=<value>... Environments where entries will be published
|
|
1826
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
1747
1827
|
-l, --locales=<value>... Locales where entries will be published
|
|
1748
1828
|
-t, --contentTypes=<value>... The Contenttypes from which entries will be published
|
|
1749
1829
|
-y, --yes Agree to process the command with the current configuration
|
|
@@ -1769,7 +1849,7 @@ ALIASES
|
|
|
1769
1849
|
EXAMPLES
|
|
1770
1850
|
General Usage
|
|
1771
1851
|
|
|
1772
|
-
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --
|
|
1852
|
+
$ 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]
|
|
1773
1853
|
|
|
1774
1854
|
|
|
1775
1855
|
|
|
@@ -1791,7 +1871,13 @@ EXAMPLES
|
|
|
1791
1871
|
|
|
1792
1872
|
Using --branch
|
|
1793
1873
|
|
|
1794
|
-
$ csdx cm:entries:update-and-publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --
|
|
1874
|
+
$ 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]
|
|
1875
|
+
|
|
1876
|
+
|
|
1877
|
+
|
|
1878
|
+
Using --stack-api-key
|
|
1879
|
+
|
|
1880
|
+
$ 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]
|
|
1795
1881
|
```
|
|
1796
1882
|
|
|
1797
1883
|
_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)_
|
|
@@ -2044,6 +2130,7 @@ USAGE
|
|
|
2044
2130
|
$ csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]
|
|
2045
2131
|
|
|
2046
2132
|
FLAGS
|
|
2133
|
+
-a, --alias=<value> Alias of the management token
|
|
2047
2134
|
-k, --stack-api-key=<value> Provide stack api key to seed content to
|
|
2048
2135
|
-n, --stack-name=<value> Name of a new stack that needs to be created.
|
|
2049
2136
|
-o, --org=<value> Provide Organization UID to create a new stack
|
|
@@ -2389,10 +2476,11 @@ The configure command is used to generate a configuration file for publish scrip
|
|
|
2389
2476
|
|
|
2390
2477
|
```
|
|
2391
2478
|
USAGE
|
|
2392
|
-
$ csdx cm:stacks:publish-configure [-a <value>]
|
|
2479
|
+
$ csdx cm:stacks:publish-configure [-a <value>] [-k <value>]
|
|
2393
2480
|
|
|
2394
2481
|
FLAGS
|
|
2395
|
-
-a, --alias=<value>
|
|
2482
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
2483
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
2396
2484
|
|
|
2397
2485
|
DESCRIPTION
|
|
2398
2486
|
The configure command is used to generate a configuration file for publish scripts.
|
|
@@ -2406,6 +2494,8 @@ EXAMPLES
|
|
|
2406
2494
|
$ csdx cm:stacks:publish-configure -a <management_token_alias>
|
|
2407
2495
|
|
|
2408
2496
|
$ csdx cm:stacks:publish-configure --alias <management_token_alias>
|
|
2497
|
+
|
|
2498
|
+
$ csdx cm:stacks:publish-configure --stack-api-key <stack_api_key>
|
|
2409
2499
|
```
|
|
2410
2500
|
|
|
2411
2501
|
_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)_
|
|
@@ -2454,6 +2544,7 @@ USAGE
|
|
|
2454
2544
|
$ csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]
|
|
2455
2545
|
|
|
2456
2546
|
FLAGS
|
|
2547
|
+
-a, --alias=<value> Alias of the management token
|
|
2457
2548
|
-k, --stack-api-key=<value> Provide stack api key to seed content to
|
|
2458
2549
|
-n, --stack-name=<value> Name of a new stack that needs to be created.
|
|
2459
2550
|
-o, --org=<value> Provide Organization UID to create a new stack
|
|
@@ -2492,18 +2583,19 @@ USAGE
|
|
|
2492
2583
|
[--only-assets] [--only-entries]
|
|
2493
2584
|
|
|
2494
2585
|
FLAGS
|
|
2495
|
-
-B, --branch=<value>
|
|
2496
|
-
-a, --alias=<value>
|
|
2497
|
-
-c, --config=<value>
|
|
2498
|
-
-e, --environment=<value>
|
|
2499
|
-
-
|
|
2500
|
-
-
|
|
2501
|
-
|
|
2502
|
-
--
|
|
2503
|
-
|
|
2504
|
-
|
|
2505
|
-
--
|
|
2506
|
-
--
|
|
2586
|
+
-B, --branch=<value> [default: main] Specify the branch to fetch the content from (default is main branch)
|
|
2587
|
+
-a, --alias=<value> Alias(name) for the management token
|
|
2588
|
+
-c, --config=<value> Path to the config file
|
|
2589
|
+
-e, --environment=<value> Source Environment
|
|
2590
|
+
-k, --stack-api-key=<value> Stack api key to be used
|
|
2591
|
+
-l, --locale=<value> Locale filter
|
|
2592
|
+
-y, --yes Agree to process the command with the current configuration
|
|
2593
|
+
--api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
|
|
2594
|
+
--bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
|
|
2595
|
+
bulkpublish API will be used to unpublish the entries and assets
|
|
2596
|
+
--content-type=<value> Content type filter
|
|
2597
|
+
--delivery-token=<value> Delivery token for source environment
|
|
2598
|
+
--retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
|
|
2507
2599
|
|
|
2508
2600
|
DESCRIPTION
|
|
2509
2601
|
Unpublish entries or assets of given content types from the specified environment
|
|
@@ -2569,6 +2661,12 @@ EXAMPLES
|
|
|
2569
2661
|
Using --branch flag
|
|
2570
2662
|
|
|
2571
2663
|
$ 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]
|
|
2664
|
+
|
|
2665
|
+
|
|
2666
|
+
|
|
2667
|
+
Using --stack-api-key flag
|
|
2668
|
+
|
|
2669
|
+
$ 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]
|
|
2572
2670
|
```
|
|
2573
2671
|
|
|
2574
2672
|
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/stacks/unpublish.js)_
|
|
@@ -2709,7 +2807,7 @@ DESCRIPTION
|
|
|
2709
2807
|
Display help for csdx.
|
|
2710
2808
|
```
|
|
2711
2809
|
|
|
2712
|
-
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.
|
|
2810
|
+
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.13/src/commands/help.ts)_
|
|
2713
2811
|
|
|
2714
2812
|
## `csdx launch`
|
|
2715
2813
|
|
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.7.
|
|
4
|
+
"version": "1.7.11",
|
|
5
5
|
"author": "Contentstack",
|
|
6
6
|
"bin": {
|
|
7
7
|
"csdx": "./bin/run"
|
|
@@ -22,26 +22,26 @@
|
|
|
22
22
|
"prepack": "pnpm compile && oclif manifest && oclif readme"
|
|
23
23
|
},
|
|
24
24
|
"dependencies": {
|
|
25
|
-
"@contentstack/cli-auth": "^1.3.
|
|
26
|
-
"@contentstack/cli-cm-bootstrap": "^1.4.
|
|
27
|
-
"@contentstack/cli-cm-bulk-publish": "^1.3.
|
|
28
|
-
"@contentstack/cli-cm-clone": "^1.4.
|
|
29
|
-
"@contentstack/cli-cm-export": "^1.
|
|
30
|
-
"@contentstack/cli-cm-export-to-csv": "^1.3.
|
|
31
|
-
"@contentstack/cli-cm-import": "^1.
|
|
32
|
-
"@contentstack/cli-cm-migrate-rte": "^1.4.
|
|
33
|
-
"@contentstack/cli-cm-seed": "^1.4.
|
|
34
|
-
"@contentstack/cli-command": "^1.2.
|
|
35
|
-
"@contentstack/cli-config": "^1.4.
|
|
36
|
-
"@contentstack/cli-launch": "^1.0.
|
|
37
|
-
"@contentstack/cli-migration": "^1.3.
|
|
38
|
-
"@contentstack/cli-utilities": "^1.5.
|
|
39
|
-
"@contentstack/management": "
|
|
40
|
-
"@contentstack/cli-cm-branches": "^1.0.
|
|
25
|
+
"@contentstack/cli-auth": "^1.3.12",
|
|
26
|
+
"@contentstack/cli-cm-bootstrap": "^1.4.13",
|
|
27
|
+
"@contentstack/cli-cm-bulk-publish": "^1.3.10",
|
|
28
|
+
"@contentstack/cli-cm-clone": "^1.4.13",
|
|
29
|
+
"@contentstack/cli-cm-export": "^1.7.0",
|
|
30
|
+
"@contentstack/cli-cm-export-to-csv": "^1.3.12",
|
|
31
|
+
"@contentstack/cli-cm-import": "^1.7.0",
|
|
32
|
+
"@contentstack/cli-cm-migrate-rte": "^1.4.10",
|
|
33
|
+
"@contentstack/cli-cm-seed": "^1.4.13",
|
|
34
|
+
"@contentstack/cli-command": "^1.2.11",
|
|
35
|
+
"@contentstack/cli-config": "^1.4.10",
|
|
36
|
+
"@contentstack/cli-launch": "^1.0.9",
|
|
37
|
+
"@contentstack/cli-migration": "^1.3.10",
|
|
38
|
+
"@contentstack/cli-utilities": "^1.5.1",
|
|
39
|
+
"@contentstack/management": "~1.10.0",
|
|
40
|
+
"@contentstack/cli-cm-branches": "^1.0.10",
|
|
41
41
|
"@oclif/plugin-help": "^5",
|
|
42
42
|
"@oclif/plugin-not-found": "^2.3.9",
|
|
43
43
|
"@oclif/plugin-plugins": "^2.1.7",
|
|
44
|
-
"@oclif/core": "^2.
|
|
44
|
+
"@oclif/core": "^2.9.3",
|
|
45
45
|
"chalk": "^4.1.2",
|
|
46
46
|
"debug": "^4.1.1",
|
|
47
47
|
"figlet": "^1.5.2",
|