@contentstack/cli 1.29.0 → 1.30.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.
Files changed (3) hide show
  1. package/README.md +621 -401
  2. package/oclif.manifest.json +1 -1
  3. package/package.json +10 -10
package/README.md CHANGED
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli
18
18
  $ csdx COMMAND
19
19
  running command...
20
20
  $ csdx (--version|-v)
21
- @contentstack/cli/1.29.0 linux-x64 node-v18.20.4
21
+ @contentstack/cli/1.30.0 linux-x64 node-v18.20.4
22
22
  $ csdx --help [COMMAND]
23
23
  USAGE
24
24
  $ csdx COMMAND
@@ -50,15 +50,15 @@ USAGE
50
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-1)
51
51
  * [`csdx cm:bulk-publish:clear`](#csdx-cmbulk-publishclear)
52
52
  * [`csdx cm:bulk-publish:configure`](#csdx-cmbulk-publishconfigure)
53
- * [`csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries]`](#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)
54
- * [`csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>]`](#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)
53
+ * [`csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>] [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y] [--branch <value>] [--onlyAssets] [--onlyEntries] [--include-variants]`](#csdx-cmbulk-publishcross-publish--a-value---retry-failed-value---bulk-publish-value---content-type-value---locales-value---source-env-value---environments-value---delivery-token-value--c-value--y---branch-value---onlyassets---onlyentries---include-variants)
54
+ * [`csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token <value>] [--source-env <value>] [--entry-uid <value>] [--include-variants]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value---entry-uid-value---include-variants)
55
55
  * [`csdx cm:entries:publish-modified [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value)
56
56
  * [`csdx cm:entries:publish-non-localized-fields [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--source-env <value>] [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value)
57
57
  * [`csdx cm:bulk-publish:revert`](#csdx-cmbulk-publishrevert)
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>]`](#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-1)
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-1)
62
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-1)
63
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-1)
64
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-1)
@@ -217,8 +217,8 @@ USAGE
217
217
  $ csdx auth:login [-u <value> | --oauth] [-p <value> | ]
218
218
 
219
219
  FLAGS
220
- -p, --password=<value> Password
221
- -u, --username=<value> User name
220
+ -p, --password=<value> Password of your Contentstack app
221
+ -u, --username=<value> Email address of your Contentstack account.
222
222
  --oauth Enables single sign-on (SSO) in Contentstack CLI
223
223
 
224
224
  DESCRIPTION
@@ -309,7 +309,7 @@ USAGE
309
309
  $ csdx auth:tokens:add [-a <value>] [--delivery] [--management] [-e <value>] [-k <value>] [-y] [--token <value>]
310
310
 
311
311
  FLAGS
312
- -a, --alias=<value> Name of the token alias
312
+ -a, --alias=<value> Alias (name) you want to assign to the token
313
313
  -d, --delivery Set this flag to save delivery token
314
314
  -e, --environment=<value> Environment name for delivery token
315
315
  -k, --stack-api-key=<value> Stack API Key
@@ -355,8 +355,8 @@ USAGE
355
355
  $ csdx auth:tokens:remove [-a <value>] [-i]
356
356
 
357
357
  FLAGS
358
- -a, --alias=<value> Token alias
359
- -i, --ignore Ignore
358
+ -a, --alias=<value> Alias (name) of the token to delete.
359
+ -i, --ignore Ignores if the token is not present.
360
360
 
361
361
  DESCRIPTION
362
362
  Removes selected tokens
@@ -399,21 +399,29 @@ USAGE
399
399
  <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>] [--delivery-token <value>] [--source-env <value>]
400
400
 
401
401
  FLAGS
402
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
403
- selected)
404
- -a, --alias=<value> Alias(name) for the management token
405
- -c, --config=<value> Path to the config file
406
- -e, --environments=<value>... Environments where assets will be published
407
- -k, --stack-api-key=<value> Stack api key to be used
408
- -l, --locales=<value>... Locales to where assets will be published
409
- -y, --yes Agree to process the command with the current configuration
410
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
411
- --bulk-publish=<value> [default: true] By default this flag is set as true. It indicates that contentstack's
412
- bulkpublish API will be used to publish the assets
413
- --delivery-token=<value> Delivery token for source environment
414
- --folder-uid=<value> [default: cs_root] Folder-uid from where the assets will be published
415
- --retry-failed=<value> Retry publishing failed assets from the logfile (optional, will override all other
416
- flags)
402
+ -B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
403
+ operation. If you don’t mention the branch name, then by default the assets from the
404
+ main branch will be published.
405
+ -a, --alias=<value> Alias (name) for the management token. You must use either the --alias flag or the
406
+ --stack-api-key flag.
407
+ -c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
408
+ for a single run. Refer to the configure command to create a configuration file.
409
+ -e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
410
+ environments, specify their names separated by spaces.
411
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
412
+ --alias flag.
413
+ -l, --locales=<value>... Locales in which assets will be published, e.g., en-us. In the case of multiple
414
+ locales, specify the codes separated by spaces.
415
+ -y, --yes Set it to true to process the command with the current configuration.
416
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
417
+ --bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
418
+ default.
419
+ --delivery-token=<value> The delivery token of the source environment.
420
+ --folder-uid=<value> (optional) The UID of the Assets’ folder from which the assets need to be published.
421
+ The default value is cs_root.
422
+ --retry-failed=<value> Use this option to retry publishing the failed assets from the logfile. Specify the
423
+ name of the logfile that lists failed publish calls. If this option is used, it will
424
+ override all other flags.
417
425
  --source-env=<value> Source environment
418
426
 
419
427
  DESCRIPTION
@@ -479,19 +487,25 @@ USAGE
479
487
  <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--delivery-token <value>]
480
488
 
481
489
  FLAGS
482
- -a, --alias=<value> Alias(name) for the management token
483
- -c, --config=<value> Path to the config file
484
- -e, --environment=<value> Source Environment
485
- -k, --stack-api-key=<value> Stack api key to be used
486
- -y, --yes Agree to process the command with the current configuration
487
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
488
- --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
489
- selected)
490
- --bulk-unpublish=<value> [default: true] By default this flag is set as true. It indicates that contentstack's
491
- bulkpublish API will be used to unpublish the assets
492
- --delivery-token=<value> Delivery Token for source environment
493
- --locale=<value> Locale filter
494
- --retry-failed=<value> Retry unpublishing failed assets from the logfile
490
+ -a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
491
+ --stack-api-key flag.
492
+ -c, --config=<value> (optional) Path of an optional configuration JSON file containing all the options for a
493
+ single run. Refer to the configure command to create a configuration file.
494
+ -e, --environment=<value> The name of the environment from where entries/assets need to be unpublished.
495
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
496
+ flag.
497
+ -y, --yes Set it to true to process the command with the current configuration.
498
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
499
+ --branch=<value> [default: main] The name of the branch where you want to perform the bulk unpublish
500
+ operation. If you don’t mention the branch name, then by default the content from the
501
+ main branch will be unpublished.
502
+ --bulk-unpublish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
503
+ default.
504
+ --delivery-token=<value> The delivery token of the source environment.
505
+ --locale=<value> Locale from which entries/assets will be unpublished, e.g., en-us.
506
+ --retry-failed=<value> (optional) Use this option to retry unpublishing the failed entries from the logfile.
507
+ Specify the name of the logfile that lists failed unpublish calls. If this option is
508
+ used, it will override all other flags.
495
509
 
496
510
  DESCRIPTION
497
511
  Unpublish assets from given environment
@@ -582,8 +596,8 @@ USAGE
582
596
  $ csdx cm:branches
583
597
 
584
598
  FLAGS
585
- -k, --stack-api-key=<value> Stack API Key
586
- --verbose Verbose
599
+ -k, --stack-api-key=<value> Stack API key
600
+ --verbose Verbose, display information in detailed format.
587
601
 
588
602
  DESCRIPTION
589
603
  List the branches
@@ -610,8 +624,8 @@ USAGE
610
624
 
611
625
  FLAGS
612
626
  -k, --stack-api-key=<value> Stack API key
613
- --source=<value> Source branch from which new branch to be created
614
- --uid=<value> Branch UID to be created
627
+ --source=<value> Source branch from which a new branch is to be created.
628
+ --uid=<value> Branch UID (unique name) to be created.
615
629
 
616
630
  DESCRIPTION
617
631
  Create a new branch
@@ -664,12 +678,13 @@ USAGE
664
678
  $ csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]
665
679
 
666
680
  FLAGS
667
- -k, --stack-api-key=<value> Provide Stack API key to show difference between branches
668
- --base-branch=<value> Base branch
669
- --compare-branch=<value> Compare branch
670
- --format=<option> [default: compact-text] [Optional] Type of flags to show branches differences
681
+ -k, --stack-api-key=<value> [optional] Provide the Stack API key to show the difference between branches.
682
+ --base-branch=<value> [optional] Base branch (Target branch).
683
+ --compare-branch=<value> [optional] Compare branch (Source branch).
684
+ --format=<option> [default: compact-text] [default: compact-text] [optional] Type of flags to show the
685
+ difference between two branches. <options: compact-text, detailed-text>
671
686
  <options: compact-text|detailed-text>
672
- --module=<option> Module
687
+ --module=<option> [optional] Module. <options: content-types, global-fields, all>
673
688
  <options: content-types|global-fields|all>
674
689
 
675
690
  DESCRIPTION
@@ -713,13 +728,13 @@ USAGE
713
728
  [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]
714
729
 
715
730
  FLAGS
