Merge pull request #262 from contentstack/development

DX | 01-07-2024 | Release
contentstack · Jun 28, 2024 · 4fd4f88 · 4fd4f88
2 parents c380787 + 6afde49
commit 4fd4f88
Show file tree

Hide file tree

Showing 21 changed files with 7,314 additions and 1,255 deletions.
diff --git a/README.md b/README.md
@@ -20,7 +20,7 @@ $ npm install -g @contentstack/apps-cli
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/apps-cli/1.1.1 darwin-arm64 node-v18.16.0
+@contentstack/apps-cli/1.2.0 darwin-arm64 node-v18.20.2
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -33,6 +33,7 @@ USAGE
 * [`csdx app`](#csdx-app)
 * [`csdx app:create`](#csdx-appcreate)
 * [`csdx app:delete`](#csdx-appdelete)
+* [`csdx app:deploy`](#csdx-appdeploy)
 * [`csdx app:get`](#csdx-appget)
 * [`csdx app:install`](#csdx-appinstall)
 * [`csdx app:reinstall`](#csdx-appreinstall)
@@ -66,23 +67,22 @@ EXAMPLES
   $ csdx app:reinstall
 ```
 
-_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.1.1/src/commands/app/index.ts)_
+_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.2.0/src/commands/app/index.ts)_
 
 ## `csdx app:create`
 
 Create a new app in Developer Hub and optionally clone a boilerplate locally.
 
 ```
 USAGE
-  $ csdx app:create [--org <value>] [-n <value>] [--app-type stack|organization] [-c <value>] [-d <value>]
+  $ csdx app:create [-n <value>] [--app-type stack|organization] [-c <value>] [-d <value>]
 
 FLAGS
   -c, --config=<value>    Path of the external config
   -d, --data-dir=<value>  Current working directory.
   -n, --name=<value>      [default: app-boilerplate] Name of the app to be created
   --app-type=<option>     [default: stack] Type of app
                           <options: stack|organization>
-  --org=<value>           Provide the organization UID to fetch the app details for the operation.
 
 DESCRIPTION
   Create a new app in Developer Hub and optionally clone a boilerplate locally.
@@ -97,19 +97,18 @@ EXAMPLES
   $ csdx app:create --name App-3 --app-type organization --org <UID> -d ./boilerplate -c ./external-config.json
 ```
 
-_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.1.1/src/commands/app/create.ts)_
+_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.2.0/src/commands/app/create.ts)_
 
 ## `csdx app:delete`
 
 Delete app from marketplace
 
 ```
 USAGE
-  $ csdx app:delete [--org <value>] [--app-uid <value>]
+  $ csdx app:delete [--app-uid <value>]
 
 FLAGS
   --app-uid=<value>  Provide the app UID of an existing app.
-  --org=<value>      Provide the organization UID to fetch the app details for the operation.
 
 DESCRIPTION
   Delete app from marketplace
@@ -122,22 +121,58 @@ EXAMPLES
   $ csdx app:delete --app-uid <value> --org <value> -d ./boilerplate
 ```
 
-_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.1.1/src/commands/app/delete.ts)_
+_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.2.0/src/commands/app/delete.ts)_
+
+## `csdx app:deploy`
+
+Deploy an app
+
+```
+USAGE
+  $ csdx app:deploy [--app-uid <value>] [--hosting-type Hosting with Launch|Custom Hosting] [--app-url <value>]
+    [--launch-project existing|new] [-c <value>]
+
+FLAGS
+  -c, --config=<value>       [optional] Please enter the path of the config file.
+  --app-uid=<value>          Provide the app UID of an existing app.
+  --app-url=<value>          Please enter the URL of the app you want to deploy.
+  --hosting-type=<option>    Choose a valid Hosting Type.
+                             <options: Hosting with Launch|Custom Hosting>
+  --launch-project=<option>  Choose a new or an existing Launch project.
+                             <options: existing|new>
+
+DESCRIPTION
+  Deploy an app
+
+EXAMPLES
+  $ csdx app:deploy
+
+  $ csdx app:deploy --org <UID> --app-uid <APP-UID-1>
+
+  $ csdx app:deploy --org <UID> --app-uid <APP-UID-1> --hosting-type <Custom Hosting> --app-url <https://localhost:3000>
+
+  $ csdx app:deploy --org <UID> --app-uid <APP-UID-1> --hosting-type <Hosting with Launch> --launch-project <existing>
+
+  $ csdx app:deploy --org <UID> --app-uid <APP-UID-1> --hosting-type <Hosting with Launch> --launch-project <new>
+
+  $ csdx app:deploy --org <UID> --app-uid <APP-UID-1> --hosting-type <Hosting with Launch> --launch-project <new> --config <config-path>
+```
+
+_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.2.0/src/commands/app/deploy.ts)_
 
 ## `csdx app:get`
 
 Get details of an app in developer hub
 
 ```
 USAGE
-  $ csdx app:get [--org <value>] [--app-uid <value>] [--app-type stack|organization] [-d <value>]
+  $ csdx app:get [--app-uid <value>] [--app-type stack|organization] [-d <value>]
 
 FLAGS
   -d, --data-dir=<value>  Current working directory.
   --app-type=<option>     [default: stack] Type of app
                           <options: stack|organization>
   --app-uid=<value>       Provide the app UID of an existing app.
-  --org=<value>           Provide the organization UID to fetch the app details for the operation.
 
 DESCRIPTION
   Get details of an app in developer hub
@@ -152,19 +187,18 @@ EXAMPLES
   $ csdx app:get --org <value> --app-uid <value> --app-type organization
 ```
 
-_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.1.1/src/commands/app/get.ts)_
+_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.2.0/src/commands/app/get.ts)_
 
 ## `csdx app:install`
 
 Install an app from the marketplace
 
 ```
 USAGE
-  $ csdx app:install [--org <value>] [--app-uid <value>] [--stack-api-key <value>]
+  $ csdx app:install [--app-uid <value>] [--stack-api-key <value>]
 
 FLAGS
   --app-uid=<value>        Provide the app UID of an existing app.
-  --org=<value>            Provide the organization UID to fetch the app details for the operation.
   --stack-api-key=<value>  API key of the stack where the app operation is to be performed.
 
 DESCRIPTION
@@ -178,19 +212,18 @@ EXAMPLES
   $ csdx app:install --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>
 ```
 
-_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.1.1/src/commands/app/install.ts)_
+_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.2.0/src/commands/app/install.ts)_
 
 ## `csdx app:reinstall`
 
 Reinstall an app from the marketplace
 
 ```
 USAGE
-  $ csdx app:reinstall [--org <value>] [--app-uid <value>] [--stack-api-key <value>]
+  $ csdx app:reinstall [--app-uid <value>] [--stack-api-key <value>]
 
 FLAGS
   --app-uid=<value>        Provide the app UID of an existing app.
-  --org=<value>            Provide the organization UID to fetch the app details for the operation.
   --stack-api-key=<value>  API key of the stack where the app operation is to be performed.
 
 DESCRIPTION
@@ -204,20 +237,19 @@ EXAMPLES
   $ csdx app:reinstall --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>
 ```
 
-_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.1.1/src/commands/app/reinstall.ts)_
+_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.2.0/src/commands/app/reinstall.ts)_
 
 ## `csdx app:uninstall`
 
 Uninstall an app
 
 ```
 USAGE
-  $ csdx app:uninstall [--org <value>] [--app-uid <value>] [--installation-uid <value>] [--uninstall-all]
+  $ csdx app:uninstall [--app-uid <value>] [--installation-uid <value>] [--uninstall-all]
 
 FLAGS
   --app-uid=<value>           Provide the app UID of an existing app.
   --installation-uid=<value>  Provide the installation ID of the app that needs to be uninstalled.
-  --org=<value>               Provide the organization UID to fetch the app details for the operation.
   --uninstall-all             Please select stacks from where the app must be uninstalled.
 
 DESCRIPTION
@@ -231,19 +263,18 @@ EXAMPLES
   $ csdx app:uninstall --org <UID> --app-uid <APP-UID-1> --installation-uid <INSTALLATION-UID-1>
 ```
 
-_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.1.1/src/commands/app/uninstall.ts)_
+_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.2.0/src/commands/app/uninstall.ts)_
 
 ## `csdx app:update`
 
 Update the existing app in developer hub
 
 ```
 USAGE
-  $ csdx app:update [--org <value>] [--app-manifest <value>]
+  $ csdx app:update [--app-manifest <value>]
 
 FLAGS
   --app-manifest=<value>  Path to the app manifest.json file:
-  --org=<value>           Provide the organization UID to fetch the app details for the operation.
 
 DESCRIPTION
   Update the existing app in developer hub
@@ -254,5 +285,5 @@ EXAMPLES
   $ csdx app:update --app-manifest ./boilerplate/manifest.json
 ```
 
-_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.1.1/src/commands/app/update.ts)_
+_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.2.0/src/commands/app/update.ts)_
 <!-- commandsstop -->
diff --git a/examples/create-launch-project.json b/examples/create-launch-project.json
@@ -0,0 +1,9 @@
+{
+  "name": "app name",
+  "type":  "GitHub",
+  "environment": "Default",
+  "framework": "NextJs",
+  "build-command": "npm run build",
+  "out-dir": "./.next",
+  "branch": "master"
+}