diff --git a/packages/contentstack-auth/README.md b/packages/contentstack-auth/README.md index af48e5686d..9b9ec8ea5a 100644 --- a/packages/contentstack-auth/README.md +++ b/packages/contentstack-auth/README.md @@ -5,40 +5,44 @@ It is Contentstack’s CLI plugin to perform authentication-related activities. [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE) -* [@contentstack/cli-auth](#contentstackcli-auth) -* [Usage](#usage) -* [Commands](#commands) + +- [@contentstack/cli-auth](#contentstackcli-auth) +- [Usage](#usage) +- [Commands](#commands) # Usage + ```sh-session $ npm install -g @contentstack/cli-auth $ csdx COMMAND running command... $ csdx (--version) -@contentstack/cli-auth/1.3.13 darwin-arm64 node-v18.11.0 +@contentstack/cli-auth/1.3.13 darwin-arm64 node-v20.7.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND ... ``` + # Commands -* [`csdx auth:login`](#csdx-authlogin) -* [`csdx auth:logout`](#csdx-authlogout) -* [`csdx auth:tokens`](#csdx-authtokens) -* [`csdx auth:tokens:add [-a ] [--delivery] [--management] [-e ] [-k ] [-y] [--token ]`](#csdx-authtokensadd--a-value---delivery---management--e-value--k-value--y---token-value) -* [`csdx auth:tokens:remove`](#csdx-authtokensremove) -* [`csdx auth:whoami`](#csdx-authwhoami) -* [`csdx login`](#csdx-login) -* [`csdx logout`](#csdx-logout) -* [`csdx tokens`](#csdx-tokens) -* [`csdx whoami`](#csdx-whoami) + +- [`csdx auth:login`](#csdx-authlogin) +- [`csdx auth:logout`](#csdx-authlogout) +- [`csdx auth:tokens`](#csdx-authtokens) +- [`csdx auth:tokens:add [-a ] [--delivery] [--management] [-e ] [-k ] [-y] [--token ]`](#csdx-authtokensadd--a-value---delivery---management--e-value--k-value--y---token-value) +- [`csdx auth:tokens:remove`](#csdx-authtokensremove) +- [`csdx auth:whoami`](#csdx-authwhoami) +- [`csdx login`](#csdx-login) +- [`csdx logout`](#csdx-logout) +- [`csdx tokens`](#csdx-tokens) +- [`csdx whoami`](#csdx-whoami) ## `csdx auth:login` @@ -324,4 +328,5 @@ ALIASES EXAMPLES $ csdx auth:whoami ``` + diff --git a/packages/contentstack-bootstrap/README.md b/packages/contentstack-bootstrap/README.md index b873acaa06..a05ef512a5 100644 --- a/packages/contentstack-bootstrap/README.md +++ b/packages/contentstack-bootstrap/README.md @@ -3,24 +3,27 @@ Contentstack CLI’s “Bootstrap” plugin enables you to automate the process This means that all the required steps such as stack, environment, and content type creation, entry and asset publishing are performed just by using a single command. -* [Usage](#usage) -* [Commands](#commands) + +- [Usage](#usage) +- [Commands](#commands) # Usage + ```sh-session $ npm install -g @contentstack/cli-cm-bootstrap $ csdx COMMAND running command... $ csdx (--version) -@contentstack/cli-cm-bootstrap/1.5.0 darwin-arm64 node-v18.11.0 +@contentstack/cli-cm-bootstrap/1.5.0 darwin-arm64 node-v20.7.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND ... ``` + ```sh-session @@ -36,7 +39,8 @@ USAGE # Commands -* [`csdx cm:bootstrap`](#csdx-cmbootstrap) + +- [`csdx cm:bootstrap`](#csdx-cmbootstrap) ## `csdx cm:bootstrap` @@ -74,4 +78,5 @@ EXAMPLES ``` _See code: [src/commands/cm/bootstrap.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-bootstrap/src/commands/cm/bootstrap.ts)_ + diff --git a/packages/contentstack-branches/README.md b/packages/contentstack-branches/README.md index 8a506d885a..4348a04f10 100755 --- a/packages/contentstack-branches/README.md +++ b/packages/contentstack-branches/README.md @@ -4,9 +4,10 @@ It is Contentstack’s CLI plugin to compare and merge content. [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE) -* [@contentstack/cli-cm-branches](#contentstackcli-cm-branches) -* [Usage](#usage) -* [Commands](#commands) + +- [@contentstack/cli-cm-branches](#contentstackcli-cm-branches) +- [Usage](#usage) +- [Commands](#commands) For switching to EU region update the hosts at config/default.js @@ -32,27 +33,30 @@ For switching to AZURE-NA region update the hosts at config/default.js # Usage + ```sh-session $ npm install -g @contentstack/cli-cm-branches $ csdx COMMAND running command... $ csdx (--version) -@contentstack/cli-cm-branches/1.0.13 darwin-arm64 node-v18.11.0 +@contentstack/cli-cm-branches/1.0.13 darwin-arm64 node-v20.7.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND ... ``` + # Commands -* [`csdx cm:branches`](#csdx-cmbranches) -* [`csdx cm:branches:create`](#csdx-cmbranchescreate) -* [`csdx cm:branches:delete [-uid ] [-k ]`](#csdx-cmbranchesdelete--uid-value--k-value) -* [`csdx cm:branches:diff [--base-branch ] [--compare-branch ] [-k ][--module ]`](#csdx-cmbranchesdiff---base-branch-value---compare-branch-value--k-value--module-value) -* [`csdx cm:branches:merge [-k ][--compare-branch ] [--no-revert] [--export-summary-path ] [--use-merge-summary ] [--comment ] [--base-branch ]`](#csdx-cmbranchesmerge--k-value--compare-branch-value---no-revert---export-summary-path-value---use-merge-summary-value---comment-value---base-branch-value) + +- [`csdx cm:branches`](#csdx-cmbranches) +- [`csdx cm:branches:create`](#csdx-cmbranchescreate) +- [`csdx cm:branches:delete [-uid ] [-k ]`](#csdx-cmbranchesdelete--uid-value--k-value) +- [`csdx cm:branches:diff [--base-branch ] [--compare-branch ] [-k ][--module ]`](#csdx-cmbranchesdiff---base-branch-value---compare-branch-value--k-value--module-value) +- [`csdx cm:branches:merge [-k ][--compare-branch ] [--no-revert] [--export-summary-path ] [--use-merge-summary ] [--comment ] [--base-branch ]`](#csdx-cmbranchesmerge--k-value--compare-branch-value---no-revert---export-summary-path-value---use-merge-summary-value---comment-value---base-branch-value) ## `csdx cm:branches` @@ -222,4 +226,5 @@ EXAMPLES ``` _See code: [src/commands/cm/branches/merge.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/merge.ts)_ + diff --git a/packages/contentstack-bulk-publish/README.md b/packages/contentstack-bulk-publish/README.md index 4fa96bfa1c..f7bd26395d 100644 --- a/packages/contentstack-bulk-publish/README.md +++ b/packages/contentstack-bulk-publish/README.md @@ -5,55 +5,59 @@ It is Contentstack’s CLI plugin to perform bulk publish/unpublish operations o [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE) -* [@contentstack/cli-cm-bulk-publish](#contentstackcli-cm-bulk-publish) -* [Usage](#usage) -* [Commands](#commands) + +- [@contentstack/cli-cm-bulk-publish](#contentstackcli-cm-bulk-publish) +- [Usage](#usage) +- [Commands](#commands) # Usage + ```sh-session $ npm install -g @contentstack/cli-cm-bulk-publish $ csdx COMMAND running command... $ csdx (--version) -@contentstack/cli-cm-bulk-publish/1.3.11 darwin-arm64 node-v18.11.0 +@contentstack/cli-cm-bulk-publish/1.3.11 darwin-arm64 node-v20.7.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND ... ``` + # Commands -* [`csdx cm:assets:publish [-a ] [--retry-failed ] [-e ] [--folder-uid ] [--bulk-publish ] [-c ] [-y] [--locales ] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmassetspublish--a-value---retry-failed-value--e-value---folder-uid-value---bulk-publish-value--c-value--y---locales-value---branch-value---delivery-token-value---source-env-value) -* [`csdx cm:assets:unpublish`](#csdx-cmassetsunpublish) -* [`csdx cm:bulk-publish`](#csdx-cmbulk-publish) -* [`csdx cm:entries:update-and-publish [-a ] [--retry-failed ] [--bulk-publish ] [--content-types ] [-t ] [-e ] [-c ] [-y] [--locales ] [--branch ]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value) -* [`csdx cm:assets:publish [-a ] [--retry-failed ] [-e ] [--folder-uid ] [--bulk-publish ] [-c ] [-y] [--locales ] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmassetspublish--a-value---retry-failed-value--e-value---folder-uid-value---bulk-publish-value--c-value--y---locales-value---branch-value---delivery-token-value---source-env-value-1) -* [`csdx cm:bulk-publish:clear`](#csdx-cmbulk-publishclear) -* [`csdx cm:bulk-publish:configure`](#csdx-cmbulk-publishconfigure) -* [`csdx cm:bulk-publish:cross-publish [-a ] [--retry-failed ] [--bulk-publish ] [--content-type ] [--locales ] [--source-env ] [--environments ] [--delivery-token ] [-c ] [-y] [--branch ] [--onlyAssets] [--onlyEntries]`](#csdx-cmbulk-publishcross-publish--a-value---retry-failed-value---bulk-publish-value---content-type-value---locales-value---source-env-value---environments-value---delivery-token-value--c-value--y---branch-value---onlyassets---onlyentries) -* [`csdx cm:entries:publish [-a ] [--retry-failed ] [--bulk-publish ] [--publish-all-content-types] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value) -* [`csdx cm:entries:publish-modified [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value) -* [`csdx cm:entries:publish-non-localized-fields [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value) -* [`csdx cm:bulk-publish:revert`](#csdx-cmbulk-publishrevert) -* [`csdx csdx cm:stacks:unpublish [-a ] [-e ] [-c ] [-y] [--locale ] [--branch ] [--retry-failed ] [--bulk-unpublish ] [--content-type ] [--delivery-token ] [--only-assets] [--only-entries]`](#csdx-csdx-cmstacksunpublish--a-value--e-value--c-value--y---locale-value---branch-value---retry-failed-value---bulk-unpublish-value---content-type-value---delivery-token-value---only-assets---only-entries) -* [`csdx cm:entries:publish-only-unpublished [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-only-unpublished--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value) -* [`csdx cm:entries:publish [-a ] [--retry-failed ] [--bulk-publish ] [--publish-all-content-types] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value-1) -* [`csdx cm:entries:publish-modified [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value-1) -* [`csdx cm:entries:publish-non-localized-fields [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value-1) -* [`csdx cm:entries:publish-only-unpublished [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-only-unpublished--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value-1) -* [`csdx cm:entries:unpublish`](#csdx-cmentriesunpublish) -* [`csdx cm:entries:update-and-publish [-a ] [--retry-failed ] [--bulk-publish ] [--content-types ] [-t ] [-e ] [-c ] [-y] [--locales ] [--branch ]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value-1) -* [`csdx cm:stacks:publish`](#csdx-cmstackspublish) -* [`csdx cm:stacks:publish-clear-logs`](#csdx-cmstackspublish-clear-logs) -* [`csdx cm:stacks:publish-configure`](#csdx-cmstackspublish-configure) -* [`csdx cm:stacks:publish-revert`](#csdx-cmstackspublish-revert) -* [`csdx csdx cm:stacks:unpublish [-a ] [-e ] [-c ] [-y] [--locale ] [--branch ] [--retry-failed ] [--bulk-unpublish ] [--content-type ] [--delivery-token ] [--only-assets] [--only-entries]`](#csdx-csdx-cmstacksunpublish--a-value--e-value--c-value--y---locale-value---branch-value---retry-failed-value---bulk-unpublish-value---content-type-value---delivery-token-value---only-assets---only-entries-1) + +- [`csdx cm:assets:publish [-a ] [--retry-failed ] [-e ] [--folder-uid ] [--bulk-publish ] [-c ] [-y] [--locales ] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmassetspublish--a-value---retry-failed-value--e-value---folder-uid-value---bulk-publish-value--c-value--y---locales-value---branch-value---delivery-token-value---source-env-value) +- [`csdx cm:assets:unpublish`](#csdx-cmassetsunpublish) +- [`csdx cm:bulk-publish`](#csdx-cmbulk-publish) +- [`csdx cm:entries:update-and-publish [-a ] [--retry-failed ] [--bulk-publish ] [--content-types ] [-t ] [-e ] [-c ] [-y] [--locales ] [--branch ]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value) +- [`csdx cm:assets:publish [-a ] [--retry-failed ] [-e ] [--folder-uid ] [--bulk-publish ] [-c ] [-y] [--locales ] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmassetspublish--a-value---retry-failed-value--e-value---folder-uid-value---bulk-publish-value--c-value--y---locales-value---branch-value---delivery-token-value---source-env-value-1) +- [`csdx cm:bulk-publish:clear`](#csdx-cmbulk-publishclear) +- [`csdx cm:bulk-publish:configure`](#csdx-cmbulk-publishconfigure) +- [`csdx cm:bulk-publish:cross-publish [-a ] [--retry-failed ] [--bulk-publish ] [--content-type ] [--locales ] [--source-env ] [--environments ] [--delivery-token ] [-c ] [-y] [--branch ] [--onlyAssets] [--onlyEntries]`](#csdx-cmbulk-publishcross-publish--a-value---retry-failed-value---bulk-publish-value---content-type-value---locales-value---source-env-value---environments-value---delivery-token-value--c-value--y---branch-value---onlyassets---onlyentries) +- [`csdx cm:entries:publish [-a ] [--retry-failed ] [--bulk-publish ] [--publish-all-content-types] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value) +- [`csdx cm:entries:publish-modified [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value) +- [`csdx cm:entries:publish-non-localized-fields [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value) +- [`csdx cm:bulk-publish:revert`](#csdx-cmbulk-publishrevert) +- [`csdx csdx cm:stacks:unpublish [-a ] [-e ] [-c ] [-y] [--locale ] [--branch ] [--retry-failed ] [--bulk-unpublish ] [--content-type ] [--delivery-token ] [--only-assets] [--only-entries]`](#csdx-csdx-cmstacksunpublish--a-value--e-value--c-value--y---locale-value---branch-value---retry-failed-value---bulk-unpublish-value---content-type-value---delivery-token-value---only-assets---only-entries) +- [`csdx cm:entries:publish-only-unpublished [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-only-unpublished--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value) +- [`csdx cm:entries:publish [-a ] [--retry-failed ] [--bulk-publish ] [--publish-all-content-types] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value-1) +- [`csdx cm:entries:publish-modified [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value-1) +- [`csdx cm:entries:publish-non-localized-fields [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value-1) +- [`csdx cm:entries:publish-only-unpublished [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-only-unpublished--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value-1) +- [`csdx cm:entries:unpublish`](#csdx-cmentriesunpublish) +- [`csdx cm:entries:update-and-publish [-a ] [--retry-failed ] [--bulk-publish ] [--content-types ] [-t ] [-e ] [-c ] [-y] [--locales ] [--branch ]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value-1) +- [`csdx cm:stacks:publish`](#csdx-cmstackspublish) +- [`csdx cm:stacks:publish-clear-logs`](#csdx-cmstackspublish-clear-logs) +- [`csdx cm:stacks:publish-configure`](#csdx-cmstackspublish-configure) +- [`csdx cm:stacks:publish-revert`](#csdx-cmstackspublish-revert) +- [`csdx csdx cm:stacks:unpublish [-a ] [-e ] [-c ] [-y] [--locale ] [--branch ] [--retry-failed ] [--bulk-unpublish ] [--content-type ] [--delivery-token ] [--only-assets] [--only-entries]`](#csdx-csdx-cmstacksunpublish--a-value--e-value--c-value--y---locale-value---branch-value---retry-failed-value---bulk-unpublish-value---content-type-value---delivery-token-value---only-assets---only-entries-1) ## `csdx cm:assets:publish [-a ] [--retry-failed ] [-e ] [--folder-uid ] [--bulk-publish ] [-c ] [-y] [--locales ] [--branch ] [--delivery-token ] [--source-env ]` @@ -1629,4 +1633,5 @@ EXAMPLES ``` _See code: [src/commands/cm/stacks/unpublish.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/stacks/unpublish.js)_ + diff --git a/packages/contentstack-clone/README.md b/packages/contentstack-clone/README.md index d33a683d32..184ad95362 100644 --- a/packages/contentstack-clone/README.md +++ b/packages/contentstack-clone/README.md @@ -3,25 +3,28 @@ It is Contentstack’s CLI plugin to clone a stack. Using this command, you can export a stack’s content/schema to a new or existing stack. Refer to the [Clone a Stack](https://www.contentstack.com/docs/developers/cli/clone-a-stack/) documentation to learn more. -* [@contentstack/cli-cm-clone](#contentstackcli-cm-clone) -* [Usage](#usage) -* [Commands](#commands) + +- [@contentstack/cli-cm-clone](#contentstackcli-cm-clone) +- [Usage](#usage) +- [Commands](#commands) # Usage + ```sh-session $ npm install -g @contentstack/cli-cm-clone $ csdx COMMAND running command... $ csdx (--version) -@contentstack/cli-cm-clone/1.5.0 darwin-arm64 node-v18.11.0 +@contentstack/cli-cm-clone/1.5.0 darwin-arm64 node-v20.7.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND ... ``` + ```sh-session @@ -37,8 +40,9 @@ USAGE # Commands -* [`csdx cm:stacks:clone [--source-branch ] [--target-branch ] [--source-management-token-alias ] [--destination-management-token-alias ] [-n ] [--type a|b] [--source-stack-api-key ] [--destination-stack-api-key ] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent) -* [`csdx cm:stacks:clone [--source-branch ] [--target-branch ] [--source-management-token-alias ] [--destination-management-token-alias ] [-n ] [--type a|b] [--source-stack-api-key ] [--destination-stack-api-key ] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent-1) + +- [`csdx cm:stacks:clone [--source-branch ] [--target-branch ] [--source-management-token-alias ] [--destination-management-token-alias ] [-n ] [--type a|b] [--source-stack-api-key ] [--destination-stack-api-key ] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent) +- [`csdx cm:stacks:clone [--source-branch ] [--target-branch ] [--source-management-token-alias ] [--destination-management-token-alias ] [-n ] [--type a|b] [--source-stack-api-key ] [--destination-stack-api-key ] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent-1) ## `csdx cm:stacks:clone [--source-branch ] [--target-branch ] [--source-management-token-alias ] [--destination-management-token-alias ] [-n ] [--type a|b] [--source-stack-api-key ] [--destination-stack-api-key ] [--import-webhook-status disable|current]` @@ -139,4 +143,5 @@ EXAMPLES ``` _See code: [src/commands/cm/stacks/clone.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-clone/src/commands/cm/stacks/clone.js)_ + diff --git a/packages/contentstack-config/README.md b/packages/contentstack-config/README.md index 745a2e213b..a4a209758b 100644 --- a/packages/contentstack-config/README.md +++ b/packages/contentstack-config/README.md @@ -5,35 +5,39 @@ The config namespace contains all the commands that you will need to configure t [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE) -* [@contentstack/cli-config](#contentstackcli-config) -* [Usage](#usage) -* [Commands](#commands) + +- [@contentstack/cli-config](#contentstackcli-config) +- [Usage](#usage) +- [Commands](#commands) # Usage + ```sh-session $ npm install -g @contentstack/cli-config $ csdx COMMAND running command... $ csdx (--version) -@contentstack/cli-config/1.4.11 darwin-arm64 node-v18.11.0 +@contentstack/cli-config/1.4.11 darwin-arm64 node-v20.7.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND ... ``` + # Commands -* [`csdx config:get:base-branch`](#csdx-configgetbase-branch) -* [`csdx config:get:region`](#csdx-configgetregion) -* [`csdx config:remove:base-branch`](#csdx-configremovebase-branch) -* [`csdx config:set:base-branch`](#csdx-configsetbase-branch) -* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region) + +- [`csdx config:get:base-branch`](#csdx-configgetbase-branch) +- [`csdx config:get:region`](#csdx-configgetregion) +- [`csdx config:remove:base-branch`](#csdx-configremovebase-branch) +- [`csdx config:set:base-branch`](#csdx-configsetbase-branch) +- [`csdx config:set:region [REGION]`](#csdx-configsetregion-region) ## `csdx config:get:base-branch` @@ -152,4 +156,5 @@ EXAMPLES ``` _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-export/README.md b/packages/contentstack-export/README.md index 51878242e8..13805a8c85 100755 --- a/packages/contentstack-export/README.md +++ b/packages/contentstack-export/README.md @@ -5,9 +5,10 @@ It is Contentstack’s CLI plugin to export content from the stack. To learn how [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE) -* [@contentstack/cli-cm-export](#contentstackcli-cm-export) -* [Usage](#usage) -* [Commands](#commands) + +- [@contentstack/cli-cm-export](#contentstackcli-cm-export) +- [Usage](#usage) +- [Commands](#commands) For switching to EU region update the hosts at config/default.js @@ -43,24 +44,27 @@ For switching to AZURE-EU region update the hosts at config/default.js # Usage + ```sh-session $ npm install -g @contentstack/cli-cm-export $ csdx COMMAND running command... $ csdx (--version) -@contentstack/cli-cm-export/1.9.0 darwin-arm64 node-v18.11.0 +@contentstack/cli-cm-export/1.9.0 darwin-arm64 node-v20.7.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND ... ``` + # Commands -* [`csdx cm:stacks:export [-c ] [-k ] [-d ] [-a ] [--module ] [--content-types ] [--branch ] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets) -* [`csdx cm:stacks:export [-c ] [-k ] [-d ] [-a ] [--module ] [--content-types ] [--branch ] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets-1) + +- [`csdx cm:stacks:export [-c ] [-k ] [-d ] [-a ] [--module ] [--content-types ] [--branch ] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets) +- [`csdx cm:stacks:export [-c ] [-k ] [-d ] [-a ] [--module ] [--content-types ] [--branch ] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets-1) ## `csdx cm:stacks:export [-c ] [-k ] [-d ] [-a ] [--module ] [--content-types ] [--branch ] [--secured-assets]` @@ -147,4 +151,5 @@ EXAMPLES ``` _See code: [src/commands/cm/stacks/export.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/stacks/export.ts)_ + diff --git a/packages/contentstack-import/README.md b/packages/contentstack-import/README.md index 6b665b92c9..16b661eec3 100644 --- a/packages/contentstack-import/README.md +++ b/packages/contentstack-import/README.md @@ -5,8 +5,9 @@ It is Contentstack’s CLI plugin to import content in the stack. To learn how t [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE) -* [Usage](#usage) -* [Commands](#commands) + +- [Usage](#usage) +- [Commands](#commands) For switching to EU region update the hosts at config/default.js @@ -42,24 +43,27 @@ For switching to AZURE-EU region update the hosts at config/default.js # Usage + ```sh-session $ npm install -g @contentstack/cli-cm-import $ csdx COMMAND running command... $ csdx (--version) -@contentstack/cli-cm-import/1.9.0 darwin-arm64 node-v18.11.0 +@contentstack/cli-cm-import/1.9.0 darwin-arm64 node-v20.7.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND ... ``` + # Commands -* [`csdx cm:stacks:import [-c ] [-k ] [-d ] [-a ] [--module ] [--backup-dir ] [--branch ] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent) -* [`csdx cm:stacks:import [-c ] [-k ] [-d ] [-a ] [--module ] [--backup-dir ] [--branch ] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent-1) + +- [`csdx cm:stacks:import [-c ] [-k ] [-d ] [-a ] [--module ] [--backup-dir ] [--branch ] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent) +- [`csdx cm:stacks:import [-c ] [-k ] [-d ] [-a ] [--module ] [--backup-dir ] [--branch ] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent-1) ## `csdx cm:stacks:import [-c ] [-k ] [-d ] [-a ] [--module ] [--backup-dir ] [--branch ] [--import-webhook-status disable|current]` @@ -152,4 +156,5 @@ EXAMPLES ``` _See code: [src/commands/cm/stacks/import.ts](https://github.com/contentstack/cli/blob/main/packages/contentstack-import/src/commands/cm/stacks/import.ts)_ + diff --git a/packages/contentstack-launch/README.md b/packages/contentstack-launch/README.md index da4551f7e6..de346bd1f4 100755 --- a/packages/contentstack-launch/README.md +++ b/packages/contentstack-launch/README.md @@ -5,26 +5,29 @@ With Launch CLI, you can interact with the Contentstack Launch platform using the terminal to create, manage and deploy Launch projects. -* [Launch CLI plugin](#launch-cli-plugin) -* [Usage](#usage) -* [Installation steps](#installation-steps) -* [Commands](#commands) + +- [Launch CLI plugin](#launch-cli-plugin) +- [Usage](#usage) +- [Installation steps](#installation-steps) +- [Commands](#commands) # Usage + ```sh-session $ npm install -g @contentstack/cli-launch $ csdx COMMAND running command... $ csdx (--version|-v) -@contentstack/cli-launch/1.0.12 darwin-arm64 node-v18.11.0 +@contentstack/cli-launch/1.0.12 darwin-arm64 node-v20.7.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND ... ``` + # Installation steps diff --git a/packages/contentstack-migrate-rte/README.md b/packages/contentstack-migrate-rte/README.md index ceb2cb49ba..fe5dd21c75 100644 --- a/packages/contentstack-migrate-rte/README.md +++ b/packages/contentstack-migrate-rte/README.md @@ -3,32 +3,36 @@ It is Contentstack’s CLI plugin to migrate rte. Using this command, you can copy existing value of HTML RTE into JSON RTE. -* [@contentstack/cli-cm-migrate-rte](#contentstackcli-cm-migrate-rte) -* [Usage](#usage) -* [Commands](#commands) + +- [@contentstack/cli-cm-migrate-rte](#contentstackcli-cm-migrate-rte) +- [Usage](#usage) +- [Commands](#commands) # Usage + ```sh-session $ npm install -g @contentstack/cli-cm-migrate-rte $ csdx COMMAND running command... $ csdx (--version) -@contentstack/cli-cm-migrate-rte/1.4.11 darwin-arm64 node-v18.11.0 +@contentstack/cli-cm-migrate-rte/1.4.11 darwin-arm64 node-v20.7.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND ... ``` + # Commands -* [`csdx cm:entries:migrate-html-rte`](#csdx-cmentriesmigrate-html-rte) -* [`csdx cm:migrate-rte`](#csdx-cmmigrate-rte) + +- [`csdx cm:entries:migrate-html-rte`](#csdx-cmentriesmigrate-html-rte) +- [`csdx cm:migrate-rte`](#csdx-cmmigrate-rte) ## `csdx cm:entries:migrate-html-rte` @@ -149,4 +153,5 @@ EXAMPLES $ csdx cm:entries:migrate-html-rte --alias alias --content-type global_field_uid --global-field --html-path html-path --json-path json-path ``` + diff --git a/packages/contentstack-migration/README.md b/packages/contentstack-migration/README.md index fee27e58a4..f878bac60b 100644 --- a/packages/contentstack-migration/README.md +++ b/packages/contentstack-migration/README.md @@ -8,32 +8,36 @@ The Contentstack CLI’s “Migration” plugin allows developers to automate th [![License](https://img.shields.io/npm/l/@contentstack/cli-migration.svg)](https://github.com/ninadhatkar/cli-migration/blob/master/package.json) -* [@contentstack/cli-migration](#contentstackcli-migration) -* [Usage](#usage) -* [Commands](#commands) + +- [@contentstack/cli-migration](#contentstackcli-migration) +- [Usage](#usage) +- [Commands](#commands) # Usage + ```sh-session $ npm install -g @contentstack/cli-migration $ csdx COMMAND running command... $ csdx (--version) -@contentstack/cli-migration/1.3.13 darwin-arm64 node-v18.11.0 +@contentstack/cli-migration/1.3.13 darwin-arm64 node-v20.7.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND ... ``` + # Commands -* [`csdx cm:stacks:migration [-k ] [-a ] [--file-path ] [--branch ] [--config-file ] [--config ] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple) -* [`csdx cm:stacks:migration [-k ] [-a ] [--file-path ] [--branch ] [--config-file ] [--config ] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple-1) + +- [`csdx cm:stacks:migration [-k ] [-a ] [--file-path ] [--branch ] [--config-file ] [--config ] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple) +- [`csdx cm:stacks:migration [-k ] [-a ] [--file-path ] [--branch ] [--config-file ] [--config ] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple-1) ## `csdx cm:stacks:migration [-k ] [-a ] [--file-path ] [--branch ] [--config-file ] [--config ] [--multiple]` @@ -69,7 +73,7 @@ EXAMPLES $ csdx cm:migration --config-file --file-path - $ csdx cm:migration --multiple --file-path + $ csdx cm:migration --multiple --file-path $ csdx cm:migration --alias --file-path -k ``` @@ -108,12 +112,13 @@ EXAMPLES $ csdx cm:migration --config-file --file-path - $ csdx cm:migration --multiple --file-path + $ csdx cm:migration --multiple --file-path $ csdx cm:migration --alias --file-path -k ``` _See code: [src/commands/cm/stacks/migration.js](https://github.com/contentstack/cli/blob/main/packages/contentstack-migration/src/commands/cm/stacks/migration.js)_ + ### Points to remember diff --git a/packages/contentstack/README.md b/packages/contentstack/README.md index cbe3c79bc2..23ba588070 100644 --- a/packages/contentstack/README.md +++ b/packages/contentstack/README.md @@ -5,105 +5,109 @@ Use Contentstack Command-line Interface to command Contentstack for executing a [![License](https://img.shields.io/npm/l/@contentstack/cli)](https://github.com/contentstack/cli/blob/main/LICENSE) -* [@contentstack/cli](#contentstackcli) -* [Usage](#usage) -* [Commands](#commands) + +- [@contentstack/cli](#contentstackcli) +- [Usage](#usage) +- [Commands](#commands) # Usage + ```sh-session $ npm install -g @contentstack/cli $ csdx COMMAND running command... $ csdx (--version|-v) -@contentstack/cli/1.9.0 darwin-arm64 node-v18.11.0 +@contentstack/cli/1.9.0 darwin-arm64 node-v20.7.0 $ csdx --help [COMMAND] USAGE $ csdx COMMAND ... ``` + # Commands -* [`csdx auth:login`](#csdx-authlogin) -* [`csdx auth:logout`](#csdx-authlogout) -* [`csdx auth:tokens`](#csdx-authtokens) -* [`csdx auth:tokens:add [-a ] [--delivery] [--management] [-e ] [-k ] [-y] [--token ]`](#csdx-authtokensadd--a-value---delivery---management--e-value--k-value--y---token-value) -* [`csdx auth:tokens:remove`](#csdx-authtokensremove) -* [`csdx auth:whoami`](#csdx-authwhoami) -* [`csdx cm:assets:publish [-a ] [--retry-failed ] [-e ] [--folder-uid ] [--bulk-publish ] [-c ] [-y] [--locales ] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmassetspublish--a-value---retry-failed-value--e-value---folder-uid-value---bulk-publish-value--c-value--y---locales-value---branch-value---delivery-token-value---source-env-value) -* [`csdx cm:assets:unpublish`](#csdx-cmassetsunpublish) -* [`csdx cm:bootstrap`](#csdx-cmbootstrap) -* [`csdx cm:branches`](#csdx-cmbranches) -* [`csdx cm:branches:create`](#csdx-cmbranchescreate) -* [`csdx cm:branches:delete [-uid ] [-k ]`](#csdx-cmbranchesdelete--uid-value--k-value) -* [`csdx cm:branches:diff [--base-branch ] [--compare-branch ] [-k ][--module ]`](#csdx-cmbranchesdiff---base-branch-value---compare-branch-value--k-value--module-value) -* [`csdx cm:branches:merge [-k ][--compare-branch ] [--no-revert] [--export-summary-path ] [--use-merge-summary ] [--comment ] [--base-branch ]`](#csdx-cmbranchesmerge--k-value--compare-branch-value---no-revert---export-summary-path-value---use-merge-summary-value---comment-value---base-branch-value) -* [`csdx cm:bulk-publish`](#csdx-cmbulk-publish) -* [`csdx cm:entries:update-and-publish [-a ] [--retry-failed ] [--bulk-publish ] [--content-types ] [-t ] [-e ] [-c ] [-y] [--locales ] [--branch ]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value) -* [`csdx cm:assets:publish [-a ] [--retry-failed ] [-e ] [--folder-uid ] [--bulk-publish ] [-c ] [-y] [--locales ] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmassetspublish--a-value---retry-failed-value--e-value---folder-uid-value---bulk-publish-value--c-value--y---locales-value---branch-value---delivery-token-value---source-env-value-1) -* [`csdx cm:bulk-publish:clear`](#csdx-cmbulk-publishclear) -* [`csdx cm:bulk-publish:configure`](#csdx-cmbulk-publishconfigure) -* [`csdx cm:bulk-publish:cross-publish [-a ] [--retry-failed ] [--bulk-publish ] [--content-type ] [--locales ] [--source-env ] [--environments ] [--delivery-token ] [-c ] [-y] [--branch ] [--onlyAssets] [--onlyEntries]`](#csdx-cmbulk-publishcross-publish--a-value---retry-failed-value---bulk-publish-value---content-type-value---locales-value---source-env-value---environments-value---delivery-token-value--c-value--y---branch-value---onlyassets---onlyentries) -* [`csdx cm:entries:publish [-a ] [--retry-failed ] [--bulk-publish ] [--publish-all-content-types] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value) -* [`csdx cm:entries:publish-modified [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value) -* [`csdx cm:entries:publish-non-localized-fields [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value) -* [`csdx cm:bulk-publish:revert`](#csdx-cmbulk-publishrevert) -* [`csdx csdx cm:stacks:unpublish [-a ] [-e ] [-c ] [-y] [--locale ] [--branch ] [--retry-failed ] [--bulk-unpublish ] [--content-type ] [--delivery-token ] [--only-assets] [--only-entries]`](#csdx-csdx-cmstacksunpublish--a-value--e-value--c-value--y---locale-value---branch-value---retry-failed-value---bulk-unpublish-value---content-type-value---delivery-token-value---only-assets---only-entries) -* [`csdx cm:entries:publish-only-unpublished [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-only-unpublished--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value) -* [`csdx cm:entries:migrate-html-rte`](#csdx-cmentriesmigrate-html-rte) -* [`csdx cm:entries:publish [-a ] [--retry-failed ] [--bulk-publish ] [--publish-all-content-types] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value-1) -* [`csdx cm:entries:publish-modified [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value-1) -* [`csdx cm:entries:publish-non-localized-fields [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value-1) -* [`csdx cm:entries:publish-only-unpublished [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-only-unpublished--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value-1) -* [`csdx cm:entries:unpublish`](#csdx-cmentriesunpublish) -* [`csdx cm:entries:update-and-publish [-a ] [--retry-failed ] [--bulk-publish ] [--content-types ] [-t ] [-e ] [-c ] [-y] [--locales ] [--branch ]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value-1) -* [`csdx cm:stacks:export [-c ] [-k ] [-d ] [-a ] [--module ] [--content-types ] [--branch ] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets) -* [`csdx cm:export-to-csv`](#csdx-cmexport-to-csv) -* [`csdx cm:stacks:import [-c ] [-k ] [-d ] [-a ] [--module ] [--backup-dir ] [--branch ] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent) -* [`csdx cm:migrate-rte`](#csdx-cmmigrate-rte) -* [`csdx cm:stacks:migration [-k ] [-a ] [--file-path ] [--branch ] [--config-file ] [--config ] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple) -* [`csdx cm:stacks:seed [--repo ] [--org ] [-k ] [-n ] [-y ] [-s ]`](#csdx-cmstacksseed---repo-value---org-value--k-value--n-value--y-value--s-value) -* [`csdx cm:stacks:clone [--source-branch ] [--target-branch ] [--source-management-token-alias ] [--destination-management-token-alias ] [-n ] [--type a|b] [--source-stack-api-key ] [--destination-stack-api-key ] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent) -* [`csdx cm:stacks:clone [--source-branch ] [--target-branch ] [--source-management-token-alias ] [--destination-management-token-alias ] [-n ] [--type a|b] [--source-stack-api-key ] [--destination-stack-api-key ] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent-1) -* [`csdx cm:stacks:export [-c ] [-k ] [-d ] [-a ] [--module ] [--content-types ] [--branch ] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets-1) -* [`csdx cm:stacks:import [-c ] [-k ] [-d ] [-a ] [--module ] [--backup-dir ] [--branch ] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent-1) -* [`csdx cm:stacks:migration [-k ] [-a ] [--file-path ] [--branch ] [--config-file ] [--config ] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple-1) -* [`csdx cm:stacks:publish`](#csdx-cmstackspublish) -* [`csdx cm:stacks:publish-clear-logs`](#csdx-cmstackspublish-clear-logs) -* [`csdx cm:stacks:publish-configure`](#csdx-cmstackspublish-configure) -* [`csdx cm:stacks:publish-revert`](#csdx-cmstackspublish-revert) -* [`csdx cm:stacks:seed [--repo ] [--org ] [-k ] [-n ] [-y ] [-s ]`](#csdx-cmstacksseed---repo-value---org-value--k-value--n-value--y-value--s-value-1) -* [`csdx csdx cm:stacks:unpublish [-a ] [-e ] [-c ] [-y] [--locale ] [--branch ] [--retry-failed ] [--bulk-unpublish ] [--content-type ] [--delivery-token ] [--only-assets] [--only-entries]`](#csdx-csdx-cmstacksunpublish--a-value--e-value--c-value--y---locale-value---branch-value---retry-failed-value---bulk-unpublish-value---content-type-value---delivery-token-value---only-assets---only-entries-1) -* [`csdx config:get:base-branch`](#csdx-configgetbase-branch) -* [`csdx config:get:region`](#csdx-configgetregion) -* [`csdx config:remove:base-branch`](#csdx-configremovebase-branch) -* [`csdx config:set:base-branch`](#csdx-configsetbase-branch) -* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region) -* [`csdx help [COMMANDS]`](#csdx-help-commands) -* [`csdx launch`](#csdx-launch) -* [`csdx launch:deployments`](#csdx-launchdeployments) -* [`csdx launch:environments`](#csdx-launchenvironments) -* [`csdx launch:functions`](#csdx-launchfunctions) -* [`csdx launch:logs`](#csdx-launchlogs) -* [`csdx launch:open`](#csdx-launchopen) -* [`csdx login`](#csdx-login) -* [`csdx logout`](#csdx-logout) -* [`csdx plugins`](#csdx-plugins) -* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin) -* [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin) -* [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin-1) -* [`csdx plugins:link PLUGIN`](#csdx-pluginslink-plugin) -* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin) -* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-1) -* [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-2) -* [`csdx plugins:update`](#csdx-pluginsupdate) -* [`csdx tokens`](#csdx-tokens) -* [`csdx whoami`](#csdx-whoami) + +- [`csdx auth:login`](#csdx-authlogin) +- [`csdx auth:logout`](#csdx-authlogout) +- [`csdx auth:tokens`](#csdx-authtokens) +- [`csdx auth:tokens:add [-a ] [--delivery] [--management] [-e ] [-k ] [-y] [--token ]`](#csdx-authtokensadd--a-value---delivery---management--e-value--k-value--y---token-value) +- [`csdx auth:tokens:remove`](#csdx-authtokensremove) +- [`csdx auth:whoami`](#csdx-authwhoami) +- [`csdx cm:assets:publish [-a ] [--retry-failed ] [-e ] [--folder-uid ] [--bulk-publish ] [-c ] [-y] [--locales ] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmassetspublish--a-value---retry-failed-value--e-value---folder-uid-value---bulk-publish-value--c-value--y---locales-value---branch-value---delivery-token-value---source-env-value) +- [`csdx cm:assets:unpublish`](#csdx-cmassetsunpublish) +- [`csdx cm:bootstrap`](#csdx-cmbootstrap) +- [`csdx cm:branches`](#csdx-cmbranches) +- [`csdx cm:branches:create`](#csdx-cmbranchescreate) +- [`csdx cm:branches:delete [-uid ] [-k ]`](#csdx-cmbranchesdelete--uid-value--k-value) +- [`csdx cm:branches:diff [--base-branch ] [--compare-branch ] [-k ][--module ]`](#csdx-cmbranchesdiff---base-branch-value---compare-branch-value--k-value--module-value) +- [`csdx cm:branches:merge [-k ][--compare-branch ] [--no-revert] [--export-summary-path ] [--use-merge-summary ] [--comment ] [--base-branch ]`](#csdx-cmbranchesmerge--k-value--compare-branch-value---no-revert---export-summary-path-value---use-merge-summary-value---comment-value---base-branch-value) +- [`csdx cm:bulk-publish`](#csdx-cmbulk-publish) +- [`csdx cm:entries:update-and-publish [-a ] [--retry-failed ] [--bulk-publish ] [--content-types ] [-t ] [-e ] [-c ] [-y] [--locales ] [--branch ]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value) +- [`csdx cm:assets:publish [-a ] [--retry-failed ] [-e ] [--folder-uid ] [--bulk-publish ] [-c ] [-y] [--locales ] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmassetspublish--a-value---retry-failed-value--e-value---folder-uid-value---bulk-publish-value--c-value--y---locales-value---branch-value---delivery-token-value---source-env-value-1) +- [`csdx cm:bulk-publish:clear`](#csdx-cmbulk-publishclear) +- [`csdx cm:bulk-publish:configure`](#csdx-cmbulk-publishconfigure) +- [`csdx cm:bulk-publish:cross-publish [-a ] [--retry-failed ] [--bulk-publish ] [--content-type ] [--locales ] [--source-env ] [--environments ] [--delivery-token ] [-c ] [-y] [--branch ] [--onlyAssets] [--onlyEntries]`](#csdx-cmbulk-publishcross-publish--a-value---retry-failed-value---bulk-publish-value---content-type-value---locales-value---source-env-value---environments-value---delivery-token-value--c-value--y---branch-value---onlyassets---onlyentries) +- [`csdx cm:entries:publish [-a ] [--retry-failed ] [--bulk-publish ] [--publish-all-content-types] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value) +- [`csdx cm:entries:publish-modified [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value) +- [`csdx cm:entries:publish-non-localized-fields [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value) +- [`csdx cm:bulk-publish:revert`](#csdx-cmbulk-publishrevert) +- [`csdx csdx cm:stacks:unpublish [-a ] [-e ] [-c ] [-y] [--locale ] [--branch ] [--retry-failed ] [--bulk-unpublish ] [--content-type ] [--delivery-token ] [--only-assets] [--only-entries]`](#csdx-csdx-cmstacksunpublish--a-value--e-value--c-value--y---locale-value---branch-value---retry-failed-value---bulk-unpublish-value---content-type-value---delivery-token-value---only-assets---only-entries) +- [`csdx cm:entries:publish-only-unpublished [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-only-unpublished--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value) +- [`csdx cm:entries:migrate-html-rte`](#csdx-cmentriesmigrate-html-rte) +- [`csdx cm:entries:publish [-a ] [--retry-failed ] [--bulk-publish ] [--publish-all-content-types] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ] [--delivery-token ] [--source-env ]`](#csdx-cmentriespublish--a-value---retry-failed-value---bulk-publish-value---publish-all-content-types---content-types-value---locales-value--e-value--c-value--y---branch-value---delivery-token-value---source-env-value-1) +- [`csdx cm:entries:publish-modified [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-modified--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value-1) +- [`csdx cm:entries:publish-non-localized-fields [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-non-localized-fields--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value--e-value--c-value--y---branch-value-1) +- [`csdx cm:entries:publish-only-unpublished [-a ] [--retry-failed ] [--bulk-publish ] [--source-env ] [--content-types ] [--locales ] [-e ] [-c ] [-y] [--branch ]`](#csdx-cmentriespublish-only-unpublished--a-value---retry-failed-value---bulk-publish-value---source-env-value---content-types-value---locales-value--e-value--c-value--y---branch-value-1) +- [`csdx cm:entries:unpublish`](#csdx-cmentriesunpublish) +- [`csdx cm:entries:update-and-publish [-a ] [--retry-failed ] [--bulk-publish ] [--content-types ] [-t ] [-e ] [-c ] [-y] [--locales ] [--branch ]`](#csdx-cmentriesupdate-and-publish--a-value---retry-failed-value---bulk-publish-value---content-types-value--t-value--e-value--c-value--y---locales-value---branch-value-1) +- [`csdx cm:stacks:export [-c ] [-k ] [-d ] [-a ] [--module ] [--content-types ] [--branch ] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets) +- [`csdx cm:export-to-csv`](#csdx-cmexport-to-csv) +- [`csdx cm:stacks:import [-c ] [-k ] [-d ] [-a ] [--module ] [--backup-dir ] [--branch ] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent) +- [`csdx cm:migrate-rte`](#csdx-cmmigrate-rte) +- [`csdx cm:stacks:migration [-k ] [-a ] [--file-path ] [--branch ] [--config-file ] [--config ] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple) +- [`csdx cm:stacks:seed [--repo ] [--org ] [-k ] [-n ] [-y ] [-s ]`](#csdx-cmstacksseed---repo-value---org-value--k-value--n-value--y-value--s-value) +- [`csdx cm:stacks:clone [--source-branch ] [--target-branch ] [--source-management-token-alias ] [--destination-management-token-alias ] [-n ] [--type a|b] [--source-stack-api-key ] [--destination-stack-api-key ] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent) +- [`csdx cm:stacks:clone [--source-branch ] [--target-branch ] [--source-management-token-alias ] [--destination-management-token-alias ] [-n ] [--type a|b] [--source-stack-api-key ] [--destination-stack-api-key ] [--import-webhook-status disable|current]`](#csdx-cmstacksclone---source-branch-value---target-branch-value---source-management-token-alias-value---destination-management-token-alias-value--n-value---type-ab---source-stack-api-key-value---destination-stack-api-key-value---import-webhook-status-disablecurrent-1) +- [`csdx cm:stacks:export [-c ] [-k ] [-d ] [-a ] [--module ] [--content-types ] [--branch ] [--secured-assets]`](#csdx-cmstacksexport--c-value--k-value--d-value--a-value---module-value---content-types-value---branch-value---secured-assets-1) +- [`csdx cm:stacks:import [-c ] [-k ] [-d ] [-a ] [--module ] [--backup-dir ] [--branch ] [--import-webhook-status disable|current]`](#csdx-cmstacksimport--c-value--k-value--d-value--a-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent-1) +- [`csdx cm:stacks:migration [-k ] [-a ] [--file-path ] [--branch ] [--config-file ] [--config ] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple-1) +- [`csdx cm:stacks:publish`](#csdx-cmstackspublish) +- [`csdx cm:stacks:publish-clear-logs`](#csdx-cmstackspublish-clear-logs) +- [`csdx cm:stacks:publish-configure`](#csdx-cmstackspublish-configure) +- [`csdx cm:stacks:publish-revert`](#csdx-cmstackspublish-revert) +- [`csdx cm:stacks:seed [--repo ] [--org ] [-k ] [-n ] [-y ] [-s ]`](#csdx-cmstacksseed---repo-value---org-value--k-value--n-value--y-value--s-value-1) +- [`csdx csdx cm:stacks:unpublish [-a ] [-e ] [-c ] [-y] [--locale ] [--branch ] [--retry-failed ] [--bulk-unpublish ] [--content-type ] [--delivery-token ] [--only-assets] [--only-entries]`](#csdx-csdx-cmstacksunpublish--a-value--e-value--c-value--y---locale-value---branch-value---retry-failed-value---bulk-unpublish-value---content-type-value---delivery-token-value---only-assets---only-entries-1) +- [`csdx config:get:base-branch`](#csdx-configgetbase-branch) +- [`csdx config:get:region`](#csdx-configgetregion) +- [`csdx config:remove:base-branch`](#csdx-configremovebase-branch) +- [`csdx config:set:base-branch`](#csdx-configsetbase-branch) +- [`csdx config:set:region [REGION]`](#csdx-configsetregion-region) +- [`csdx help [COMMANDS]`](#csdx-help-commands) +- [`csdx launch`](#csdx-launch) +- [`csdx launch:deployments`](#csdx-launchdeployments) +- [`csdx launch:environments`](#csdx-launchenvironments) +- [`csdx launch:functions`](#csdx-launchfunctions) +- [`csdx launch:logs`](#csdx-launchlogs) +- [`csdx launch:open`](#csdx-launchopen) +- [`csdx login`](#csdx-login) +- [`csdx logout`](#csdx-logout) +- [`csdx plugins`](#csdx-plugins) +- [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin) +- [`csdx plugins:inspect PLUGIN...`](#csdx-pluginsinspect-plugin) +- [`csdx plugins:install PLUGIN...`](#csdx-pluginsinstall-plugin-1) +- [`csdx plugins:link PLUGIN`](#csdx-pluginslink-plugin) +- [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin) +- [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-1) +- [`csdx plugins:uninstall PLUGIN...`](#csdx-pluginsuninstall-plugin-2) +- [`csdx plugins:update`](#csdx-pluginsupdate) +- [`csdx tokens`](#csdx-tokens) +- [`csdx whoami`](#csdx-whoami) ## `csdx auth:login` @@ -2116,7 +2120,7 @@ EXAMPLES $ csdx cm:migration --config-file --file-path - $ csdx cm:migration --multiple --file-path + $ csdx cm:migration --multiple --file-path $ csdx cm:migration --alias --file-path -k ``` @@ -2381,7 +2385,7 @@ EXAMPLES $ csdx cm:migration --config-file --file-path - $ csdx cm:migration --multiple --file-path + $ csdx cm:migration --multiple --file-path $ csdx cm:migration --alias --file-path -k ``` @@ -3138,7 +3142,7 @@ ALIASES $ csdx plugins:add EXAMPLES - $ csdx plugins:install myplugin + $ csdx plugins:install myplugin $ csdx plugins:install https://github.com/someuser/someplugin @@ -3203,7 +3207,7 @@ ALIASES $ csdx plugins:add EXAMPLES - $ csdx plugins:install myplugin + $ csdx plugins:install myplugin $ csdx plugins:install https://github.com/someuser/someplugin @@ -3377,6 +3381,7 @@ ALIASES EXAMPLES $ csdx auth:whoami ``` + ```