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.
$ csdx plugins:install @contentstack/apps-cli
This plugin requires you to be authenticated using csdx auth:login.
$ npm install -g @contentstack/apps-cli
$ csdx COMMAND
running command...
$ csdx (--version|-v)
@contentstack/apps-cli/1.0.5 darwin-arm64 node-v20.10.0
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
...
csdx app
csdx app:create
csdx app:delete
csdx app:get
csdx app:install
csdx app:uninstall
csdx app:update
Apps CLI plugin
USAGE
$ csdx app
DESCRIPTION
Apps CLI plugin
EXAMPLES
$ csdx app:create
$ csdx app:get
$ csdx app:update
$ csdx app:delete
$ csdx app:install
$ csdx app:uninstall
See code: src/commands/app/index.ts
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>]
FLAGS
-c, --config=<value> Path of the external config
-d, --data-dir=<value> Current working directory.
-n, --name=<value> Name of the app to be created
--app-type=<option> [default: stack] Type of App
<options: stack|organization>
--org=<value> Provide the organization UID
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 <UID> -d ./boilerplate -c ./external-config.json
See code: src/commands/app/create.ts
Delete app from marketplace
USAGE
$ csdx app:delete [--org <value>] [--app-uid <value>]
FLAGS
--app-uid=<value> Provide the app UID
--org=<value> Provide the organization UID
DESCRIPTION
Delete app from marketplace
EXAMPLES
$ csdx app:delete
$ csdx app:delete --app-uid <value>
$ csdx app:delete --app-uid <value> --org <value> -d ./boilerplate
See code: src/commands/app/delete.ts
Get details of an app in developer hub
USAGE
$ csdx app:get [--org <value>] [--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
--org=<value> Provide the organization UID
DESCRIPTION
Get details of an app in developer hub
EXAMPLES
$ csdx app:get
$ csdx app:get --org <value> --app-uid <value>
$ csdx app:get --org <value> --app-uid <value> --app-type stack
$ csdx app:get --org <value> --app-uid <value> --app-type organization
See code: src/commands/app/get.ts
Install an app from the marketplace
USAGE
$ csdx app:install [--org <value>] [--app-uid <value>] [--stack-api-key <value>]
FLAGS
--app-uid=<value> Provide the app UID
--org=<value> Provide the organization UID
--stack-api-key=<value> API key of the stack where the app is to be installed.
DESCRIPTION
Install an app from the marketplace
EXAMPLES
$ csdx app:install
$ csdx app:install --org <UID> --app-uid <APP-UID-1>
$ csdx app:install --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>
See code: src/commands/app/install.ts
Uninstall an app
USAGE
$ csdx app:uninstall [--org <value>] [--app-uid <value>] [--installation-uid <value>] [--uninstall-all]
FLAGS
--app-uid=<value> Provide the app UID
--installation-uid=<value> Provide the installation ID of the app that needs to be uninstalled.
--org=<value> Provide the organization UID
--uninstall-all Please select stacks from where the app must be uninstalled.
DESCRIPTION
Uninstall an app
EXAMPLES
$ csdx app:uninstall
$ csdx app:uninstall --org <UID> --app-uid <APP-UID-1>
$ csdx app:uninstall --org <UID> --app-uid <APP-UID-1> --installation-uid <INSTALLATION-UID-1>
See code: src/commands/app/uninstall.ts
Update the existing app in developer hub
USAGE
$ csdx app:update [--org <value>] [--app-manifest <value>]
FLAGS
--app-manifest=<value> Path to the app manifest.json file:
--org=<value> Provide the organization UID
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