From 3ba1d1f9801a37b2230c01fc283e90fd35e8c811 Mon Sep 17 00:00:00 2001 From: sunil-lakshman <104969541+sunil-lakshman@users.noreply.github.com> Date: Wed, 6 Nov 2024 12:17:19 +0530 Subject: [PATCH] updated readme file --- packages/contentstack/README.md | 50 ++++++++++++++++++--------------- 1 file changed, 27 insertions(+), 23 deletions(-) diff --git a/packages/contentstack/README.md b/packages/contentstack/README.md index 1a8fa359f0..6cd4dd06e9 100644 --- a/packages/contentstack/README.md +++ b/packages/contentstack/README.md @@ -1085,25 +1085,32 @@ USAGE ] [--delivery-token ] [--source-env ] FLAGS - -B, --branch= [default: main] Specify the branch to fetch the content (by default the main branch - is selected) - -a, --alias= Alias(name) for the management token - -c, --config= Path for the external config file (A new config file can be generated at the current - working directory using `csdx cm:bulk-publish:configure -a [ALIAS]`) - -e, --environments=... Environments where entries will be published - -k, --stack-api-key= Stack api key to be used - -l, --locales=... Locales where entries will be published - -y, --yes Agree to process the command with the current configuration - --api-version= API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]. - --bulk-publish= [default: true] This flag is set to true by default. It indicates that contentstack's - bulkpublish API will be used to publish the entries - --content-types=... The Contenttypes from which entries need to be published - --delivery-token= Delivery token for source environment - --publish-all-content-types (optional) Publish all contenttypes (cannot be set when contentTypes flag is set) - --retry-failed= (optional) Retry failed entries from the logfile (overrides all other flags) This - flag is used to retry publishing entries that failed to publish in a previous - attempt. A log file for the previous session will be required for processing the - failed entries + -B, --branch= [default: main] The name of the branch where you want to perform the bulk publish + operation. If you don’t mention the branch name, then by default the content from + main branch will be published. + -a, --alias= Alias (name) of the management token. You must use either the --alias flag or the + --stack-api-key flag. + -c, --config= (optional) The path of the optional configuration JSON file containing all the + options for a single run. Refer to the configure command to create a configuration + file. + -e, --environments=... The name of the environment on which entries will be published. In case of multiple + environments, specify their names separated by spaces. + -k, --stack-api-key= API key of the source stack. You must use either the --stack-api-key flag or the + --alias flag. + -l, --locales=... Locales in which entries will be published, e.g., en-us. In the case of multiple + locales, specify the codes separated by spaces. + -y, --yes Set it to true to process the command with the current configuration. + --api-version= API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]. + --bulk-publish= [default: true] Set this flag to use Contentstack's Bulk Publish APIs. This flag is + set to true, by default. + --content-types=... The UID of the content type(s) whose entries you want to publish in bulk. In case of + multiple content types, specify the IDs separated by spaces. + --delivery-token= The delivery token of the source environment. + --publish-all-content-types (optional) Set it to true to bulk publish entries from all content types. If the + --content-types option is already used, then you cannot use this option. + --retry-failed= (optional) Use this option to retry publishing the failed entries/ assets from the + logfile. Specify the name of the logfile that lists failed publish calls. If this + option is used, it will override all other flags. --source-env= Source environment DESCRIPTION @@ -1632,8 +1639,6 @@ FLAGS --content-types=... The UID of the content type(s) whose entries you want to publish in bulk. In case of multiple content types, specify the IDs separated by spaces. --delivery-token= The delivery token of the source environment. - --entry-uid= Entry Uid for publish all associated variant entries. - --include-variants Include Variants flag will publish all associated variant entries with base entry. --publish-all-content-types (optional) Set it to true to bulk publish entries from all content types. If the --content-types option is already used, then you cannot use this option. --retry-failed= (optional) Use this option to retry publishing the failed entries/ assets from the @@ -1971,7 +1976,6 @@ FLAGS Bulk Publish APIs will be used to unpublish the entries. --content-type= The UID of the content type whose entries you want to unpublish in bulk. --delivery-token= The delivery token of the source environment. - --include-variants Include Variants flag will unpublish all associated variant entries. --locale= Locale from which entries/assets will be unpublished, e.g., en-us. --retry-failed= (optional) Use this option to retry unpublishing the failed entries from the logfile. Specify the name of the logfile that lists failed unpublish calls. If used, this option @@ -4086,4 +4090,4 @@ EXAMPLES ``` -``` +``` \ No newline at end of file