Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
36 commits
Select commit Hold shift + click to select a range
3f66ba3
feat: app deploy command
aman19K Jun 11, 2024
d783fe2
update launch version
aman19K Jun 11, 2024
5335578
Merge pull request #253 from contentstack/staging
cs-raj Jun 11, 2024
5df4ce5
fix org type def issue
aman19K Jun 11, 2024
43b0570
Merge pull request #250 from contentstack/feat/DX-541
aman19K Jun 11, 2024
3683642
feat: config based launch project creation
aman19K Jun 17, 2024
b2bda01
Merge pull request #254 from contentstack/feat/DX-785
aman19K Jun 17, 2024
8403398
refactor: updated examples
aman19K Jun 18, 2024
e4bfc23
updated readme
aman19K Jun 18, 2024
b4950f2
fix: snyk issues
aman19K Jun 18, 2024
dd1e7dc
updated utilities version
aman19K Jun 18, 2024
83b96dc
version bump
aman19K Jun 18, 2024
fabe102
Merge pull request #255 from contentstack/feat/app-deploy-command
aman19K Jun 18, 2024
09754e4
fix: deploy command
aman19K Jun 19, 2024
335f067
refactor: launch project flag
aman19K Jun 19, 2024
2f923bc
refactor: app disconnect
aman19K Jun 19, 2024
cef7d91
Merge pull request #256 from contentstack/fix/deploy-command
aman19K Jun 19, 2024
8eba9b7
fix: launch project query, removed duplicate yes flag & updated readm…
aman19K Jun 19, 2024
b9cf987
Merge pull request #257 from contentstack/fix/launch-project-query
aman19K Jun 19, 2024
4cd7cc6
fix: app uid issue
aman19K Jun 19, 2024
99f75d8
added check for app-uid
aman19K Jun 19, 2024
e008e13
updated reademe file
aman19K Jun 19, 2024
5c9d2ca
Merge branch 'development' into fix/app-uid-issue
aman19K Jun 19, 2024
f327429
Merge pull request #258 from contentstack/fix/app-uid-issue
aman19K Jun 19, 2024
75dfe08
build: updated oclif/test version to 2.5.6
harshithad0703 Jun 24, 2024
6b18665
test: deploy command unit test
harshithad0703 Jun 24, 2024
57afe40
test: :adhesive_bandage: deploy command unit test update
harshithad0703 Jun 24, 2024
57af772
chore: updated test script in package.json
harshithad0703 Jun 24, 2024
d342cb5
refactor: deploy command ui text
aman19K Jun 26, 2024
b9ed523
Merge pull request #261 from contentstack/refactor/deploy-command-ui-…
aman19K Jun 26, 2024
6f7b5f5
test: added hosting with launch test case for deploy
harshithad0703 Jun 26, 2024
43e2bb6
refactor: deploy command ui text
aman19K Jun 26, 2024
cf74caa
test: added mock data for deploy unit test
harshithad0703 Jun 26, 2024
9d7bb0f
Merge branch 'development' into test/DX-543-deploy-command-unit-tests
harshithad0703 Jun 27, 2024
2feb7d0
test: added 1 more test case using flags in command
harshithad0703 Jun 27, 2024
6afde49
Merge pull request #260 from contentstack/test/DX-543-deploy-command-…
harshithad0703 Jun 28, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 54 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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)
Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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 -->
9 changes: 9 additions & 0 deletions examples/create-launch-project.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
{
"name": "app name",
"type": "GitHub",
"environment": "Default",
"framework": "NextJs",
"build-command": "npm run build",
"out-dir": "./.next",
"branch": "master"
}
Loading