716
- -k, --stack-api-key=<value> Provide Stack API key to show difference between branches
717
- --base-branch=<value> Base branch
718
- --comment=<value> Merge comment
719
- --compare-branch=<value> Compare branch name
720
- --export-summary-path=<value> Export summary file path
721
- --no-revert If passed, will not create the new revert branch
722
- --use-merge-summary=<value> Path of merge summary file
731
+ -k, --stack-api-key=<value> [optional] Provide stack API key to show the difference between the branches.
732
+ --base-branch=<value> [optional] Base branch (Target branch).
733
+ --comment=<value> [optional] Pass a comment.
734
+ --compare-branch=<value> [optional] Compare branch (Source branch).
735
+ --export-summary-path=<value> [optional] Export summary file path.
736
+ --no-revert [optional] If passed, will not create the new revert branch.
737
+ --use-merge-summary=<value> [optional] Path of merge summary file.
723
738
 
724
739
  DESCRIPTION
725
740
  Merge changes from a branch
@@ -766,21 +781,30 @@ USAGE
766
781
  [--content-types <value>] [-t <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
767
782
 
768
783
  FLAGS
769
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
770
- selected)
771
- -a, --alias=<value> Alias(name) for the management token
772
- -c, --config=<value> Path to the config file
773
- -e, --environments=<value>... Environments where entries will be published
774
- -k, --stack-api-key=<value> Stack api key to be used
775
- -l, --locales=<value>... Locales where entries will be published
776
- -t, --contentTypes=<value>... The Contenttypes from which entries will be published
777
- -y, --yes Agree to process the command with the current configuration
778
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
779
- --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
780
- bulkpublish API will be used to publish the entries
781
- --content-types=<value>... The Contenttypes from which entries will be published
782
- --force Update and publish all entries even if no fields have been added
783
- --retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
784
+ -B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
785
+ operation. If you don’t mention the branch name, then by default the content from the
786
+ main branch will be published.
787
+ -a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
788
+ --stack-api-key flag.
789
+ -c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
790
+ for a single run. Refer to the configure command to create a configuration file.
791
+ -e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
792
+ environments, specify their names separated by spaces.
793
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
794
+ --alias flag.
795
+ -l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
796
+ locales, specify the codes separated by spaces.
797
+ -t, --contentTypes=<value>... The Contenttypes from which entries will be published.
798
+ -y, --yes Set it to true to process the command with the current configuration.
799
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
800
+ --bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
801
+ default.
802
+ --content-types=<value>... The UID of the content type ID whose entries you want to publish in bulk. In case of
803
+ multiple content types, specify their IDs separated by spaces.
804
+ --force Update and publish all entries even if no fields have been added.
805
+ --retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
806
+ name of the logfile that lists failed publish calls. If this option is used, it will
807
+ override all other flags.
784
808
 
785
809
  DESCRIPTION
786
810
  Add fields from updated content types to their respective entries
@@ -839,21 +863,29 @@ USAGE
839
863
  [--source-env <value>]
840
864
 
841
865
  FLAGS
842
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
843
- selected)
844
- -a, --alias=<value> Alias(name) for the management token
845
- -c, --config=<value> Path to the config file
846
- -e, --environments=<value>... Environments where assets will be published
847
- -k, --stack-api-key=<value> Stack api key to be used
848
- -l, --locales=<value>... Locales to where assets will be published
849
- -y, --yes Agree to process the command with the current configuration
850
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
851
- --bulk-publish=<value> [default: true] By default this flag is set as true. It indicates that contentstack's
852
- bulkpublish API will be used to publish the assets
853
- --delivery-token=<value> Delivery token for source environment
854
- --folder-uid=<value> [default: cs_root] Folder-uid from where the assets will be published
855
- --retry-failed=<value> Retry publishing failed assets from the logfile (optional, will override all other
856
- flags)
866
+ -B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
867
+ operation. If you don’t mention the branch name, then by default the assets from the
868
+ main branch will be published.
869
+ -a, --alias=<value> Alias (name) for the management token. You must use either the --alias flag or the
870
+ --stack-api-key flag.
871
+ -c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
872
+ for a single run. Refer to the configure command to create a configuration file.
873
+ -e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
874
+ environments, specify their names separated by spaces.
875
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
876
+ --alias flag.
877
+ -l, --locales=<value>... Locales in which assets will be published, e.g., en-us. In the case of multiple
878
+ locales, specify the codes separated by spaces.
879
+ -y, --yes Set it to true to process the command with the current configuration.
880
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
881
+ --bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
882
+ default.
883
+ --delivery-token=<value> The delivery token of the source environment.
884
+ --folder-uid=<value> (optional) The UID of the Assets’ folder from which the assets need to be published.
885
+ The default value is cs_root.
886
+ --retry-failed=<value> Use this option to retry publishing the failed assets from the logfile. Specify the
887
+ name of the logfile that lists failed publish calls. If this option is used, it will
888
+ override all other flags.
857
889
  --source-env=<value> Source environment
858
890
 
859
891
  DESCRIPTION
@@ -944,8 +976,10 @@ USAGE
944
976
  $ csdx cm:bulk-publish:configure [-a <value>] [-k <value>]
945
977
 
946
978
  FLAGS
947
- -a, --alias=<value> Alias(name) for the management token
948
- -k, --stack-api-key=<value> Stack api key to be used
979
+ -a, --alias=<value> Name (alias) of the management token you want to use. You must use either the --alias
980
+ flag or the --stack-api-key flag.
981
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
982
+ flag.
949
983
 
950
984
  DESCRIPTION
951
985
  The configure command is used to generate a configuration file for publish scripts.
@@ -963,7 +997,7 @@ EXAMPLES
963
997
  $ csdx cm:stacks:publish-configure --stack-api-key <stack_api_key>
964
998
  ```
965
999
 
966
- ## `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]`
1000
+ ## `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]`
967
1001
 
968
1002
  Publish entries and assets from one environment to other environments
969
1003
 
@@ -971,7 +1005,7 @@ Publish entries and assets from one environment to other environments
971
1005
  USAGE
972
1006
  $ csdx cm:bulk-publish:cross-publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--content-type <value>]
973
1007
  [--locales <value>] [--source-env <value>] [--environments <value>] [--delivery-token <value>] [-c <value>] [-y]
974
- [--branch <value>] [--onlyAssets] [--onlyEntries]
1008
+ [--branch <value>] [--onlyAssets] [--onlyEntries] [--include-variants]
975
1009
 
976
1010
  FLAGS
977
1011
  -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
@@ -980,12 +1014,13 @@ FLAGS
980
1014
  -c, --config=<value> Path to the config file
981
1015
  -k, --stack-api-key=<value> Stack api key to be used
982
1016
  -y, --yes Agree to process the command with the current configuration
983
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
984
- --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
985
- bulkpublish API will be used to publish the entries
1017
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1018
+ --bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
1019
+ default.
986
1020
  --content-type=<value>... The Contenttypes from which entries will be published
987
- --delivery-token=<value> Delivery token for source environment
1021
+ --delivery-token=<value> The delivery token of the source environment.
988
1022
  --environments=<value>... Destination Environments
1023
+ --include-variants Include Variants flag will publish all associated variant entries.
989
1024
  --locales=<value> Source locale
990
1025
  --onlyAssets Unpublish only assets
991
1026
  --onlyEntries Unpublish only entries
@@ -1036,11 +1071,17 @@ EXAMPLES
1036
1071
  Using --stack-api-key flag
1037
1072
 
1038
1073
  $ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN]
1074
+
1075
+
1076
+
1077
+ Using --include-variants flag
1078
+
1079
+ $ csdx cm:bulk-publish:cross-publish --content-type [CONTENT TYPE] --source-env [SOURCE ENV] --environments [DESTINATION ENVIRONMENT] --locales [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN] [--include-variants]
1039
1080
  ```
1040
1081
 
1041
1082
  _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js)_
1042
1083
 
1043
- ## `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>]`
1084
+ ## `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]`
1044
1085
 
1045
1086
  Publish entries from multiple contenttypes to multiple environments and locales
1046
1087
 
@@ -1048,28 +1089,37 @@ Publish entries from multiple contenttypes to multiple environments and locales
1048
1089
  USAGE
1049
1090
  $ csdx cm:bulk-publish:entries cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>]
