@contentstack/cli 1.5.2 → 1.7.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 +464 -2
- package/bin/dev +2 -2
- package/bin/run +2 -2
- package/oclif.manifest.json +1 -1
- package/package.json +25 -18
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @contentstack/cli
|
|
2
2
|
|
|
3
|
-
Use Contentstack Command-line Interface to command Contentstack for executing a set of operations from the terminal. To get started with CLI, refer to the
|
|
3
|
+
Use Contentstack Command-line Interface to command Contentstack for executing a set of operations from the terminal. To get started with CLI, refer to the [CLI’s documentation](https://www.contentstack.com/docs/developers/cli)
|
|
4
4
|
|
|
5
5
|
[](https://github.com/contentstack/cli/blob/main/LICENSE)
|
|
6
6
|
|
|
@@ -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.7.0 linux-x64 node-v16.20.0
|
|
22
22
|
$ csdx --help [COMMAND]
|
|
23
23
|
USAGE
|
|
24
24
|
$ csdx COMMAND
|
|
@@ -38,6 +38,11 @@ USAGE
|
|
|
38
38
|
* [`csdx cm:assets:publish [-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-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)
|
|
39
39
|
* [`csdx cm:assets:unpublish`](#csdx-cmassetsunpublish)
|
|
40
40
|
* [`csdx cm:bootstrap`](#csdx-cmbootstrap)
|
|
41
|
+
* [`csdx cm:branches`](#csdx-cmbranches)
|
|
42
|
+
* [`csdx cm:branches:create`](#csdx-cmbranchescreate)
|
|
43
|
+
* [`csdx cm:branches:delete [-uid <value>] [-k <value>]`](#csdx-cmbranchesdelete--uid-value--k-value)
|
|
44
|
+
* [`csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]`](#csdx-cmbranchesdiff---base-branch-value---compare-branch-value--k-value--module-value)
|
|
45
|
+
* [`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)
|
|
41
46
|
* [`csdx cm:bulk-publish`](#csdx-cmbulk-publish)
|
|
42
47
|
* [`csdx cm:entries:update-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-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)
|
|
43
48
|
* [`csdx cm:assets:publish [-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-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)
|
|
@@ -74,9 +79,18 @@ USAGE
|
|
|
74
79
|
* [`csdx cm:stacks:publish-revert`](#csdx-cmstackspublish-revert)
|
|
75
80
|
* [`csdx cm:stacks:seed [--repo <value>] [--org <value>] [-k <value>] [-n <value>] [-y <value>] [-s <value>]`](#csdx-cmstacksseed---repo-value---org-value--k-value--n-value--y-value--s-value-1)
|
|
76
81
|
* [`csdx csdx cm:stacks:unpublish [-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-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)
|
|
82
|
+
* [`csdx config:get:base-branch`](#csdx-configgetbase-branch)
|
|
77
83
|
* [`csdx config:get:region`](#csdx-configgetregion)
|
|
84
|
+
* [`csdx config:remove:base-branch`](#csdx-configremovebase-branch)
|
|
85
|
+
* [`csdx config:set:base-branch`](#csdx-configsetbase-branch)
|
|
78
86
|
* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
|
|
79
87
|
* [`csdx help [COMMANDS]`](#csdx-help-commands)
|
|
88
|
+
* [`csdx launch`](#csdx-launch)
|
|
89
|
+
* [`csdx launch:deployments`](#csdx-launchdeployments)
|
|
90
|
+
* [`csdx launch:environments`](#csdx-launchenvironments)
|
|
91
|
+
* [`csdx launch:functions`](#csdx-launchfunctions)
|
|
92
|
+
* [`csdx launch:logs`](#csdx-launchlogs)
|
|
93
|
+
* [`csdx launch:open`](#csdx-launchopen)
|
|
80
94
|
* [`csdx login`](#csdx-login)
|
|
81
95
|
* [`csdx logout`](#csdx-logout)
|
|
82
96
|
* [`csdx plugins`](#csdx-plugins)
|
|
@@ -439,6 +453,175 @@ EXAMPLES
|
|
|
439
453
|
|
|
440
454
|
_See code: [@contentstack/cli-cm-bootstrap](https://github.com/contentstack/cli/blob/main/packages/contentstack-bootstrap/src/commands/cm/bootstrap.ts)_
|
|
441
455
|
|
|
456
|
+
## `csdx cm:branches`
|
|
457
|
+
|
|
458
|
+
List the branches
|
|
459
|
+
|
|
460
|
+
```
|
|
461
|
+
USAGE
|
|
462
|
+
$ csdx cm:branches
|
|
463
|
+
|
|
464
|
+
FLAGS
|
|
465
|
+
-k, --stack-api-key=<value> Stack API Key
|
|
466
|
+
--verbose Verbose
|
|
467
|
+
|
|
468
|
+
DESCRIPTION
|
|
469
|
+
List the branches
|
|
470
|
+
|
|
471
|
+
EXAMPLES
|
|
472
|
+
$ csdx cm:branches
|
|
473
|
+
|
|
474
|
+
$ csdx cm:branches --verbose
|
|
475
|
+
|
|
476
|
+
$ csdx cm:branches -k <stack api key>
|
|
477
|
+
```
|
|
478
|
+
|
|
479
|
+
_See code: [@contentstack/cli-cm-branches](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/index.ts)_
|
|
480
|
+
|
|
481
|
+
## `csdx cm:branches:create`
|
|
482
|
+
|
|
483
|
+
Create a new branch
|
|
484
|
+
|
|
485
|
+
```
|
|
486
|
+
USAGE
|
|
487
|
+
$ csdx cm:branches:create
|
|
488
|
+
$ csdx cm:branches:create [--source <value>] [--uid <value>] [-k <value>]
|
|
489
|
+
$ csdx cm:branches:create [--source <value>] [--uid <value>] [--stack-api-key <value>]
|
|
490
|
+
|
|
491
|
+
FLAGS
|
|
492
|
+
-k, --stack-api-key=<value> Stack API key
|
|
493
|
+
--source=<value> Source branch from which new branch to be created
|
|
494
|
+
--uid=<value> Branch UID to be created
|
|
495
|
+
|
|
496
|
+
DESCRIPTION
|
|
497
|
+
Create a new branch
|
|
498
|
+
|
|
499
|
+
EXAMPLES
|
|
500
|
+
$ csdx cm:branches:create
|
|
501
|
+
|
|
502
|
+
$ csdx cm:branches:create --source main -uid new_branch -k bltxxxxxxxx
|
|
503
|
+
|
|
504
|
+
$ csdx cm:branches:create --source main --uid new_branch --stack-api-key bltxxxxxxxx
|
|
505
|
+
```
|
|
506
|
+
|
|
507
|
+
_See code: [@contentstack/cli-cm-branches](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/create.ts)_
|
|
508
|
+
|
|
509
|
+
## `csdx cm:branches:delete [-uid <value>] [-k <value>]`
|
|
510
|
+
|
|
511
|
+
Delete a branch
|
|
512
|
+
|
|
513
|
+
```
|
|
514
|
+
USAGE
|
|
515
|
+
$ csdx cm:branches:delete [-uid <value>] [-k <value>]
|
|
516
|
+
$ csdx cm:branches:delete [--uid <value>] [--stack-api-key <value>]
|
|
517
|
+
|
|
518
|
+
FLAGS
|
|
519
|
+
-k, --stack-api-key=<value> Stack API key
|
|
520
|
+
-y, --yes Force the deletion of the branch by skipping the confirmation
|
|
521
|
+
--uid=<value> Branch UID to be deleted
|
|
522
|
+
|
|
523
|
+
DESCRIPTION
|
|
524
|
+
Delete a branch
|
|
525
|
+
|
|
526
|
+
EXAMPLES
|
|
527
|
+
$ csdx cm:branches:delete
|
|
528
|
+
|
|
529
|
+
$ csdx cm:branches:delete --uid main -k bltxxxxxxxx
|
|
530
|
+
|
|
531
|
+
$ csdx cm:branches:delete --uid main --stack-api-key bltxxxxxxxx
|
|
532
|
+
|
|
533
|
+
$ csdx cm:branches:delete --uid main --stack-api-key bltxxxxxxxx --yes
|
|
534
|
+
```
|
|
535
|
+
|
|
536
|
+
_See code: [@contentstack/cli-cm-branches](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/delete.ts)_
|
|
537
|
+
|
|
538
|
+
## `csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]`
|
|
539
|
+
|
|
540
|
+
Differences between two branches
|
|
541
|
+
|
|
542
|
+
```
|
|
543
|
+
USAGE
|
|
544
|
+
$ csdx cm:branches:diff [--base-branch <value>] [--compare-branch <value>] [-k <value>][--module <value>]
|
|
545
|
+
|
|
546
|
+
FLAGS
|
|
547
|
+
-k, --stack-api-key=<value> Provide Stack API key to show difference between branches
|
|
548
|
+
--base-branch=<value> Base branch
|
|
549
|
+
--compare-branch=<value> Compare branch
|
|
550
|
+
--format=<option> [default: compact-text] [Optional] Type of flags to show branches differences
|
|
551
|
+
<options: compact-text|detailed-text>
|
|
552
|
+
--module=<option> Module
|
|
553
|
+
<options: content-types|global-fields|all>
|
|
554
|
+
|
|
555
|
+
DESCRIPTION
|
|
556
|
+
Differences between two branches
|
|
557
|
+
|
|
558
|
+
EXAMPLES
|
|
559
|
+
$ csdx cm:branches:diff
|
|
560
|
+
|
|
561
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx"
|
|
562
|
+
|
|
563
|
+
$ csdx cm:branches:diff --compare-branch "develop"
|
|
564
|
+
|
|
565
|
+
$ csdx cm:branches:diff --compare-branch "develop" --stack-api-key "bltxxxxxxxx"
|
|
566
|
+
|
|
567
|
+
$ csdx cm:branches:diff --compare-branch "develop" --module "content-types"
|
|
568
|
+
|
|
569
|
+
$ csdx cm:branches:diff --module "content-types" --format "detailed-text"
|
|
570
|
+
|
|
571
|
+
$ csdx cm:branches:diff --compare-branch "develop" --format "detailed-text"
|
|
572
|
+
|
|
573
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main"
|
|
574
|
+
|
|
575
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop"
|
|
576
|
+
|
|
577
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --module "content-types"
|
|
578
|
+
|
|
579
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types"
|
|
580
|
+
|
|
581
|
+
$ csdx cm:branches:diff --stack-api-key "bltxxxxxxxx" --base-branch "main" --compare-branch "develop" --module "content-types" --format "detailed-text"
|
|
582
|
+
```
|
|
583
|
+
|
|
584
|
+
_See code: [@contentstack/cli-cm-branches](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/diff.ts)_
|
|
585
|
+
|
|
586
|
+
## `csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>] [--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]`
|
|
587
|
+
|
|
588
|
+
Merge changes from a branch
|
|
589
|
+
|
|
590
|
+
```
|
|
591
|
+
USAGE
|
|
592
|
+
$ csdx cm:branches:merge [-k <value>][--compare-branch <value>] [--no-revert] [--export-summary-path <value>]
|
|
593
|
+
[--use-merge-summary <value>] [--comment <value>] [--base-branch <value>]
|
|
594
|
+
|
|
595
|
+
FLAGS
|
|
596
|
+
-k, --stack-api-key=<value> Provide Stack API key to show difference between branches
|
|
597
|
+
--base-branch=<value> Base branch
|
|
598
|
+
--comment=<value> Merge comment
|
|
599
|
+
--compare-branch=<value> Compare branch name
|
|
600
|
+
--export-summary-path=<value> Export summary file path
|
|
601
|
+
--no-revert If passed, will not create the new revert branch
|
|
602
|
+
--use-merge-summary=<value> Path of merge summary file
|
|
603
|
+
|
|
604
|
+
DESCRIPTION
|
|
605
|
+
Merge changes from a branch
|
|
606
|
+
|
|
607
|
+
EXAMPLES
|
|
608
|
+
$ csdx cm:branches:merge --stack-api-key bltxxxxxxxx --compare-branch feature-branch
|
|
609
|
+
|
|
610
|
+
$ csdx cm:branches:merge --stack-api-key bltxxxxxxxx --comment "merge comment"
|
|
611
|
+
|
|
612
|
+
$ csdx cm:branches:merge -k bltxxxxxxxx --base-branch base-branch
|
|
613
|
+
|
|
614
|
+
$ csdx cm:branches:merge --export-summary-path file/path
|
|
615
|
+
|
|
616
|
+
$ csdx cm:branches:merge --use-merge-summary file-path
|
|
617
|
+
|
|
618
|
+
$ csdx cm:branches:merge -k bltxxxxxxxx --no-revert
|
|
619
|
+
|
|
620
|
+
$ csdx cm:branches:merge -k bltxxxxxxxx --compare-branch feature-branch --no-revert
|
|
621
|
+
```
|
|
622
|
+
|
|
623
|
+
_See code: [@contentstack/cli-cm-branches](https://github.com/contentstack/cli/blob/main/packages/contentstack-export/src/commands/cm/branches/merge.ts)_
|
|
624
|
+
|
|
442
625
|
## `csdx cm:bulk-publish`
|
|
443
626
|
|
|
444
627
|
Bulk Publish script for managing entries and assets
|
|
@@ -2338,6 +2521,23 @@ EXAMPLES
|
|
|
2338
2521
|
|
|
2339
2522
|
_See code: [@contentstack/cli-cm-bulk-publish](https://github.com/contentstack/cli/blob/main/packages/contentstack-bulk-publish/src/commands/cm/stacks/unpublish.js)_
|
|
2340
2523
|
|
|
2524
|
+
## `csdx config:get:base-branch`
|
|
2525
|
+
|
|
2526
|
+
Get current branch set for CLI
|
|
2527
|
+
|
|
2528
|
+
```
|
|
2529
|
+
USAGE
|
|
2530
|
+
$ csdx config:get:base-branch
|
|
2531
|
+
|
|
2532
|
+
DESCRIPTION
|
|
2533
|
+
Get current branch set for CLI
|
|
2534
|
+
|
|
2535
|
+
EXAMPLES
|
|
2536
|
+
$ csdx config:get:base-branch
|
|
2537
|
+
```
|
|
2538
|
+
|
|
2539
|
+
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/base-branch.ts)_
|
|
2540
|
+
|
|
2341
2541
|
## `csdx config:get:region`
|
|
2342
2542
|
|
|
2343
2543
|
Get current region set for CLI
|
|
@@ -2355,6 +2555,52 @@ EXAMPLES
|
|
|
2355
2555
|
|
|
2356
2556
|
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/get/region.ts)_
|
|
2357
2557
|
|
|
2558
|
+
## `csdx config:remove:base-branch`
|
|
2559
|
+
|
|
2560
|
+
Remove branch config for CLI
|
|
2561
|
+
|
|
2562
|
+
```
|
|
2563
|
+
USAGE
|
|
2564
|
+
$ csdx config:remove:base-branch [-k <value>] [-y]
|
|
2565
|
+
|
|
2566
|
+
FLAGS
|
|
2567
|
+
-k, --stack-api-key=<value> Stack API Key
|
|
2568
|
+
-y, --yes Force Remove
|
|
2569
|
+
|
|
2570
|
+
DESCRIPTION
|
|
2571
|
+
Remove branch config for CLI
|
|
2572
|
+
|
|
2573
|
+
EXAMPLES
|
|
2574
|
+
$ csdx config:remove:base-branch
|
|
2575
|
+
|
|
2576
|
+
$ csdx config:remove:base-branch --stack-api-key <value>
|
|
2577
|
+
```
|
|
2578
|
+
|
|
2579
|
+
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/remove/base-branch.ts)_
|
|
2580
|
+
|
|
2581
|
+
## `csdx config:set:base-branch`
|
|
2582
|
+
|
|
2583
|
+
Set branch for CLI
|
|
2584
|
+
|
|
2585
|
+
```
|
|
2586
|
+
USAGE
|
|
2587
|
+
$ csdx config:set:base-branch [-k <value>] [--base-branch <value>]
|
|
2588
|
+
|
|
2589
|
+
FLAGS
|
|
2590
|
+
-k, --stack-api-key=<value> Stack API Key
|
|
2591
|
+
--base-branch=<value> Base Branch
|
|
2592
|
+
|
|
2593
|
+
DESCRIPTION
|
|
2594
|
+
Set branch for CLI
|
|
2595
|
+
|
|
2596
|
+
EXAMPLES
|
|
2597
|
+
$ csdx config:set:base-branch
|
|
2598
|
+
|
|
2599
|
+
$ csdx config:set:base-branch --stack-api-key <value> --base-branch <value>
|
|
2600
|
+
```
|
|
2601
|
+
|
|
2602
|
+
_See code: [@contentstack/cli-config](https://github.com/contentstack/cli/blob/main/packages/contentstack-config/src/commands/config/set/base-branch.ts)_
|
|
2603
|
+
|
|
2358
2604
|
## `csdx config:set:region [REGION]`
|
|
2359
2605
|
|
|
2360
2606
|
Set region for CLI
|
|
@@ -2409,6 +2655,222 @@ DESCRIPTION
|
|
|
2409
2655
|
|
|
2410
2656
|
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
|
|
2411
2657
|
|
|
2658
|
+
## `csdx launch`
|
|
2659
|
+
|
|
2660
|
+
Launch related operations
|
|
2661
|
+
|
|
2662
|
+
```
|
|
2663
|
+
USAGE
|
|
2664
|
+
$ csdx launch [-d <value>] [-c <value>] [--type GitHub|FileUpload] [--framework Gatsby|NextJs|Other]
|
|
2665
|
+
[--org <value>] [-n <value>] [-e <value>] [--branch <value>] [--build-command <value>] [--out-dir <value>] [--init]
|
|
2666
|
+
|
|
2667
|
+
FLAGS
|
|
2668
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
2669
|
+
-d, --data-dir=<value> Current working directory
|
|
2670
|
+
-e, --environment=<value> [Optional] Environment name for the Launch project
|
|
2671
|
+
-n, --name=<value> [Optional] Name of the project
|
|
2672
|
+
--branch=<value> [Optional] GitHub branch name
|
|
2673
|
+
--build-command=<value> [Optional] Build Command
|
|
2674
|
+
--framework=<option> [Optional] Type of framework
|
|
2675
|
+
<options: Gatsby|NextJs|Other>
|
|
2676
|
+
--init [Optional, Hidden] Reinitialize the project if it is an existing launch project.
|
|
2677
|
+
--org=<value> [Optional] Provide the organization UID to create a new project or deployment
|
|
2678
|
+
--out-dir=<value> [Optional] Output Directory
|
|
2679
|
+
--type=<option> [Optional] Choose the type of adapters
|
|
2680
|
+
<options: GitHub|FileUpload>
|
|
2681
|
+
|
|
2682
|
+
DESCRIPTION
|
|
2683
|
+
Launch related operations
|
|
2684
|
+
|
|
2685
|
+
EXAMPLES
|
|
2686
|
+
$ csdx launch
|
|
2687
|
+
|
|
2688
|
+
$ csdx launch --data-dir <path/of/current/working/dir>
|
|
2689
|
+
|
|
2690
|
+
$ csdx launch --config <path/to/launch/config/file>
|
|
2691
|
+
|
|
2692
|
+
$ csdx launch --type <options: GitHub|FileUpload>
|
|
2693
|
+
|
|
2694
|
+
$ csdx launch --data-dir <path/of/current/working/dir> --type <options: GitHub|FileUpload>
|
|
2695
|
+
|
|
2696
|
+
$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload>
|
|
2697
|
+
|
|
2698
|
+
$ 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>
|
|
2699
|
+
```
|
|
2700
|
+
|
|
2701
|
+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/dist/commands/launch/index.ts)_
|
|
2702
|
+
|
|
2703
|
+
## `csdx launch:deployments`
|
|
2704
|
+
|
|
2705
|
+
Show list of deployments for an environment
|
|
2706
|
+
|
|
2707
|
+
```
|
|
2708
|
+
USAGE
|
|
2709
|
+
$ csdx launch:deployments [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]
|
|
2710
|
+
|
|
2711
|
+
FLAGS
|
|
2712
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
2713
|
+
-d, --data-dir=<value> Current working directory
|
|
2714
|
+
-e, --environment=<value> Environment name or UID
|
|
2715
|
+
--org=<value> [Optional] Provide the organization UID
|
|
2716
|
+
--project=<value> [Optional] Provide the project UID
|
|
2717
|
+
|
|
2718
|
+
DESCRIPTION
|
|
2719
|
+
Show list of deployments for an environment
|
|
2720
|
+
|
|
2721
|
+
EXAMPLES
|
|
2722
|
+
$ csdx launch:deployments
|
|
2723
|
+
|
|
2724
|
+
$ csdx launch:deployments -d "current working directory"
|
|
2725
|
+
|
|
2726
|
+
$ csdx launch:deployments -c "path to the local config file"
|
|
2727
|
+
|
|
2728
|
+
$ csdx launch:deployments -e "environment number or uid" --org=<org UID> --project=<Project UID>
|
|
2729
|
+
```
|
|
2730
|
+
|
|
2731
|
+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/dist/commands/launch/deployments.ts)_
|
|
2732
|
+
|
|
2733
|
+
## `csdx launch:environments`
|
|
2734
|
+
|
|
2735
|
+
Show list of environments for a project
|
|
2736
|
+
|
|
2737
|
+
```
|
|
2738
|
+
USAGE
|
|
2739
|
+
$ csdx launch:environments [-d <value>] [-c <value>] [--org <value>] [--project <value>]
|
|
2740
|
+
|
|
2741
|
+
FLAGS
|
|
2742
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
2743
|
+
-d, --data-dir=<value> Current working directory
|
|
2744
|
+
--org=<value> [Optional] Provide the organization UID
|
|
2745
|
+
--project=<value> [Optional] Provide the project UID
|
|
2746
|
+
|
|
2747
|
+
DESCRIPTION
|
|
2748
|
+
Show list of environments for a project
|
|
2749
|
+
|
|
2750
|
+
EXAMPLES
|
|
2751
|
+
$ csdx launch:environments
|
|
2752
|
+
|
|
2753
|
+
$ csdx launch:environments -d "current working directory"
|
|
2754
|
+
|
|
2755
|
+
$ csdx launch:environments -c "path to the local config file"
|
|
2756
|
+
|
|
2757
|
+
$ csdx launch:environments --org=<org UID> --project=<Project UID>
|
|
2758
|
+
```
|
|
2759
|
+
|
|
2760
|
+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/dist/commands/launch/environments.ts)_
|
|
2761
|
+
|
|
2762
|
+
## `csdx launch:functions`
|
|
2763
|
+
|
|
2764
|
+
Serve cloud functions
|
|
2765
|
+
|
|
2766
|
+
```
|
|
2767
|
+
USAGE
|
|
2768
|
+
$ csdx launch:functions [-d <value>] [-c <value>] [-p <value>]
|
|
2769
|
+
|
|
2770
|
+
FLAGS
|
|
2771
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
2772
|
+
-d, --data-dir=<value> Current working directory
|
|
2773
|
+
-p, --port=<value> [default: 3000] Port number
|
|
2774
|
+
|
|
2775
|
+
DESCRIPTION
|
|
2776
|
+
Serve cloud functions
|
|
2777
|
+
|
|
2778
|
+
EXAMPLES
|
|
2779
|
+
$ csdx launch:functions
|
|
2780
|
+
|
|
2781
|
+
$ csdx launch:functions --port=port
|
|
2782
|
+
|
|
2783
|
+
$ csdx launch:logs --data-dir <path/of/current/working/dir>
|
|
2784
|
+
|
|
2785
|
+
$ csdx launch:logs --config <path/to/launch/config/file>
|
|
2786
|
+
|
|
2787
|
+
$ csdx launch:logs --data-dir <path/of/current/working/dir> -p "port number"
|
|
2788
|
+
|
|
2789
|
+
$ csdx launch:logs --config <path/to/launch/config/file> --port=port
|
|
2790
|
+
```
|
|
2791
|
+
|
|
2792
|
+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/dist/commands/launch/functions.ts)_
|
|
2793
|
+
|
|
2794
|
+
## `csdx launch:logs`
|
|
2795
|
+
|
|
2796
|
+
Show deployment or server logs
|
|
2797
|
+
|
|
2798
|
+
```
|
|
2799
|
+
USAGE
|
|
2800
|
+
$ csdx launch:logs [-d <value>] [-c <value>] [-e <value>] [--deployment <value>] [--type d|s]
|
|
2801
|
+
|
|
2802
|
+
FLAGS
|
|
2803
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
2804
|
+
-d, --data-dir=<value> Current working directory
|
|
2805
|
+
-e, --environment=<value> Environment name or UID
|
|
2806
|
+
--deployment=<value> Deployment number or UID
|
|
2807
|
+
--type=<option> [default: s] Choose type of flags to show logs
|
|
2808
|
+
d) Deployment logs
|
|
2809
|
+
s) Server logs
|
|
2810
|
+
|
|
2811
|
+
<options: d|s>
|
|
2812
|
+
|
|
2813
|
+
DESCRIPTION
|
|
2814
|
+
Show deployment or server logs
|
|
2815
|
+
|
|
2816
|
+
EXAMPLES
|
|
2817
|
+
$ csdx launch:logs
|
|
2818
|
+
|
|
2819
|
+
$ csdx launch:logs --data-dir <path/of/current/working/dir>
|
|
2820
|
+
|
|
2821
|
+
$ csdx launch:logs --data-dir <path/of/current/working/dir> --type <options: d|s>
|
|
2822
|
+
|
|
2823
|
+
$ csdx launch:logs --config <path/to/launch/config/file> --type <options: d|s>
|
|
2824
|
+
|
|
2825
|
+
$ csdx launch:logs --deployment=deployment
|
|
2826
|
+
|
|
2827
|
+
$ csdx launch:logs --environment=environment
|
|
2828
|
+
|
|
2829
|
+
$ csdx launch:logs --environment=environment --deployment=deployment
|
|
2830
|
+
|
|
2831
|
+
$ csdx launch:logs --environment=environment --type <options: d|s>
|
|
2832
|
+
|
|
2833
|
+
$ csdx launch:logs --environment=environment --data-dir <path/of/current/working/dir> --deployment=deployment
|
|
2834
|
+
|
|
2835
|
+
$ csdx launch:logs --environment=environment --config <path/to/launch/config/file> --deployment=deployment
|
|
2836
|
+
```
|
|
2837
|
+
|
|
2838
|
+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/dist/commands/launch/logs.ts)_
|
|
2839
|
+
|
|
2840
|
+
## `csdx launch:open`
|
|
2841
|
+
|
|
2842
|
+
Open a website for an environment
|
|
2843
|
+
|
|
2844
|
+
```
|
|
2845
|
+
USAGE
|
|
2846
|
+
$ csdx launch:open [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]
|
|
2847
|
+
|
|
2848
|
+
FLAGS
|
|
2849
|
+
-c, --config=<value> Path to the local '.cs-launch.json' file
|
|
2850
|
+
-d, --data-dir=<value> Current working directory
|
|
2851
|
+
-e, --environment=<value> Environment name or UID
|
|
2852
|
+
--org=<value> [Optional] Provide the organization UID
|
|
2853
|
+
--project=<value> [Optional] Provide the project UID
|
|
2854
|
+
|
|
2855
|
+
DESCRIPTION
|
|
2856
|
+
Open a website for an environment
|
|
2857
|
+
|
|
2858
|
+
EXAMPLES
|
|
2859
|
+
$ csdx launch:open
|
|
2860
|
+
|
|
2861
|
+
$ csdx launch:open --config <path/to/launch/config/file>
|
|
2862
|
+
|
|
2863
|
+
$ csdx launch:open --data-dir <path/of/current/working/dir>
|
|
2864
|
+
|
|
2865
|
+
$ csdx launch:open --environment=environment
|
|
2866
|
+
|
|
2867
|
+
$ csdx launch:open --environment=environment --config <path/to/launch/config/file>
|
|
2868
|
+
|
|
2869
|
+
$ csdx launch:open --environment=environment --data-dir <path/of/current/working/dir>
|
|
2870
|
+
```
|
|
2871
|
+
|
|
2872
|
+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/dist/commands/launch/open.ts)_
|
|
2873
|
+
|
|
2412
2874
|
## `csdx login`
|
|
2413
2875
|
|
|
2414
2876
|
User sessions login
|
package/bin/dev
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
#!/usr/bin/env node
|
|
2
2
|
require('dotenv').config({ path: './.env' });
|
|
3
3
|
(async () => {
|
|
4
|
-
const
|
|
5
|
-
await
|
|
4
|
+
const { execute } = require('@contentstack/cli-utilities');
|
|
5
|
+
await execute({ type: 'cjs', development: true, dir: __dirname });
|
|
6
6
|
})();
|
package/bin/run
CHANGED
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.7.0",
|
|
5
5
|
"author": "Contentstack",
|
|
6
6
|
"bin": {
|
|
7
7
|
"csdx": "./bin/run"
|
|
@@ -21,20 +21,22 @@
|
|
|
21
21
|
"prepack": "pnpm compile && oclif manifest && oclif readme"
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@contentstack/cli-auth": "^1.3.
|
|
25
|
-
"@contentstack/cli-cm-bootstrap": "^1.4.
|
|
26
|
-
"@contentstack/cli-cm-bulk-publish": "^1.3.
|
|
27
|
-
"@contentstack/cli-cm-clone": "^1.4.
|
|
28
|
-
"@contentstack/cli-cm-export": "^1.5.
|
|
29
|
-
"@contentstack/cli-cm-export-to-csv": "^1.3.
|
|
30
|
-
"@contentstack/cli-cm-import": "^1.5.
|
|
31
|
-
"@contentstack/cli-cm-migrate-rte": "^1.4.
|
|
32
|
-
"@contentstack/cli-cm-seed": "^1.4.
|
|
33
|
-
"@contentstack/cli-command": "^1.2.
|
|
34
|
-
"@contentstack/cli-config": "^1.
|
|
35
|
-
"@contentstack/cli-
|
|
36
|
-
"@contentstack/cli-
|
|
37
|
-
"@contentstack/
|
|
24
|
+
"@contentstack/cli-auth": "^1.3.2",
|
|
25
|
+
"@contentstack/cli-cm-bootstrap": "^1.4.2",
|
|
26
|
+
"@contentstack/cli-cm-bulk-publish": "^1.3.2",
|
|
27
|
+
"@contentstack/cli-cm-clone": "^1.4.2",
|
|
28
|
+
"@contentstack/cli-cm-export": "^1.5.2",
|
|
29
|
+
"@contentstack/cli-cm-export-to-csv": "^1.3.2",
|
|
30
|
+
"@contentstack/cli-cm-import": "^1.5.2",
|
|
31
|
+
"@contentstack/cli-cm-migrate-rte": "^1.4.2",
|
|
32
|
+
"@contentstack/cli-cm-seed": "^1.4.2",
|
|
33
|
+
"@contentstack/cli-command": "^1.2.3",
|
|
34
|
+
"@contentstack/cli-config": "^1.4.0",
|
|
35
|
+
"@contentstack/cli-launch": "^1.0.1",
|
|
36
|
+
"@contentstack/cli-migration": "^1.3.2",
|
|
37
|
+
"@contentstack/cli-utilities": "^1.4.0",
|
|
38
|
+
"@contentstack/management": "^1.8.0",
|
|
39
|
+
"@contentstack/cli-cm-branches": "^1.0.0",
|
|
38
40
|
"@oclif/core": "^2.3.0",
|
|
39
41
|
"@oclif/plugin-help": "^5",
|
|
40
42
|
"@oclif/plugin-not-found": "^2.3.9",
|
|
@@ -65,7 +67,7 @@
|
|
|
65
67
|
"mocha": "^10.0.0",
|
|
66
68
|
"nock": "^13.1.0",
|
|
67
69
|
"nyc": "^15.1.0",
|
|
68
|
-
"oclif": "^3.1
|
|
70
|
+
"oclif": "^3.8.1",
|
|
69
71
|
"rimraf": "^2.7.1",
|
|
70
72
|
"shelljs": "^0.8.4",
|
|
71
73
|
"sinon": "^15.0.1",
|
|
@@ -116,6 +118,9 @@
|
|
|
116
118
|
"cm:stacks": {
|
|
117
119
|
"description": "Stacks related operations"
|
|
118
120
|
},
|
|
121
|
+
"launch": {
|
|
122
|
+
"description": "Launch related operations"
|
|
123
|
+
},
|
|
119
124
|
"plugins": {
|
|
120
125
|
"description": "List installed plugins"
|
|
121
126
|
}
|
|
@@ -136,7 +141,9 @@
|
|
|
136
141
|
"@contentstack/cli-cm-clone",
|
|
137
142
|
"@contentstack/cli-cm-migrate-rte",
|
|
138
143
|
"@contentstack/cli-migration",
|
|
139
|
-
"@contentstack/cli-cm-bulk-publish"
|
|
144
|
+
"@contentstack/cli-cm-bulk-publish",
|
|
145
|
+
"@contentstack/cli-cm-branches",
|
|
146
|
+
"@contentstack/cli-launch"
|
|
140
147
|
],
|
|
141
148
|
"hooks": {
|
|
142
149
|
"prerun": [
|
|
@@ -149,4 +156,4 @@
|
|
|
149
156
|
}
|
|
150
157
|
},
|
|
151
158
|
"repository": "https://github.com/contentstack/cli"
|
|
152
|
-
}
|
|
159
|
+
}
|