Skip to content

Commit 9e511c0

Browse files
authored
Merge pull request #363 from contentstack/feat/oclif-v4-migration
Feat/oclif v4 migration
2 parents 9943bc4 + 6f9cc0e commit 9e511c0

File tree

3 files changed

+14765
-16709
lines changed

3 files changed

+14765
-16709
lines changed

README.md

Lines changed: 34 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
<!-- Insert Apps CLI version here -->
33

44
# @contentstack/apps-cli
5+
56
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.
67

78
## How to install this plugin
@@ -20,7 +21,7 @@ $ npm install -g @contentstack/apps-cli
2021
$ csdx COMMAND
2122
running command...
2223
$ csdx (--version|-v)
23-
@contentstack/apps-cli/1.5.0 darwin-arm64 node-v22.14.0
24+
@contentstack/apps-cli/1.5.0 darwin-arm64 node-v22.13.1
2425
$ csdx --help [COMMAND]
2526
USAGE
2627
$ csdx COMMAND
@@ -29,6 +30,7 @@ USAGE
2930
<!-- usagestop -->
3031

3132
# Commands
33+
3234
<!-- commands -->
3335
* [`csdx app`](#csdx-app)
3436
* [`csdx app:create`](#csdx-appcreate)
@@ -77,18 +79,18 @@ Create a new app in Developer Hub and optionally clone a boilerplate locally.
7779

7880
```
7981
USAGE
80-
$ csdx app:create [-n <value>] [--app-type stack|organization] [-c <value>] [-d <value>] [--boilerplate
81-
<value>] [--org <value>]
82+
$ csdx app:create [--org <value>] [-n <value>] [--app-type stack|organization] [-c <value>] [-d <value>]
83+
[--boilerplate <value>]
8284
8385
FLAGS
84-
-c, --config=<value> Path of the external config
85-
-d, --data-dir=<value> Current working directory.
86-
-n, --name=<value> Name of the app to be created
87-
--app-type=<option> [default: stack] Type of app
88-
<options: stack|organization>
89-
--boilerplate=<value> Provide a boilerplate. <options: App Boilerplate|DAM App Boilerplate|Ecommerce App
90-
Boilerplate>
91-
--org=<value> Provide the organization UID to fetch the app details for the operation.
86+
-c, --config=<value> Path of the external config
87+
-d, --data-dir=<value> Current working directory.
88+
-n, --name=<value> Name of the app to be created
89+
--app-type=<option> [default: stack] Type of app
90+
<options: stack|organization>
91+
--boilerplate=<value> Provide a boilerplate. <options: App Boilerplate|DAM App Boilerplate|Ecommerce App
92+
Boilerplate>
93+
--org=<value> Provide the organization UID to fetch the app details for the operation.
9294
9395
DESCRIPTION
9496
Create a new app in Developer Hub and optionally clone a boilerplate locally.
@@ -117,7 +119,7 @@ Delete app from marketplace
117119

118120
```
119121
USAGE
120-
$ csdx app:delete [--app-uid <value>] [--org <value>]
122+
$ csdx app:delete [--org <value>] [--app-uid <value>]
121123
122124
FLAGS
123125
--app-uid=<value> Provide the app UID of an existing app.
@@ -142,18 +144,18 @@ Deploy an app
142144

143145
```
144146
USAGE
145-
$ csdx app:deploy [--app-uid <value>] [--hosting-type hosting-with-launch|custom-hosting] [--app-url <value>]
146-
[--launch-project existing|new] [-c <value>] [--org <value>]
147+
$ csdx app:deploy [--org <value>] [--app-uid <value>] [--hosting-type hosting-with-launch|custom-hosting]
148+
[--app-url <value>] [--launch-project existing|new] [-c <value>]
147149
148150
FLAGS
149-
-c, --config=<value> [optional] Please enter the path of the config file.
150-
--app-uid=<value> Provide the app UID of an existing app.
151-
--app-url=<value> Please enter the URL of the app you want to deploy.
152-
--hosting-type=<option> Choose a valid Hosting Type.
153-
<options: hosting-with-launch|custom-hosting>
154-
--launch-project=<option> Choose a new or an existing Launch project.
155-
<options: existing|new>
156-
--org=<value> Provide the organization UID to fetch the app details for the operation.
151+
-c, --config=<value> [optional] Please enter the path of the config file.
152+
--app-uid=<value> Provide the app UID of an existing app.
153+
--app-url=<value> Please enter the URL of the app you want to deploy.
154+
--hosting-type=<option> Choose a valid Hosting Type.
155+
<options: hosting-with-launch|custom-hosting>
156+
--launch-project=<option> Choose a new or an existing Launch project.
157+
<options: existing|new>
158+
--org=<value> Provide the organization UID to fetch the app details for the operation.
157159
158160
DESCRIPTION
159161
Deploy an app
@@ -180,14 +182,14 @@ Get details of an app in developer hub
180182

181183
```
182184
USAGE
183-
$ csdx app:get [--app-uid <value>] [--app-type stack|organization] [-d <value>] [--org <value>]
185+
$ csdx app:get [--org <value>] [--app-uid <value>] [--app-type stack|organization] [-d <value>]
184186
185187
FLAGS
186-
-d, --data-dir=<value> Current working directory.
187-
--app-type=<option> [default: stack] Type of app
188-
<options: stack|organization>
189-
--app-uid=<value> Provide the app UID of an existing app.
190-
--org=<value> Provide the organization UID to fetch the app details for the operation.
188+
-d, --data-dir=<value> Current working directory.
189+
--app-type=<option> [default: stack] Type of app
190+
<options: stack|organization>
191+
--app-uid=<value> Provide the app UID of an existing app.
192+
--org=<value> Provide the organization UID to fetch the app details for the operation.
191193
192194
DESCRIPTION
193195
Get details of an app in developer hub
@@ -210,7 +212,7 @@ Install an app from the marketplace
210212

211213
```
212214
USAGE
213-
$ csdx app:install [--app-uid <value>] [--stack-api-key <value>] [--org <value>]
215+
$ csdx app:install [--org <value>] [--app-uid <value>] [--stack-api-key <value>]
214216
215217
FLAGS
216218
--app-uid=<value> Provide the app UID of an existing app.
@@ -236,7 +238,7 @@ Reinstall an app from the marketplace
236238

237239
```
238240
USAGE
239-
$ csdx app:reinstall [--app-uid <value>] [--stack-api-key <value>] [--org <value>]
241+
$ csdx app:reinstall [--org <value>] [--app-uid <value>] [--stack-api-key <value>]
240242
241243
FLAGS
242244
--app-uid=<value> Provide the app UID of an existing app.
@@ -262,7 +264,7 @@ Uninstall an app
262264

263265
```
264266
USAGE
265-
$ csdx app:uninstall [--app-uid <value>] [--installation-uid <value>] [--uninstall-all] [--org <value>]
267+
$ csdx app:uninstall [--org <value>] [--app-uid <value>] [--installation-uid <value>] [--uninstall-all]
266268
267269
FLAGS
268270
--app-uid=<value> Provide the app UID of an existing app.
@@ -289,7 +291,7 @@ Update the existing app in developer hub
289291

290292
```
291293
USAGE
292-
$ csdx app:update [--app-manifest <value>] [--org <value>]
294+
$ csdx app:update [--org <value>] [--app-manifest <value>]
293295
294296
FLAGS
295297
--app-manifest=<value> Path to the app manifest.json file:

0 commit comments

Comments
 (0)