1050
1091
  [--publish-all-content-types] [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch
1051
- <value>] [--delivery-token <value>] [--source-env <value>]
1052
-
1053
- FLAGS
1054
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch
1055
- is selected)
1056
- -a, --alias=<value> Alias(name) for the management token
1057
- -c, --config=<value> Path for the external config file (A new config file can be generated at the current
1058
- working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
1059
- -e, --environments=<value>... Environments where entries will be published
1060
- -k, --stack-api-key=<value> Stack api key to be used
1061
- -l, --locales=<value>... Locales where entries will be published
1062
- -y, --yes Agree to process the command with the current configuration
1063
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1064
- --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1065
- bulkpublish API will be used to publish the entries
1066
- --content-types=<value>... The Contenttypes from which entries need to be published
1067
- --delivery-token=<value> Delivery token for source environment
1068
- --publish-all-content-types (optional) Publish all contenttypes (cannot be set when contentTypes flag is set)
1069
- --retry-failed=<value> (optional) Retry failed entries from the logfile (overrides all other flags) This
1070
- flag is used to retry publishing entries that failed to publish in a previous
1071
- attempt. A log file for the previous session will be required for processing the
1072
- failed entries
1092
+ <value>] [--delivery-token <value>] [--source-env <value>] [--entry-uid <value>] [--include-variants]
1093
+
1094
+ FLAGS
1095
+ -B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
1096
+ operation. If you don’t mention the branch name, then by default the content from
1097
+ main branch will be published.
1098
+ -a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
1099
+ --stack-api-key flag.
1100
+ -c, --config=<value> (optional) The path of the optional configuration JSON file containing all the
1101
+ options for a single run. Refer to the configure command to create a configuration
1102
+ file.
1103
+ -e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
1104
+ environments, specify their names separated by spaces.
1105
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
1106
+ --alias flag.
1107
+ -l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
1108
+ locales, specify the codes separated by spaces.
1109
+ -y, --yes Set it to true to process the command with the current configuration.
1110
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1111
+ --bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. This flag is
1112
+ set to true, by default.
1113
+ --content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
1114
+ multiple content types, specify the IDs separated by spaces.
1115
+ --delivery-token=<value> The delivery token of the source environment.
1116
+ --entry-uid=<value> Entry Uid for publish all associated variant entries.
1117
+ --include-variants Include Variants flag will publish all associated variant entries with base entry.
1118
+ --publish-all-content-types (optional) Set it to true to bulk publish entries from all content types. If the
1119
+ --content-types option is already used, then you cannot use this option.
1120
+ --retry-failed=<value> (optional) Use this option to retry publishing the failed entries/ assets from the
1121
+ logfile. Specify the name of the logfile that lists failed publish calls. If this
1122
+ option is used, it will override all other flags.
1073
1123
  --source-env=<value> Source environment
1074
1124
 
1075
1125
  DESCRIPTION
@@ -1124,6 +1174,18 @@ EXAMPLES
1124
1174
  Using --stack-api-key
1125
1175
 
1126
1176
  $ 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]
1177
+
1178
+
1179
+
1180
+ Using --include-variants
1181
+
1182
+ $ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] [--include-variants]
1183
+
1184
+
1185
+
1186
+ Using --entry-uid and --include-variants
1187
+
1188
+ $ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] --entry-uid [ENTRY UID] [--include-variants]
1127
1189
  ```
1128
1190
 
1129
1191
  ## `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>]`
@@ -1137,20 +1199,29 @@ USAGE
1137
1199
  <value>]
1138
1200
 
1139
1201
  FLAGS
1140
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
1141
- selected)
1142
- -a, --alias=<value> Alias(name) for the management token
1143
- -c, --config=<value> Path to the config file
1144
- -e, --environments=<value>... Destination environments
1145
- -k, --stack-api-key=<value> Stack api key to be used
1146
- -l, --locales=<value>... Locales where edited entries will be published
1147
- -y, --yes Agree to process the command with the current configuration
1148
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1149
- --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1150
- bulkpublish API will be used to publish the entries
1151
- --content-types=<value>... The Contenttypes which will be checked for edited entries
1152
- --retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
1153
- --source-env=<value> Environment from which edited entries will be published
1202
+ -B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
1203
+ operation. If you don't mention the branch name, then by default the entries from main
1204
+ branch will be published.
1205
+ -a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
1206
+ --stack-api-key flag.
1207
+ -c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
1208
+ for a single run. Refer to the configure command to create a configuration file.
1209
+ -e, --environments=<value>... The name of the environment(s) on which the entries will be published. In case of
1210
+ multiple environments, specify their names separated by spaces.
1211
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
1212
+ --alias flag.
1213
+ -l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
1214
+ locales, specify the codes separated by spaces.
1215
+ -y, --yes Set it to true to process the command with the current configuration.
1216
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1217
+ --bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
1218
+ default.
1219
+ --content-types=<value>... The UID of the content type(s) whose edited entries you want to publish in bulk. In
1220
+ case of multiple content types, specify the IDs separated by spaces.
1221
+ --retry-failed=<value> (optional) Use this option to retry publishing the failed entries/assets from the
1222
+ logfile. Specify the name of the logfile that lists failed publish calls. If this
1223
+ option is used, it will override all other flags
1224
+ --source-env=<value> The name of the source environment where the entries were initially published.
1154
1225
 
1155
1226
  DESCRIPTION
1156
1227
  Publish edited entries from a specified content type to the given locales and environments
@@ -1212,19 +1283,27 @@ USAGE
1212
1283
  <value>]
1213
1284
 
1214
1285
  FLAGS
1215
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
1216
- selected)
1217
- -a, --alias=<value> Alias(name) for the management token
1218
- -c, --config=<value> Path to the config file
1219
- -e, --environments=<value>... Destination environments
1220
- -k, --stack-api-key=<value> Stack api key to be used
1221
- -y, --yes Agree to process the command with the current configuration
1222
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1223
- --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1224
- bulkpublish API will be used to publish the entries
1225
- --content-types=<value>... The Contenttypes from which entries will be published
1226
- --retry-failed=<value> Retry publishing failed entries from the logfile
1227
- --source-env=<value> Source Environment
1286
+ -B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
1287
+ operation. If you don’t mention the branch name, then by default the content from the
1288
+ main branch will be published.
1289
+ -a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
1290
+ --stack-api-key flag.
1291
+ -c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
1292
+ for a single run. Refer to the configure command to create a configuration file.
1293
+ -e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
1294
+ environments, specify their names separated by spaces.
1295
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
1296
+ --alias flag.
1297
+ -y, --yes Set it to true to process the command with the current configuration.
1298
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1299
+ --bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
1300
+ default.
1301
+ --content-types=<value>... The UID of the content type whose entries you want to publish in bulk. In case of
1302
+ multiple content types, specify their IDs separated by spaces.
1303
+ --retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
1304
+ name of the logfile that lists failed publish calls. If this option is used, it will
1305
+ override all other flags.
1306
+ --source-env=<value> The name of the source environment.
1228
1307
 
1229
1308
  DESCRIPTION
1230
1309
  Publish non-localized fields for the given content types, from a particular source environment to the specified
@@ -1281,8 +1360,10 @@ USAGE
1281
1360
  $ csdx cm:bulk-publish:revert [--retry-failed <value>] [--log-file <value>]
1282
1361
 
1283
1362
  FLAGS
1284
- --log-file=<value> logfile to be used to revert
1285
- --retry-failed=<value> retry publishing failed entries from the logfile
1363
+ --log-file=<value> Path of the success logfile of a particular publish action.
1364
+ --retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. Specify
1365
+ the name of the logfile that lists failed publish calls. If this option is used, it will
1366
+ override all other flags.
1286
1367
 
1287
1368
  DESCRIPTION
1288
1369
  Revert publish operations by using a log file
@@ -1323,11 +1404,11 @@ FLAGS
1323
1404
  -k, --stack-api-key=<value> Stack api key to be used
1324
1405
  -l, --locale=<value> Locale filter
1325
1406
  -y, --yes Agree to process the command with the current configuration
1326
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1407
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1327
1408
  --bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1328
1409
  bulkpublish API will be used to unpublish the entries and assets
1329
1410
  --content-type=<value> Content type filter
1330
- --delivery-token=<value> Delivery token for source environment
1411
+ --delivery-token=<value> The delivery token of the source environment.
1331
1412
  --retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
1332
1413
 
1333
1414
  DESCRIPTION
@@ -1413,20 +1494,29 @@ USAGE
1413
1494
  [--branch <value>]
1414
1495
 
1415
1496
  FLAGS
1416
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
1417
- selected)
1418
- -a, --alias=<value> Alias(name) for the management token
1419
- -b, --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1420
- bulkpublish API will be used to publish the entries
1421
- -c, --config=<value> Path to the config file
1422
- -e, --environments=<value>... Destination environments
1423
- -k, --stack-api-key=<value> Stack api key to be used
1424
- -y, --yes Agree to process the command with the current configuration
1425
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1426
- --content-types=<value>... The Contenttypes from which entries will be published
1427
- --locales=<value> Source locale
1428
- --retry-failed=<value> Retry publishing failed entries from the logfile
1429
- --source-env=<value> Source Env
1497
+ -B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
1498
+ operation. If you don't mention the branch name, then by default the entries from main
1499
+ branch will be published.
1500
+ -a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
1501
+ --stack-api-key flag.
1502
+ -b, --bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
1503
+ default.
1504
+ -c, --config=<value> (optional) The path of the optional configuration JSON file containing all the
1505
+ options for a single run. Refer to the configure command to create a configuration
1506
+ file.
1507
+ -e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
1508
+ environments, specify their names separated by spaces.
1509
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
1510
+ --alias flag.
1511
+ -y, --yes Set it to true to process the command with the current configuration.
1512
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]..
1513
+ --content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
1514
+ multiple content types, specify their IDs separated by spaces.
1515
+ --locales=<value> Locale in which entries will be published, e.g., en-us
1516
+ --retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. It
1517
+ is optional. Specify the name of the logfile that lists failed publish calls. If this
1518
+ option is used, it will override all other flags.
1519
+ --source-env=<value> The name of the source environment where the entries were initially published.
1430
1520
 
1431
1521
  DESCRIPTION
1432
1522
  Publish unpublished entries from the source environment, to other environments and locales
@@ -1486,19 +1576,21 @@ USAGE
1486
1576
  <value>] [--batch-limit <value>]
1487
1577
 
1488
1578
  FLAGS
1489
- -a, --alias=<value> Alias(name) for the management token
1490
- -c, --config-path=<value> Path to config file
1491
- -y, --yes Agree to process the command with the current configuration
1492
- --batch-limit=<value> [default: 50] Provide batch limit for updating entries
1493
- --branch=<value> [optional] branch name
1494
- --content-type=<value> The content type from which entries will be migrated
1495
- --delay=<value> [default: 1000] Provide delay in ms between two entry update
1496
- --global-field This flag is set to false by default. It indicates that current content type is a
1497
- globalfield
1498
- --html-path=<value> Provide path of HTML RTE to migrate
1499
- --json-path=<value> Provide path of JSON RTE to migrate
1500
- --locale=<value> The locale from which entries will be migrated
1501
- --stack-api-key=<value> Stack api key to be used
1579
+ -a, --alias=<value> Enter the alias name. You must use either the --alias flag or the --stack-api-key flag.
1580
+ -c, --config-path=<value> Specify the path where your config file is located.
1581
+ -y, --yes Avoids reconfirmation of your configuration.
1582
+ --batch-limit=<value> [default: 50] Provide batch limit for updating entries (default: 50).
1583
+ --branch=<value> The name of the branch to be used.
1584
+ --content-type=<value> Specify the UID of the content type for which you want to migrate HTML RTE content.
1585
+ --delay=<value> [default: 1000] To set the interval time between the migration of HTML RTE to JSON RTE in
1586
+ subsequent entries of a content type. The default value is 1,000 milliseconds.
1587
+ --global-field Checks whether the specified UID belongs to a content type or a global field. This flag
1588
+ is set to false by default.
1589
+ --html-path=<value> Enter the path to the HTML RTE whose content you want to migrate.
1590
+ --json-path=<value> Enter the path to the JSON RTE to which you want to migrate the HTML RTE content.
1591
+ --locale=<value> The locale from which entries will be migrated.
1592
+ --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
1593
+ flag.
1502
1594
 
1503
1595
  DESCRIPTION
1504
1596
  Migration script to migrate content from HTML RTE to JSON RTE
@@ -1536,7 +1628,7 @@ EXAMPLES
1536
1628
 
1537
1629
  _See code: [@contentstack/cli-cm-migrate-rte](https://github.com/contentstack/cli/blob/main/packages/contentstack-migrate-rte/src/commands/cm/entries/migrate-html-rte.js)_
1538
1630
 
1539
- ## `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>]`
1631
+ ## `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]`
1540
1632
 
1541
1633
  Publish entries from multiple contenttypes to multiple environments and locales
1542
1634
 
@@ -1544,28 +1636,37 @@ Publish entries from multiple contenttypes to multiple environments and locales
1544
1636
  USAGE
1545
1637
  $ csdx cm:entries:publish [-a <value>] [--retry-failed <value>] [--bulk-publish <value>] [--publish-all-content-types]
1546
1638
  [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>] [--delivery-token
1547
- <value>] [--source-env <value>]
1548
-
1549
- FLAGS
1550
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch
1551
- is selected)
1552
- -a, --alias=<value> Alias(name) for the management token
1553
- -c, --config=<value> Path for the external config file (A new config file can be generated at the current
1554
- working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`)
1555
- -e, --environments=<value>... Environments where entries will be published
1556
- -k, --stack-api-key=<value> Stack api key to be used
1557
- -l, --locales=<value>... Locales where entries will be published
1558
- -y, --yes Agree to process the command with the current configuration
1559
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1560
- --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1561
- bulkpublish API will be used to publish the entries
1562
- --content-types=<value>... The Contenttypes from which entries need to be published
1563
- --delivery-token=<value> Delivery token for source environment
1564
- --publish-all-content-types (optional) Publish all contenttypes (cannot be set when contentTypes flag is set)
1565
- --retry-failed=<value> (optional) Retry failed entries from the logfile (overrides all other flags) This
1566
- flag is used to retry publishing entries that failed to publish in a previous
1567
- attempt. A log file for the previous session will be required for processing the
1568
- failed entries
1639
+ <value>] [--source-env <value>] [--entry-uid <value>] [--include-variants]
1640
+
1641
+ FLAGS
1642
+ -B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
1643
+ operation. If you don’t mention the branch name, then by default the content from
1644
+ main branch will be published.
1645
+ -a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
1646
+ --stack-api-key flag.
1647
+ -c, --config=<value> (optional) The path of the optional configuration JSON file containing all the
1648
+ options for a single run. Refer to the configure command to create a configuration
1649
+ file.
1650
+ -e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
1651
+ environments, specify their names separated by spaces.
1652
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
1653
+ --alias flag.
1654
+ -l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
1655
+ locales, specify the codes separated by spaces.
1656
+ -y, --yes Set it to true to process the command with the current configuration.
1657
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1658
+ --bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. This flag is
1659
+ set to true, by default.
1660
+ --content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
1661
+ multiple content types, specify the IDs separated by spaces.
1662
+ --delivery-token=<value> The delivery token of the source environment.
1663
+ --entry-uid=<value> Entry Uid for publish all associated variant entries.
1664
+ --include-variants Include Variants flag will publish all associated variant entries with base entry.
1665
+ --publish-all-content-types (optional) Set it to true to bulk publish entries from all content types. If the
1666
+ --content-types option is already used, then you cannot use this option.
1667
+ --retry-failed=<value> (optional) Use this option to retry publishing the failed entries/ assets from the
1668
+ logfile. Specify the name of the logfile that lists failed publish calls. If this
1669
+ option is used, it will override all other flags.
1569
1670
  --source-env=<value> Source environment
