@contentstack/cli 1.33.0 → 1.35.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +63 -33
- package/oclif.manifest.json +1 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli
|
|
|
18
18
|
$ csdx COMMAND
|
|
19
19
|
running command...
|
|
20
20
|
$ csdx (--version|-v)
|
|
21
|
-
@contentstack/cli/1.
|
|
21
|
+
@contentstack/cli/1.35.0 linux-x64 node-v18.20.6
|
|
22
22
|
$ csdx --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ csdx COMMAND
|
|
@@ -2375,27 +2375,37 @@ EXAMPLES
|
|
|
2375
2375
|
|
|
2376
2376
|
## `csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]`
|
|
2377
2377
|
|
|
2378
|
-
|
|
2378
|
+
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
2379
2379
|
|
|
2380
2380
|
```
|
|
2381
2381
|
USAGE
|
|
2382
2382
|
$ csdx cm:import-setup cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
|
|
2383
2383
|
|
|
2384
2384
|
FLAGS
|
|
2385
|
-
-
|
|
2386
|
-
|
|
2385
|
+
-B, --branch=<value> The name of the branch where you want to import your content. If you don't mention the
|
|
2386
|
+
branch name, then by default the content will be imported to the main branch.
|
|
2387
|
+
-a, --alias=<value> The management token of the destination stack where you will import the content.
|
|
2388
|
+
-d, --data-dir=<value> The path or the location in your file system where the content, you intend to import, is
|
|
2389
|
+
stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
|
|
2390
|
+
branches involved, then the path should point till the particular branch. For example,
|
|
2391
|
+
“-d "C:\Users\Name\Desktop\cli\content\branch_name"
|
|
2387
2392
|
-k, --stack-api-key=<value> API key of the target stack
|
|
2388
|
-
--
|
|
2389
|
-
|
|
2393
|
+
--module=<option>... [optional] Specify the modules/module to import into the target stack. currently options
|
|
2394
|
+
are global-fields, content-types, entries
|
|
2395
|
+
<options: global-fields|content-types|entries>
|
|
2390
2396
|
|
|
2391
2397
|
DESCRIPTION
|
|
2392
|
-
|
|
2398
|
+
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
2393
2399
|
|
|
2394
2400
|
ALIASES
|
|
2395
2401
|
$ csdx cm:import-setup
|
|
2396
2402
|
|
|
2397
2403
|
EXAMPLES
|
|
2398
|
-
$ csdx cm:stacks:import-setup --stack-api-key <
|
|
2404
|
+
$ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
|
|
2405
|
+
|
|
2406
|
+
$ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>
|
|
2407
|
+
|
|
2408
|
+
$ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>
|
|
2399
2409
|
```
|
|
2400
2410
|
|
|
2401
2411
|
## `csdx cm:migrate-rte`
|
|
@@ -2858,27 +2868,37 @@ _See code: [@contentstack/cli-cm-import](https://github.com/contentstack/cli/blo
|
|
|
2858
2868
|
|
|
2859
2869
|
## `csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]`
|
|
2860
2870
|
|
|
2861
|
-
|
|
2871
|
+
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
2862
2872
|
|
|
2863
2873
|
```
|
|
2864
2874
|
USAGE
|
|
2865
2875
|
$ csdx cm:stacks:import-setup [-k <value>] [-d <value>] [-a <value>] [--modules <value,value>]
|
|
2866
2876
|
|
|
2867
2877
|
FLAGS
|
|
2868
|
-
-
|
|
2869
|
-
|
|
2878
|
+
-B, --branch=<value> The name of the branch where you want to import your content. If you don't mention the
|
|
2879
|
+
branch name, then by default the content will be imported to the main branch.
|
|
2880
|
+
-a, --alias=<value> The management token of the destination stack where you will import the content.
|
|
2881
|
+
-d, --data-dir=<value> The path or the location in your file system where the content, you intend to import, is
|
|
2882
|
+
stored. For example, -d "C:\Users\Name\Desktop\cli\content". If the export folder has
|
|
2883
|
+
branches involved, then the path should point till the particular branch. For example,
|
|
2884
|
+
“-d "C:\Users\Name\Desktop\cli\content\branch_name"
|
|
2870
2885
|
-k, --stack-api-key=<value> API key of the target stack
|
|
2871
|
-
--
|
|
2872
|
-
|
|
2886
|
+
--module=<option>... [optional] Specify the modules/module to import into the target stack. currently options
|
|
2887
|
+
are global-fields, content-types, entries
|
|
2888
|
+
<options: global-fields|content-types|entries>
|
|
2873
2889
|
|
|
2874
2890
|
DESCRIPTION
|
|
2875
|
-
|
|
2891
|
+
Helps to generate mappers and backup folder for importing (overwriting) specific modules
|
|
2876
2892
|
|
|
2877
2893
|
ALIASES
|
|
2878
2894
|
$ csdx cm:import-setup
|
|
2879
2895
|
|
|
2880
2896
|
EXAMPLES
|
|
2881
|
-
$ csdx cm:stacks:import-setup --stack-api-key <
|
|
2897
|
+
$ csdx cm:stacks:import-setup --stack-api-key <target_stack_api_key> --data-dir <path/of/export/destination/dir> --modules <module_name, module_name>
|
|
2898
|
+
|
|
2899
|
+
$ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name>
|
|
2900
|
+
|
|
2901
|
+
$ csdx cm:stacks:import-setup -k <target_stack_api_key> -d <path/of/export/destination/dir> --modules <module_name, module_name> -b <branch_name>
|
|
2882
2902
|
```
|
|
2883
2903
|
|
|
2884
2904
|
_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)_
|
|
@@ -3581,8 +3601,9 @@ Launch related operations
|
|
|
3581
3601
|
USAGE
|
|
3582
3602
|
$ csdx launch [--type GitHub|FileUpload] [--framework Gatsby|NextJs|CRA (Create React App)|CSR
|
|
3583
3603
|
(Client-Side Rendered)|Angular|VueJs|Other] [--org <value>] [-n <value>] [-e <value>] [--branch <value>]
|
|
3584
|
-
[--build-command <value>] [--out-dir <value>] [--variable-type Import variables from a
|
|
3585
|
-
variables to the list|Import variables from the local env file] [-a <value>]
|
|
3604
|
+
[--build-command <value>] [--out-dir <value>] [--server-command <value>] [--variable-type Import variables from a
|
|
3605
|
+
stack|Manually add custom variables to the list|Import variables from the local env file] [-a <value>]
|
|
3606
|
+
[--env-variables <value>] [--redeploy-latest] [--redeploy-last-upload]
|
|
3586
3607
|
|
|
3587
3608
|
FLAGS
|
|
3588
3609
|
-a, --alias=<value> [optional] Alias (name) for the delivery token.
|
|
@@ -3597,6 +3618,9 @@ FLAGS
|
|
|
3597
3618
|
Rendered)|Angular|VueJs|Other>
|
|
3598
3619
|
--org=<value> [optional] Provide the organization UID to create a new project or deployment.
|
|
3599
3620
|
--out-dir=<value> [optional] Output Directory.
|
|
3621
|
+
--redeploy-last-upload [optional] Redeploy with last file upload
|
|
3622
|
+
--redeploy-latest [optional] Redeploy latest commit/code
|
|
3623
|
+
--server-command=<value> [optional] Server Command.
|
|
3600
3624
|
--type=<option> [optional] Type of adapters. <options: GitHub|FileUpload>
|
|
3601
3625
|
<options: GitHub|FileUpload>
|
|
3602
3626
|
--variable-type=<option> [optional] Provide a variable type. <options: Import variables from a stack|Manually add
|
|
@@ -3618,16 +3642,22 @@ EXAMPLES
|
|
|
3618
3642
|
|
|
3619
3643
|
$ csdx launch --data-dir <path/of/current/working/dir> --type <options: GitHub|FileUpload>
|
|
3620
3644
|
|
|
3645
|
+
$ csdx launch --data-dir <path/of/current/working/dir> --redeploy-latest
|
|
3646
|
+
|
|
3647
|
+
$ csdx launch --data-dir <path/of/current/working/dir> --redeploy-latest --redeploy-last-upload
|
|
3648
|
+
|
|
3621
3649
|
$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload>
|
|
3622
3650
|
|
|
3623
3651
|
$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value>
|
|
3624
3652
|
|
|
3653
|
+
$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --server-command=<value>
|
|
3654
|
+
|
|
3625
3655
|
$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --variable-type="Import variables from a stack" --alias=<value>
|
|
3626
3656
|
|
|
3627
3657
|
$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload> --name=<value> --environment=<value> --branch=<value> --build-command=<value> --framework=<option> --org=<value> --out-dir=<value> --variable-type="Manually add custom variables to the list" --env-variables="APP_ENV:prod, TEST_ENV:testVal"
|
|
3628
3658
|
```
|
|
3629
3659
|
|
|
3630
|
-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/src/commands/launch/index.ts)_
|
|
3660
|
+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/index.ts)_
|
|
3631
3661
|
|
|
3632
3662
|
## `csdx launch:deployments`
|
|
3633
3663
|
|
|
@@ -3655,7 +3685,7 @@ EXAMPLES
|
|
|
3655
3685
|
$ csdx launch:deployments -e "environment number or uid" --org=<org UID> --project=<Project UID>
|
|
3656
3686
|
```
|
|
3657
3687
|
|
|
3658
|
-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/src/commands/launch/deployments.ts)_
|
|
3688
|
+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/deployments.ts)_
|
|
3659
3689
|
|
|
3660
3690
|
## `csdx launch:environments`
|
|
3661
3691
|
|
|
@@ -3682,7 +3712,7 @@ EXAMPLES
|
|
|
3682
3712
|
$ csdx launch:environments --org=<org UID> --project=<Project UID>
|
|
3683
3713
|
```
|
|
3684
3714
|
|
|
3685
|
-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/src/commands/launch/environments.ts)_
|
|
3715
|
+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/environments.ts)_
|
|
3686
3716
|
|
|
3687
3717
|
## `csdx launch:functions`
|
|
3688
3718
|
|
|
@@ -3712,7 +3742,7 @@ EXAMPLES
|
|
|
3712
3742
|
$ csdx launch:functions --config <path/to/launch/config/file> --port=port
|
|
3713
3743
|
```
|
|
3714
3744
|
|
|
3715
|
-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/src/commands/launch/functions.ts)_
|
|
3745
|
+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/functions.ts)_
|
|
3716
3746
|
|
|
3717
3747
|
## `csdx launch:logs`
|
|
3718
3748
|
|
|
@@ -3756,7 +3786,7 @@ EXAMPLES
|
|
|
3756
3786
|
$ csdx launch:logs --environment=environment --config <path/to/launch/config/file> --deployment=deployment
|
|
3757
3787
|
```
|
|
3758
3788
|
|
|
3759
|
-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/src/commands/launch/logs.ts)_
|
|
3789
|
+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/logs.ts)_
|
|
3760
3790
|
|
|
3761
3791
|
## `csdx launch:open`
|
|
3762
3792
|
|
|
@@ -3788,7 +3818,7 @@ EXAMPLES
|
|
|
3788
3818
|
$ csdx launch:open --environment=environment --data-dir <path/of/current/working/dir>
|
|
3789
3819
|
```
|
|
3790
3820
|
|
|
3791
|
-
_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/src/commands/launch/open.ts)_
|
|
3821
|
+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/open.ts)_
|
|
3792
3822
|
|
|
3793
3823
|
## `csdx login`
|
|
3794
3824
|
|
|
@@ -3867,7 +3897,7 @@ EXAMPLES
|
|
|
3867
3897
|
$ csdx plugins
|
|
3868
3898
|
```
|
|
3869
3899
|
|
|
3870
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3900
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.30/src/commands/plugins/index.ts)_
|
|
3871
3901
|
|
|
3872
3902
|
## `csdx plugins:add PLUGIN`
|
|
3873
3903
|
|
|
@@ -3941,7 +3971,7 @@ EXAMPLES
|
|
|
3941
3971
|
$ csdx plugins:inspect myplugin
|
|
3942
3972
|
```
|
|
3943
3973
|
|
|
3944
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
3974
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.30/src/commands/plugins/inspect.ts)_
|
|
3945
3975
|
|
|
3946
3976
|
## `csdx plugins:install PLUGIN`
|
|
3947
3977
|
|
|
@@ -3990,7 +4020,7 @@ EXAMPLES
|
|
|
3990
4020
|
$ csdx plugins:install someuser/someplugin
|
|
3991
4021
|
```
|
|
3992
4022
|
|
|
3993
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
4023
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.30/src/commands/plugins/install.ts)_
|
|
3994
4024
|
|
|
3995
4025
|
## `csdx plugins:link PATH`
|
|
3996
4026
|
|
|
@@ -4021,7 +4051,7 @@ EXAMPLES
|
|
|
4021
4051
|
$ csdx plugins:link myplugin
|
|
4022
4052
|
```
|
|
4023
4053
|
|
|
4024
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
4054
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.30/src/commands/plugins/link.ts)_
|
|
4025
4055
|
|
|
4026
4056
|
## `csdx plugins:remove [PLUGIN]`
|
|
4027
4057
|
|
|
@@ -4062,7 +4092,7 @@ FLAGS
|
|
|
4062
4092
|
--reinstall Reinstall all plugins after uninstalling.
|
|
4063
4093
|
```
|
|
4064
4094
|
|
|
4065
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
4095
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.30/src/commands/plugins/reset.ts)_
|
|
4066
4096
|
|
|
4067
4097
|
## `csdx plugins:uninstall [PLUGIN]`
|
|
4068
4098
|
|
|
@@ -4090,7 +4120,7 @@ EXAMPLES
|
|
|
4090
4120
|
$ csdx plugins:uninstall myplugin
|
|
4091
4121
|
```
|
|
4092
4122
|
|
|
4093
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
4123
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.30/src/commands/plugins/uninstall.ts)_
|
|
4094
4124
|
|
|
4095
4125
|
## `csdx plugins:unlink [PLUGIN]`
|
|
4096
4126
|
|
|
@@ -4134,7 +4164,7 @@ DESCRIPTION
|
|
|
4134
4164
|
Update installed plugins.
|
|
4135
4165
|
```
|
|
4136
4166
|
|
|
4137
|
-
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.
|
|
4167
|
+
_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.30/src/commands/plugins/update.ts)_
|
|
4138
4168
|
|
|
4139
4169
|
## `csdx tokens`
|
|
4140
4170
|
|
|
@@ -4168,7 +4198,7 @@ EXAMPLES
|
|
|
4168
4198
|
|
|
4169
4199
|
## `csdx tsgen`
|
|
4170
4200
|
|
|
4171
|
-
|
|
4201
|
+
Generate TypeScript typings from a Stack
|
|
4172
4202
|
|
|
4173
4203
|
```
|
|
4174
4204
|
USAGE
|
|
@@ -4188,7 +4218,7 @@ FLAGS
|
|
|
4188
4218
|
types.
|
|
4189
4219
|
|
|
4190
4220
|
DESCRIPTION
|
|
4191
|
-
|
|
4221
|
+
Generate TypeScript typings from a Stack
|
|
4192
4222
|
|
|
4193
4223
|
EXAMPLES
|
|
4194
4224
|
$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts"
|
|
@@ -4202,7 +4232,7 @@ EXAMPLES
|
|
|
4202
4232
|
$ csdx tsgen -a "delivery token alias" -o "contentstack/generated.d.ts" --api-type graphql --namespace "GraphQL"
|
|
4203
4233
|
```
|
|
4204
4234
|
|
|
4205
|
-
_See code: [contentstack-cli-tsgen](https://github.com/Contentstack-Solutions/contentstack-cli-tsgen/blob/v3.0
|
|
4235
|
+
_See code: [contentstack-cli-tsgen](https://github.com/Contentstack-Solutions/contentstack-cli-tsgen/blob/v3.1.0/src/commands/tsgen.ts)_
|
|
4206
4236
|
|
|
4207
4237
|
## `csdx whoami`
|
|
4208
4238
|
|
package/oclif.manifest.json
CHANGED
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@contentstack/cli",
|
|
3
3
|
"description": "Command-line tool (CLI) to interact with Contentstack",
|
|
4
|
-
"version": "1.
|
|
4
|
+
"version": "1.35.0",
|
|
5
5
|
"author": "Contentstack",
|
|
6
6
|
"bin": {
|
|
7
7
|
"csdx": "./bin/run.js"
|
|
@@ -31,12 +31,12 @@
|
|
|
31
31
|
"@contentstack/cli-cm-export": "~1.14.1",
|
|
32
32
|
"@contentstack/cli-cm-export-to-csv": "~1.7.3",
|
|
33
33
|
"@contentstack/cli-cm-import": "~1.19.3",
|
|
34
|
-
"@contentstack/cli-cm-import-setup": "1.0.0
|
|
34
|
+
"@contentstack/cli-cm-import-setup": "1.0.0",
|
|
35
35
|
"@contentstack/cli-cm-migrate-rte": "~1.4.20",
|
|
36
36
|
"@contentstack/cli-cm-seed": "~1.10.0",
|
|
37
37
|
"@contentstack/cli-command": "~1.3.2",
|
|
38
38
|
"@contentstack/cli-config": "~1.9.0",
|
|
39
|
-
"@contentstack/cli-launch": "
|
|
39
|
+
"@contentstack/cli-launch": "^1.4.1",
|
|
40
40
|
"@contentstack/cli-migration": "~1.6.4",
|
|
41
41
|
"@contentstack/cli-utilities": "~1.8.0",
|
|
42
42
|
"@contentstack/cli-variants": "~1.1.4",
|