https://github.com/contentstack/contentstack-apps-cli
This contentstack CLI plugin will allows users to manage their Apps.
https://github.com/contentstack/contentstack-apps-cli
Last synced: 29 days ago
JSON representation
This contentstack CLI plugin will allows users to manage their Apps.
- Host: GitHub
- URL: https://github.com/contentstack/contentstack-apps-cli
- Owner: contentstack
- License: mit
- Created: 2022-11-21T11:28:49.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2026-04-15T06:31:34.000Z (30 days ago)
- Last Synced: 2026-04-15T08:25:19.661Z (30 days ago)
- Language: TypeScript
- Homepage:
- Size: 2.14 MB
- Stars: 2
- Watchers: 7
- Forks: 0
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
# @contentstack/apps-cli
Contentstack lets you develop apps in your organization using the Developer Hub portal. With the Apps CLI plugin, Contentstack CLI allows you to perform the CRUD operations on your app in Developer Hub and then use the app in your organization or stack by installing or uninstalling your app as required.
## How to install this plugin
```shell
$ csdx plugins:install @contentstack/apps-cli
```
## How to use this plugin
This plugin requires you to be authenticated using [csdx auth:login](https://www.contentstack.com/docs/developers/cli/authenticate-with-the-cli/).
```sh-session
$ npm install -g @contentstack/apps-cli
$ csdx COMMAND
running command...
$ csdx (--version|-v)
@contentstack/apps-cli/1.6.1 darwin-arm64 node-v18.20.2
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
```
# Commands
* [`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)
* [`csdx app:uninstall`](#csdx-appuninstall)
* [`csdx app:update`](#csdx-appupdate)
## `csdx app`
Apps CLI plugin
```
USAGE
$ csdx app
DESCRIPTION
Apps CLI plugin
EXAMPLES
$ csdx app:create
$ csdx app:delete
$ csdx app:deploy
$ csdx app:get
$ csdx app:install
$ csdx app:reinstall
$ csdx app:uninstall
$ csdx app:update
```
_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/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 ] [-n ] [--app-type stack|organization] [-c ] [-d ]
[--boilerplate ]
FLAGS
-c, --config= Path of the external config
-d, --data-dir= Current working directory.
-n, --name= Name of the app to be created
--app-type= [default: stack] Type of app
--boilerplate= Provide a boilerplate.
--org= 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.
EXAMPLES
$ csdx app:create
$ csdx app:create --name App-1 --app-type stack
$ csdx app:create --name App-2 --app-type stack -d ./boilerplate
$ csdx app:create --name App-3 --app-type organization --org -d ./boilerplate -c ./external-config.json
$ csdx app:create --name App-4 --app-type organization --org --boilerplate
$ csdx app:create --name App-4 --app-type organization --org --boilerplate
$ csdx app:create --name App-4 --app-type organization --org --boilerplate
```
_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/create.ts)_
## `csdx app:delete`
Delete app from marketplace
```
USAGE
$ csdx app:delete [--org ] [--app-uid ]
FLAGS
--app-uid= Provide the app UID of an existing app.
--org= Provide the organization UID to fetch the app details for the operation.
DESCRIPTION
Delete app from marketplace
EXAMPLES
$ csdx app:delete
$ csdx app:delete --app-uid
$ csdx app:delete --app-uid --org -d ./boilerplate
```
_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/delete.ts)_
## `csdx app:deploy`
Deploy an app
```
USAGE
$ csdx app:deploy [--org ] [--app-uid ] [--hosting-type hosting-with-launch|custom-hosting]
[--app-url ] [--launch-project existing|new] [-c ]
FLAGS
-c, --config= [optional] Please enter the path of the config file.
--app-uid= Provide the app UID of an existing app.
--app-url= Please enter the URL of the app you want to deploy.
--hosting-type= Choose a valid Hosting Type.
--launch-project= Choose a new or an existing Launch project.
--org= Provide the organization UID to fetch the app details for the operation.
DESCRIPTION
Deploy an app
EXAMPLES
$ csdx app:deploy
$ csdx app:deploy --org --app-uid
$ csdx app:deploy --org --app-uid --hosting-type --app-url
$ csdx app:deploy --org --app-uid --hosting-type --launch-project
$ csdx app:deploy --org --app-uid --hosting-type --launch-project
$ csdx app:deploy --org --app-uid --hosting-type --launch-project --config
```
_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/deploy.ts)_
## `csdx app:get`
Get details of an app in developer hub
```
USAGE
$ csdx app:get [--org ] [--app-uid ] [--app-type stack|organization] [-d ]
FLAGS
-d, --data-dir= Current working directory.
--app-type= [default: stack] Type of app
--app-uid= Provide the app UID of an existing app.
--org= Provide the organization UID to fetch the app details for the operation.
DESCRIPTION
Get details of an app in developer hub
EXAMPLES
$ csdx app:get
$ csdx app:get --org --app-uid
$ csdx app:get --org --app-uid --app-type stack
$ csdx app:get --org --app-uid --app-type organization
```
_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/get.ts)_
## `csdx app:install`
Install an app from the marketplace
```
USAGE
$ csdx app:install [--org ] [--app-uid ] [--stack-api-key ]
FLAGS
--app-uid= Provide the app UID of an existing app.
--org= Provide the organization UID to fetch the app details for the operation.
--stack-api-key= API key of the stack where the app operation is to be performed.
DESCRIPTION
Install an app from the marketplace
EXAMPLES
$ csdx app:install
$ csdx app:install --org --app-uid
$ csdx app:install --org --app-uid --stack-api-key
```
_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/install.ts)_
## `csdx app:reinstall`
Reinstall an app from the marketplace
```
USAGE
$ csdx app:reinstall [--org ] [--app-uid ] [--stack-api-key ]
FLAGS
--app-uid= Provide the app UID of an existing app.
--org= Provide the organization UID to fetch the app details for the operation.
--stack-api-key= API key of the stack where the app operation is to be performed.
DESCRIPTION
Reinstall an app from the marketplace
EXAMPLES
$ csdx app:reinstall
$ csdx app:reinstall --org --app-uid
$ csdx app:reinstall --org --app-uid --stack-api-key
```
_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/reinstall.ts)_
## `csdx app:uninstall`
Uninstall an app
```
USAGE
$ csdx app:uninstall [--org ] [--app-uid ] [--installation-uid ] [--uninstall-all]
FLAGS
--app-uid= Provide the app UID of an existing app.
--installation-uid= Provide the installation ID of the app that needs to be uninstalled.
--org= 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
Uninstall an app
EXAMPLES
$ csdx app:uninstall
$ csdx app:uninstall --org --app-uid
$ csdx app:uninstall --org --app-uid --installation-uid
```
_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/uninstall.ts)_
## `csdx app:update`
Update the existing app in developer hub
```
USAGE
$ csdx app:update [--org ] [--app-manifest ]
FLAGS
--app-manifest= Path to the app manifest.json file:
--org= Provide the organization UID to fetch the app details for the operation.
DESCRIPTION
Update the existing app in developer hub
EXAMPLES
$ csdx app:update
$ csdx app:update --app-manifest ./boilerplate/manifest.json
```
_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.6.1/src/commands/app/update.ts)_