1570
1671
 
1571
1672
  DESCRIPTION
@@ -1620,6 +1721,18 @@ EXAMPLES
1620
1721
  Using --stack-api-key
1621
1722
 
1622
1723
  $ 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]
1724
+
1725
+
1726
+
1727
+ Using --include-variants
1728
+
1729
+ $ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] [--include-variants]
1730
+
1731
+
1732
+
1733
+ Using --entry-uid and --include-variants
1734
+
1735
+ $ csdx cm:entries:publish --content-types [CONTENT TYPE 1] [CONTENT TYPE 2] -e [ENVIRONMENT 1] [ENVIRONMENT 2] --locales [LOCALE 1] [LOCALE 2] --stack-api-key [STACK API KEY] --source-env [SOURCE ENVIRONMENT] --delivery-token [DELIVERY TOKEN] --entry-uid [ENTRY UID] [--include-variants]
1623
1736
  ```
1624
1737
 
1625
1738
  _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js)_
@@ -1634,20 +1747,29 @@ USAGE
1634
1747
  [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
1635
1748
 
1636
1749
  FLAGS
1637
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
1638
- selected)
1639
- -a, --alias=<value> Alias(name) for the management token
1640
- -c, --config=<value> Path to the config file
1641
- -e, --environments=<value>... Destination environments
1642
- -k, --stack-api-key=<value> Stack api key to be used
1643
- -l, --locales=<value>... Locales where edited entries will be published
1644
- -y, --yes Agree to process the command with the current configuration
1645
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1646
- --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1647
- bulkpublish API will be used to publish the entries
1648
- --content-types=<value>... The Contenttypes which will be checked for edited entries
1649
- --retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
1650
- --source-env=<value> Environment from which edited entries will be published
1750
+ -B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
1751
+ operation. If you don't mention the branch name, then by default the entries from main
1752
+ branch will be published.
1753
+ -a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
1754
+ --stack-api-key flag.
1755
+ -c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
1756
+ for a single run. Refer to the configure command to create a configuration file.
1757
+ -e, --environments=<value>... The name of the environment(s) on which the entries will be published. In case of
1758
+ multiple environments, specify their names separated by spaces.
1759
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
1760
+ --alias flag.
1761
+ -l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
1762
+ locales, specify the codes separated by spaces.
1763
+ -y, --yes Set it to true to process the command with the current configuration.
1764
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1765
+ --bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
1766
+ default.
1767
+ --content-types=<value>... The UID of the content type(s) whose edited entries you want to publish in bulk. In
1768
+ case of multiple content types, specify the IDs separated by spaces.
1769
+ --retry-failed=<value> (optional) Use this option to retry publishing the failed entries/assets from the
1770
+ logfile. Specify the name of the logfile that lists failed publish calls. If this
1771
+ option is used, it will override all other flags
1772
+ --source-env=<value> The name of the source environment where the entries were initially published.
1651
1773
 
1652
1774
  DESCRIPTION
1653
1775
  Publish edited entries from a specified content type to the given locales and environments
@@ -1710,19 +1832,27 @@ USAGE
1710
1832
  [--content-types <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
1711
1833
 
1712
1834
  FLAGS
1713
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
1714
- selected)
1715
- -a, --alias=<value> Alias(name) for the management token
1716
- -c, --config=<value> Path to the config file
1717
- -e, --environments=<value>... Destination environments
1718
- -k, --stack-api-key=<value> Stack api key to be used
1719
- -y, --yes Agree to process the command with the current configuration
1720
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1721
- --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1722
- bulkpublish API will be used to publish the entries
1723
- --content-types=<value>... The Contenttypes from which entries will be published
1724
- --retry-failed=<value> Retry publishing failed entries from the logfile
1725
- --source-env=<value> Source Environment
1835
+ -B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
1836
+ operation. If you don’t mention the branch name, then by default the content from the
1837
+ main branch will be published.
1838
+ -a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
1839
+ --stack-api-key flag.
1840
+ -c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
1841
+ for a single run. Refer to the configure command to create a configuration file.
1842
+ -e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
1843
+ environments, specify their names separated by spaces.
1844
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
1845
+ --alias flag.
1846
+ -y, --yes Set it to true to process the command with the current configuration.
1847
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1848
+ --bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
1849
+ default.
1850
+ --content-types=<value>... The UID of the content type whose entries you want to publish in bulk. In case of
1851
+ multiple content types, specify their IDs separated by spaces.
1852
+ --retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
1853
+ name of the logfile that lists failed publish calls. If this option is used, it will
1854
+ override all other flags.
1855
+ --source-env=<value> The name of the source environment.
1726
1856
 
1727
1857
  DESCRIPTION
1728
1858
  Publish non-localized fields for the given content types, from a particular source environment to the specified
@@ -1782,20 +1912,29 @@ USAGE
1782
1912
  [--content-types <value>] [--locales <value>] [-e <value>] [-c <value>] [-y] [--branch <value>]
1783
1913
 
1784
1914
  FLAGS
1785
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
1786
- selected)
1787
- -a, --alias=<value> Alias(name) for the management token
1788
- -b, --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1789
- bulkpublish API will be used to publish the entries
1790
- -c, --config=<value> Path to the config file
1791
- -e, --environments=<value>... Destination environments
1792
- -k, --stack-api-key=<value> Stack api key to be used
1793
- -y, --yes Agree to process the command with the current configuration
1794
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1795
- --content-types=<value>... The Contenttypes from which entries will be published
1796
- --locales=<value> Source locale
1797
- --retry-failed=<value> Retry publishing failed entries from the logfile
1798
- --source-env=<value> Source Env
1915
+ -B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
1916
+ operation. If you don't mention the branch name, then by default the entries from main
1917
+ branch will be published.
1918
+ -a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
1919
+ --stack-api-key flag.
1920
+ -b, --bulk-publish=<value> [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by
1921
+ default.
1922
+ -c, --config=<value> (optional) The path of the optional configuration JSON file containing all the
1923
+ options for a single run. Refer to the configure command to create a configuration
1924
+ file.
1925
+ -e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
1926
+ environments, specify their names separated by spaces.
1927
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
1928
+ --alias flag.
1929
+ -y, --yes Set it to true to process the command with the current configuration.
1930
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]..
1931
+ --content-types=<value>... The UID of the content type(s) whose entries you want to publish in bulk. In case of
1932
+ multiple content types, specify their IDs separated by spaces.
1933
+ --locales=<value> Locale in which entries will be published, e.g., en-us
1934
+ --retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. It
1935
+ is optional. Specify the name of the logfile that lists failed publish calls. If this
1936
+ option is used, it will override all other flags.
1937
+ --source-env=<value> The name of the source environment where the entries were initially published.
1799
1938
 
1800
1939
  DESCRIPTION
1801
1940
  Publish unpublished entries from the source environment, to other environments and locales
@@ -1854,23 +1993,29 @@ Unpublish entries from the given environment
1854
1993
  USAGE
1855
1994
  $ csdx cm:entries:unpublish [-a <value>] [-k <value>] [-e <value>] [-c <value>] [-y] [--locale <value>] [--branch
1856
1995
  <value>] [--retry-failed <value>] [--bulk-unpublish <value>] [--api-version <value>] [--content-type <value>]
1857
- [--delivery-token <value>]
1996
+ [--delivery-token <value>] [--include-variants]
1858
1997
 
1859
1998
  FLAGS
1860
- -a, --alias=<value> Alias(name) for the management token
1861
- -c, --config=<value> Path to the config file
1862
- -e, --environment=<value> Source Environment
1863
- -k, --stack-api-key=<value> Stack api key to be used
1864
- -y, --yes Agree to process the command with the current configuration
1865
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1866
- --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
1867
- selected)
1868
- --bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1869
- bulkpublish API will be used to unpublish the entries
1870
- --content-type=<value> Content type filter
1871
- --delivery-token=<value> Delivery token for source environment
1872
- --locale=<value> Locale filter
1873
- --retry-failed=<value> Retry publishing failed entries from the logfile
1999
+ -a, --alias=<value> Alias (name) for the management token. You must use either the --alias flag or the
2000
+ --stack-api-key flag.
2001
+ -c, --config=<value> (optional) Path to the configuration JSON file containing all options for a single run.
2002
+ Refer to the configure command to create a configuration file.
2003
+ -e, --environment=<value> The name of the environment from where entries/assets need to be unpublished.
2004
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
2005
+ flag.
2006
+ -y, --yes Set to true to process the command with the current configuration.
2007
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
2008
+ --branch=<value> [default: main] Specify the branch to fetch the content. If not mentioned, the main
2009
+ branch will be used by default.
2010
+ --bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that Contentstack's
2011
+ Bulk Publish APIs will be used to unpublish the entries.
2012
+ --content-type=<value> The UID of the content type whose entries you want to unpublish in bulk.
2013
+ --delivery-token=<value> The delivery token of the source environment.
2014
+ --include-variants Include Variants flag will unpublish all associated variant entries.
2015
+ --locale=<value> Locale from which entries/assets will be unpublished, e.g., en-us.
2016
+ --retry-failed=<value> (optional) Use this option to retry unpublishing the failed entries from the logfile.
2017
+ Specify the name of the logfile that lists failed unpublish calls. If used, this option
2018
+ will override all other flags.
1874
2019
 
1875
2020
  DESCRIPTION
1876
2021
  Unpublish entries from the given environment
@@ -1911,6 +2056,12 @@ EXAMPLES
1911
2056
  Using --stack-api-key flag
1912
2057
 
1913
2058
  $ 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]
2059
+
2060
+
2061
+
2062
+ Using --include-variants flag
2063
+
2064
+ $ csdx cm:stacks:unpublish --bulk-unpublish --content-type [CONTENT TYPE] --environment [SOURCE ENV] --locale [LOCALE] --stack-api-key [STACK API KEY] --delivery-token [DELIVERY TOKEN] --include-variants
1914
2065
  ```
