Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
d290a58
Merge pull request #360 from contentstack/main
harshithad0703 Mar 4, 2025
344e34c
Merge pull request #361 from contentstack/staging
harshithad0703 Mar 4, 2025
9d17a6f
migrated oclif v3 to v4, loader update
shafeeqd959 Mar 26, 2025
6abb7c1
Merge branch 'main' into development
shafeeqd959 Mar 26, 2025
29d1681
version bump
shafeeqd959 Apr 1, 2025
09596c1
feat: Avoid Direct Imports from Dist Directory in CLI
aman19K Apr 8, 2025
1247140
refactor: updated @contentstack/cli-command, @contentstack/cli-launch…
aman19K Apr 8, 2025
b416198
refactor: updated shelljs version from 0.8.5 to 0.9.0
aman19K Apr 8, 2025
12a936a
bumped versions
shafeeqd959 Apr 8, 2025
01a647c
Revert "bumped versions"
shafeeqd959 Apr 8, 2025
2a5121c
used current version of command package
shafeeqd959 Apr 9, 2025
f568ee9
updated utility version
shafeeqd959 Apr 9, 2025
da6f859
upgraded versions
shafeeqd959 Apr 9, 2025
63b89fb
updated lock file
shafeeqd959 Apr 9, 2025
86b8a3d
version bumped
aman19K Apr 11, 2025
597bfcd
Merge branch 'development' into feat/DX-2363
aman19K Apr 11, 2025
72f93e4
lock file updated
aman19K Apr 11, 2025
2a165e4
refactor: bumped @contentstack/cli-command version from 1.3.3 to 1.4.…
aman19K Apr 11, 2025
9943bc4
Merge pull request #364 from contentstack/feat/DX-2363
aman19K Apr 11, 2025
57c0b67
updated dependency packages
shafeeqd959 Apr 14, 2025
6f9cc0e
merged changes
shafeeqd959 Apr 14, 2025
9e511c0
Merge pull request #363 from contentstack/feat/oclif-v4-migration
shafeeqd959 Apr 14, 2025
ad6b6a9
Merge pull request #365 from contentstack/development
shafeeqd959 Apr 15, 2025
ab46adf
Merge pull request #367 from contentstack/main
shafeeqd959 Apr 16, 2025
c3e3beb
Merge pull request #368 from contentstack/staging
shafeeqd959 Apr 16, 2025
8fc4d87
updated license
shafeeqd959 Apr 16, 2025
734ea17
Merge branch 'development' of github.com:contentstack/contentstack-ap…
shafeeqd959 Apr 16, 2025
94638f7
Merge pull request #369 from contentstack/development
shafeeqd959 Apr 16, 2025
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
4 changes: 2 additions & 2 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2024 Contentstack
Copyright (c) 2025 Contentstack

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand All @@ -18,4 +18,4 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
SOFTWARE.
84 changes: 43 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
<!-- Insert Apps CLI version here -->

# @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
Expand All @@ -20,7 +21,7 @@ $ npm install -g @contentstack/apps-cli
$ csdx COMMAND
running command...
$ csdx (--version|-v)
@contentstack/apps-cli/1.3.4 darwin-arm64 node-v22.2.0
@contentstack/apps-cli/1.5.0 darwin-arm64 node-v22.13.1
$ csdx --help [COMMAND]
USAGE
$ csdx COMMAND
Expand All @@ -29,6 +30,7 @@ USAGE
<!-- usagestop -->

# Commands

