@contentstack/cli 1.5.1 → 1.6.0

package/README.md

@@ -18,7 +18,7 @@ $ npm install -g @contentstack/cli
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli/1.5.1 linux-x64 node-v16.20.0
+@contentstack/cli/1.6.0 linux-x64 node-v16.20.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -77,6 +77,12 @@ USAGE
 * [`csdx config:get:region`](#csdx-configgetregion)
 * [`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)
@@ -2409,6 +2415,222 @@ DESCRIPTION
 
 _See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v5.2.9/src/commands/help.ts)_
 
+## `csdx launch`
+
+Launch related operations
+
+```
+USAGE
+  $ csdx launch [-d <value>] [-c <value>] [--type GitHub|FileUpload] [--framework Gatsby|NextJs|Other]
+    [--org <value>] [-n <value>] [-e <value>] [--branch <value>] [--build-command <value>] [--out-dir <value>] [--init]
+
+FLAGS
+  -c, --config=<value>       Path to the local '.cs-launch.json' file
+  -d, --data-dir=<value>     Current working directory
+  -e, --environment=<value>  [Optional] Environment name for the Launch project
+  -n, --name=<value>         [Optional] Name of the project
+  --branch=<value>           [Optional] GitHub branch name
+  --build-command=<value>    [Optional] Build Command
+  --framework=<option>       [Optional] Type of framework
+                             <options: Gatsby|NextJs|Other>
+  --init                     [Optional, Hidden] Reinitialize the project if it is an existing launch project.
+  --org=<value>              [Optional] Provide the organization UID to create a new project or deployment
+  --out-dir=<value>          [Optional] Output Directory
+  --type=<option>            [Optional] Choose the type of adapters
+                             <options: GitHub|FileUpload>
+
+DESCRIPTION
+  Launch related operations
+
+EXAMPLES
+  $ csdx launch
+
+  $ csdx launch --data-dir <path/of/current/working/dir>
+
+  $ csdx launch --config <path/to/launch/config/file>
+
+  $ csdx launch --type <options: GitHub|FileUpload>
+
+  $ csdx launch --data-dir <path/of/current/working/dir> --type <options: GitHub|FileUpload>
+
+  $ csdx launch --config <path/to/launch/config/file> --type <options: GitHub|FileUpload>
+
+  $ 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>
+```
+
+_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/dist/commands/launch/index.ts)_
+
+## `csdx launch:deployments`
+
+Show list of deployments for an environment
+
+```
+USAGE
+  $ csdx launch:deployments [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]
+
+FLAGS
+  -c, --config=<value>       Path to the local '.cs-launch.json' file
+  -d, --data-dir=<value>     Current working directory
+  -e, --environment=<value>  Environment name or UID
+  --org=<value>              [Optional] Provide the organization UID
+  --project=<value>          [Optional] Provide the project UID
+
+DESCRIPTION
+  Show list of deployments for an environment
+
+EXAMPLES
+  $ csdx launch:deployments
+
+  $ csdx launch:deployments -d "current working directory"
+
+  $ csdx launch:deployments -c "path to the local config file"
+
+  $ csdx launch:deployments -e "environment number or uid" --org=<org UID> --project=<Project UID>
+```
+
+_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/dist/commands/launch/deployments.ts)_
+
+## `csdx launch:environments`
+
+Show list of environments for a project
+
+```
+USAGE
+  $ csdx launch:environments [-d <value>] [-c <value>] [--org <value>] [--project <value>]
+
+FLAGS
+  -c, --config=<value>    Path to the local '.cs-launch.json' file
+  -d, --data-dir=<value>  Current working directory
+  --org=<value>           [Optional] Provide the organization UID
+  --project=<value>       [Optional] Provide the project UID
+
+DESCRIPTION
+  Show list of environments for a project
+
+EXAMPLES
+  $ csdx launch:environments
+
+  $ csdx launch:environments -d "current working directory"
+
+  $ csdx launch:environments -c "path to the local config file"
+
+  $ csdx launch:environments --org=<org UID> --project=<Project UID>
+```
+
+_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/dist/commands/launch/environments.ts)_
+
+## `csdx launch:functions`
+
+Serve cloud functions
+
+```
+USAGE
+  $ csdx launch:functions [-d <value>] [-c <value>] [-p <value>]
+
+FLAGS
+  -c, --config=<value>    Path to the local '.cs-launch.json' file
+  -d, --data-dir=<value>  Current working directory
+  -p, --port=<value>      [default: 3000] Port number
+
+DESCRIPTION
+  Serve cloud functions
+
+EXAMPLES
+  $ csdx launch:functions
+
+  $ csdx launch:functions --port=port
+
+  $ csdx launch:logs --data-dir <path/of/current/working/dir>
+
+  $ csdx launch:logs --config <path/to/launch/config/file>
+
+  $ csdx launch:logs --data-dir <path/of/current/working/dir> -p "port number"
+
+  $ csdx launch:logs --config <path/to/launch/config/file> --port=port
+```
+
+_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/dist/commands/launch/functions.ts)_
+
+## `csdx launch:logs`
+
+Show deployment or server logs
+
+```
+USAGE
+  $ csdx launch:logs [-d <value>] [-c <value>] [-e <value>] [--deployment <value>] [--type d|s]
+
+FLAGS
+  -c, --config=<value>       Path to the local '.cs-launch.json' file
+  -d, --data-dir=<value>     Current working directory
+  -e, --environment=<value>  Environment name or UID
+  --deployment=<value>       Deployment number or UID
+  --type=<option>            [default: s] Choose type of flags to show logs
+                             d) Deployment logs
+                             s) Server logs
+
+                             <options: d|s>
+
+DESCRIPTION
+  Show deployment or server logs
+
+EXAMPLES
+  $ csdx launch:logs
+
+  $ csdx launch:logs --data-dir <path/of/current/working/dir>
+
+  $ csdx launch:logs --data-dir <path/of/current/working/dir> --type <options: d|s>
+
+  $ csdx launch:logs --config <path/to/launch/config/file> --type <options: d|s>
+
+  $ csdx launch:logs --deployment=deployment
+
+  $ csdx launch:logs --environment=environment
+
+  $ csdx launch:logs --environment=environment --deployment=deployment
+
+  $ csdx launch:logs --environment=environment --type <options: d|s>
+
+  $ csdx launch:logs --environment=environment --data-dir <path/of/current/working/dir> --deployment=deployment
+
+  $ csdx launch:logs --environment=environment --config <path/to/launch/config/file> --deployment=deployment
+```
+
+_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/dist/commands/launch/logs.ts)_
+
+## `csdx launch:open`
+
+Open a website for an environment
+
+```
+USAGE
+  $ csdx launch:open [-d <value>] [-c <value>] [--org <value>] [--project <value>] [-e <value>]
+
+FLAGS
+  -c, --config=<value>       Path to the local '.cs-launch.json' file
+  -d, --data-dir=<value>     Current working directory
+  -e, --environment=<value>  Environment name or UID
+  --org=<value>              [Optional] Provide the organization UID
+  --project=<value>          [Optional] Provide the project UID
+
+DESCRIPTION
+  Open a website for an environment
+
+EXAMPLES
+  $ csdx launch:open
+
+  $ csdx launch:open --config <path/to/launch/config/file>
+
+  $ csdx launch:open --data-dir <path/of/current/working/dir>
+
+  $ csdx launch:open --environment=environment
+
+  $ csdx launch:open --environment=environment --config <path/to/launch/config/file>
+
+  $ csdx launch:open --environment=environment --data-dir <path/of/current/working/dir>
+```
+
+_See code: [@contentstack/cli-launch](https://github.com/contentstack/cli/blob/main/packages/contentstack-launch/dist/commands/launch/open.ts)_
+
 ## `csdx login`
 
 User sessions login

package/oclif.manifest.json

@@ -1,4 +1,4 @@
 {
-  "version": "1.5.1",
+  "version": "1.6.0",
   "commands": {}
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@contentstack/cli",
   "description": "Command-line tool (CLI) to interact with Contentstack",
-  "version": "1.5.1",
+  "version": "1.6.0",
   "author": "Contentstack",
   "bin": {
     "csdx": "./bin/run"
@@ -32,8 +32,9 @@
     "@contentstack/cli-cm-seed": "^1.4.1",
     "@contentstack/cli-command": "^1.2.2",
     "@contentstack/cli-config": "^1.3.1",
+    "@contentstack/cli-launch": "^1.0.0",
     "@contentstack/cli-migration": "^1.3.1",
-    "@contentstack/cli-utilities": "^1.3.1",
+    "@contentstack/cli-utilities": "^1.3.2",
     "@contentstack/management": "^1.6.1",
     "@oclif/core": "^2.3.0",
     "@oclif/plugin-help": "^5",
@@ -43,10 +44,11 @@
     "debug": "^4.1.1",
     "figlet": "^1.5.2",
     "inquirer": "8.2.4",
-    "uuid": "^9.0.0",
-    "winston": "^3.7.2",
     "node-machine-id": "^1.1.12",
-    "short-uuid": "^4.2.2"
+    "open": "^8.4.2",
+    "short-uuid": "^4.2.2",
+    "uuid": "^9.0.0",
+    "winston": "^3.7.2"
   },
   "devDependencies": {
     "@oclif/test": "^2.2.10",
@@ -115,6 +117,9 @@
       "cm:stacks": {
         "description": "Stacks related operations"
       },
+      "launch": {
+        "description": "Launch related operations"
+      },
       "plugins": {
         "description": "List installed plugins"
       }
@@ -135,7 +140,8 @@
       "@contentstack/cli-cm-clone",
       "@contentstack/cli-cm-migrate-rte",
       "@contentstack/cli-migration",
-      "@contentstack/cli-cm-bulk-publish"
+      "@contentstack/cli-cm-bulk-publish",
+      "@contentstack/cli-launch"
     ],
     "hooks": {
       "prerun": [
@@ -148,4 +154,4 @@
     }
   },
   "repository": "https://github.com/contentstack/cli"
-}
+}