1915
2066
 
1916
2067
  _See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/entries/unpublish.js)_
@@ -1925,21 +2076,30 @@ USAGE
1925
2076
  <value>] [-e <value>] [-c <value>] [-y] [--locales <value>] [--branch <value>]
1926
2077
 
1927
2078
  FLAGS
1928
- -B, --branch=<value> [default: main] Specify the branch to fetch the content (by default the main branch is
1929
- selected)
1930
- -a, --alias=<value> Alias(name) for the management token
1931
- -c, --config=<value> Path to the config file
1932
- -e, --environments=<value>... Environments where entries will be published
1933
- -k, --stack-api-key=<value> Stack api key to be used
1934
- -l, --locales=<value>... Locales where entries will be published
1935
- -t, --contentTypes=<value>... The Contenttypes from which entries will be published
1936
- -y, --yes Agree to process the command with the current configuration
1937
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
1938
- --bulk-publish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
1939
- bulkpublish API will be used to publish the entries
1940
- --content-types=<value>... The Contenttypes from which entries will be published
1941
- --force Update and publish all entries even if no fields have been added
1942
- --retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
2079
+ -B, --branch=<value> [default: main] The name of the branch where you want to perform the bulk publish
2080
+ operation. If you don’t mention the branch name, then by default the content from the
2081
+ main branch will be published.
2082
+ -a, --alias=<value> Alias (name) of the management token. You must use either the --alias flag or the
2083
+ --stack-api-key flag.
2084
+ -c, --config=<value> (optional) The path of the optional configuration JSON file containing all the options
2085
+ for a single run. Refer to the configure command to create a configuration file.
2086
+ -e, --environments=<value>... The name of the environment on which entries will be published. In case of multiple
2087
+ environments, specify their names separated by spaces.
2088
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the
2089
+ --alias flag.
2090
+ -l, --locales=<value>... Locales in which entries will be published, e.g., en-us. In the case of multiple
2091
+ locales, specify the codes separated by spaces.
2092
+ -t, --contentTypes=<value>... The Contenttypes from which entries will be published.
2093
+ -y, --yes Set it to true to process the command with the current configuration.
2094
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
2095
+ --bulk-publish=<value> [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by
2096
+ default.
2097
+ --content-types=<value>... The UID of the content type ID whose entries you want to publish in bulk. In case of
2098
+ multiple content types, specify their IDs separated by spaces.
2099
+ --force Update and publish all entries even if no fields have been added.
2100
+ --retry-failed=<value> Use this option to retry publishing the failed entries from the logfile. Specify the
2101
+ name of the logfile that lists failed publish calls. If this option is used, it will
2102
+ override all other flags.
1943
2103
 
1944
2104
  DESCRIPTION
1945
2105
  Add fields from updated content types to their respective entries
@@ -1999,15 +2159,22 @@ USAGE
1999
2159
  [--content-types <value>] [--branch <value>] [--secured-assets]
2000
2160
 
2001
2161
  FLAGS
2002
- -B, --branch=<value> [optional] branch name
2003
- -a, --alias=<value> alias of the management token
2004
- -c, --config=<value> [optional] path of the config
2005
- -d, --data-dir=<value> path or location to store the data
2006
- -k, --stack-api-key=<value> API key of the source stack
2007
- -m, --module=<value> [optional] specific module name
2008
- -t, --content-types=<value>... [optional] content type
2009
- -y, --yes [optional] Override marketplace apps related prompts
2010
- --secured-assets [optional] use when assets are secured
2162
+ -B, --branch=<value> [optional] The name of the branch where you want to export your content. If you don't
2163
+ mention the branch name, then by default the content will be exported from all the
2164
+ branches of your stack.
2165
+ -a, --alias=<value> The management token alias of the source stack from which you will export content.
2166
+ -c, --config=<value> [optional] Path of the config
2167
+ -d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
2168
+ ./content
2169
+ -k, --stack-api-key=<value> API Key of the source stack
2170
+ -m, --module=<value> [optional] Specific module name. If not specified, the export command will export all
2171
+ the modules to the stack. The available modules are assets, content-types, entries,
2172
+ environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
2173
+ workflows, custom-roles, and taxonomies.
2174
+ -t, --content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
2175
+ of multiple content types, specify the IDs separated by spaces.
2176
+ -y, --yes [optional] Force override all Marketplace prompts.
2177
+ --secured-assets [optional] Use this flag for assets that are secured.
2011
2178
 
2012
2179
  DESCRIPTION
2013
2180
  Export content from a stack
@@ -2042,20 +2209,21 @@ USAGE
2042
2209
  [--taxonomy-uid <value>] [--delimiter <value>]
2043
2210
 
2044
2211
  FLAGS
2045
- -a, --alias=<value> Alias of the management token
2046
- -k, --stack-api-key=<value> API key of the source stack
2047
- -n, --stack-name=<value> Name of the stack that needs to be created as csv filename.
2048
- --action=<option> Option to export data (entries, users, teams, taxonomies)
2212
+ -a, --alias=<value> Alias of the management token.
2213
+ -k, --stack-api-key=<value> API Key of the source stack.
2214
+ -n, --stack-name=<value> Name of the stack that needs to be created as CSV filename.
2215
+ --action=<option> Option to export data (entries, users, teams, taxonomies). [options:
2216
+ entries|users|teams|taxonomies]
2049
2217
  <options: entries|users|teams|taxonomies>
2050
- --branch=<value> Branch from which entries need to be exported
2051
- --content-type=<value> Content type for which entries needs to be exported
2052
- --delimiter=<value> [default: ,] [optional] Provide a delimiter to separate individual data fields within the
2053
- CSV file.
2054
- --locale=<value> Locale for which entries need to be exported
2055
- --org=<value> Provide organization UID to clone org users
2056
- --org-name=<value> Name of the organization that needs to be created as csv filename.
2057
- --taxonomy-uid=<value> Provide the taxonomy UID of the related terms you want to export
2058
- --team-uid=<value> Uid of the team whose user data and stack roles are required
2218
+ --branch=<value> Branch from which entries will be exported.
2219
+ --content-type=<value> Content type of entries that will be exported.
2220
+ --delimiter=<value> [default: ,] [default: ,] [optional] Provide a delimiter to separate individual data
2221
+ fields within the CSV file. For example: cm:export-to-csv --delimiter '|'
2222
+ --locale=<value> Locale of entries that will be exported.
2223
+ --org=<value> Provide organization UID to clone org users.
2224
+ --org-name=<value> Name of the organization that needs to be created as CSV filename.
2225
+ --taxonomy-uid=<value> Provide the taxonomy UID of the related terms you want to export.
2226
+ --team-uid=<value> Provide the UID of a specific team in an organization.
2059
2227
 
2060
2228
  DESCRIPTION
2061
2229
  Export entries, taxonomies, terms or organization users to csv using this command
@@ -2148,21 +2316,33 @@ USAGE
2148
2316
  [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]
2149
2317
 
2150
2318
  FLAGS
2151
- -B, --branch=<value> [optional] branch name
2152
- -a, --alias=<value> alias of the management token
2153
- -b, --backup-dir=<value> [optional] backup directory name when using specific module
2154
- -c, --config=<value> [optional] path of config file
2155
- -d, --data-dir=<value> path and location where data is stored
2319
+ -B, --branch=<value> The name of the branch where you want to import your content. If you don't
2320
+ mention the branch name, then by default the content will be imported to the
2321
+ main branch.
2322
+ -a, --alias=<value> The management token of the destination stack where you will import the
2323
+ content.
2324
+ -b, --backup-dir=<value> [optional] Backup directory name when using specific module.
2325
+ -c, --config=<value> [optional] Path of config file.
2326
+ -d, --data-dir=<value> The path or the location in your file system where the content, you intend to
2327
+ import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
2328
+ export folder has branches involved, then the path should point till the
2329
+ particular branch. For example, “-d
2330
+ "C:\Users\Name\Desktop\cli\content\branch_name"
2156
2331
  -k, --stack-api-key=<value> API key of the target stack
2157
- -m, --module=<value> [optional] specific module name
2158
- -y, --yes [optional] Override marketplace prompts
2159
- --exclude-global-modules Excludes the branch-independent module from the import operation
2160
- --import-webhook-status=<option> [default: disable] [optional] Webhook state
2332
+ -m, --module=<value> [optional] Specify the module to import into the target stack. If not
2333
+ specified, the import command will import all the modules into the stack. The
2334
+ available modules are assets, content-types, entries, environments,
2335
+ extensions, marketplace-apps, global-fields, labels, locales, webhooks,
2336
+ workflows, custom-roles, and taxonomies.
2337
+ -y, --yes [optional] Force override all Marketplace prompts.
2338
+ --exclude-global-modules Excludes the branch-independent module from the import operation.
2339
+ --import-webhook-status=<option> [default: disable] [optional] This webhook state keeps the same state of
2340
+ webhooks as the source stack.
2161
2341
  <options: disable|current>
2162
2342
  --personalize-project-name=<value> Personalize project name.
2163
2343
  --replace-existing Replaces the existing module in the target stack.
2164
2344
  --skip-app-recreation [optional] Skip private apps recreation if already exist
2165
- --skip-audit Skips the audit fix.
2345
+ --skip-audit Skips the audit fix that occurs during an import operation.
2166
2346
  --skip-existing Skips the module exists warning messages.
2167
2347
 
2168
2348
  DESCRIPTION
@@ -2200,19 +2380,21 @@ USAGE
2200
2380
  <value>] [--batch-limit <value>]