<!-- commands -->
* [`csdx app`](#csdx-app)
* [`csdx app:create`](#csdx-appcreate)
Expand Down Expand Up @@ -69,26 +71,26 @@ EXAMPLES
$ csdx app:update
```

_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.3.4/src/commands/app/index.ts)_
_See code: [src/commands/app/index.ts](https://github.com/contentstack/apps-cli/blob/v1.5.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 [-n <value>] [--app-type stack|organization] [-c <value>] [-d <value>] [--boilerplate
<value>] [--org <value>]
$ csdx app:create [--org <value>] [-n <value>] [--app-type stack|organization] [-c <value>] [-d <value>]
[--boilerplate <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>
--boilerplate=<value> Provide a boilerplate. <options: App Boilerplate|DAM App Boilerplate|Ecommerce App
Boilerplate>
--org=<value> Provide the organization UID to fetch the app details for the operation.
-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>
--boilerplate=<value> Provide a boilerplate. <options: App Boilerplate|DAM App Boilerplate|Ecommerce App
Boilerplate>
--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 @@ -109,15 +111,15 @@ EXAMPLES
$ csdx app:create --name App-4 --app-type organization --org <UID> --boilerplate <Ecommerce App Boilerplate>
```

_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.3.4/src/commands/app/create.ts)_
_See code: [src/commands/app/create.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/create.ts)_

## `csdx app:delete`

Delete app from marketplace

```
USAGE
$ csdx app:delete [--app-uid <value>] [--org <value>]
$ csdx app:delete [--org <value>] [--app-uid <value>]

FLAGS
--app-uid=<value> Provide the app UID of an existing app.
Expand All @@ -134,26 +136,26 @@ 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.3.4/src/commands/app/delete.ts)_
_See code: [src/commands/app/delete.ts](https://github.com/contentstack/apps-cli/blob/v1.5.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>] [--org <value>]
$ csdx app:deploy [--org <value>] [--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>
--org=<value> Provide the organization UID to fetch the app details for the operation.
-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>
--org=<value> Provide the organization UID to fetch the app details for the operation.

DESCRIPTION
Deploy an app
Expand All @@ -172,22 +174,22 @@ EXAMPLES
$ 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.3.4/src/commands/app/deploy.ts)_
_See code: [src/commands/app/deploy.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/deploy.ts)_

## `csdx app:get`

Get details of an app in developer hub

```
USAGE
$ csdx app:get [--app-uid <value>] [--app-type stack|organization] [-d <value>] [--org <value>]
$ 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 of an existing app.
--org=<value> Provide the organization UID to fetch the app details for the operation.
-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 @@ -202,15 +204,15 @@ 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.3.4/src/commands/app/get.ts)_
_See code: [src/commands/app/get.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/get.ts)_

## `csdx app:install`

Install an app from the marketplace

```
USAGE
$ csdx app:install [--app-uid <value>] [--stack-api-key <value>] [--org <value>]
$ csdx app:install [--org <value>] [--app-uid <value>] [--stack-api-key <value>]

FLAGS
--app-uid=<value> Provide the app UID of an existing app.
Expand All @@ -228,15 +230,15 @@ 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.3.4/src/commands/app/install.ts)_
_See code: [src/commands/app/install.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/install.ts)_

## `csdx app:reinstall`

Reinstall an app from the marketplace

```
USAGE
$ csdx app:reinstall [--app-uid <value>] [--stack-api-key <value>] [--org <value>]
$ csdx app:reinstall [--org <value>] [--app-uid <value>] [--stack-api-key <value>]

FLAGS
--app-uid=<value> Provide the app UID of an existing app.
Expand All @@ -254,15 +256,15 @@ 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.3.4/src/commands/app/reinstall.ts)_
_See code: [src/commands/app/reinstall.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/reinstall.ts)_

## `csdx app:uninstall`

Uninstall an app

```
USAGE
$ csdx app:uninstall [--app-uid <value>] [--installation-uid <value>] [--uninstall-all] [--org <value>]
$ csdx app:uninstall [--org <value>] [--app-uid <value>] [--installation-uid <value>] [--uninstall-all]

FLAGS
--app-uid=<value> Provide the app UID of an existing app.
Expand All @@ -281,15 +283,15 @@ 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.3.4/src/commands/app/uninstall.ts)_
_See code: [src/commands/app/uninstall.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/uninstall.ts)_

## `csdx app:update`

Update the existing app in developer hub

```
USAGE
$ csdx app:update [--app-manifest <value>] [--org <value>]
$ csdx app:update [--org <value>] [--app-manifest <value>]

FLAGS
--app-manifest=<value> Path to the app manifest.json file:
Expand All @@ -304,5 +306,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.3.4/src/commands/app/update.ts)_
_See code: [src/commands/app/update.ts](https://github.com/contentstack/apps-cli/blob/v1.5.0/src/commands/app/update.ts)_
<!-- commandsstop -->
Loading