Skip to content

Commit b94824f

Browse files
committed
add launch in plugin list
1 parent 28b8cbd commit b94824f

File tree

2 files changed

+246
-1
lines changed

2 files changed

+246
-1
lines changed

packages/contentstack/README.md

Lines changed: 244 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -100,6 +100,12 @@ USAGE
100100
* [`csdx config:set:rate-limit`](#csdx-configsetrate-limit)
101101
* [`csdx config:set:region [REGION]`](#csdx-configsetregion-region)
102102
* [`csdx help [COMMAND]`](#csdx-help-command)
103+
* [`csdx launch`](#csdx-launch)
104+
* [`csdx launch:deployments`](#csdx-launchdeployments)
105+
* [`csdx launch:environments`](#csdx-launchenvironments)
106+
* [`csdx launch:functions`](#csdx-launchfunctions)
107+
* [`csdx launch:logs`](#csdx-launchlogs)
108+
* [`csdx launch:open`](#csdx-launchopen)
103109
* [`csdx login`](#csdx-login)
104110
* [`csdx logout`](#csdx-logout)
105111
* [`csdx plugins`](#csdx-plugins)
@@ -3623,6 +3629,244 @@ DESCRIPTION
36233629

36243630
_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.27/src/commands/help.ts)_
36253631

3632+
## `csdx launch`
3633+
3634+
Launch related operations
3635+
3636+
```
3637+
USAGE
3638+
$ csdx launch [-d <value>] [-c <value>] [--type GitHub|FileUpload] [--framework Gatsby|NextJs|CRA (Create
3639+
React App)|CSR (Client-Side Rendered)|Angular|VueJs|Other] [--org <value>] [-n <value>] [-e <value>] [--branch
3640+
<value>] [--build-command <value>] [--out-dir <value>] [--server-command <value>] [--variable-type Import variables
3641+
from a stack|Manually add custom variables to the list|Import variables from the local env file] [-a <value>]
3642+
[--env-variables <value>] [--redeploy-latest] [--redeploy-last-upload]
3643+
3644+
FLAGS
3645+
-a, --alias=<value> [optional] Alias (name) for the delivery token.
3646+
-c, --config=<value> Path to the local '.cs-launch.json' file
3647+
-d, --data-dir=<value> Current working directory
3648+
-e, --environment=<value> [optional] Environment name for the Launch project.
3649+
-n, --name=<value> [optional] Name of the project.
3650+
--branch=<value> [optional] GitHub branch name.
3651+
--build-command=<value> [optional] Build Command.
3652+
--env-variables=<value> [optional] Provide the environment variables in the key:value format, separated by
3653+
comma. For example: APP_ENV:prod, TEST_ENV:testVal.
3654+
--framework=<option> [optional] Type of framework. <options: Gatsby|NextJS|Other>
3655+
<options: Gatsby|NextJs|CRA (Create React App)|CSR (Client-Side
3656+
Rendered)|Angular|VueJs|Other>
3657+
--org=<value> [optional] Provide the organization UID to create a new project or deployment.
3658+
--out-dir=<value> [optional] Output Directory.
3659+
--redeploy-last-upload [optional] Redeploy with last file upload
3660+
--redeploy-latest [optional] Redeploy latest commit/code
3661+
--server-command=<value> [optional] Server Command.
3662+
--type=<option> [optional] Type of adapters. <options: GitHub|FileUpload>
3663+
<options: GitHub|FileUpload>
3664+
--variable-type=<option> [optional] Provide a variable type. <options: Import variables from a stack|Manually add
3665+
custom variables to the list|Import variables from the local env file>
3666+
<options: Import variables from a stack|Manually add custom variables to the list|Import
3667+
variables from the local env file>
3668+
3669+
DESCRIPTION
3670+
Launch related operations
3671+
3672+
EXAMPLES
3673+
$ csdx launch
3674+
3675+
$ csdx launch --data-dir <path/of/current/working/dir>
3676+
3677+
$ csdx launch --config <path/to/launch/config/file>
3678+
3679+
$ csdx launch --type <options: GitHub|FileUpload>
3680+
3681+
$ csdx launch --data-dir <path/of/current/working/dir> --type <options: GitHub|FileUpload>
3682+
3683+
$ csdx launch --data-dir <path/of/current/working/dir> --redeploy-latest
3684+
3685+
$ csdx launch --data-dir <path/of/current/working/dir> --redeploy-last-upload
3686+
3687+
$ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload>
3688+
3689+
$ csdx launch --environment=<value> --redeploy-latest
3690+
3691+
$ 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>
3692+
3693+
$ 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>
3694+
3695+
$ 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>
3696+
3697+
$ 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"
3698+
```
3699+
3700+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/index.ts)_
3701+
3702+
## `csdx launch:deployments`
3703+
3704+
Show list of deployments for an environment
3705+
3706+
```
3707+
USAGE
3708+
$ csdx launch:deployments [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]
3709+
3710+
FLAGS
3711+
-c, --config=<value> Path to the local '.cs-launch.json' file
3712+
-d, --data-dir=<value> Current working directory
3713+
-e, --environment=<value> Environment name or UID
3714+
--org=<value> [Optional] Provide the organization UID
3715+
--project=<value> [Optional] Provide the project UID
3716+
3717+
DESCRIPTION
3718+
Show list of deployments for an environment
3719+
3720+
EXAMPLES
3721+
$ csdx launch:deployments
3722+
3723+
$ csdx launch:deployments -d "current working directory"
3724+
3725+
$ csdx launch:deployments -c "path to the local config file"
3726+
3727+
$ csdx launch:deployments -e "environment number or uid" --org=<org UID> --project=<Project UID>
3728+
```
3729+
3730+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/deployments.ts)_
3731+
3732+
## `csdx launch:environments`
3733+
3734+
Show list of environments for a project
3735+
3736+
```
3737+
USAGE
3738+
$ csdx launch:environments [-d <value>] [-c <value>] [--org <value>] [--project <value>]
3739+
3740+
FLAGS
3741+
-c, --config=<value> Path to the local '.cs-launch.json' file
3742+
-d, --data-dir=<value> Current working directory
3743+
--org=<value> [Optional] Provide the organization UID
3744+
--project=<value> [Optional] Provide the project UID
3745+
3746+
DESCRIPTION
3747+
Show list of environments for a project
3748+
3749+
EXAMPLES
3750+
$ csdx launch:environments
3751+
3752+
$ csdx launch:environments -d "current working directory"
3753+
3754+
$ csdx launch:environments -c "path to the local config file"
3755+
3756+
$ csdx launch:environments --org=<org UID> --project=<Project UID>
3757+
```
3758+
3759+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/environments.ts)_
3760+
3761+
## `csdx launch:functions`
3762+
3763+
Serve cloud functions
3764+
3765+
```
3766+
USAGE
3767+
$ csdx launch:functions [-p <value>] [-d <value>]
3768+
3769+
FLAGS
3770+
-d, --data-dir=<value> [default: /Users/aman.kumar/Documents/cli-repo/cli/packages/contentstack] Current working
3771+
directory
3772+
-p, --port=<value> [default: 3000] Port number
3773+
3774+
DESCRIPTION
3775+
Serve cloud functions
3776+
3777+
EXAMPLES
3778+
$ csdx launch:functions
3779+
3780+
$ csdx launch:functions --port=port
3781+
3782+
$ csdx launch:functions --data-dir <path/of/current/working/dir>
3783+
3784+
$ csdx launch:functions --data-dir <path/of/current/working/dir> -p "port number"
3785+
```
3786+
3787+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/functions.ts)_
3788+
3789+
## `csdx launch:logs`
3790+
3791+
Show deployment or server logs
3792+
3793+
```
3794+
USAGE
3795+
$ csdx launch:logs [-d <value>] [-c <value>] [-e <value>] [--deployment <value>] [--type d|s] [--org <value>]
3796+
[--project <value>]
3797+
3798+
FLAGS
3799+
-c, --config=<value> Path to the local '.cs-launch.json' file
3800+
-d, --data-dir=<value> Current working directory
3801+
-e, --environment=<value> Environment name or UID
3802+
--deployment=<value> Deployment number or UID
3803+
--org=<value> [Optional] Provide the organization UID
3804+
--project=<value> [Optional] Provide the project UID
3805+
--type=<option> [default: s] Type of flags to show logs. By default, these are server logs. Options [d -
3806+
deployment logs, s - server logs]
3807+
<options: d|s>
3808+
3809+
DESCRIPTION
3810+
Show deployment or server logs
3811+
3812+
EXAMPLES
3813+
$ csdx launch:logs
3814+
3815+
$ csdx launch:logs --data-dir <path/of/current/working/dir>
3816+
3817+
$ csdx launch:logs --data-dir <path/of/current/working/dir> --type <options: d|s>
3818+
3819+
$ csdx launch:logs --config <path/to/launch/config/file> --type <options: d|s>
3820+
3821+
$ csdx launch:logs --deployment=deployment
3822+
3823+
$ csdx launch:logs --environment=environment
3824+
3825+
$ csdx launch:logs --environment=environment --deployment=deployment
3826+
3827+
$ csdx launch:logs --environment=environment --type <options: d|s>
3828+
3829+
$ csdx launch:logs --environment=environment --data-dir <path/of/current/working/dir> --deployment=deployment
3830+
3831+
$ csdx launch:logs --environment=environment --config <path/to/launch/config/file> --deployment=deployment
3832+
```
3833+
3834+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/logs.ts)_
3835+
3836+
## `csdx launch:open`
3837+
3838+
Open a website for an environment
3839+
3840+
```
3841+
USAGE
3842+
$ csdx launch:open [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]
3843+
3844+
FLAGS
3845+
-c, --config=<value> Path to the local '.cs-launch.json' file
3846+
-d, --data-dir=<value> Current working directory
3847+
-e, --environment=<value> Environment name or UID
3848+
--org=<value> [Optional] Provide the organization UID
3849+
--project=<value> [Optional] Provide the project UID
3850+
3851+
DESCRIPTION
3852+
Open a website for an environment
3853+
3854+
EXAMPLES
3855+
$ csdx launch:open
3856+
3857+
$ csdx launch:open --config <path/to/launch/config/file>
3858+
3859+
$ csdx launch:open --data-dir <path/of/current/working/dir>
3860+
3861+
$ csdx launch:open --environment=environment
3862+
3863+
$ csdx launch:open --environment=environment --config <path/to/launch/config/file>
3864+
3865+
$ csdx launch:open --environment=environment --data-dir <path/of/current/working/dir>
3866+
```
3867+
3868+
_See code: [@contentstack/cli-launch](https://github.com/contentstack/launch-cli/blob/main/packages/contentstack-launch/src/commands/launch/open.ts)_
3869+
36263870
## `csdx login`
36273871

36283872
User sessions login

packages/contentstack/package.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,8 @@
151151
"@contentstack/cli-cm-bulk-publish",
152152
"@contentstack/cli-cm-branches",
153153
"@contentstack/cli-audit",
154-
"@contentstack/cli-cm-import-setup"
154+
"@contentstack/cli-cm-import-setup",
155+
"@contentstack/cli-launch"
155156
],
156157
"hooks": {
157158
"prerun": [

0 commit comments

Comments
 (0)