2201
2381
 
2202
2382
  FLAGS
2203
- -a, --alias=<value> Alias(name) for the management token
2204
- -c, --config-path=<value> Path to config file
2205
- -y, --yes Agree to process the command with the current configuration
2206
- --batch-limit=<value> [default: 50] Provide batch limit for updating entries
2207
- --branch=<value> [optional] branch name
2208
- --content-type=<value> The content type from which entries will be migrated
2209
- --delay=<value> [default: 1000] Provide delay in ms between two entry update
2210
- --global-field This flag is set to false by default. It indicates that current content type is a
2211
- globalfield
2212
- --html-path=<value> Provide path of HTML RTE to migrate
2213
- --json-path=<value> Provide path of JSON RTE to migrate
2214
- --locale=<value> The locale from which entries will be migrated
2215
- --stack-api-key=<value> Stack api key to be used
2383
+ -a, --alias=<value> Enter the alias name. You must use either the --alias flag or the --stack-api-key flag.
2384
+ -c, --config-path=<value> Specify the path where your config file is located.
2385
+ -y, --yes Avoids reconfirmation of your configuration.
2386
+ --batch-limit=<value> [default: 50] Provide batch limit for updating entries (default: 50).
2387
+ --branch=<value> The name of the branch to be used.
2388
+ --content-type=<value> Specify the UID of the content type for which you want to migrate HTML RTE content.
2389
+ --delay=<value> [default: 1000] To set the interval time between the migration of HTML RTE to JSON RTE in
2390
+ subsequent entries of a content type. The default value is 1,000 milliseconds.
2391
+ --global-field Checks whether the specified UID belongs to a content type or a global field. This flag
2392
+ is set to false by default.
2393
+ --html-path=<value> Enter the path to the HTML RTE whose content you want to migrate.
2394
+ --json-path=<value> Enter the path to the JSON RTE to which you want to migrate the HTML RTE content.
2395
+ --locale=<value> The locale from which entries will be migrated.
2396
+ --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
2397
+ flag.
2216
2398
 
2217
2399
  DESCRIPTION
2218
2400
  Migration script to migrate content from HTML RTE to JSON RTE
@@ -2258,14 +2440,18 @@ USAGE
2258
2440
  [--config-file <value>] [--config <value>] [--multiple]
2259
2441
 
2260
2442
  FLAGS
2261
- -B, --branch=<value> Use this flag to add the branch name where you want to perform the migration.
2262
- -a, --alias=<value> Use this flag to add the management token alias.
2263
- -k, --stack-api-key=<value> With this flag add the API key of your stack.
2264
- --config=<value>... [optional] inline configuration, <key1>:<value1>
2265
- --config-file=<value> [optional] Path of the JSON configuration file
2266
- --file-path=<value> Use this flag to provide the path of the file of the migration script provided by the
2267
- user.
2268
- --multiple This flag helps you to migrate multiple content files in a single instance.
2443
+ -B, --branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
2444
+ branch name)
2445
+ -a, --alias=<value> Use this flag to add the management token alias. You must use either the --alias flag or
2446
+ the --stack-api-key flag.
2447
+ -k, --stack-api-key=<value> Use this flag to add the API key of your stack. You must use either the --stack-api-key
2448
+ flag or the --alias flag.
2449
+ --config=<value>... [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
2450
+ the script re-usable.
2451
+ --config-file=<value> [optional] Path of the JSON configuration file.
2452
+ --file-path=<value> Use this flag to provide the path of the file of the migration script.
2453
+ --multiple This flag helps you to migrate multiple content files in a single instance. Mention the
2454
+ folder path where your migration script files are stored.
2269
2455
 
2270
2456
  DESCRIPTION
2271
2457
  Contentstack migration script.
@@ -2335,20 +2521,22 @@ USAGE
2335
2521
 
2336
2522
  FLAGS
2337
2523
  -c, --config=<value> Path for the external configuration
2338
- -n, --stack-name=<value> Name for the new stack to store the cloned content.
2339
- -y, --yes [Optional] Override marketplace prompts
2340
- --destination-management-token-alias=<value> Source API key of the target stack token alias.
2524
+ -n, --stack-name=<value> Provide a name for the new stack to store the cloned content.
2525
+ -y, --yes Force override all Marketplace prompts.
2526
+ --destination-management-token-alias=<value> Destination management token alias.
2341
2527
  --destination-stack-api-key=<value> Destination stack API Key
2342
- --import-webhook-status=<option> [default: disable] [Optional] Webhook state
2528
+ --import-webhook-status=<option> [default: disable] [Optional] The status of the import webhook.
2529
+ <options: disable, current>
2343
2530
  <options: disable|current>
2344
- --skip-audit Skips the audit fix.
2531
+ --skip-audit (optional) Skips the audit fix that occurs during an import
2532
+ operation.
2345
2533
  --source-branch=<value> Branch of the source stack.
2346
- --source-management-token-alias=<value> Source API key of the target stack token alias.
2534
+ --source-management-token-alias=<value> Source management token alias.
2347
2535
  --source-stack-api-key=<value> Source stack API Key
2348
2536
  --target-branch=<value> Branch of the target stack.
2349
- --type=<option> Type of data to clone
2350
- a) Structure (all modules except entries & assets)
2351
- b) Structure with content (all modules including entries & assets)
2537
+ --type=<option> Type of data to clone. You can select option a or b.
2538
+ a) Structure (all modules except entries & assets).
2539
+ b) Structure with content (all modules including entries & assets).
2352
2540
 
