From 55fd751a18ee4345f0b45f2ec707d84e7c2c2b2a Mon Sep 17 00:00:00 2001 From: "harshitha.d" Date: Wed, 30 Oct 2024 17:11:29 +0530 Subject: [PATCH 1/3] update ui text changes --- .../src/commands/auth/login.ts | 4 +- .../src/commands/auth/tokens/add.ts | 2 +- .../src/commands/auth/tokens/remove.ts | 4 +- .../src/commands/cm/branches/create.ts | 4 +- .../src/commands/cm/branches/diff.ts | 12 +++--- .../src/commands/cm/branches/index.ts | 4 +- .../src/commands/cm/branches/merge.ts | 22 +++++----- .../src/commands/cm/assets/publish.js | 36 ++++++++-------- .../src/commands/cm/assets/unpublish.js | 23 +++++------ .../commands/cm/bulk-publish/cross-publish.js | 10 ++--- .../commands/cm/entries/publish-modified.js | 32 +++++++-------- .../entries/publish-non-localized-fields.js | 30 +++++++------- .../cm/entries/publish-only-unpublished.js | 34 +++++++-------- .../src/commands/cm/entries/publish.js | 35 ++++++++-------- .../src/commands/cm/entries/unpublish.js | 25 ++++++----- .../commands/cm/entries/update-and-publish.js | 41 +++++++++++-------- .../commands/cm/stacks/publish-configure.js | 4 +- .../src/commands/cm/stacks/publish-revert.js | 8 ++-- .../src/commands/cm/stacks/unpublish.js | 4 +- .../src/commands/cm/stacks/clone.js | 18 ++++---- .../src/commands/config/remove/base-branch.ts | 4 +- .../config/remove/early-access-header.ts | 4 +- .../src/commands/config/set/base-branch.ts | 4 +- .../config/set/early-access-header.ts | 4 +- .../src/commands/config/set/region.ts | 10 ++--- .../src/commands/cm/export-to-csv.js | 28 ++++++------- .../src/commands/cm/stacks/export.ts | 18 ++++---- .../src/commands/cm/stacks/import.ts | 22 +++++----- .../src/commands/launch/index.ts | 29 +++++++------ .../commands/cm/entries/migrate-html-rte.js | 36 ++++++++-------- .../src/commands/cm/stacks/migration.js | 21 +++++----- 31 files changed, 267 insertions(+), 265 deletions(-) diff --git a/packages/contentstack-auth/src/commands/auth/login.ts b/packages/contentstack-auth/src/commands/auth/login.ts index 8b61d65ca8..8c93dba56f 100644 --- a/packages/contentstack-auth/src/commands/auth/login.ts +++ b/packages/contentstack-auth/src/commands/auth/login.ts @@ -27,14 +27,14 @@ export default class LoginCommand extends BaseCommand { static flags: FlagInput = { username: flags.string({ char: 'u', - description: 'User name', + description: 'Email address of your Contentstack account.', multiple: false, required: false, exclusive: ['oauth'], }), password: flags.string({ char: 'p', - description: 'Password', + description: 'Password of your Contentstack app', multiple: false, required: false, exclusive: ['oauth'], diff --git a/packages/contentstack-auth/src/commands/auth/tokens/add.ts b/packages/contentstack-auth/src/commands/auth/tokens/add.ts index 9eec9c464c..07480aaf09 100644 --- a/packages/contentstack-auth/src/commands/auth/tokens/add.ts +++ b/packages/contentstack-auth/src/commands/auth/tokens/add.ts @@ -30,7 +30,7 @@ export default class TokensAddCommand extends BaseCommand']; static flags: FlagInput = { - alias: flags.string({ char: 'a', description: 'Token alias' }), - ignore: flags.boolean({ char: 'i', description: 'Ignore' }), + alias: flags.string({ char: 'a', description: 'Alias (name) of the token to delete.' }), + ignore: flags.boolean({ char: 'i', description: 'Ignores if the token is not present.' }), }; async run(): Promise { diff --git a/packages/contentstack-branches/src/commands/cm/branches/create.ts b/packages/contentstack-branches/src/commands/cm/branches/create.ts index 00d264484b..322d7a6bc7 100644 --- a/packages/contentstack-branches/src/commands/cm/branches/create.ts +++ b/packages/contentstack-branches/src/commands/cm/branches/create.ts @@ -19,8 +19,8 @@ export default class BranchCreateCommand extends Command { ]; // Note: Add and modify the usage static flags = { - uid: flags.string({ description: 'Branch UID to be created' }), - source: flags.string({ description: 'Source branch from which new branch to be created' }), + uid: flags.string({ description: 'Branch UID (unique name) to be created.' }), + source: flags.string({ description: 'Source branch from which a new branch is to be created.' }), 'stack-api-key': flags.string({ char: 'k', description: 'Stack API key' }), }; diff --git a/packages/contentstack-branches/src/commands/cm/branches/diff.ts b/packages/contentstack-branches/src/commands/cm/branches/diff.ts index 054a613d82..e0dc63eb57 100644 --- a/packages/contentstack-branches/src/commands/cm/branches/diff.ts +++ b/packages/contentstack-branches/src/commands/cm/branches/diff.ts @@ -26,26 +26,26 @@ export default class BranchDiffCommand extends Command { static flags = { 'base-branch': flags.string({ - description: 'Base branch', + description: '[optional] Base branch (Target branch).', }), 'compare-branch': flags.string({ - description: 'Compare branch', + description: '[optional] Compare branch (Source branch).', }), module: flags.string({ - description: 'Module', + description: '[optional] Module. ', options: ['content-types', 'global-fields', 'all'], }), 'stack-api-key': flags.string({ char: 'k', - description: 'Provide Stack API key to show difference between branches', + description: '[optional] Provide the Stack API key to show the difference between branches.', }), format: flags.string({ default: 'compact-text', multiple: false, options: ['compact-text', 'detailed-text'], - description: '[Optional] Type of flags to show branches differences', + description: '[default: compact-text] [optional] Type of flags to show the difference between two branches. ', }), - }; + }; static aliases: string[] = []; // Note: alternative usage if any diff --git a/packages/contentstack-branches/src/commands/cm/branches/index.ts b/packages/contentstack-branches/src/commands/cm/branches/index.ts index 2be2e4b689..59c4efb931 100644 --- a/packages/contentstack-branches/src/commands/cm/branches/index.ts +++ b/packages/contentstack-branches/src/commands/cm/branches/index.ts @@ -10,8 +10,8 @@ export default class BranchListCommand extends Command { static usage: string = 'cm:branches'; // Note: Add and modify the usage static flags = { - 'stack-api-key': flags.string({ char: 'k', description: 'Stack API Key' }), - verbose: flags.boolean({ description: 'Verbose' }), + 'stack-api-key': flags.string({ char: 'k', description: 'Stack API key' }), + verbose: flags.boolean({ description: 'Verbose, display information in detailed format.' }), }; static aliases: string[] = []; // Note: alternative usage if any diff --git a/packages/contentstack-branches/src/commands/cm/branches/merge.ts b/packages/contentstack-branches/src/commands/cm/branches/merge.ts index beccf50e53..0fae9a34d3 100644 --- a/packages/contentstack-branches/src/commands/cm/branches/merge.ts +++ b/packages/contentstack-branches/src/commands/cm/branches/merge.ts @@ -20,40 +20,40 @@ export default class BranchMergeCommand extends Command { // TBD improve flag descriptions static flags = { - 'compare-branch': flags.string({ - description: 'Compare branch name', + 'compare-branch': flags.string({ + description: '[optional] Compare branch (Source branch).', }), 'base-branch': flags.string({ - description: 'Base branch', + description: '[optional] Base branch (Target branch).', }), comment: flags.string({ - description: 'Merge comment', + description: '[optional] Pass a comment.', }), 'stack-api-key': flags.string({ char: 'k', - description: 'Provide Stack API key to show difference between branches', + description: '[optional] Provide stack API key to show the difference between the branches.', }), 'export-summary-path': flags.string({ - description: 'Export summary file path', + description: '[optional] Export summary file path.', }), 'use-merge-summary': flags.string({ - description: 'Path of merge summary file', + description: '[optional] Path of merge summary file.', }), 'no-revert': flags.boolean({ - description: 'If passed, will not create the new revert branch', + description: '[optional] If passed, will not create the new revert branch.', }), strategy: flags.string({ - description: 'Merge strategy', + description: '[hidden] Merge strategy.', options: ['merge_prefer_base', 'merge_prefer_compare', 'overwrite_with_compare', 'custom_preferences'], hidden: true, }), 'strategy-sub-options': flags.string({ - description: 'Merge strategy sub options', + description: '[hidden] Merge strategy sub options.', options: ['new', 'modified', 'both'], hidden: true, }), 'merge-action': flags.string({ - description: 'Merge strategy', + description: '[hidden] Merge action.', options: ['export', 'execute', 'both'], hidden: true, }), diff --git a/packages/contentstack-bulk-publish/src/commands/cm/assets/publish.js b/packages/contentstack-bulk-publish/src/commands/cm/assets/publish.js index 4fd065f7f2..5e919b05d0 100644 --- a/packages/contentstack-bulk-publish/src/commands/cm/assets/publish.js +++ b/packages/contentstack-bulk-publish/src/commands/cm/assets/publish.js @@ -157,79 +157,77 @@ But, if retryFailed flag is set, then only a logfile is required AssetsPublishCommand.flags = { alias: flags.string({ char: 'a', - description: 'Alias(name) for the management token', + description: 'Alias (name) for the management token. You must use either the --alias flag or the --stack-api-key flag.', }), 'stack-api-key': flags.string({ char: 'k', - description: 'Stack api key to be used', + description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.', required: false, }), 'retry-failed': flags.string({ - description: 'Retry publishing failed assets from the logfile (optional, will override all other flags)', + description: 'Use this option to retry publishing the failed 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.', }), environments: flags.string({ char: 'e', - description: 'Environments where assets will be published', + description: 'The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.', multiple: true, }), 'folder-uid': flags.string({ - description: '[default: cs_root] Folder-uid from where the assets will be published', + description: '(optional) The UID of the Assets’ folder from which the assets need to be published. The default value is cs_root.', exclusive: ['source-env'], }), 'bulk-publish': flags.string({ - description: - "By default this flag is set as true. It indicates that contentstack's bulkpublish API will be used to publish the assets", + description: 'Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.', default: 'true', }), config: flags.string({ char: 'c', - description: 'Path to the config file', + description: '(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.', }), yes: flags.boolean({ char: 'y', - description: 'Agree to process the command with the current configuration', + description: 'Set it to true to process the command with the current configuration.', }), locales: flags.string({ char: 'l', - description: 'Locales to where assets will be published', + description: 'Locales in which assets will be published, e.g., en-us. In the case of multiple locales, specify the codes separated by spaces.', multiple: true, parse: printFlagDeprecation(['-l'], ['--locales']), }), branch: flags.string({ char: 'B', default: 'main', - description: 'Specify the branch to fetch the content (by default the main branch is selected)', + description: '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 assets from the main branch will be published.', parse: printFlagDeprecation(['-B'], ['--branch']), }), - + // To be deprecated retryFailed: flags.string({ char: 'r', - description: 'Retry publishing failed assets from the logfile (optional, will override all other flags)', + description: 'Retry publishing failed assets from the logfile (optional, will override all other flags).', hidden: true, parse: printFlagDeprecation(['-r', '--retryFailed'], ['--retry-failed']), }), folderUid: flags.string({ char: 'u', - description: '[default: cs_root] Folder-uid from where the assets will be published', + description: '(default: cs_root) Folder-uid from where the assets will be published.', hidden: true, parse: printFlagDeprecation(['-u', '--folderUid'], ['--folder-uid']), exclusive: ['source-env'], }), bulkPublish: flags.string({ char: 'b', - description: - "By default this flag is set as true. It indicates that contentstack's bulkpublish API will be used to publish the entries", + description: "By default this flag is set as true. It indicates that Contentstack's bulk publish API will be used to publish the entries.", default: 'true', hidden: true, parse: printFlagDeprecation(['-b', '--bulkPublish'], ['--bulk-publish']), }), 'api-version': flags.string({ - description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", + description: "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", }), - 'delivery-token': flags.string({ description: 'Delivery token for source environment' }), + 'delivery-token': flags.string({ description: 'The delivery token of the source environment.' }), 'source-env': flags.string({ description: 'Source environment' }), - 'content-types': flags.string({ description: 'Content types', hidden: true, multiple: true }), // this is a work around, as this command is to be run with entries:publish command and should not break flags check. + 'content-types': flags.string({ description: 'Content types', hidden: true, multiple: true }), }; AssetsPublishCommand.examples = [ diff --git a/packages/contentstack-bulk-publish/src/commands/cm/assets/unpublish.js b/packages/contentstack-bulk-publish/src/commands/cm/assets/unpublish.js index 5e1ffe1f65..a074f1e838 100644 --- a/packages/contentstack-bulk-publish/src/commands/cm/assets/unpublish.js +++ b/packages/contentstack-bulk-publish/src/commands/cm/assets/unpublish.js @@ -134,45 +134,44 @@ But, if retry-failed flag is set, then only a logfile is required`; UnpublishCommand.flags = { alias: flags.string({ char: 'a', - description: 'Alias(name) for the management token', + description: 'Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.', }), 'stack-api-key': flags.string({ char: 'k', - description: 'Stack api key to be used', + description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.', required: false, }), environment: flags.string({ char: 'e', - description: 'Source Environment', + description: 'The name of the environment from where entries/assets need to be unpublished.', }), config: flags.string({ char: 'c', - description: 'Path to the config file', + description: '(optional) Path of an optional configuration JSON file containing all the options for a single run. Refer to the configure command to create a configuration file.', }), yes: flags.boolean({ char: 'y', - description: 'Agree to process the command with the current configuration', + description: 'Set it to true to process the command with the current configuration.', }), locale: flags.string({ - description: 'Locale filter', + description: 'Locale from which entries/assets will be unpublished, e.g., en-us.', }), branch: flags.string({ default: 'main', - description: 'Specify the branch to fetch the content (by default the main branch is selected)', + description: 'The name of the branch where you want to perform the bulk unpublish operation. If you don’t mention the branch name, then by default the content from the main branch will be unpublished.', }), 'retry-failed': flags.string({ - description: 'Retry unpublishing failed assets from the logfile', + description: '(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 this option is used, it will override all other flags.', }), 'bulk-unpublish': flags.string({ - description: - "By default this flag is set as true. It indicates that contentstack's bulkpublish API will be used to unpublish the assets", + description: 'Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.', default: 'true', }), 'api-version': flags.string({ - description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", + description: 'API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].', }), 'delivery-token': flags.string({ - description: 'Delivery Token for source environment', + description: 'The delivery token of the source environment.', }), }; diff --git a/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js b/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js index 63638b8bfa..d8c32f34f4 100644 --- a/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js +++ b/packages/contentstack-bulk-publish/src/commands/cm/bulk-publish/cross-publish.js @@ -186,17 +186,17 @@ CrossPublishCommand.flags = { char: 'b', hidden: true, description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries", + "Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.", default: 'true', parse: printFlagDeprecation(['--bulkPublish', '-b'], ['--bulk-publish']), }), 'bulk-publish': flags.string({ description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries", + "Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.", default: 'true', }), 'api-version': flags.string({ - description: 'API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].', + description: 'API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].', }), contentType: flags.string({ char: 't', @@ -240,12 +240,12 @@ CrossPublishCommand.flags = { }), deliveryToken: flags.string({ char: 'x', - description: 'Delivery token for source environment', + description: 'The delivery token of the source environment.', hidden: true, parse: printFlagDeprecation(['--deliveryToken', '-x'], ['--delivery-token']), }), 'delivery-token': flags.string({ - description: 'Delivery token for source environment', + description: 'The delivery token of the source environment.', }), config: flags.string({ char: 'c', description: 'Path to the config file' }), yes: flags.boolean({ char: 'y', description: 'Agree to process the command with the current configuration' }), diff --git a/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-modified.js b/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-modified.js index 1b1bf24130..c6d09fcd9d 100644 --- a/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-modified.js +++ b/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-modified.js @@ -125,69 +125,69 @@ But, if retry-failed flag is set, then only a logfile is required `; PublishModifiedCommand.flags = { - alias: flags.string({ char: 'a', description: 'Alias(name) for the management token' }), + alias: flags.string({ char: 'a', description: 'Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.' }), 'stack-api-key': flags.string({ char: 'k', - description: 'Stack api key to be used', + description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.', required: false, }), retryFailed: flags.string({ char: 'r', - description: 'Retry publishing failed entries from the logfile (optional, overrides all other flags)', + description: '(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', hidden: true, parse: printFlagDeprecation(['-r', '--retryFailed'], ['--retry-failed']), }), 'retry-failed': flags.string({ - description: 'Retry publishing failed entries from the logfile (optional, overrides all other flags)', + description: '(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', }), bulkPublish: flags.string({ char: 'b', description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries", + "Set this flag to use Contentstack\'s Bulk Publish APIs. It is true, by default.", hidden: true, parse: printFlagDeprecation(['-b', '--bulkPublish'], ['--bulk-publish']), }), 'bulk-publish': flags.string({ description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries", + "Set this flag to use Contentstack\'s Bulk Publish APIs. It is true, by default.", default: 'true', }), 'api-version': flags.string({ - description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", + description : "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", }), sourceEnv: flags.string({ char: 's', - description: 'Environment from which edited entries will be published', + description: 'The name of the source environment where the entries were initially published.', hidden: true, parse: printFlagDeprecation(['-s', '--sourceEnv'], ['--source-env']), }), 'source-env': flags.string({ - description: 'Environment from which edited entries will be published', + description: 'The name of the source environment where the entries were initially published.', }), contentTypes: flags.string({ char: 't', - description: 'The Content-Types which will be checked for edited entries', + description: 'The UID of the content type(s) whose edited entries you want to publish in bulk. In case of multiple content types, specify the IDs separated by spaces.', multiple: true, parse: printFlagDeprecation(['-t', '--contentTypes'], ['--content-types']), hidden: true, }), 'content-types': flags.string({ - description: 'The Contenttypes which will be checked for edited entries', + description: 'The UID of the content type(s) whose edited entries you want to publish in bulk. In case of multiple content types, specify the IDs separated by spaces.', multiple: true, }), locales: flags.string({ char: 'l', - description: 'Locales where edited entries will be published', + description: 'Locales in which entries will be published, e.g., en-us. In the case of multiple locales, specify the codes separated by spaces.', multiple: true, parse: printFlagDeprecation(['-l'], ['--locales']), }), - environments: flags.string({ char: 'e', description: 'Destination environments', multiple: true }), - config: flags.string({ char: 'c', description: 'Path to the config file' }), - yes: flags.boolean({ char: 'y', description: 'Agree to process the command with the current configuration' }), + environments: flags.string({ char: 'e', description: 'The name of the environment(s) on which the entries will be published. In case of multiple environments, specify their names separated by spaces.', multiple: true }), + config: flags.string({ char: 'c', description: '(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.' }), + yes: flags.boolean({ char: 'y', description: 'Set it to true to process the command with the current configuration.' }), branch: flags.string({ char: 'B', default: 'main', - description: 'Specify the branch to fetch the content (by default the main branch is selected)', + description: '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 entries from main branch will be published.', parse: printFlagDeprecation(['-B'], ['--branch']), }), }; diff --git a/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-non-localized-fields.js b/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-non-localized-fields.js index e3e219a511..1c7fa6c7a8 100644 --- a/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-non-localized-fields.js +++ b/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-non-localized-fields.js @@ -129,65 +129,63 @@ But, if retryFailed flag is set, then only a logfile is required`; NonlocalizedFieldChangesCommand.flags = { alias: flags.string({ char: 'a', - description: 'Alias(name) for the management token', + description: 'Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.', }), 'stack-api-key': flags.string({ char: 'k', - description: 'Stack api key to be used', + description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.', required: false, }), 'retry-failed': flags.string({ - description: 'Retry publishing failed entries from the logfile', + description: 'Use this option to retry publishing the failed entries 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.', }), 'bulk-publish': flags.string({ - description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries", + description: "Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.", default: 'true', }), 'source-env': flags.string({ - description: 'Source Environment', + description: 'The name of the source environment.', }), 'content-types': flags.string({ - description: 'The Contenttypes from which entries will be published', + description: 'The UID of the content type whose entries you want to publish in bulk. In case of multiple content types, specify their IDs separated by spaces.', multiple: true, }), environments: flags.string({ char: 'e', - description: 'Destination environments', + description: 'The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.', multiple: true, }), config: flags.string({ char: 'c', - description: 'Path to the config file', + description: '(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.', }), yes: flags.boolean({ char: 'y', - description: 'Agree to process the command with the current configuration', + description: 'Set it to true to process the command with the current configuration.', }), branch: flags.string({ char: 'B', default: 'main', - description: 'Specify the branch to fetch the content (by default the main branch is selected)', + description: '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 the main branch will be published.', parse: printFlagDeprecation(['-B'], ['--branch']), }), // To be deprecated retryFailed: flags.string({ char: 'r', - description: 'Retry publishing failed entries from the logfile', + description: 'Retry publishing failed entries from the logfile.', hidden: true, parse: printFlagDeprecation(['-r', '--retryFailed'], ['--retry-failed']), }), bulkPublish: flags.string({ char: 'b', - description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries", + description: "This flag is set to true by default. It indicates that Contentstack's bulk publish API will be used to publish the entries.", default: 'true', hidden: true, parse: printFlagDeprecation(['-b', '--bulkPublish'], ['--bulk-publish']), }), 'api-version': flags.string({ - description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", + description: "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", }), sourceEnv: flags.string({ char: 's', @@ -197,7 +195,7 @@ NonlocalizedFieldChangesCommand.flags = { }), contentTypes: flags.string({ char: 't', - description: 'The contenttypes from which entries will be published', + description: 'The content types from which entries will be published.', multiple: true, hidden: true, parse: printFlagDeprecation(['-t', '--contentTypes'], ['--content-types']), diff --git a/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-only-unpublished.js b/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-only-unpublished.js index 8fddb670c7..febfa9f96c 100644 --- a/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-only-unpublished.js +++ b/packages/contentstack-bulk-publish/src/commands/cm/entries/publish-only-unpublished.js @@ -21,73 +21,73 @@ But, if retry-failed flag is set, then only a logfile is required `; PublishOnlyUnpublished.flags = { - alias: flags.string({ char: 'a', description: 'Alias(name) for the management token' }), + alias: flags.string({ char: 'a', description: 'Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.' }), 'stack-api-key': flags.string({ char: 'k', - description: 'Stack api key to be used', + description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.', }), retryFailed: flags.string({ char: 'r', hidden: true, - description: 'Retry publishing failed entries from the logfile', + description: '(optional) Use this option to retry publishing the failed entries from the logfile. It is optional. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.', parse: printFlagDeprecation(['--retryFailed', '-r'], ['--retry-failed']), }), 'retry-failed': flags.string({ - description: 'Retry publishing failed entries from the logfile', + description: '(optional) Use this option to retry publishing the failed entries from the logfile. It is optional. Specify the name of the logfile that lists failed publish calls. If this option is used, it will override all other flags.', }), bulkPublish: flags.string({ char: 'b', hidden: true, description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries", + "Set this flag to use Contentstack\'s Bulk Publish APIs. It is true, by default.", default: 'true', parse: printFlagDeprecation(['--bulkPublish', '-b'], ['--bulk-publish']), }), 'bulk-publish': flags.string({ char: 'b', description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries", + "Set this flag to use Contentstack\'s Bulk Publish APIs. It is true, by default.", default: 'true', }), 'api-version': flags.string({ - description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", + description : "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]..", }), sourceEnv: flags.string({ char: 's', hidden: true, - description: 'Source Env', + description: 'The name of the source environment where the entries were initially published.', parse: printFlagDeprecation(['--sourceEnv', '-s'], ['--source-env']), }), 'source-env': flags.string({ - description: 'Source Env', + description: 'The name of the source environment where the entries were initially published.', }), contentTypes: flags.string({ char: 't', - description: 'The Content-Types from which entries need to be published', + description: 'The UID of the content type(s) whose entries you want to publish in bulk. In case of multiple content types, specify their IDs separated by spaces.', multiple: true, hidden: true, parse: printFlagDeprecation(['--contentTypes', '-t'], ['--content-types']), }), 'content-types': flags.string({ - description: 'The Contenttypes from which entries will be published', + description: 'The UID of the content type(s) whose entries you want to publish in bulk. In case of multiple content types, specify their IDs separated by spaces.', multiple: true, }), locale: flags.string({ hidden: true, char: 'l', - description: 'Source locale', + description: 'Locale in which entries will be published, e.g., en-us', parse: printFlagDeprecation(['-l'], ['--locales']), }), locales: flags.string({ - description: 'Source locale', + description: 'Locale in which entries will be published, e.g., en-us', }), - environments: flags.string({ char: 'e', description: 'Destination environments', multiple: true }), - config: flags.string({ char: 'c', description: 'Path to the config file' }), - yes: flags.boolean({ char: 'y', description: 'Agree to process the command with the current configuration' }), + environments: flags.string({ char: 'e', description: 'The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.', multiple: true }), + config: flags.string({ char: 'c', description: '(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.' }), + yes: flags.boolean({ char: 'y', description: 'Set it to true to process the command with the current configuration.' }), branch: flags.string({ char: 'B', default: 'main', - description: 'Specify the branch to fetch the content (by default the main branch is selected)', + description: '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 entries from main branch will be published.', parse: printFlagDeprecation(['-B'], ['--branch']), }), }; diff --git a/packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js b/packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js index 8b50c8b1ee..7e700eb13b 100644 --- a/packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js +++ b/packages/contentstack-bulk-publish/src/commands/cm/entries/publish.js @@ -168,81 +168,80 @@ But, if retry-failed flag is set, then only a logfile is required `; PublishEntriesCommand.flags = { - alias: flags.string({ char: 'a', description: 'Alias(name) for the management token' }), + alias: flags.string({ char: 'a', description: 'Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.' }), 'stack-api-key': flags.string({ char: 'k', - description: 'Stack api key to be used', + description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.', }), retryFailed: flags.string({ char: 'r', description: - 'Retry failed entries from the logfile (optional, 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', + '(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.', hidden: true, parse: printFlagDeprecation(['-r', '--retryFailed'], ['--retry-failed']), }), 'retry-failed': flags.string({ description: - '(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', + '(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.', }), bulkPublish: flags.string({ char: 'b', - description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries", + description: `Set this flag to use Contentstack\'s Bulk Publish APIs. This flag is set to true, by default.`, hidden: true, parse: printFlagDeprecation(['-b', '--bulkPublish'], ['--bulk-publish']), }), 'bulk-publish': flags.string({ description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries", + `Set this flag to use Contentstack\'s Bulk Publish APIs. This flag is set to true, by default.`, default: 'true', }), 'api-version': flags.string({ - description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", + description : 'API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].', }), 'publish-all-content-types': flags.boolean({ - description: '(optional) Publish all contenttypes (cannot be set when contentTypes flag is set)', + description: '(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.', }), publishAllContentTypes: flags.boolean({ char: 'o', - description: 'Publish all content-types (optional, cannot be set when contentTypes flag is set)', + description: '(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.', hidden: true, parse: printFlagDeprecation(['-o', '--publishAllContentTypes'], ['--publish-all-content-types']), }), 'content-types': flags.string({ - description: 'The Contenttypes from which entries need to be published', + description: '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.', multiple: true, }), contentTypes: flags.string({ char: 't', - description: 'The Contenttypes from which entries will be published', + description: '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.', multiple: true, parse: printFlagDeprecation(['-t', '--contentTypes'], ['--content-types']), hidden: true, }), locales: flags.string({ char: 'l', - description: 'Locales where entries will be published', + description: ' Locales in which entries will be published, e.g., en-us. In the case of multiple locales, specify the codes separated by spaces.', multiple: true, parse: printFlagDeprecation(['-l'], ['--locales']), }), environments: flags.string({ char: 'e', - description: 'Environments where entries will be published', + description: 'The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.', multiple: true, }), config: flags.string({ char: 'c', description: - '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]`)', + '(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.', }), - yes: flags.boolean({ char: 'y', description: 'Agree to process the command with the current configuration' }), + yes: flags.boolean({ char: 'y', description: 'Set it to true to process the command with the current configuration.' }), branch: flags.string({ char: 'B', default: 'main', - description: 'Specify the branch to fetch the content (by default the main branch is selected)', + description: '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.', parse: printFlagDeprecation(['-B'], ['--branch']), }), - 'delivery-token': flags.string({ description: 'Delivery token for source environment' }), + 'delivery-token': flags.string({ description: 'The delivery token of the source environment.' }), 'source-env': flags.string({ description: 'Source environment' }), }; diff --git a/packages/contentstack-bulk-publish/src/commands/cm/entries/unpublish.js b/packages/contentstack-bulk-publish/src/commands/cm/entries/unpublish.js index 605f19caa6..523ea2c1bd 100644 --- a/packages/contentstack-bulk-publish/src/commands/cm/entries/unpublish.js +++ b/packages/contentstack-bulk-publish/src/commands/cm/entries/unpublish.js @@ -135,47 +135,46 @@ But, if retry-failed flag is set, then only a logfile is required`; UnpublishCommand.flags = { alias: flags.string({ char: 'a', - description: 'Alias(name) for the management token', + description: 'Alias (name) for the management token. You must use either the --alias flag or the --stack-api-key flag.', }), 'stack-api-key': flags.string({ char: 'k', - description: 'Stack api key to be used', + description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.', }), environment: flags.string({ char: 'e', - description: 'Source Environment', + description: 'The name of the environment from where entries/assets need to be unpublished.', }), config: flags.string({ char: 'c', - description: 'Path to the config file', + description: '(optional) Path to the configuration JSON file containing all options for a single run. Refer to the configure command to create a configuration file.', }), yes: flags.boolean({ char: 'y', - description: 'Agree to process the command with the current configuration', + description: 'Set to true to process the command with the current configuration.', }), locale: flags.string({ - description: 'Locale filter', + description: 'Locale from which entries/assets will be unpublished, e.g., en-us.', }), branch: flags.string({ default: 'main', - description: 'Specify the branch to fetch the content (by default the main branch is selected)', + description: 'Specify the branch to fetch the content. If not mentioned, the main branch will be used by default.', }), 'retry-failed': flags.string({ - description: 'Retry publishing failed entries from the logfile', + description: '(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 will override all other flags.', }), 'bulk-unpublish': flags.string({ - description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to unpublish the entries", + description: "This flag is set to true by default. It indicates that Contentstack's Bulk Publish APIs will be used to unpublish the entries.", default: 'true', }), 'api-version': flags.string({ - description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", + description: 'API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].', }), 'content-type': flags.string({ - description: 'Content type filter', + description: 'The UID of the content type whose entries you want to unpublish in bulk.', }), 'delivery-token': flags.string({ - description: 'Delivery token for source environment', + description: 'The delivery token of the source environment.', }), }; diff --git a/packages/contentstack-bulk-publish/src/commands/cm/entries/update-and-publish.js b/packages/contentstack-bulk-publish/src/commands/cm/entries/update-and-publish.js index 8c08408ad2..a4e0690e17 100644 --- a/packages/contentstack-bulk-publish/src/commands/cm/entries/update-and-publish.js +++ b/packages/contentstack-bulk-publish/src/commands/cm/entries/update-and-publish.js @@ -117,67 +117,74 @@ But, if retry-failed flag is set, then only a logfile is required `; UpdateAndPublishCommand.flags = { - alias: flags.string({ char: 'a', description: 'Alias(name) for the management token' }), + alias: flags.string({ + char: 'a', + description: 'Alias (name) of the management token. You must use either the --alias flag or the --stack-api-key flag.', + }), 'stack-api-key': flags.string({ char: 'k', - description: 'Stack api key to be used', + description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.', }), 'retry-failed': flags.string({ - description: 'Retry publishing failed entries from the logfile (optional, overrides all other flags)', + description: 'Use this option to retry publishing the failed entries 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.', }), 'bulk-publish': flags.string({ - description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries", + description: "Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by default.", default: 'true', }), 'api-version': flags.string({ - description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", + description: "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", }), 'content-types': flags.string({ - description: 'The Contenttypes from which entries will be published', + description: 'The UID of the content type ID whose entries you want to publish in bulk. In case of multiple content types, specify their IDs separated by spaces.', multiple: true, }), environments: flags.string({ char: 'e', - description: 'Environments where entries will be published', + description: 'The name of the environment on which entries will be published. In case of multiple environments, specify their names separated by spaces.', multiple: true, }), - config: flags.string({ char: 'c', description: 'Path to the config file' }), - yes: flags.boolean({ char: 'y', description: 'Agree to process the command with the current configuration' }), + config: flags.string({ + char: 'c', + description: '(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.', + }), + yes: flags.boolean({ + char: 'y', + description: 'Set it to true to process the command with the current configuration.', + }), locales: flags.string({ char: 'l', - description: 'Locales where entries will be published', + description: 'Locales in which entries will be published, e.g., en-us. In the case of multiple locales, specify the codes separated by spaces.', multiple: true, parse: printFlagDeprecation(['-l'], ['--locales']), }), branch: flags.string({ char: 'B', default: 'main', - description: 'Specify the branch to fetch the content (by default the main branch is selected)', + description: '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 the main branch will be published.', parse: printFlagDeprecation(['-B'], ['--branch']), }), force: flags.boolean({ default: false, - description: 'Update and publish all entries even if no fields have been added', + description: 'Update and publish all entries even if no fields have been added.', }), // To be deprecated retryFailed: flags.string({ char: 'r', - description: 'Retry publishing failed entries from the logfile (optional, overrides all other flags)', + description: 'Retry publishing failed entries from the logfile (optional, overrides all other flags).', hidden: true, parse: printFlagDeprecation(['-r', '--retryFailed'], ['--retry-failed']), }), bulkPublish: flags.string({ char: 'b', - description: - "This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to publish the entries", + description: "This flag is set to true by default. It indicates that contentstack's bulk publish API will be used to publish the entries.", hidden: true, parse: printFlagDeprecation(['-b', '--bulkPublish'], ['--bulk-publish']), }), contentTypes: flags.string({ char: 't', - description: 'The Contenttypes from which entries will be published', + description: 'The Contenttypes from which entries will be published.', multiple: true, parse: printFlagDeprecation(['-t', '--contentTypes'], ['--content-types']), }), diff --git a/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-configure.js b/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-configure.js index 9fe10f5aa6..8ec32697f3 100644 --- a/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-configure.js +++ b/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-configure.js @@ -35,8 +35,8 @@ class ConfigureCommand extends Command { ConfigureCommand.description = `The configure command is used to generate a configuration file for publish scripts.`; ConfigureCommand.flags = { - alias: flags.string({ char: 'a', description: 'Alias(name) for the management token' }), - 'stack-api-key': flags.string({ char: 'k', description: 'Stack api key to be used' }), + alias: flags.string({ char: 'a', description: 'Name (alias) of the management token you want to use. You must use either the --alias flag or the --stack-api-key flag.' }), + 'stack-api-key': flags.string({ char: 'k', description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.' }), }; ConfigureCommand.examples = [ diff --git a/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-revert.js b/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-revert.js index ce1a95d372..d7d6bb2f60 100644 --- a/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-revert.js +++ b/packages/contentstack-bulk-publish/src/commands/cm/stacks/publish-revert.js @@ -71,19 +71,19 @@ A log file name is required to execute revert command `; RevertCommand.flags = { - 'retry-failed': flags.string({ description: 'retry publishing failed entries from the logfile' }), - 'log-file': flags.string({ description: 'logfile to be used to revert' }), + 'retry-failed': flags.string({ description: '(optional) Use this option to retry publishing the failed entries 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.' }), + 'log-file': flags.string({ description: 'Path of the success logfile of a particular publish action.' }), //To be deprecated retryFailed: flags.string({ char: 'r', - description: 'retry publishing failed entries from the logfile', + description: '(optional) Use this option to retry publishing the failed entries 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.', hidden: true, parse: printFlagDeprecation(['-r', '--retryFailed'], ['--retry-failed']), }), logFile: flags.string({ char: 'l', - description: 'logfile to be used to revert', + description: 'Path of the success logfile of a particular publish action.', hidden: true, parse: printFlagDeprecation(['-l', '--logFile'], ['--log-file']), }), diff --git a/packages/contentstack-bulk-publish/src/commands/cm/stacks/unpublish.js b/packages/contentstack-bulk-publish/src/commands/cm/stacks/unpublish.js index 57a6206a08..d911e5222f 100644 --- a/packages/contentstack-bulk-publish/src/commands/cm/stacks/unpublish.js +++ b/packages/contentstack-bulk-publish/src/commands/cm/stacks/unpublish.js @@ -203,13 +203,13 @@ UnpublishCommand.flags = { default: 'true', }), 'api-version': flags.string({ - description : "API Version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", + description : "API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2].", }), 'content-type': flags.string({ description: 'Content type filter', }), 'delivery-token': flags.string({ - description: 'Delivery token for source environment', + description: 'The delivery token of the source environment.', }), 'only-assets': flags.boolean({ description: 'Unpublish only assets', diff --git a/packages/contentstack-clone/src/commands/cm/stacks/clone.js b/packages/contentstack-clone/src/commands/cm/stacks/clone.js index d8f3107fb9..cb91f80e1d 100644 --- a/packages/contentstack-clone/src/commands/cm/stacks/clone.js +++ b/packages/contentstack-clone/src/commands/cm/stacks/clone.js @@ -211,26 +211,26 @@ StackCloneCommand.flags = { 'source-management-token-alias': flags.string({ required: false, multiple: false, - description: 'Source API key of the target stack token alias.', + description: 'Source management token alias.', }), 'destination-management-token-alias': flags.string({ required: false, multiple: false, - description: 'Source API key of the target stack token alias.', + description: 'Destination management token alias.', }), 'stack-name': flags.string({ char: 'n', required: false, multiple: false, - description: 'Name for the new stack to store the cloned content.', + description: 'Provide a name for the new stack to store the cloned content.', }), type: flags.string({ required: false, multiple: false, options: ['a', 'b'], - description: `Type of data to clone -a) Structure (all modules except entries & assets) -b) Structure with content (all modules including entries & assets) + description: ` Type of data to clone. You can select option a or b. +a) Structure (all modules except entries & assets). +b) Structure with content (all modules including entries & assets). `, }), 'source-stack-api-key': flags.string({ @@ -240,7 +240,7 @@ b) Structure with content (all modules including entries & assets) description: 'Destination stack API Key', }), 'import-webhook-status': flags.string({ - description: '[Optional] Webhook state', + description: '[Optional] The status of the import webhook. ', options: ['disable', 'current'], required: false, default: 'disable', @@ -248,10 +248,10 @@ b) Structure with content (all modules including entries & assets) yes: flags.boolean({ char: 'y', required: false, - description: '[Optional] Override marketplace prompts', + description: 'Force override all Marketplace prompts.', }), 'skip-audit': flags.boolean({ - description: 'Skips the audit fix.', + description: ' (optional) Skips the audit fix that occurs during an import operation.', }), config: flags.string({ char: 'c', diff --git a/packages/contentstack-config/src/commands/config/remove/base-branch.ts b/packages/contentstack-config/src/commands/config/remove/base-branch.ts index 466925d90a..9386b9f064 100644 --- a/packages/contentstack-config/src/commands/config/remove/base-branch.ts +++ b/packages/contentstack-config/src/commands/config/remove/base-branch.ts @@ -5,8 +5,8 @@ import { interactive } from '../../../utils'; export default class RemoveBranchConfigCommand extends Command { static description = 'Remove branch config for CLI'; static flags: FlagInput = { - 'stack-api-key': flags.string({ char: 'k', description: 'Stack API Key' }), - yes: flags.boolean({ char: 'y', description: 'Force Remove' }), + 'stack-api-key': flags.string({ char: 'k', description: 'Stack API key.' }), + yes: flags.boolean({ char: 'y', description: 'Force remove.' }), }; static examples = ['$ csdx config:remove:base-branch', '$ csdx config:remove:base-branch --stack-api-key ']; diff --git a/packages/contentstack-config/src/commands/config/remove/early-access-header.ts b/packages/contentstack-config/src/commands/config/remove/early-access-header.ts index 6cabb33dd3..60110e1272 100644 --- a/packages/contentstack-config/src/commands/config/remove/early-access-header.ts +++ b/packages/contentstack-config/src/commands/config/remove/early-access-header.ts @@ -6,8 +6,8 @@ export default class RemoveEarlyAccessHeader extends Command { static description = 'Remove Early Access header'; static aliases: string[] = ['config:remove:ea-header']; static flags: FlagInput = { - 'header-alias': flags.string({ description: 'Early access header alias' }), - yes: flags.boolean({ char: 'y', description: 'Force Remove' }), + 'header-alias': flags.string({ description: '(optional) Provide the Early Access header alias name.' }), + yes: flags.boolean({ char: 'y', description: '(optional) Force the removal of Early Access header configuration by skipping the confirmation.' }), }; static examples: string[] = [ '$ <%= config.bin %> <%= command.id %>', diff --git a/packages/contentstack-config/src/commands/config/set/base-branch.ts b/packages/contentstack-config/src/commands/config/set/base-branch.ts index 90ec72d806..ed770aa546 100644 --- a/packages/contentstack-config/src/commands/config/set/base-branch.ts +++ b/packages/contentstack-config/src/commands/config/set/base-branch.ts @@ -5,8 +5,8 @@ import { interactive } from '../../../utils'; export default class BranchSetCommand extends Command { static description = 'Set branch for CLI'; static flags: FlagInput = { - 'stack-api-key': flags.string({ char: 'k', description: 'Stack API Key' }), - 'base-branch': flags.string({ description: 'Base Branch' }), + 'stack-api-key': flags.string({ char: 'k', description: 'Stack API key' }), + 'base-branch': flags.string({ description: 'Base branch (Target branch).' }), }; static examples = [ '$ csdx config:set:base-branch', diff --git a/packages/contentstack-config/src/commands/config/set/early-access-header.ts b/packages/contentstack-config/src/commands/config/set/early-access-header.ts index 8cb814e234..f6e4ac1c27 100644 --- a/packages/contentstack-config/src/commands/config/set/early-access-header.ts +++ b/packages/contentstack-config/src/commands/config/set/early-access-header.ts @@ -6,8 +6,8 @@ export default class SetEarlyAccessHeaderCommand extends Command { static description = 'Set Early Access header'; static aliases: string[] = ['config:set:ea-header']; static flags: FlagInput = { - 'header-alias': flags.string({ description: 'Early access header alias' }), - header: flags.string({ description: 'Early access header value' }), + 'header-alias': flags.string({ description: '(optional) Provide the Early Access header value.' }), + header: flags.string({ description: '(optional) Provide the Early Access header alias name.' }), }; static examples: string[] = [ '$ <%= config.bin %> <%= command.id %>', diff --git a/packages/contentstack-config/src/commands/config/set/region.ts b/packages/contentstack-config/src/commands/config/set/region.ts index 669727a430..3e2ae47684 100644 --- a/packages/contentstack-config/src/commands/config/set/region.ts +++ b/packages/contentstack-config/src/commands/config/set/region.ts @@ -56,11 +56,11 @@ export default class RegionSetCommand extends BaseCommand --cda --ui-host --name "India"', - '$ csdx config:set:region --cma --cda --ui-host --name "India" --developer-hub ', - '$ csdx config:set:region --cma --cda --ui-host --name "India" --personalize ', - '$ csdx config:set:region --cma --cda --ui-host --name "India" --launch ', - '$ csdx config:set:region --cda --cma --ui-host --name "India" --developer-hub --personalize --launch ', + '$ csdx config:set:region --cma --cda --ui-host --name "India"', + '$ csdx config:set:region --cma --cda --ui-host --name "India" --developer-hub ', + '$ csdx config:set:region --cma --cda --ui-host --name "India" --personalize ', + '$ csdx config:set:region --cma --cda --ui-host --name "India" --launch ', + '$ csdx config:set:region --cda --cma --ui-host --name "India" --developer-hub --launch --personalize ', ]; static args: ArgInput = { diff --git a/packages/contentstack-export-to-csv/src/commands/cm/export-to-csv.js b/packages/contentstack-export-to-csv/src/commands/cm/export-to-csv.js index 332301b3ab..255aafa166 100644 --- a/packages/contentstack-export-to-csv/src/commands/cm/export-to-csv.js +++ b/packages/contentstack-export-to-csv/src/commands/cm/export-to-csv.js @@ -17,60 +17,60 @@ class ExportToCsvCommand extends Command { required: false, multiple: false, options: ['entries', 'users', 'teams', 'taxonomies'], - description: `Option to export data (entries, users, teams, taxonomies)`, + description: 'Option to export data (entries, users, teams, taxonomies). [options: entries|users|teams|taxonomies]', }), alias: flags.string({ char: 'a', - description: 'Alias of the management token', + description: 'Alias of the management token.', }), org: flags.string({ multiple: false, required: false, - description: 'Provide organization UID to clone org users', + description: 'Provide organization UID to clone org users.', }), 'stack-name': flags.string({ char: 'n', multiple: false, required: false, - description: 'Name of the stack that needs to be created as csv filename.', + description: 'Name of the stack that needs to be created as CSV filename.', }), 'stack-api-key': flags.string({ char: 'k', multiple: false, required: false, - description: 'API key of the source stack', + description: 'API Key of the source stack.', }), 'org-name': flags.string({ multiple: false, required: false, - description: 'Name of the organization that needs to be created as csv filename.', + description: 'Name of the organization that needs to be created as CSV filename.', }), locale: flags.string({ required: false, multiple: false, - description: 'Locale for which entries need to be exported', + description: 'Locale of entries that will be exported.', }), 'content-type': flags.string({ - description: 'Content type for which entries needs to be exported', + description: 'Content type of entries that will be exported.', required: false, multiple: false, }), branch: flags.string({ - description: 'Branch from which entries need to be exported', + description: 'Branch from which entries will be exported.', multiple: false, required: false, }), - "team-uid": flags.string({ - description: 'Uid of the team whose user data and stack roles are required' + 'team-uid': flags.string({ + description: 'Provide the UID of a specific team in an organization.', }), 'taxonomy-uid': flags.string({ - description: 'Provide the taxonomy UID of the related terms you want to export', + description: 'Provide the taxonomy UID of the related terms you want to export.', }), delimiter: flags.string({ - description: '[optional] Provide a delimiter to separate individual data fields within the CSV file.', + description: '[default: ,] [optional] Provide a delimiter to separate individual data fields within the CSV file. For example: cm:export-to-csv --delimiter \'|\'', default: ',', }), - }; + }; async run() { try { diff --git a/packages/contentstack-export/src/commands/cm/stacks/export.ts b/packages/contentstack-export/src/commands/cm/stacks/export.ts index 79568c00bf..280c1fc527 100644 --- a/packages/contentstack-export/src/commands/cm/stacks/export.ts +++ b/packages/contentstack-export/src/commands/cm/stacks/export.ts @@ -33,7 +33,7 @@ export default class ExportCommand extends Command { static flags: FlagInput = { config: flags.string({ char: 'c', - description: '[optional] path of the config', + description: '[optional] Path of the config', }), 'stack-uid': flags.string({ char: 's', @@ -43,7 +43,7 @@ export default class ExportCommand extends Command { }), 'stack-api-key': flags.string({ char: 'k', - description: 'API key of the source stack', + description: 'API Key of the source stack', }), data: flags.string({ description: 'path or location to store the data', @@ -52,11 +52,11 @@ export default class ExportCommand extends Command { }), 'data-dir': flags.string({ char: 'd', - description: 'path or location to store the data', + description: 'The path or the location in your file system to store the exported content. For e.g., ./content', }), alias: flags.string({ char: 'a', - description: 'alias of the management token', + description: 'The management token alias of the source stack from which you will export content.', }), 'management-token-alias': flags.string({ description: 'alias of the management token', @@ -71,28 +71,28 @@ export default class ExportCommand extends Command { }), module: flags.string({ char: 'm', - description: '[optional] specific module name', + description: '[optional] Specific module name. If not specified, the export command will export all the modules to the stack. The available modules are assets, content-types, entries, environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, and taxonomies.', parse: printFlagDeprecation(['-m'], ['--module']), }), 'content-types': flags.string({ char: 't', - description: '[optional] content type', + description: '[optional] The UID of the content type(s) whose content you want to export. In case of multiple content types, specify the IDs separated by spaces.', multiple: true, parse: printFlagDeprecation(['-t'], ['--content-types']), }), branch: flags.string({ char: 'B', // default: 'main', - description: '[optional] branch name', + description: '[optional] The name of the branch where you want to export your content. If you don\'t mention the branch name, then by default the content will be exported from all the branches of your stack.', parse: printFlagDeprecation(['-B'], ['--branch']), }), 'secured-assets': flags.boolean({ - description: '[optional] use when assets are secured', + description: '[optional] Use this flag for assets that are secured.', }), yes: flags.boolean({ char: 'y', required: false, - description: '[optional] Override marketplace apps related prompts', + description: '[optional] Force override all Marketplace prompts.', }), }; diff --git a/packages/contentstack-import/src/commands/cm/stacks/import.ts b/packages/contentstack-import/src/commands/cm/stacks/import.ts index 19b20877f8..925c868996 100644 --- a/packages/contentstack-import/src/commands/cm/stacks/import.ts +++ b/packages/contentstack-import/src/commands/cm/stacks/import.ts @@ -31,11 +31,11 @@ export default class ImportCommand extends Command { static flags: FlagInput = { config: flags.string({ char: 'c', - description: '[optional] path of config file', + description: '[optional] Path of config file.', }), 'stack-uid': flags.string({ char: 's', - description: 'API key of the target stack', + description: 'API key of the target stack.', hidden: true, parse: printFlagDeprecation(['-s', '--stack-uid'], ['-k', '--stack-api-key']), }), @@ -50,11 +50,11 @@ export default class ImportCommand extends Command { }), 'data-dir': flags.string({ char: 'd', - description: 'path and location where data is stored', + description: `The path or the location in your file system where the content, you intend to import, is stored. For example, -d "C:\\Users\\Name\\Desktop\\cli\\content". If the export folder has branches involved, then the path should point till the particular branch. For example, “-d "C:\\Users\\Name\\Desktop\\cli\\content\\branch_name"`, }), alias: flags.string({ char: 'a', - description: 'alias of the management token', + description: 'The management token of the destination stack where you will import the content.', }), 'management-token-alias': flags.string({ description: 'alias of the management token', @@ -70,21 +70,21 @@ export default class ImportCommand extends Command { module: flags.string({ required: false, char: 'm', - description: '[optional] specific module name', + description: '[optional] Specify the module to import into the target stack. If not specified, the import command will import all the modules into the stack. The available modules are assets, content-types, entries, environments, extensions, marketplace-apps, global-fields, labels, locales, webhooks, workflows, custom-roles, and taxonomies.', parse: printFlagDeprecation(['-m'], ['--module']), }), 'backup-dir': flags.string({ char: 'b', - description: '[optional] backup directory name when using specific module', + description: '[optional] Backup directory name when using specific module.', parse: printFlagDeprecation(['-b'], ['--backup-dir']), }), branch: flags.string({ char: 'B', - description: '[optional] branch name', + description: 'The name of the branch where you want to import your content. If you don\'t mention the branch name, then by default the content will be imported to the main branch.', parse: printFlagDeprecation(['-B'], ['--branch']), }), 'import-webhook-status': flags.string({ - description: '[optional] Webhook state', + description: '[optional] This webhook state keeps the same state of webhooks as the source stack.', options: ['disable', 'current'], required: false, default: 'disable', @@ -92,7 +92,7 @@ export default class ImportCommand extends Command { yes: flags.boolean({ char: 'y', required: false, - description: '[optional] Override marketplace prompts', + description: '[optional] Force override all Marketplace prompts.', }), 'skip-app-recreation': flags.boolean({ description: '[optional] Skip private apps recreation if already exist', @@ -111,10 +111,10 @@ export default class ImportCommand extends Command { description: 'Personalize project name.', }), 'skip-audit': flags.boolean({ - description: 'Skips the audit fix.', + description: 'Skips the audit fix that occurs during an import operation.', }), 'exclude-global-modules': flags.boolean({ - description: 'Excludes the branch-independent module from the import operation', + description: 'Excludes the branch-independent module from the import operation.', default: false, }), }; diff --git a/packages/contentstack-launch/src/commands/launch/index.ts b/packages/contentstack-launch/src/commands/launch/index.ts index bc6114930d..8041461e12 100755 --- a/packages/contentstack-launch/src/commands/launch/index.ts +++ b/packages/contentstack-launch/src/commands/launch/index.ts @@ -26,54 +26,53 @@ export default class Launch extends BaseCommand { static flags: FlagInput = { type: Flags.string({ options: [...config.supportedAdapters, 'FileUpload'], - description: '[Optional] Choose the type of adapters', + description: '[optional] Type of adapters. ', }), framework: Flags.string({ options: map(config.listOfFrameWorks, 'name'), - description: '[Optional] Type of framework', + description: '[optional] Type of framework. ', }), org: Flags.string({ - description: '[Optional] Provide the organization UID to create a new project or deployment', + description: '[optional] Provide the organization UID to create a new project or deployment.', }), name: Flags.string({ char: 'n', - description: '[Optional] Name of the project', + description: '[optional] Name of the project.', }), environment: Flags.string({ char: 'e', - description: '[Optional] Environment name for the Launch project', + description: '[optional] Environment name for the Launch project.', }), branch: Flags.string({ - description: '[Optional] GitHub branch name', + description: '[optional] GitHub branch name.', }), 'build-command': Flags.string({ - description: '[Optional] Build Command', + description: '[optional] Build Command.', }), 'out-dir': Flags.string({ - description: '[Optional] Output Directory', + description: '[optional] Output Directory.', }), 'variable-type': Flags.string({ options: [...config.variablePreparationTypeOptions], - description: '[Optional] Provide a variable type.', + description: '[optional] Provide a variable type. ', }), 'show-variables': Flags.boolean({ hidden: true, default: false, - description: '[Optional, Hidden] Show variable values on the UI', + description: '[optional, Hidden] Show variable values on the UI.', }), init: Flags.boolean({ hidden: true, - description: '[Optional, Hidden] Reinitialize the project if it is an existing launch project.', + description: '[optional, Hidden] Reinitialize the project if it is an existing Launch project.', }), alias: Flags.string({ char: 'a', - description: '[Optional] Alias(name) for the delivery token', + description: '[optional] Alias (name) for the delivery token.', }), 'env-variables': Flags.string({ - description: - '[Optional] Provide the environment variables in the key:value format, separated by comma Ex:APP_ENV:prod, TEST_ENV:testVal', + description: '[optional] Provide the environment variables in the key:value format, separated by comma. For example: APP_ENV:prod, TEST_ENV:testVal.', }), - }; + }; async run(): Promise { if (!this.flags.init) { diff --git a/packages/contentstack-migrate-rte/src/commands/cm/entries/migrate-html-rte.js b/packages/contentstack-migrate-rte/src/commands/cm/entries/migrate-html-rte.js index b61b69963c..5a04309a1b 100644 --- a/packages/contentstack-migrate-rte/src/commands/cm/entries/migrate-html-rte.js +++ b/packages/contentstack-migrate-rte/src/commands/cm/entries/migrate-html-rte.js @@ -66,58 +66,62 @@ JsonMigrationCommand.description = 'Migration script to migrate content from HTM JsonMigrationCommand.flags = { 'config-path': flags.string({ char: 'c', - description: 'Path to config file', + description: 'Specify the path where your config file is located.', required: false, }), alias: flags.string({ char: 'a', - description: 'Alias(name) for the management token', + description: 'Enter the alias name. You must use either the --alias flag or the --stack-api-key flag.', required: false, }), 'stack-api-key': flags.string({ - description: 'Stack api key to be used', + description: 'API key of the source stack. You must use either the --stack-api-key flag or the --alias flag.', required: false, }), 'content-type': flags.string({ - description: 'The content type from which entries will be migrated', + description: 'Specify the UID of the content type for which you want to migrate HTML RTE content.', required: false, }), 'global-field': flags.boolean({ - description: 'This flag is set to false by default. It indicates that current content type is a globalfield', + description: 'Checks whether the specified UID belongs to a content type or a global field. This flag is set to false by default.', default: false, required: false, }), yes: flags.boolean({ char: 'y', - description: 'Agree to process the command with the current configuration', + description: 'Avoids reconfirmation of your configuration.', default: false, required: false, }), branch: flags.string({ - description: '[optional] branch name', + description: 'The name of the branch to be used.', + required: false, }), 'html-path': flags.string({ - description: 'Provide path of HTML RTE to migrate', + description: 'Enter the path to the HTML RTE whose content you want to migrate.', dependsOn: ['json-path'], required: false, }), 'json-path': flags.string({ - description: 'Provide path of JSON RTE to migrate', + description: 'Enter the path to the JSON RTE to which you want to migrate the HTML RTE content.', dependsOn: ['html-path'], required: false, }), delay: flags.integer({ - description: 'Provide delay in ms between two entry update', + description: 'To set the interval time between the migration of HTML RTE to JSON RTE in subsequent entries of a content type. The default value is 1,000 milliseconds.', default: 1000, required: false, }), locale: flags.string({ - description: 'The locale from which entries will be migrated', + description: 'The locale from which entries will be migrated.', required: false, }), - 'batch-limit': flags.integer({ description: 'Provide batch limit for updating entries', default: 50 }), + 'batch-limit': flags.integer({ + description: 'Provide batch limit for updating entries (default: 50).', + default: 50, + }), - //To be deprecated + // To be deprecated configPath: flags.string({ char: 'p', description: 'Path to the config file', @@ -131,19 +135,19 @@ JsonMigrationCommand.flags = { }), isGlobalField: flags.boolean({ char: 'g', - description: 'This flag is set to false by default. It indicates that current content-type is global-field', + description: 'Indicates that the current content type is a global field (default: false)', hidden: true, parse: printFlagDeprecation(['-g', '--isGlobalField'], ['--global-field']), }), htmlPath: flags.string({ char: 'h', - description: 'Provide path of HTML RTE to migrate', + description: 'Provide the path of HTML RTE to migrate', hidden: true, parse: printFlagDeprecation(['-h', '--htmlPath'], ['--html-path']), }), jsonPath: flags.string({ char: 'j', - description: 'Provide path of JSON RTE to migrate', + description: 'Provide the path of JSON RTE to migrate', hidden: true, parse: printFlagDeprecation(['-j', '--jsonPath'], ['--json-path']), }), diff --git a/packages/contentstack-migration/src/commands/cm/stacks/migration.js b/packages/contentstack-migration/src/commands/cm/stacks/migration.js index 238ea8eb74..6f308a0123 100644 --- a/packages/contentstack-migration/src/commands/cm/stacks/migration.js +++ b/packages/contentstack-migration/src/commands/cm/stacks/migration.js @@ -246,33 +246,33 @@ MigrationCommand.description = 'Contentstack migration script.'; MigrationCommand.flags = { 'stack-api-key': flags.string({ char: 'k', - description: 'With this flag add the API key of your stack.', + description: 'Use this flag to add the API key of your stack. You must use either the --stack-api-key flag or the --alias flag.', exclusive: ['alias'], }), alias: flags.string({ char: 'a', - description: 'Use this flag to add the management token alias.', + description: 'Use this flag to add the management token alias. You must use either the --alias flag or the --stack-api-key flag.', }), 'file-path': flags.string({ - description: 'Use this flag to provide the path of the file of the migration script provided by the user.', + description: 'Use this flag to provide the path of the file of the migration script.', }), branch: flags.string({ char: 'B', - description: 'Use this flag to add the branch name where you want to perform the migration.', + description: 'Use this flag to add the branch name where you want to perform the migration. (target branch name)', parse: printFlagDeprecation(['-B'], ['--branch']), }), 'config-file': flags.string({ - description: '[optional] Path of the JSON configuration file', + description: '[optional] Path of the JSON configuration file.', }), config: flags.string({ - description: '[optional] inline configuration, :', + description: '[optional] Inline configuration, :. Passing an external configuration makes the script re-usable.', multiple: true, }), multiple: flags.boolean({ - description: 'This flag helps you to migrate multiple content files in a single instance.', + description: 'This flag helps you to migrate multiple content files in a single instance. Mention the folder path where your migration script files are stored.', }), - //To be deprecated + // To be deprecated 'api-key': flags.string({ char: 'k', description: 'With this flag add the API key of your stack.', @@ -283,15 +283,14 @@ MigrationCommand.flags = { }), authtoken: flags.boolean({ char: 'A', - description: - 'Use this flag to use the auth token of the current session. After logging in CLI, an auth token is generated for each new session.', + description: 'Use this flag to use the auth token of the current session. After logging in CLI, an auth token is generated for each new session.', dependsOn: ['api-key'], exclusive: ['alias'], parse: printFlagDeprecation(['-A', '--authtoken']), hidden: true, }), 'management-token-alias': flags.string({ - description: 'alias of the management token', + description: 'Alias of the management token.', exclusive: ['authtoken'], hidden: true, parse: printFlagDeprecation(['--management-token-alias'], ['-a', '--alias']), From fda2b45f1c688f694486fa68d4beeb8309b9530d Mon Sep 17 00:00:00 2001 From: "harshitha.d" Date: Wed, 30 Oct 2024 17:41:26 +0530 Subject: [PATCH 2/3] updated readme for few packages --- packages/contentstack-audit/README.md | 14 +- packages/contentstack-auth/README.md | 14 +- packages/contentstack-bulk-publish/README.md | 559 +++++++++++-------- packages/contentstack-config/README.md | 36 +- packages/contentstack-migrate-rte/README.md | 56 +- packages/contentstack-migration/README.md | 40 +- 6 files changed, 425 insertions(+), 294 deletions(-) diff --git a/packages/contentstack-audit/README.md b/packages/contentstack-audit/README.md index ca2a518bf6..4a256efa79 100644 --- a/packages/contentstack-audit/README.md +++ b/packages/contentstack-audit/README.md @@ -269,7 +269,7 @@ EXAMPLES $ csdx plugins ``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/index.ts)_ +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/index.ts)_ ## `csdx plugins:add PLUGIN` @@ -343,7 +343,7 @@ EXAMPLES $ csdx plugins:inspect myplugin ``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/inspect.ts)_ +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/inspect.ts)_ ## `csdx plugins:install PLUGIN` @@ -392,7 +392,7 @@ EXAMPLES $ csdx plugins:install someuser/someplugin ``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/install.ts)_ +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/install.ts)_ ## `csdx plugins:link PATH` @@ -423,7 +423,7 @@ EXAMPLES $ csdx plugins:link myplugin ``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/link.ts)_ +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/link.ts)_ ## `csdx plugins:remove [PLUGIN]` @@ -464,7 +464,7 @@ FLAGS --reinstall Reinstall all plugins after uninstalling. ``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/reset.ts)_ +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/reset.ts)_ ## `csdx plugins:uninstall [PLUGIN]` @@ -492,7 +492,7 @@ EXAMPLES $ csdx plugins:uninstall myplugin ``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/uninstall.ts)_ +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/uninstall.ts)_ ## `csdx plugins:unlink [PLUGIN]` @@ -536,5 +536,5 @@ DESCRIPTION Update installed plugins. ``` -_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.14/src/commands/plugins/update.ts)_ +_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.15/src/commands/plugins/update.ts)_ diff --git a/packages/contentstack-auth/README.md b/packages/contentstack-auth/README.md index 97600ae039..9dd85b7b54 100644 --- a/packages/contentstack-auth/README.md +++ b/packages/contentstack-auth/README.md @@ -49,8 +49,8 @@ USAGE $ csdx auth:login [-u | --oauth] [-p | ] FLAGS - -p, --password= Password - -u, --username= User name + -p, --password= Password of your Contentstack app + -u, --username= Email address of your Contentstack account. --oauth Enables single sign-on (SSO) in Contentstack CLI DESCRIPTION @@ -141,7 +141,7 @@ USAGE $ csdx auth:tokens:add [-a ] [--delivery] [--management] [-e ] [-k ] [-y] [--token ] FLAGS - -a, --alias= Name of the token alias + -a, --alias= Alias (name) you want to assign to the token -d, --delivery Set this flag to save delivery token -e, --environment= Environment name for delivery token -k, --stack-api-key= Stack API Key @@ -187,8 +187,8 @@ USAGE $ csdx auth:tokens:remove [-a ] [-i] FLAGS - -a, --alias= Token alias - -i, --ignore Ignore + -a, --alias= Alias (name) of the token to delete. + -i, --ignore Ignores if the token is not present. DESCRIPTION Removes selected tokens @@ -230,8 +230,8 @@ USAGE $ csdx login [-u | --oauth] [-p | ] FLAGS - -p, --password= Password - -u, --username= User name + -p, --password= Password of your Contentstack app + -u, --username= Email address of your Contentstack account. --oauth Enables single sign-on (SSO) in Contentstack CLI DESCRIPTION diff --git a/packages/contentstack-bulk-publish/README.md b/packages/contentstack-bulk-publish/README.md index 2035167a06..42be050662 100644 --- a/packages/contentstack-bulk-publish/README.md +++ b/packages/contentstack-bulk-publish/README.md @@ -65,21 +65,29 @@ USAGE ] [-c ] [-y] [--locales ] [--branch ] [--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 to the config file - -e, --environments=... Environments where assets will be published - -k, --stack-api-key= Stack api key to be used - -l, --locales=... Locales to where assets 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] By default this flag is set as true. It indicates that contentstack's - bulkpublish API will be used to publish the assets - --delivery-token= Delivery token for source environment - --folder-uid= [default: cs_root] Folder-uid from where the assets will be published - --retry-failed= Retry publishing failed assets from the logfile (optional, will override all other - flags) + -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 assets from the + main branch will be published. + -a, --alias= Alias (name) for 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 assets 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. It is true, by + default. + --delivery-token= The delivery token of the source environment. + --folder-uid= (optional) The UID of the Assets’ folder from which the assets need to be published. + The default value is cs_root. + --retry-failed= Use this option to retry publishing the failed 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 @@ -145,19 +153,25 @@ USAGE ] [--retry-failed ] [--bulk-unpublish ] [--api-version ] [--delivery-token ] FLAGS - -a, --alias= Alias(name) for the management token - -c, --config= Path to the config file - -e, --environment= Source Environment - -k, --stack-api-key= Stack api key to be used - -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]. - --branch= [default: main] Specify the branch to fetch the content (by default the main branch is - selected) - --bulk-unpublish= [default: true] By default this flag is set as true. It indicates that contentstack's - bulkpublish API will be used to unpublish the assets - --delivery-token= Delivery Token for source environment - --locale= Locale filter - --retry-failed= Retry unpublishing failed assets from the logfile + -a, --alias= Alias (name) of the management token. You must use either the --alias flag or the + --stack-api-key flag. + -c, --config= (optional) Path of an optional configuration JSON file containing all the options for a + single run. Refer to the configure command to create a configuration file. + -e, --environment= The name of the environment from where entries/assets need to be unpublished. + -k, --stack-api-key= API key of the source stack. You must use either the --stack-api-key flag or the --alias + flag. + -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]. + --branch= [default: main] The name of the branch where you want to perform the bulk unpublish + operation. If you don’t mention the branch name, then by default the content from the + main branch will be unpublished. + --bulk-unpublish= [default: true] Set this flag to use Contentstack’s Bulk Publish APIs. It is true, by + default. + --delivery-token= The delivery token of the source environment. + --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 this option is + used, it will override all other flags. DESCRIPTION Unpublish assets from given environment @@ -226,21 +240,30 @@ USAGE ] [-t ] [-e ] [-c ] [-y] [--locales ] [--branch ] 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 to the config file - -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 - -t, --contentTypes=... The Contenttypes from which 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 will be published - --force Update and publish all entries even if no fields have been added - --retry-failed= Retry publishing failed entries from the logfile (optional, overrides all other flags) + -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 the + 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. + -t, --contentTypes=... The Contenttypes from which entries will be published. + -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. It is true, by + default. + --content-types=... The UID of the content type ID whose entries you want to publish in bulk. In case of + multiple content types, specify their IDs separated by spaces. + --force Update and publish all entries even if no fields have been added. + --retry-failed= Use this option to retry publishing the failed entries 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. DESCRIPTION Add fields from updated content types to their respective entries @@ -298,21 +321,29 @@ USAGE ] [-c ] [-y] [--locales ] [--branch ] [--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 to the config file - -e, --environments=... Environments where assets will be published - -k, --stack-api-key= Stack api key to be used - -l, --locales=... Locales to where assets 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] By default this flag is set as true. It indicates that contentstack's - bulkpublish API will be used to publish the assets - --delivery-token= Delivery token for source environment - --folder-uid= [default: cs_root] Folder-uid from where the assets will be published - --retry-failed= Retry publishing failed assets from the logfile (optional, will override all other - flags) + -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 assets from the + main branch will be published. + -a, --alias= Alias (name) for 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 assets 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. It is true, by + default. + --delivery-token= The delivery token of the source environment. + --folder-uid= (optional) The UID of the Assets’ folder from which the assets need to be published. + The default value is cs_root. + --retry-failed= Use this option to retry publishing the failed 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 @@ -403,8 +434,10 @@ USAGE $ csdx cm:bulk-publish:configure [-a ] [-k ] FLAGS - -a, --alias= Alias(name) for the management token - -k, --stack-api-key= Stack api key to be used + -a, --alias= Name (alias) of the management token you want to use. You must use either the --alias + flag or the --stack-api-key flag. + -k, --stack-api-key= API key of the source stack. You must use either the --stack-api-key flag or the --alias + flag. DESCRIPTION The configure command is used to generate a configuration file for publish scripts. @@ -439,11 +472,11 @@ FLAGS -c, --config= Path to the config file -k, --stack-api-key= Stack api key to be used -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 + --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. It is true, by + default. --content-type=... The Contenttypes from which entries will be published - --delivery-token= Delivery token for source environment + --delivery-token= The delivery token of the source environment. --environments=... Destination Environments --locales= Source locale --onlyAssets Unpublish only assets @@ -510,24 +543,31 @@ 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 @@ -594,20 +634,29 @@ USAGE ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ] 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 to the config file - -e, --environments=... Destination environments - -k, --stack-api-key= Stack api key to be used - -l, --locales=... Locales where edited 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 which will be checked for edited entries - --retry-failed= Retry publishing failed entries from the logfile (optional, overrides all other flags) - --source-env= Environment from which edited entries will be published + -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 entries 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(s) on which the 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. It is true, by + default. + --content-types=... The UID of the content type(s) whose edited entries you want to publish in bulk. In + case of multiple content types, specify the IDs separated by spaces. + --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= The name of the source environment where the entries were initially published. DESCRIPTION Publish edited entries from a specified content type to the given locales and environments @@ -668,19 +717,27 @@ USAGE [--source-env ] [--content-types ] [-e ] [-c ] [-y] [--branch ] 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 to the config file - -e, --environments=... Destination environments - -k, --stack-api-key= Stack api key to be used - -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 will be published - --retry-failed= Retry publishing failed entries from the logfile - --source-env= Source Environment + -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 the + 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. + -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. It is true, by + default. + --content-types=... The UID of the content type whose entries you want to publish in bulk. In case of + multiple content types, specify their IDs separated by spaces. + --retry-failed= Use this option to retry publishing the failed entries 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= The name of the source environment. DESCRIPTION Publish non-localized fields for the given content types, from a particular source environment to the specified @@ -737,8 +794,10 @@ USAGE $ csdx cm:bulk-publish:revert [--retry-failed ] [--log-file ] FLAGS - --log-file= logfile to be used to revert - --retry-failed= retry publishing failed entries from the logfile + --log-file= Path of the success logfile of a particular publish action. + --retry-failed= (optional) Use this option to retry publishing the failed entries 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. DESCRIPTION Revert publish operations by using a log file @@ -779,11 +838,11 @@ FLAGS -k, --stack-api-key= Stack api key to be used -l, --locale= Locale filter -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]. + --api-version= API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]. --bulk-unpublish= [default: true] This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to unpublish the entries and assets --content-type= Content type filter - --delivery-token= Delivery token for source environment + --delivery-token= The delivery token of the source environment. --retry-failed= Retry publishing failed entries from the logfile (optional, overrides all other flags) DESCRIPTION @@ -869,20 +928,28 @@ USAGE ] 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 - -b, --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 - -c, --config= Path to the config file - -e, --environments=... Destination environments - -k, --stack-api-key= Stack api key to be used - -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]. - --content-types=... The Contenttypes from which entries will be published - --locales= Source locale - --retry-failed= Retry publishing failed entries from the logfile - --source-env= Source Env + -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 entries 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. + -b, --bulk-publish= [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by + default. + -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. + -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].. + --content-types=... The UID of the content type(s) whose entries you want to publish in bulk. In case of + multiple content types, specify their IDs separated by spaces. + --locales= Locale in which entries will be published, e.g., en-us + --retry-failed= (optional) Use this option to retry publishing the failed entries from the logfile. It + is optional. Specify the name of the logfile that lists failed publish calls. If this + option is used, it will override all other flags. + --source-env= The name of the source environment where the entries were initially published. DESCRIPTION Publish unpublished entries from the source environment, to other environments and locales @@ -942,24 +1009,31 @@ 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 @@ -1028,20 +1102,29 @@ USAGE ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ] 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 to the config file - -e, --environments=... Destination environments - -k, --stack-api-key= Stack api key to be used - -l, --locales=... Locales where edited 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 which will be checked for edited entries - --retry-failed= Retry publishing failed entries from the logfile (optional, overrides all other flags) - --source-env= Environment from which edited entries will be published + -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 entries 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(s) on which the 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. It is true, by + default. + --content-types=... The UID of the content type(s) whose edited entries you want to publish in bulk. In + case of multiple content types, specify the IDs separated by spaces. + --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= The name of the source environment where the entries were initially published. DESCRIPTION Publish edited entries from a specified content type to the given locales and environments @@ -1104,19 +1187,27 @@ USAGE [--source-env ] [--content-types ] [-e ] [-c ] [-y] [--branch ] 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 to the config file - -e, --environments=... Destination environments - -k, --stack-api-key= Stack api key to be used - -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 will be published - --retry-failed= Retry publishing failed entries from the logfile - --source-env= Source Environment + -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 the + 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. + -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. It is true, by + default. + --content-types=... The UID of the content type whose entries you want to publish in bulk. In case of + multiple content types, specify their IDs separated by spaces. + --retry-failed= Use this option to retry publishing the failed entries 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= The name of the source environment. DESCRIPTION Publish non-localized fields for the given content types, from a particular source environment to the specified @@ -1177,20 +1268,28 @@ USAGE ] 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 - -b, --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 - -c, --config= Path to the config file - -e, --environments=... Destination environments - -k, --stack-api-key= Stack api key to be used - -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]. - --content-types=... The Contenttypes from which entries will be published - --locales= Source locale - --retry-failed= Retry publishing failed entries from the logfile - --source-env= Source Env + -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 entries 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. + -b, --bulk-publish= [default: true] Set this flag to use Contentstack's Bulk Publish APIs. It is true, by + default. + -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. + -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].. + --content-types=... The UID of the content type(s) whose entries you want to publish in bulk. In case of + multiple content types, specify their IDs separated by spaces. + --locales= Locale in which entries will be published, e.g., en-us + --retry-failed= (optional) Use this option to retry publishing the failed entries from the logfile. It + is optional. Specify the name of the logfile that lists failed publish calls. If this + option is used, it will override all other flags. + --source-env= The name of the source environment where the entries were initially published. DESCRIPTION Publish unpublished entries from the source environment, to other environments and locales @@ -1252,20 +1351,25 @@ USAGE [--delivery-token ] FLAGS - -a, --alias= Alias(name) for the management token - -c, --config= Path to the config file - -e, --environment= Source Environment - -k, --stack-api-key= Stack api key to be used - -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]. - --branch= [default: main] Specify the branch to fetch the content (by default the main branch is - selected) - --bulk-unpublish= [default: true] This flag is set to true by default. It indicates that contentstack's - bulkpublish API will be used to unpublish the entries - --content-type= Content type filter - --delivery-token= Delivery token for source environment - --locale= Locale filter - --retry-failed= Retry publishing failed entries from the logfile + -a, --alias= Alias (name) for the management token. You must use either the --alias flag or the + --stack-api-key flag. + -c, --config= (optional) Path to the configuration JSON file containing all options for a single run. + Refer to the configure command to create a configuration file. + -e, --environment= The name of the environment from where entries/assets need to be unpublished. + -k, --stack-api-key= API key of the source stack. You must use either the --stack-api-key flag or the --alias + flag. + -y, --yes Set 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]. + --branch= [default: main] Specify the branch to fetch the content. If not mentioned, the main + branch will be used by default. + --bulk-unpublish= [default: true] This flag is set to true by default. It indicates that Contentstack's + 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. + --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 + will override all other flags. DESCRIPTION Unpublish entries from the given environment @@ -1320,21 +1424,30 @@ USAGE ] [-t ] [-e ] [-c ] [-y] [--locales ] [--branch ] 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 to the config file - -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 - -t, --contentTypes=... The Contenttypes from which 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 will be published - --force Update and publish all entries even if no fields have been added - --retry-failed= Retry publishing failed entries from the logfile (optional, overrides all other flags) + -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 the + 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. + -t, --contentTypes=... The Contenttypes from which entries will be published. + -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. It is true, by + default. + --content-types=... The UID of the content type ID whose entries you want to publish in bulk. In case of + multiple content types, specify their IDs separated by spaces. + --force Update and publish all entries even if no fields have been added. + --retry-failed= Use this option to retry publishing the failed entries 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. DESCRIPTION Add fields from updated content types to their respective entries @@ -1475,8 +1588,10 @@ USAGE $ csdx cm:stacks:publish-configure [-a ] [-k ] FLAGS - -a, --alias= Alias(name) for the management token - -k, --stack-api-key= Stack api key to be used + -a, --alias= Name (alias) of the management token you want to use. You must use either the --alias + flag or the --stack-api-key flag. + -k, --stack-api-key= API key of the source stack. You must use either the --stack-api-key flag or the --alias + flag. DESCRIPTION The configure command is used to generate a configuration file for publish scripts. @@ -1505,8 +1620,10 @@ USAGE $ csdx cm:stacks:publish-revert [--retry-failed ] [--log-file ] FLAGS - --log-file= logfile to be used to revert - --retry-failed= retry publishing failed entries from the logfile + --log-file= Path of the success logfile of a particular publish action. + --retry-failed= (optional) Use this option to retry publishing the failed entries 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. DESCRIPTION Revert publish operations by using a log file @@ -1549,11 +1666,11 @@ FLAGS -k, --stack-api-key= Stack api key to be used -l, --locale= Locale filter -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]. + --api-version= API version to be used. Values [Default: 3, Nested Reference Publishing: 3.2]. --bulk-unpublish= [default: true] This flag is set to true by default. It indicates that contentstack's bulkpublish API will be used to unpublish the entries and assets --content-type= Content type filter - --delivery-token= Delivery token for source environment + --delivery-token= The delivery token of the source environment. --retry-failed= Retry publishing failed entries from the logfile (optional, overrides all other flags) DESCRIPTION diff --git a/packages/contentstack-config/README.md b/packages/contentstack-config/README.md index e4d0841a5a..2d16285e7a 100644 --- a/packages/contentstack-config/README.md +++ b/packages/contentstack-config/README.md @@ -142,8 +142,8 @@ USAGE $ csdx config:remove:base-branch [-k ] [-y] FLAGS - -k, --stack-api-key= Stack API Key - -y, --yes Force Remove + -k, --stack-api-key= Stack API key. + -y, --yes Force remove. DESCRIPTION Remove branch config for CLI @@ -165,8 +165,9 @@ USAGE $ csdx config:remove:ea-header [--header-alias ] [-y] FLAGS - -y, --yes Force Remove - --header-alias= Early access header alias + -y, --yes (optional) Force the removal of Early Access header configuration by skipping the + confirmation. + --header-alias= (optional) Provide the Early Access header alias name. DESCRIPTION Remove Early Access header @@ -189,8 +190,9 @@ USAGE $ csdx config:remove:early-access-header [--header-alias ] [-y] FLAGS - -y, --yes Force Remove - --header-alias= Early access header alias + -y, --yes (optional) Force the removal of Early Access header configuration by skipping the + confirmation. + --header-alias= (optional) Provide the Early Access header alias name. DESCRIPTION Remove Early Access header @@ -235,8 +237,8 @@ USAGE $ csdx config:set:base-branch [-k ] [--base-branch ] FLAGS - -k, --stack-api-key= Stack API Key - --base-branch= Base Branch + -k, --stack-api-key= Stack API key + --base-branch= Base branch (Target branch). DESCRIPTION Set branch for CLI @@ -258,8 +260,8 @@ USAGE $ csdx config:set:ea-header [--header-alias ] [--header ] FLAGS - --header= Early access header value - --header-alias= Early access header alias + --header= (optional) Provide the Early Access header alias name. + --header-alias= (optional) Provide the Early Access header value. DESCRIPTION Set Early Access header @@ -282,8 +284,8 @@ USAGE $ csdx config:set:early-access-header [--header-alias ] [--header ] FLAGS - --header= Early access header value - --header-alias= Early access header alias + --header= (optional) Provide the Early Access header alias name. + --header-alias= (optional) Provide the Early Access header value. DESCRIPTION Set Early Access header @@ -366,15 +368,15 @@ EXAMPLES $ csdx config:set:region GCP-NA - $ csdx config:set:region --cma --cda --ui-host --name "India" + $ csdx config:set:region --cma --cda --ui-host --name "India" - $ csdx config:set:region --cma --cda --ui-host --name "India" --developer-hub + $ csdx config:set:region --cma --cda --ui-host --name "India" --developer-hub - $ csdx config:set:region --cma --cda --ui-host --name "India" --personalize + $ csdx config:set:region --cma --cda --ui-host --name "India" --personalize - $ csdx config:set:region --cma --cda --ui-host --name "India" --launch + $ csdx config:set:region --cma --cda --ui-host --name "India" --launch - $ csdx config:set:region --cda --cma --ui-host --name "India" --developer-hub --personalize --launch + $ csdx config:set:region --cda --cma --ui-host --name "India" --developer-hub --launch --personalize ``` _See code: [src/commands/config/set/region.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/region.ts)_ diff --git a/packages/contentstack-migrate-rte/README.md b/packages/contentstack-migrate-rte/README.md index 36d4f7dec6..a5edd9f051 100644 --- a/packages/contentstack-migrate-rte/README.md +++ b/packages/contentstack-migrate-rte/README.md @@ -41,19 +41,21 @@ USAGE ] [--batch-limit ] FLAGS - -a, --alias= Alias(name) for the management token - -c, --config-path= Path to config file - -y, --yes Agree to process the command with the current configuration - --batch-limit= [default: 50] Provide batch limit for updating entries - --branch= [optional] branch name - --content-type= The content type from which entries will be migrated - --delay= [default: 1000] Provide delay in ms between two entry update - --global-field This flag is set to false by default. It indicates that current content type is a - globalfield - --html-path= Provide path of HTML RTE to migrate - --json-path= Provide path of JSON RTE to migrate - --locale= The locale from which entries will be migrated - --stack-api-key= Stack api key to be used + -a, --alias= Enter the alias name. You must use either the --alias flag or the --stack-api-key flag. + -c, --config-path= Specify the path where your config file is located. + -y, --yes Avoids reconfirmation of your configuration. + --batch-limit= [default: 50] Provide batch limit for updating entries (default: 50). + --branch= The name of the branch to be used. + --content-type= Specify the UID of the content type for which you want to migrate HTML RTE content. + --delay= [default: 1000] To set the interval time between the migration of HTML RTE to JSON RTE in + subsequent entries of a content type. The default value is 1,000 milliseconds. + --global-field Checks whether the specified UID belongs to a content type or a global field. This flag is + set to false by default. + --html-path= Enter the path to the HTML RTE whose content you want to migrate. + --json-path= Enter the path to the JSON RTE to which you want to migrate the HTML RTE content. + --locale= The locale from which entries will be migrated. + --stack-api-key= API key of the source stack. You must use either the --stack-api-key flag or the --alias + flag. DESCRIPTION Migration script to migrate content from HTML RTE to JSON RTE @@ -102,19 +104,21 @@ USAGE ] [--batch-limit ] FLAGS - -a, --alias= Alias(name) for the management token - -c, --config-path= Path to config file - -y, --yes Agree to process the command with the current configuration - --batch-limit= [default: 50] Provide batch limit for updating entries - --branch= [optional] branch name - --content-type= The content type from which entries will be migrated - --delay= [default: 1000] Provide delay in ms between two entry update - --global-field This flag is set to false by default. It indicates that current content type is a - globalfield - --html-path= Provide path of HTML RTE to migrate - --json-path= Provide path of JSON RTE to migrate - --locale= The locale from which entries will be migrated - --stack-api-key= Stack api key to be used + -a, --alias= Enter the alias name. You must use either the --alias flag or the --stack-api-key flag. + -c, --config-path= Specify the path where your config file is located. + -y, --yes Avoids reconfirmation of your configuration. + --batch-limit= [default: 50] Provide batch limit for updating entries (default: 50). + --branch= The name of the branch to be used. + --content-type= Specify the UID of the content type for which you want to migrate HTML RTE content. + --delay= [default: 1000] To set the interval time between the migration of HTML RTE to JSON RTE in + subsequent entries of a content type. The default value is 1,000 milliseconds. + --global-field Checks whether the specified UID belongs to a content type or a global field. This flag is + set to false by default. + --html-path= Enter the path to the HTML RTE whose content you want to migrate. + --json-path= Enter the path to the JSON RTE to which you want to migrate the HTML RTE content. + --locale= The locale from which entries will be migrated. + --stack-api-key= API key of the source stack. You must use either the --stack-api-key flag or the --alias + flag. DESCRIPTION Migration script to migrate content from HTML RTE to JSON RTE diff --git a/packages/contentstack-migration/README.md b/packages/contentstack-migration/README.md index e415cf3fd0..f30eab7c23 100644 --- a/packages/contentstack-migration/README.md +++ b/packages/contentstack-migration/README.md @@ -45,14 +45,18 @@ USAGE [--config ] [--multiple] FLAGS - -B, --branch= Use this flag to add the branch name where you want to perform the migration. - -a, --alias= Use this flag to add the management token alias. - -k, --stack-api-key= With this flag add the API key of your stack. - --config=... [optional] inline configuration, : - --config-file= [optional] Path of the JSON configuration file - --file-path= Use this flag to provide the path of the file of the migration script provided by the - user. - --multiple This flag helps you to migrate multiple content files in a single instance. + -B, --branch= Use this flag to add the branch name where you want to perform the migration. (target + branch name) + -a, --alias= Use this flag to add the management token alias. You must use either the --alias flag or + the --stack-api-key flag. + -k, --stack-api-key= Use this flag to add the API key of your stack. You must use either the --stack-api-key + flag or the --alias flag. + --config=... [optional] Inline configuration, :. Passing an external configuration makes + the script re-usable. + --config-file= [optional] Path of the JSON configuration file. + --file-path= Use this flag to provide the path of the file of the migration script. + --multiple This flag helps you to migrate multiple content files in a single instance. Mention the + folder path where your migration script files are stored. DESCRIPTION Contentstack migration script. @@ -84,14 +88,18 @@ USAGE [--config ] [--multiple] FLAGS - -B, --branch= Use this flag to add the branch name where you want to perform the migration. - -a, --alias= Use this flag to add the management token alias. - -k, --stack-api-key= With this flag add the API key of your stack. - --config=... [optional] inline configuration, : - --config-file= [optional] Path of the JSON configuration file - --file-path= Use this flag to provide the path of the file of the migration script provided by the - user. - --multiple This flag helps you to migrate multiple content files in a single instance. + -B, --branch= Use this flag to add the branch name where you want to perform the migration. (target + branch name) + -a, --alias= Use this flag to add the management token alias. You must use either the --alias flag or + the --stack-api-key flag. + -k, --stack-api-key= Use this flag to add the API key of your stack. You must use either the --stack-api-key + flag or the --alias flag. + --config=... [optional] Inline configuration, :. Passing an external configuration makes + the script re-usable. + --config-file= [optional] Path of the JSON configuration file. + --file-path= Use this flag to provide the path of the file of the migration script. + --multiple This flag helps you to migrate multiple content files in a single instance. Mention the + folder path where your migration script files are stored. DESCRIPTION Contentstack migration script. From fce404dc1c3ed6fa59fe192d0447b9baf92fa2e4 Mon Sep 17 00:00:00 2001 From: raj pandey Date: Wed, 30 Oct 2024 17:56:50 +0530 Subject: [PATCH 3/3] File update and readme --- package-lock.json | 119 +-- packages/contentstack-branches/README.md | 35 +- packages/contentstack-clone/README.md | 40 +- packages/contentstack-export/README.md | 52 +- packages/contentstack-import/README.md | 62 +- packages/contentstack/README.md | 950 ++++++++++++++--------- pnpm-lock.yaml | 379 +++++---- 7 files changed, 887 insertions(+), 750 deletions(-) diff --git a/package-lock.json b/package-lock.json index 530dd66477..9d5e2dba01 100644 --- a/package-lock.json +++ b/package-lock.json @@ -823,9 +823,9 @@ "link": true }, "node_modules/@contentstack/json-rte-serializer": { - "version": "2.0.10", - "resolved": "https://registry.npmjs.org/@contentstack/json-rte-serializer/-/json-rte-serializer-2.0.10.tgz", - "integrity": "sha512-32tzzNTaXsfJjuPe2x0xz1f1c3JKKtS7XHBo2y6C4NujKe2ROW2Fq50VjdEYbjm7oo8uOt4yOE1XZpj0KjmQXQ==", + "version": "2.0.11", + "resolved": "https://registry.npmjs.org/@contentstack/json-rte-serializer/-/json-rte-serializer-2.0.11.tgz", + "integrity": "sha512-FOcB3YANmCchIPXblYi5LZ8viViVslhLibHsYnopmiT+3Jvyw8K2hbdTS2/Cm4hqIppBn2u76Xk2XjdW0LlBYQ==", "license": "MIT", "dependencies": { "array-flat-polyfill": "^1.0.1", @@ -943,9 +943,6 @@ "funding": { "url": "https://opencollective.com/eslint" }, - "funding": { - "url": "https://opencollective.com/eslint" - }, "peerDependencies": { "eslint": "^6.0.0 || ^7.0.0 || >=8.0.0" } @@ -2416,9 +2413,9 @@ } }, "node_modules/@oclif/plugin-plugins/node_modules/@oclif/core": { - "version": "4.0.30", - "resolved": "https://registry.npmjs.org/@oclif/core/-/core-4.0.30.tgz", - "integrity": "sha512-Ak3OUdOcoovIRWZOT6oC5JhZgyJD90uWX/7HjSofn+C4LEmHxxfiyu04a73dwnezfzqDu9jEXfd2mQOOC54KZw==", + "version": "4.0.31", + "resolved": "https://registry.npmjs.org/@oclif/core/-/core-4.0.31.tgz", + "integrity": "sha512-7oyIZv/C1TP+fPc2tSzVPYqG1zU+nel1QvJxjAWyVhud0J8B5SpKZnryedxs3nlSVPJ6K1MT31C9esupCBYgZw==", "license": "MIT", "dependencies": { "ansi-escapes": "^4.3.2", @@ -2430,7 +2427,7 @@ "get-package-type": "^0.1.0", "globby": "^11.1.0", "indent-string": "^4.0.0", - "is-wsl": "^3", + "is-wsl": "^2.2.0", "lilconfig": "^3.1.2", "minimatch": "^9.0.5", "semver": "^7.6.3", @@ -2464,21 +2461,6 @@ "url": "https://github.com/sponsors/sindresorhus" } }, - "node_modules/@oclif/plugin-plugins/node_modules/is-wsl": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/is-wsl/-/is-wsl-3.1.0.tgz", - "integrity": "sha512-UcVfVfaK4Sc4m7X3dUSoHoozQGBEFeDC+zVo06t98xe8CzHSZZBekNXH+tu0NalHolcJ/QAGqS46Hef7QXBIMw==", - "license": "MIT", - "dependencies": { - "is-inside-container": "^1.0.0" - }, - "engines": { - "node": ">=16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/@oclif/plugin-plugins/node_modules/object-treeify": { "version": "4.0.1", "resolved": "https://registry.npmjs.org/object-treeify/-/object-treeify-4.0.1.tgz", @@ -3314,9 +3296,9 @@ } }, "node_modules/@types/adm-zip": { - "version": "0.5.5", - "resolved": "https://registry.npmjs.org/@types/adm-zip/-/adm-zip-0.5.5.tgz", - "integrity": "sha512-YCGstVMjc4LTY5uK9/obvxBya93axZOVOyf2GSUulADzmLhYE45u2nAssCs/fWBs1Ifq5Vat75JTPwd5XZoPJw==", + "version": "0.5.6", + "resolved": "https://registry.npmjs.org/@types/adm-zip/-/adm-zip-0.5.6.tgz", + "integrity": "sha512-lRlcSLg5Yoo7C2H2AUiAoYlvifWoCx/se7iUNiCBTfEVVYFVn+Tr9ZGed4K73tYgLe9O4PjdJvbxlkdAOx/qiw==", "dev": true, "license": "MIT", "dependencies": { @@ -3633,9 +3615,9 @@ "license": "MIT" }, "node_modules/@types/lodash": { - "version": "4.17.12", - "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.12.tgz", - "integrity": "sha512-sviUmCE8AYdaF/KIHLDJBQgeYzPBI0vf/17NaYehBJfYD1j6/L95Slh07NlyK2iNyBNaEkb3En2jRt+a8y3xZQ==", + "version": "4.17.13", + "resolved": "https://registry.npmjs.org/@types/lodash/-/lodash-4.17.13.tgz", + "integrity": "sha512-lfx+dftrEZcdBPczf9d0Qv0x+j/rfNCMuC6OcfXmO8gkfeNAY88PgKUbvG56whcN23gc27yenwF6oJZXGFpYxg==", "license": "MIT" }, "node_modules/@types/markdown-it": { @@ -5530,9 +5512,9 @@ } }, "node_modules/caniuse-lite": { - "version": "1.0.30001673", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001673.tgz", - "integrity": "sha512-WTrjUCSMp3LYX0nE12ECkV0a+e6LC85E0Auz75555/qr78Oc8YWhEPNfDd6SHdtlCMSzqtuXY0uyEMNRcsKpKw==", + "version": "1.0.30001675", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001675.tgz", + "integrity": "sha512-/wV1bQwPrkLiQMjaJF5yUMVM/VdRPOCU8QZ+PmG6uW6DvYSrNY1bpwHI/3mOcUosLaJCzYDi5o91IQB51ft6cg==", "dev": true, "funding": [ { @@ -7274,9 +7256,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.47", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.47.tgz", - "integrity": "sha512-zS5Yer0MOYw4rtK2iq43cJagHZ8sXN0jDHDKzB+86gSBSAI4v07S97mcq+Gs2vclAxSh1j7vOAHxSVgduiiuVQ==", + "version": "1.5.49", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.49.tgz", + "integrity": "sha512-ZXfs1Of8fDb6z7WEYZjXpgIRF6MEu8JdeGA0A40aZq6OQbS+eJpnnV49epZRna2DU/YsEjSQuGtQPPtvt6J65A==", "dev": true, "license": "ISC" }, @@ -11961,39 +11943,6 @@ "node": ">=0.10.0" } }, - "node_modules/is-inside-container": { - "version": "1.0.0", - "resolved": "https://registry.npmjs.org/is-inside-container/-/is-inside-container-1.0.0.tgz", - "integrity": "sha512-KIYLCCJghfHZxqjYBE7rEy0OBuTd5xCHS7tHVgvCLkx7StIoaxwNW3hCALgEUjFfeRk+MG/Qxmp/vtETEF3tRA==", - "license": "MIT", - "dependencies": { - "is-docker": "^3.0.0" - }, - "bin": { - "is-inside-container": "cli.js" - }, - "engines": { - "node": ">=14.16" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, - "node_modules/is-inside-container/node_modules/is-docker": { - "version": "3.0.0", - "resolved": "https://registry.npmjs.org/is-docker/-/is-docker-3.0.0.tgz", - "integrity": "sha512-eljcgEDlEns/7AXFosB5K/2nCM4P7FQPkGc/DWLy5rmFEWvZayGrik1d9/QIY5nJ4f9YsVvBkA6kJpHn9rISdQ==", - "license": "MIT", - "bin": { - "is-docker": "cli.js" - }, - "engines": { - "node": "^12.20.0 || ^14.13.1 || >=16.0.0" - }, - "funding": { - "url": "https://github.com/sponsors/sindresorhus" - } - }, "node_modules/is-interactive": { "version": "1.0.0", "resolved": "https://registry.npmjs.org/is-interactive/-/is-interactive-1.0.0.tgz", @@ -15763,9 +15712,9 @@ } }, "node_modules/nise/node_modules/@sinonjs/fake-timers": { - "version": "13.0.4", - "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-13.0.4.tgz", - "integrity": "sha512-wpUq+QiKxrWk7U2pdvNSY9fNX62/k+7eEdlQMO0A3rU8tQ+vvzY/WzBhMz+GbQlATXZlXWYQqFWNFcn1SVvThA==", + "version": "13.0.5", + "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-13.0.5.tgz", + "integrity": "sha512-36/hTbH2uaWuGVERyC6da9YwGWnzUZXuPro/F2LfsdOsLnCojz/iSH8MxUt/FD2S5XBSVPhmArFUXcpCQ2Hkiw==", "license": "BSD-3-Clause", "dependencies": { "@sinonjs/commons": "^3.0.1" @@ -23078,9 +23027,9 @@ } }, "node_modules/sinon/node_modules/@sinonjs/fake-timers": { - "version": "13.0.4", - "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-13.0.4.tgz", - "integrity": "sha512-wpUq+QiKxrWk7U2pdvNSY9fNX62/k+7eEdlQMO0A3rU8tQ+vvzY/WzBhMz+GbQlATXZlXWYQqFWNFcn1SVvThA==", + "version": "13.0.5", + "resolved": "https://registry.npmjs.org/@sinonjs/fake-timers/-/fake-timers-13.0.5.tgz", + "integrity": "sha512-36/hTbH2uaWuGVERyC6da9YwGWnzUZXuPro/F2LfsdOsLnCojz/iSH8MxUt/FD2S5XBSVPhmArFUXcpCQ2Hkiw==", "license": "BSD-3-Clause", "dependencies": { "@sinonjs/commons": "^3.0.1" @@ -27063,9 +27012,9 @@ "license": "MIT" }, "packages/contentstack-audit/node_modules/@types/node": { - "version": "20.17.1", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.1.tgz", - "integrity": "sha512-j2VlPv1NnwPJbaCNv69FO/1z4lId0QmGvpT41YxitRtWlg96g/j8qcv2RKsLKe2F6OJgyXhupN1Xo17b2m139Q==", + "version": "20.17.3", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.3.tgz", + "integrity": "sha512-tSQrmKKatLDGnG92h40GD7FzUt0MjahaHwOME4VAFeeA/Xopayq5qLyQRy7Jg/pjgKIFBXuKcGhJo+UdYG55jQ==", "dev": true, "license": "MIT", "dependencies": { @@ -29642,9 +29591,9 @@ "license": "BSD-3-Clause" }, "packages/contentstack-launch/node_modules/@types/node": { - "version": "16.18.115", - "resolved": "https://registry.npmjs.org/@types/node/-/node-16.18.115.tgz", - "integrity": "sha512-NF5ajYn+dq0tRfswdyp8Df75h7D9z+L8TCIwrXoh46ZLK6KZVXkRhf/luXaZytvm/keUo9vU4m1Bg39St91a5w==", + "version": "16.18.116", + "resolved": "https://registry.npmjs.org/@types/node/-/node-16.18.116.tgz", + "integrity": "sha512-mLigUvhoaADRewggiby+XfAAFOUOMCm/SwL5DAJ+CMUGjSLIGMsJVN7BOKftuQSHGjUmS/W7hVht8fcNbi/MRA==", "dev": true, "license": "MIT" }, @@ -30516,9 +30465,9 @@ } }, "packages/contentstack-variants/node_modules/@types/node": { - "version": "20.17.1", - "resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.1.tgz", - "integrity": "sha512-j2VlPv1NnwPJbaCNv69FO/1z4lId0QmGvpT41YxitRtWlg96g/j8qcv2RKsLKe2F6OJgyXhupN1Xo17b2m139Q==", + "version": "20.17.3", + "resolved": "https://registry.npmjs.org/@types/node/-/node-20.17.3.tgz", + "integrity": "sha512-tSQrmKKatLDGnG92h40GD7FzUt0MjahaHwOME4VAFeeA/Xopayq5qLyQRy7Jg/pjgKIFBXuKcGhJo+UdYG55jQ==", "dev": true, "license": "MIT", "dependencies": { diff --git a/packages/contentstack-branches/README.md b/packages/contentstack-branches/README.md index 2098948b1f..86878e4e0c 100755 --- a/packages/contentstack-branches/README.md +++ b/packages/contentstack-branches/README.md @@ -37,7 +37,7 @@ $ npm install -g @contentstack/cli-cm-branches $ csdx COMMAND running command... $ csdx (--version) -@contentstack/cli-cm-branches/1.2.0 darwin-arm64 node-v22.2.0 +@contentstack/cli-cm-branches/1.2.0 darwin-arm64 node-v22.8.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND @@ -63,8 +63,8 @@ USAGE $ csdx cm:branches FLAGS - -k, --stack-api-key= Stack API Key - --verbose Verbose + -k, --stack-api-key= Stack API key + --verbose Verbose, display information in detailed format. DESCRIPTION List the branches @@ -91,8 +91,8 @@ USAGE FLAGS -k, --stack-api-key= Stack API key - --source= Source branch from which new branch to be created - --uid= Branch UID to be created + --source= Source branch from which a new branch is to be created. + --uid= Branch UID (unique name) to be created. DESCRIPTION Create a new branch @@ -145,12 +145,13 @@ USAGE $ csdx cm:branches:diff [--base-branch ] [--compare-branch ] [-k ][--module ] FLAGS - -k, --stack-api-key= Provide Stack API key to show difference between branches - --base-branch= Base branch - --compare-branch= Compare branch - --format=