Skip to content

Commit 1cf1dac

Browse files
committed
updated readme
1 parent 8f1b358 commit 1cf1dac

3 files changed

Lines changed: 27 additions & 201 deletions

File tree

packages/contentstack-auth/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-auth
1818
$ csdx COMMAND
1919
running command...
2020
$ csdx (--version)
21-
@contentstack/cli-auth/2.0.0-beta.4 darwin-arm64 node-v22.13.1
21+
@contentstack/cli-auth/2.0.0-beta.7 darwin-arm64 node-v22.13.1
2222
$ csdx --help [COMMAND]
2323
USAGE
2424
$ csdx COMMAND

packages/contentstack-config/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli-config
1818
$ csdx COMMAND
1919
running command...
2020
$ csdx (--version)
21-
@contentstack/cli-config/2.0.0-beta.2 darwin-arm64 node-v22.13.1
21+
@contentstack/cli-config/2.0.0-beta.3 darwin-arm64 node-v22.13.1
2222
$ csdx --help [COMMAND]
2323
USAGE
2424
$ csdx COMMAND

packages/contentstack/README.md

Lines changed: 25 additions & 199 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli
1818
$ csdx COMMAND
1919
running command...
2020
$ csdx (--version|-v)
21-
@contentstack/cli/2.0.0-beta.10 darwin-arm64 node-v22.13.1
21+
@contentstack/cli/2.0.0-beta.13 darwin-arm64 node-v22.13.1
2222
$ csdx --help [COMMAND]
2323
USAGE
2424
$ csdx COMMAND
@@ -41,8 +41,6 @@ USAGE
4141
* [`csdx cm:branches:delete [-uid <value>] [-k <value>]`](#csdx-cmbranchesdelete--uid-value--k-value)
4242
* [`csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>] [--format <value>] [--csv-path <value>]`](#csdx-cmbranchesdiff---base-branch-value---compare-branch-value--k-value--module-value---format-value---csv-path-value)
4343
* [`csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>] [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]`](#csdx-cmbranchesmerge--k-value--compare-branch-value---no-revert---export-summary-path-value---use-merge-summary-value---comment-value---base-branch-value)
44-
* [`csdx cm:export-to-csv`](#csdx-cmexport-to-csv)
45-
* [`csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple)
4644
* [`csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--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)
4745
* [`csdx cm:stacks:audit`](#csdx-cmstacksaudit)
4846
* [`csdx cm:stacks:audit:fix`](#csdx-cmstacksauditfix)
@@ -52,7 +50,6 @@ USAGE
5250
* [`csdx cm:stacks:export [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--content-types <value>] [--branch <value>] [--secured-assets]`](#csdx-cmstacksexport---config-value---stack-api-key-value---data-dir-value---alias-value---module-value---content-types-value---branch-value---secured-assets)
5351
* [`csdx cm:stacks:import [--config <value>] [--stack-api-key <value>] [--data-dir <value>] [--alias <value>] [--module <value>] [--backup-dir <value>] [--branch <value>] [--import-webhook-status disable|current]`](#csdx-cmstacksimport---config-value---stack-api-key-value---data-dir-value---alias-value---module-value---backup-dir-value---branch-value---import-webhook-status-disablecurrent)
5452
* [`csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]`](#csdx-cmstacksimport-setup--k-value--d-value--a-value---modules-valuevalue)
55-
* [`csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`](#csdx-cmstacksmigration--k-value--a-value---file-path-value---branch-value---config-file-value---config-value---multiple)
5653
* [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes <value>] [--alias <value>] [--locale <value>]`](#csdx-cmstacksseed---repo-value---org-value---stack-api-key-value---stack-name-value---yes-value---alias-value---locale-value)
5754
* [`csdx config:get:base-branch`](#csdx-configgetbase-branch)
5855
* [`csdx config:get:ea-header`](#csdx-configgetea-header)
@@ -492,142 +489,6 @@ EXAMPLES
492489

493490
_See code: [@contentstack/cli-cm-branches](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/merge.ts)_
494491

495-
## `csdx cm:export-to-csv`
496-
497-
Export entries, taxonomies, terms or organization users to csv using this command
498-
499-
```
500-
USAGE
501-
$ csdx cm:export-to-csv [--action entries|users|teams|taxonomies] [-a <value>] [--org <value>] [-n <value>] [-k
502-
<value>] [--org-name <value>] [--locale <value>] [--content-type <value>] [--branch <value>] [--team-uid <value>]
503-
[--taxonomy-uid <value>] [--include-fallback] [--fallback-locale <value>] [--delimiter <value>]
504-
505-
FLAGS
506-
-a, --alias=<value> Alias of the management token.
507-
-k, --stack-api-key=<value> API Key of the source stack.
508-
-n, --stack-name=<value> Name of the stack that needs to be created as CSV filename.
509-
--action=<option> Option to export data (entries, users, teams, taxonomies). <options:
510-
entries|users|teams|taxonomies>
511-
<options: entries|users|teams|taxonomies>
512-
--branch=<value> Branch from which entries will be exported.
513-
--content-type=<value> Content type of entries that will be exported.
514-
--delimiter=<value> [default: ,] [optional] Provide a delimiter to separate individual data fields within
515-
the CSV file. For example: cm:export-to-csv --delimiter '|'
516-
--fallback-locale=<value> [Optional] Specify a specific fallback locale for taxonomy export. This locale will be
517-
used when a taxonomy term doesn't exist in the primary locale. Takes priority over
518-
branch fallback hierarchy when both are specified.
519-
--include-fallback [Optional] Include fallback locale data when exporting taxonomies. When enabled, if a
520-
taxonomy term doesn't exist in the specified locale, it will fallback to the hierarchy
521-
defined in the branch settings.
522-
--locale=<value> Locale of entries that will be exported.
523-
--org=<value> Provide organization UID to clone org users.
524-
--org-name=<value> Name of the organization that needs to be created as CSV filename.
525-
--taxonomy-uid=<value> Provide the taxonomy UID of the related terms you want to export.
526-
--team-uid=<value> Provide the UID of a specific team in an organization.
527-
528-
DESCRIPTION
529-
Export entries, taxonomies, terms or organization users to csv using this command
530-
531-
ALIASES
532-
$ csdx cm:export-to-csv
533-
534-
EXAMPLES
535-
$ csdx cm:export-to-csv
536-
537-
538-
539-
Exporting entries to CSV
540-
541-
$ csdx cm:export-to-csv --action entries --locale <locale> --alias <management-token-alias> --content-type <content-type>
542-
543-
544-
545-
Exporting entries to CSV with stack name and branch
546-
547-
$ csdx cm:export-to-csv --action entries --locale <locale> --alias <management-token-alias> --content-type <content-type> --stack-name <stack-name> --branch <branch-name>
548-
549-
550-
551-
Exporting organization users to CSV
552-
553-
$ csdx cm:export-to-csv --action users --org <org-uid>
554-
555-
556-
557-
Exporting organization teams to CSV
558-
559-
$ csdx cm:export-to-csv --action teams --org <org-uid>
560-
561-
562-
563-
Exporting teams with specific team UID
564-
565-
$ csdx cm:export-to-csv --action teams --org <org-uid> --team-uid <team-uid>
566-
567-
568-
569-
Exporting taxonomies to CSV
570-
571-
$ csdx cm:export-to-csv --action taxonomies --alias <management-token-alias>
572-
573-
574-
575-
Exporting specific taxonomy with locale
576-
577-
$ csdx cm:export-to-csv --action taxonomies --alias <management-token-alias> --taxonomy-uid <taxonomy-uid> --locale <locale>
578-
579-
580-
581-
Exporting taxonomies with fallback locale
582-
583-
$ csdx cm:export-to-csv --action taxonomies --alias <management-token-alias> --locale <locale> --include-fallback --fallback-locale <fallback-locale>
584-
```
585-
586-
_See code: [@contentstack/cli-cm-export-to-csv](https://github.com/contentstack/cli/blob/main/packages/contentstack-export-to-csv/src/commands/cm/export-to-csv.ts)_
587-
588-
## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
589-
590-
Contentstack migration script.
591-
592-
```
593-
USAGE
594-
$ csdx cm:migration cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>]
595-
[--config-file <value>] [--config <value>] [--multiple]
596-
597-
FLAGS
598-
-a, --alias=<value> Use this flag to add the management token alias. You must use either the --alias flag or
599-
the --stack-api-key flag.
600-
-k, --stack-api-key=<value> Use this flag to add the API key of your stack. You must use either the --stack-api-key
601-
flag or the --alias flag.
602-
--branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
603-
branch name)
604-
--config=<value>... [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
605-
the script re-usable.
606-
--config-file=<value> [optional] Path of the JSON configuration file.
607-
--file-path=<value> Use this flag to provide the path of the file of the migration script.
608-
--multiple This flag helps you to migrate multiple content files in a single instance. Mention the
609-
folder path where your migration script files are stored.
610-
611-
DESCRIPTION
612-
Contentstack migration script.
613-
614-
ALIASES
615-
$ csdx cm:migration
616-
617-
EXAMPLES
618-
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>
619-
620-
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>
621-
622-
$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>
623-
624-
$ csdx cm:migration --config-file <path/to/json/config/file> --file-path <migration/script/file/path>
625-
626-
$ csdx cm:migration --multiple --file-path <migration/scripts/dir/path>
627-
628-
$ csdx cm:migration --alias <management-token-alias> --file-path <migration/script/file/path>
629-
```
630-
631492
## `csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`
632493

633494
Clone data (structure/content or both) of a stack into another stack
@@ -854,7 +715,7 @@ EXAMPLES
854715
$ csdx cm:stacks:bulk-assets --revert ./bulk-operation -a myAlias
855716
```
856717

857-
_See code: [@contentstack/cli-bulk-operations](https://github.com/contentstack/cli-bulk-operations/blob/v1.0.0-beta/src/commands/cm/stacks/bulk-assets.ts)_
718+
_See code: [@contentstack/cli-bulk-operations](https://github.com/contentstack/cli-bulk-operations/blob/v1.0.0/src/commands/cm/stacks/bulk-assets.ts)_
858719

859720
## `csdx cm:stacks:bulk-entries`
860721

@@ -927,14 +788,20 @@ EXAMPLES
927788
928789
$ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us --filter modified -k blt123
929790
791+
$ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us --filter draft -k blt123
792+
793+
$ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us --filter unpublished -k blt123
794+
795+
$ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --filter non-localized -k blt123
796+
930797
$ csdx cm:stacks:bulk-entries --operation publish --content-types blog --environments prod --locales en-us --include-variants -k blt123
931798
932799
$ csdx cm:stacks:bulk-entries --retry-failed ./bulk-operation
933800
934801
$ csdx cm:stacks:bulk-entries --revert ./bulk-operation
935802
```
936803

937-
_See code: [@contentstack/cli-bulk-operations](https://github.com/contentstack/cli-bulk-operations/blob/v1.0.0-beta/src/commands/cm/stacks/bulk-entries.ts)_
804+
_See code: [@contentstack/cli-bulk-operations](https://github.com/contentstack/cli-bulk-operations/blob/v1.0.0/src/commands/cm/stacks/bulk-entries.ts)_
938805

939806
## `csdx cm:stacks:clone [--source-branch <value>] [--target-branch <value>] [--source-management-token-alias <value>] [--destination-management-token-alias <value>] [-n <value>] [--type a|b] [--source-stack-api-key <value>] [--destination-stack-api-key <value>] [--import-webhook-status disable|current]`
940807

@@ -1167,51 +1034,6 @@ EXAMPLES
11671034

11681035
_See code: [@contentstack/cli-cm-import-setup](https://github.com/contentstack/cli/blob/main/packages/contentstack-import-setup/src/commands/cm/stacks/import-setup.ts)_
11691036

1170-
## `csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>] [--config <value>] [--multiple]`
1171-
1172-
Contentstack migration script.
1173-
1174-
```
1175-
USAGE
1176-
$ csdx cm:stacks:migration [-k <value>] [-a <value>] [--file-path <value>] [--branch <value>] [--config-file <value>]
1177-
[--config <value>] [--multiple]
1178-
1179-
FLAGS
1180-
-a, --alias=<value> Use this flag to add the management token alias. You must use either the --alias flag or
1181-
the --stack-api-key flag.
1182-
-k, --stack-api-key=<value> Use this flag to add the API key of your stack. You must use either the --stack-api-key
1183-
flag or the --alias flag.
1184-
--branch=<value> Use this flag to add the branch name where you want to perform the migration. (target
1185-
branch name)
1186-
--config=<value>... [optional] Inline configuration, <key1>:<value1>. Passing an external configuration makes
1187-
the script re-usable.
1188-
--config-file=<value> [optional] Path of the JSON configuration file.
1189-
--file-path=<value> Use this flag to provide the path of the file of the migration script.
1190-
--multiple This flag helps you to migrate multiple content files in a single instance. Mention the
1191-
folder path where your migration script files are stored.
1192-
1193-
DESCRIPTION
1194-
Contentstack migration script.
1195-
1196-
ALIASES
1197-
$ csdx cm:migration
1198-
1199-
EXAMPLES
1200-
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key>
1201-
1202-
$ csdx cm:migration --file-path <migration/script/file/path> -k <api-key> --branch <target branch name>
1203-
1204-
$ csdx cm:migration --config <key1>:<value1> <key2>:<value2> ... --file-path <migration/script/file/path>
1205-
1206-
$ csdx cm:migration --config-file <path/to/json/config/file> --file-path <migration/script/file/path>
1207-
1208-
$ csdx cm:migration --multiple --file-path <migration/scripts/dir/path>
1209-
1210-
$ csdx cm:migration --alias <management-token-alias> --file-path <migration/script/file/path>
1211-
```
1212-
1213-
_See code: [@contentstack/cli-migration](https://github.com/contentstack/cli/blob/main/packages/contentstack-migration/src/commands/cm/stacks/migration.ts)_
1214-
12151037
## `csdx cm:stacks:seed [--repo <value>] [--org <value>] [--stack-api-key <value>] [--stack-name <value>] [--yes <value>] [--alias <value>] [--locale <value>]`
12161038

12171039
Create a stack from existing content types, entries, assets, etc
@@ -1654,23 +1476,25 @@ Set region for CLI
16541476
```
16551477
USAGE
16561478
$ csdx config:set:region [REGION] [--cda <value> --cma <value> --ui-host <value> -n <value>] [--developer-hub
1657-
<value>] [--personalize <value>] [--launch <value>] [--studio <value>]
1479+
<value>] [--personalize <value>] [--launch <value>] [--studio <value>] [--asset-management <value>]
16581480
16591481
ARGUMENTS
16601482
[REGION] Name for the region
16611483
16621484
FLAGS
1663-
-n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are required
1664-
--cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host and
1665-
name flags are required
1666-
--cma=<value> Custom host to set for content management API, , if this flag is added then cda, ui-host
1667-
and name flags are required
1668-
--developer-hub=<value> Custom host to set for Developer hub API
1669-
--launch=<value> Custom host to set for Launch API
1670-
--personalize=<value> Custom host to set for Personalize API
1671-
--studio=<value> Custom host to set for Studio API
1672-
--ui-host=<value> Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
1673-
required
1485+
-n, --name=<value> Name for the region, if this flag is added then cda, cma and ui-host flags are
1486+
required
1487+
--asset-management=<value> Custom host to set for Asset Management API
1488+
--cda=<value> Custom host to set for content delivery API, if this flag is added then cma, ui-host
1489+
and name flags are required
1490+
--cma=<value> Custom host to set for content management API, , if this flag is added then cda,
1491+
ui-host and name flags are required
1492+
--developer-hub=<value> Custom host to set for Developer hub API
1493+
--launch=<value> Custom host to set for Launch API
1494+
--personalize=<value> Custom host to set for Personalize API
1495+
--studio=<value> Custom host to set for Studio API
1496+
--ui-host=<value> Custom UI host to set for CLI, if this flag is added then cda, cma and name flags are
1497+
required
16741498
16751499
DESCRIPTION
16761500
Set region for CLI
@@ -1702,6 +1526,8 @@ EXAMPLES
17021526
17031527
$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --studio <custom_studio_url>
17041528
1529+
$ csdx config:set:region --cma <custom_cma_host_url> --cda <custom_cda_host_url> --ui-host <custom_ui_host_url> --name "India" --asset-management <asset_management_url>
1530+
17051531
$ csdx config:set:region --cda <custom_cda_host_url> --cma <custom_cma_host_url> --ui-host <custom_ui_host_url> --name "India" --developer-hub <custom_developer_hub_url> --launch <custom_launch_url> --personalize <custom_personalize_url> --studio <custom_studio_url>
17061532
```
17071533

0 commit comments

Comments
 (0)