2353
2541
  <options: a|b>
2354
2542
 
@@ -2479,20 +2667,22 @@ USAGE
2479
2667
 
2480
2668
  FLAGS
2481
2669
  -c, --config=<value> Path for the external configuration
2482
- -n, --stack-name=<value> Name for the new stack to store the cloned content.
2483
- -y, --yes [Optional] Override marketplace prompts
2484
- --destination-management-token-alias=<value> Source API key of the target stack token alias.
2670
+ -n, --stack-name=<value> Provide a name for the new stack to store the cloned content.
2671
+ -y, --yes Force override all Marketplace prompts.
2672
+ --destination-management-token-alias=<value> Destination management token alias.
2485
2673
  --destination-stack-api-key=<value> Destination stack API Key
2486
- --import-webhook-status=<option> [default: disable] [Optional] Webhook state
2674
+ --import-webhook-status=<option> [default: disable] [Optional] The status of the import webhook.
2675
+ <options: disable, current>
2487
2676
  <options: disable|current>
2488
- --skip-audit Skips the audit fix.
2677
+ --skip-audit (optional) Skips the audit fix that occurs during an import
2678
+ operation.
2489
2679
  --source-branch=<value> Branch of the source stack.
2490
- --source-management-token-alias=<value> Source API key of the target stack token alias.
2680
+ --source-management-token-alias=<value> Source management token alias.
2491
2681
  --source-stack-api-key=<value> Source stack API Key
2492
2682
  --target-branch=<value> Branch of the target stack.
2493
- --type=<option> Type of data to clone
2494
- a) Structure (all modules except entries & assets)
2495
- b) Structure with content (all modules including entries & assets)
2683
+ --type=<option> Type of data to clone. You can select option a or b.
2684
+ a) Structure (all modules except entries & assets).
2685
+ b) Structure with content (all modules including entries & assets).
2496
2686
 
2497
2687
  <options: a|b>
2498
2688
 
@@ -2530,15 +2720,22 @@ USAGE
2530
2720
  <value>] [--branch <value>] [--secured-assets]
2531
2721
 
2532
2722
  FLAGS
2533
- -B, --branch=<value> [optional] branch name
2534
- -a, --alias=<value> alias of the management token
2535
- -c, --config=<value> [optional] path of the config
2536
- -d, --data-dir=<value> path or location to store the data
2537
- -k, --stack-api-key=<value> API key of the source stack
2538
- -m, --module=<value> [optional] specific module name
2539
- -t, --content-types=<value>... [optional] content type
2540
- -y, --yes [optional] Override marketplace apps related prompts
2541
- --secured-assets [optional] use when assets are secured
2723
+ -B, --branch=<value> [optional] The name of the branch where you want to export your content. If you don't
2724
+ mention the branch name, then by default the content will be exported from all the
2725
+ branches of your stack.
2726
+ -a, --alias=<value> The management token alias of the source stack from which you will export content.
2727
+ -c, --config=<value> [optional] Path of the config
2728
+ -d, --data-dir=<value> The path or the location in your file system to store the exported content. For e.g.,
2729
+ ./content
2730
+ -k, --stack-api-key=<value> API Key of the source stack
2731
+ -m, --module=<value> [optional] Specific module name. If not specified, the export command will export all
2732
+ the modules to the stack. The available modules are assets, content-types, entries,
2733
+ environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks,
2734
+ workflows, custom-roles, and taxonomies.
2735
+ -t, --content-types=<value>... [optional] The UID of the content type(s) whose content you want to export. In case
2736
+ of multiple content types, specify the IDs separated by spaces.
2737
+ -y, --yes [optional] Force override all Marketplace prompts.
2738
+ --secured-assets [optional] Use this flag for assets that are secured.
2542
2739
 
2543
2740
  DESCRIPTION
2544
2741
  Export content from a stack
@@ -2574,21 +2771,33 @@ USAGE
2574
2771
  <value>] [--branch <value>] [--import-webhook-status disable|current]
2575
2772
 
2576
2773
  FLAGS
2577
- -B, --branch=<value> [optional] branch name
2578
- -a, --alias=<value> alias of the management token
2579
- -b, --backup-dir=<value> [optional] backup directory name when using specific module
2580
- -c, --config=<value> [optional] path of config file
2581
- -d, --data-dir=<value> path and location where data is stored
2774
+ -B, --branch=<value> The name of the branch where you want to import your content. If you don't
2775
+ mention the branch name, then by default the content will be imported to the
2776
+ main branch.
2777
+ -a, --alias=<value> The management token of the destination stack where you will import the
2778
+ content.
2779
+ -b, --backup-dir=<value> [optional] Backup directory name when using specific module.
2780
+ -c, --config=<value> [optional] Path of config file.
2781
+ -d, --data-dir=<value> The path or the location in your file system where the content, you intend to
2782
+ import, is stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the
2783
+ export folder has branches involved, then the path should point till the
2784
+ particular branch. For example, “-d
2785
+ "C:\Users\Name\Desktop\cli\content\branch_name"
2582
2786
  -k, --stack-api-key=<value> API key of the target stack
2583
- -m, --module=<value> [optional] specific module name
2584
- -y, --yes [optional] Override marketplace prompts
2585
- --exclude-global-modules Excludes the branch-independent module from the import operation
2586
- --import-webhook-status=<option> [default: disable] [optional] Webhook state
2787
+ -m, --module=<value> [optional] Specify the module to import into the target stack. If not
2788
+ specified, the import command will import all the modules into the stack. The
2789
+ available modules are assets, content-types, entries, environments,
2790
+ extensions, marketplace-apps, global-fields, labels, locales, webhooks,
2791
+ workflows, custom-roles, and taxonomies.
2792
+ -y, --yes [optional] Force override all Marketplace prompts.
2793
+ --exclude-global-modules Excludes the branch-independent module from the import operation.
2794
+ --import-webhook-status=<option> [default: disable] [optional] This webhook state keeps the same state of
2795
+ webhooks as the source stack.
2587
2796
  <options: disable|current>
2588
2797
  --personalize-project-name=<value> Personalize project name.
2589
2798
  --replace-existing Replaces the existing module in the target stack.
2590
2799
  --skip-app-recreation [optional] Skip private apps recreation if already exist
2591
- --skip-audit Skips the audit fix.
2800
+ --skip-audit Skips the audit fix that occurs during an import operation.
2592
2801
  --skip-existing Skips the module exists warning messages.
2593
2802
 
2594
2803
  DESCRIPTION
@@ -2627,14 +2836,18 @@ USAGE
2627
2836
  [--config <value>] [--multiple]
2628
2837
 
2629
2838
  FLAGS
