Skip to content

Commit b320131

Browse files
fix: updated README
1 parent 037ca0f commit b320131

1 file changed

Lines changed: 57 additions & 1 deletion

File tree

README.md

Lines changed: 57 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ $ npm install -g @contentstack/apps-cli
2828
$ csdx COMMAND
2929
running command...
3030
$ csdx (--version|-v)
31-
@contentstack/apps-cli/0.0.0-alpha-1 darwin-arm64 node-v16.19.0
31+
@contentstack/apps-cli/0.0.0-alpha-1 darwin-arm64 node-v20.3.1
3232
$ csdx --help [COMMAND]
3333
USAGE
3434
$ csdx COMMAND
@@ -41,6 +41,8 @@ USAGE
4141
* [`csdx app:create`](#csdx-appcreate)
4242
* [`csdx app:delete`](#csdx-appdelete)
4343
* [`csdx app:get`](#csdx-appget)
44+
* [`csdx app:install`](#csdx-appinstall)
45+
* [`csdx app:uninstall`](#csdx-appuninstall)
4446
* [`csdx app:update`](#csdx-appupdate)
4547

4648
## `csdx app:create`
@@ -132,6 +134,60 @@ EXAMPLES
132134

133135
_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v0.0.0-alpha-1/src/commands/app/get.ts)_
134136

137+
## `csdx app:install`
138+
139+
Install an app from the marketplace
140+
141+
```
142+
USAGE
143+
$ csdx app:install [--org <value>] [-y] [--app-uid <value>] [--stack-api-key <value>]
144+
145+
FLAGS
146+
-y, --yes Use this flag to skip the confirmation.
147+
--app-uid=<value> Provide the app UID
148+
--org=<value> Provide the organization UID
149+
--stack-api-key=<value> API key of the stack where the app is to be installed.
150+
151+
DESCRIPTION
152+
Install an app from the marketplace
153+
154+
EXAMPLES
155+
$ csdx app:install
156+
157+
$ csdx app:install --org <UID> --app-uid <APP-UID-1>
158+
159+
$ csdx app:install --org <UID> --app-uid <APP-UID-1> --stack-api-key <STACK-API-KEY-1>
160+
```
161+
162+
_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v0.0.0-alpha-1/src/commands/app/install.ts)_
163+
164+
## `csdx app:uninstall`
165+
166+
Uninstall an app
167+
168+
```
169+
USAGE
170+
$ csdx app:uninstall [--org <value>] [-y] [--app-uid <value>] [--installation-uid <value>]
171+
172+
FLAGS
173+
-y, --yes Use this flag to skip the confirmation.
174+
--app-uid=<value> Provide the app UID
175+
--installation-uid=<value> Provide the installation ID of the app that needs to be uninstalled.
176+
--org=<value> Provide the organization UID
177+
178+
DESCRIPTION
179+
Uninstall an app
180+
181+
EXAMPLES
182+
$ csdx app:uninstall
183+
184+
$ csdx app:uninstall --org <UID> --app-uid <APP-UID-1>
185+
186+
$ csdx app:uninstall --org <UID> --app-uid <APP-UID-1> --installation-uid <INSTALLATION-UID-1>
187+
```
188+
189+
_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v0.0.0-alpha-1/src/commands/app/uninstall.ts)_
190+
135191
## `csdx app:update`
136192

137193
Update the existing app in developer hub

0 commit comments

Comments
 (0)