2630
- -B, --branch=<value> Use this flag to add the branch name where you want to perform the migration.
2631
- -a, --alias=<value> Use this flag to add the management token alias.
2632
- -k, --stack-api-key=<value> With this flag add the API key of your stack.
2633
- --config=<value>... [optional] inline configuration, <key1>:<value1>
2634
- --config-file=<value> [optional] Path of the JSON configuration file
2635
- --file-path=<value> Use this flag to provide the path of the file of the migration script provided by the
2636
- user.
2637
- --multiple This flag helps you to migrate multiple content files in a single instance.
2839
+ -B, --branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
2840
+ branch name)
2841
+ -a, --alias=<value> Use this flag to add the management token alias. You must use either the --alias flag or
2842
+ the --stack-api-key flag.
2843
+ -k, --stack-api-key=<value> Use this flag to add the API key of your stack. You must use either the --stack-api-key
2844
+ flag or the --alias flag.
2845
+ --config=<value>... [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
2846
+ the script re-usable.
2847
+ --config-file=<value> [optional] Path of the JSON configuration file.
2848
+ --file-path=<value> Use this flag to provide the path of the file of the migration script.
2849
+ --multiple This flag helps you to migrate multiple content files in a single instance. Mention the
2850
+ folder path where your migration script files are stored.
2638
2851
 
2639
2852
  DESCRIPTION
2640
2853
  Contentstack migration script.
@@ -2749,8 +2962,10 @@ USAGE
2749
2962
  $ csdx cm:stacks:publish-configure [-a <value>] [-k <value>]
2750
2963
 
2751
2964
  FLAGS
2752
- -a, --alias=<value> Alias(name) for the management token
2753
- -k, --stack-api-key=<value> Stack api key to be used
2965
+ -a, --alias=<value> Name (alias) of the management token you want to use. You must use either the --alias
2966
+ flag or the --stack-api-key flag.
2967
+ -k, --stack-api-key=<value> API key of the source stack. You must use either the --stack-api-key flag or the --alias
2968
+ flag.
2754
2969
 
2755
2970
  DESCRIPTION
2756
2971
  The configure command is used to generate a configuration file for publish scripts.
@@ -2779,8 +2994,10 @@ USAGE
2779
2994
  $ csdx cm:stacks:publish-revert [--retry-failed <value>] [--log-file <value>]
2780
2995
 
2781
2996
  FLAGS
2782
- --log-file=<value> logfile to be used to revert
2783
- --retry-failed=<value> retry publishing failed entries from the logfile
2997
+ --log-file=<value> Path of the success logfile of a particular publish action.
2998
+ --retry-failed=<value> (optional) Use this option to retry publishing the failed entries from the logfile. Specify
2999
+ the name of the logfile that lists failed publish calls. If this option is used, it will
3000
+ override all other flags.
2784
3001
 
2785
3002
  DESCRIPTION
2786
3003
  Revert publish operations by using a log file
@@ -2861,11 +3078,11 @@ FLAGS
2861
3078
  -k, --stack-api-key=<value> Stack api key to be used
2862
3079
  -l, --locale=<value> Locale filter
2863
3080
  -y, --yes Agree to process the command with the current configuration
2864
- --api-version=<value> API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
3081
+ --api-version=<value> API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].
2865
3082
  --bulk-unpublish=<value> [default: true] This flag is set to true by default. It indicates that contentstack's
2866
3083
  bulkpublish API will be used to unpublish the entries and assets
2867
3084
  --content-type=<value> Content type filter
2868
- --delivery-token=<value> Delivery token for source environment
3085
+ --delivery-token=<value> The delivery token of the source environment.
2869
3086
  --retry-failed=<value> Retry publishing failed entries from the logfile (optional, overrides all other flags)
2870
3087
 
2871
3088
  DESCRIPTION
@@ -3040,8 +3257,8 @@ USAGE
3040
3257
  $ csdx config:remove:base-branch [-k <value>] [-y]
3041
3258
 
3042
3259
  FLAGS
3043
- -k, --stack-api-key=<value> Stack API Key
3044
- -y, --yes Force Remove
3260
+ -k, --stack-api-key=<value> Stack API key.
3261
+ -y, --yes Force remove.
3045
3262
 
3046
3263
  DESCRIPTION
3047
3264
  Remove branch config for CLI
@@ -3063,8 +3280,9 @@ USAGE
3063
3280
  $ csdx config:remove:ea-header [--header-alias <value>] [-y]
3064
3281
 
3065
3282
  FLAGS
3066
- -y, --yes Force Remove
3067
- --header-alias=<value> Early access header alias
3283
+ -y, --yes (optional) Force the removal of Early Access header configuration by skipping the
3284
+ confirmation.
3285
+ --header-alias=<value> (optional) Provide the Early Access header alias name.
3068
3286
 
3069
3287
  DESCRIPTION
3070
3288
  Remove Early Access header
@@ -3087,8 +3305,9 @@ USAGE
3087
3305
  $ csdx config:remove:early-access-header [--header-alias <value>] [-y]
3088
3306
 
3089
3307
  FLAGS
3090
- -y, --yes Force Remove
3091
- --header-alias=<value> Early access header alias
3308
+ -y, --yes (optional) Force the removal of Early Access header configuration by skipping the
3309
+ confirmation.
3310
+ --header-alias=<value> (optional) Provide the Early Access header alias name.
3092
3311
 
3093
3312
  DESCRIPTION
3094
3313
  Remove Early Access header
@@ -3133,8 +3352,8 @@ USAGE
3133
3352
  $ csdx config:set:base-branch [-k <value>] [--base-branch <value>]
3134
3353
 
3135
3354
  FLAGS
3136
- -k, --stack-api-key=<value> Stack API Key
3137
- --base-branch=<value> Base Branch
3355
+ -k, --stack-api-key=<value> Stack API key
3356
+ --base-branch=<value> Base branch (Target branch).
3138
3357
 
3139
3358
  DESCRIPTION
3140
3359
  Set branch for CLI
@@ -3156,8 +3375,8 @@ USAGE
3156
3375
  $ csdx config:set:ea-header [--header-alias <value>] [--header <value>]
3157
3376
 
3158
3377
  FLAGS
3159
- --header=<value> Early access header value
3160
- --header-alias=<value> Early access header alias
3378
+ --header=<value> (optional) Provide the Early Access header alias name.
3379
+ --header-alias=<value> (optional) Provide the Early Access header value.
3161
3380
 
3162
3381
  DESCRIPTION
3163
3382
  Set Early Access header
@@ -3180,8 +3399,8 @@ USAGE
3180
3399
  $ csdx config:set:early-access-header [--header-alias <value>] [--header <value>]
3181
3400
 
3182
3401
  FLAGS
3183
- --header=<value> Early access header value
3184
- --header-alias=<value> Early access header alias
3402
+ --header=<value> (optional) Provide the Early Access header alias name.
3403
+ --header-alias=<value> (optional) Provide the Early Access header value.
3185
3404
 
3186
3405
  DESCRIPTION
3187
3406
  Set Early Access header
@@ -3264,15 +3483,15 @@ EXAMPLES
3264
3483
 
3265
3484
  $ csdx config:set:region GCP-NA
3266
3485
 
3267
- $ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India"
3486
+ $ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India"
3268
3487
 
3269
- $ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India" --developer-hub <developer_hub_url>
3488
+ $ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url>
3270
3489
 
3271
- $ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India" --personalize <personalize_url>
3490
+ $ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --personalize <custom_personalize_url>
3272
3491
 
3273
- $ csdx config:set:region --cma <contentstack_cma_endpoint> --cda <contentstack_cda_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India" --launch <launch_url>
3492
+ $ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --launch <custom_launch_url>
3274
3493
 
3275
- $ csdx config:set:region --cda <contentstack_cda_endpoint> --cma <contentstack_cma_endpoint> --ui-host <contentstack_ui_host_endpoint> --name "India" --developer-hub <developer_hub_url> --personalize <personalize_url> --launch <launch_url>
3494
+ $ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url>
3276
3495
  ```
3277
3496
 
3278
3497
  _See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/region.ts)_
@@ -3309,21 +3528,22 @@ USAGE
3309
3528
  variables to the list|Import variables from the local env file] [-a <value>] [--env-variables <value>]
3310
3529
 
3311
3530
  FLAGS
3312
- -a, --alias=<value> [Optional] Alias(name) for the delivery token
3313
- -e, --environment=<value> [Optional] Environment name for the Launch project
3314
- -n, --name=<value> [Optional] Name of the project
3315
- --branch=<value> [Optional] GitHub branch name
3316
- --build-command=<value> [Optional] Build Command
3317
- --env-variables=<value> [Optional] Provide the environment variables in the key:value format, separated by comma
3318
- Ex:APP_ENV:prod, TEST_ENV:testVal
3319
- --framework=<option> [Optional] Type of framework
3531
+ -a, --alias=<value> [optional] Alias (name) for the delivery token.
3532
+ -e, --environment=<value> [optional] Environment name for the Launch project.
3533
+ -n, --name=<value> [optional] Name of the project.
3534
+ --branch=<value> [optional] GitHub branch name.
3535
+ --build-command=<value> [optional] Build Command.
3536
+ --env-variables=<value> [optional] Provide the environment variables in the key:value format, separated by
3537
+ comma. For example: APP_ENV:prod, TEST_ENV:testVal.
3538
+ --framework=<option> [optional] Type of framework. <options: Gatsby|NextJS|Other>
3320
3539
  <options: Gatsby|NextJs|CRA (Create React App)|CSR (Client-Side
3321
3540
  Rendered)|Angular|VueJs|Other>
3322
- --org=<value> [Optional] Provide the organization UID to create a new project or deployment
3323
- --out-dir=<value> [Optional] Output Directory
3324
- --type=<option> [Optional] Choose the type of adapters
3541
+ --org=<value> [optional] Provide the organization UID to create a new project or deployment.
3542
+ --out-dir=<value> [optional] Output Directory.
3543
+ --type=<option> [optional] Type of adapters. <options: GitHub|FileUpload>
3325
3544
  <options: GitHub|FileUpload>
3326
- --variable-type=<option> [Optional] Provide a variable type.
3545
+ --variable-type=<option> [optional] Provide a variable type. <options: Import variables from a stack|Manually add
3546
+ custom variables to the list|Import variables from the local env file>
3327
3547
  <options: Import variables from a stack|Manually add custom variables to the list|Import
3328
3548
  variables from the local env file>
3329
3549
 
@@ -3524,8 +3744,8 @@ USAGE
3524
3744
  $ csdx login [-u <value> | --oauth] [-p <value> | ]
3525
3745
 
3526
3746
  FLAGS
3527
- -p, --password=<value> Password
3528
- -u, --username=<value> User name
3747
+ -p, --password=<value> Password of your Contentstack app
3748
+ -u, --username=<value> Email address of your Contentstack account.
3529
3749
  --oauth Enables single sign-on (SSO) in Contentstack CLI
3530
3750
 
3531
3751
  DESCRIPTION