Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adobe/aio-cli-plugin-app
Create, Build and Deploy Cloud Native Applications
https://github.com/adobe/aio-cli-plugin-app
cli
Last synced: 3 months ago
JSON representation
Create, Build and Deploy Cloud Native Applications
- Host: GitHub
- URL: https://github.com/adobe/aio-cli-plugin-app
- Owner: adobe
- License: apache-2.0
- Created: 2019-05-08T22:32:22.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-07-17T08:43:16.000Z (4 months ago)
- Last Synced: 2024-07-17T10:53:47.387Z (4 months ago)
- Topics: cli
- Language: JavaScript
- Homepage:
- Size: 1.74 MB
- Stars: 19
- Watchers: 24
- Forks: 35
- Open Issues: 72
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
aio-cli-plugin-app
==================
Create, Build and Deploy Adobe I/O Apps
[](https://oclif.io)
[](https://npmjs.org/package/@adobe/aio-cli-plugin-app)
[](https://npmjs.org/package/@adobe/aio-cli-plugin-app)
[](https://opensource.org/licenses/Apache-2.0)
[](https://codecov.io/gh/adobe/aio-cli-plugin-app/)
* [Usage](#usage)
* [Commands](#commands)
# Usage
```sh-session
$ aio plugins:install -g @adobe/aio-cli-plugin-app
$ # OR
$ aio discover -i
$ aio app --help
```
# Commands
* [`aio app`](#aio-app)
* [`aio app add`](#aio-app-add)
* [`aio app add action`](#aio-app-add-action)
* [`aio app add ci`](#aio-app-add-ci)
* [`aio app add event`](#aio-app-add-event)
* [`aio app add extension`](#aio-app-add-extension)
* [`aio app add service`](#aio-app-add-service)
* [`aio app add web-assets`](#aio-app-add-web-assets)
* [`aio app build`](#aio-app-build)
* [`aio app create [PATH]`](#aio-app-create-path)
* [`aio app delete`](#aio-app-delete)
* [`aio app delete action [ACTION-NAME]`](#aio-app-delete-action-action-name)
* [`aio app delete ci`](#aio-app-delete-ci)
* [`aio app delete extension`](#aio-app-delete-extension)
* [`aio app delete service`](#aio-app-delete-service)
* [`aio app delete web-assets`](#aio-app-delete-web-assets)
* [`aio app deploy`](#aio-app-deploy)
* [`aio app get-url [ACTION]`](#aio-app-get-url-action)
* [`aio app info`](#aio-app-info)
* [`aio app init [PATH]`](#aio-app-init-path)
* [`aio app install PATH`](#aio-app-install-path)
* [`aio app list`](#aio-app-list)
* [`aio app list extension`](#aio-app-list-extension)
* [`aio app logs`](#aio-app-logs)
* [`aio app pack [PATH]`](#aio-app-pack-path)
* [`aio app run`](#aio-app-run)
* [`aio app test`](#aio-app-test)
* [`aio app undeploy`](#aio-app-undeploy)
* [`aio app use [CONFIG_FILE_PATH]`](#aio-app-use-config_file_path)
## `aio app`
Create, run, test, and deploy Adobe I/O Apps
```
USAGE
$ aio app [-v] [--version]
FLAGS
-v, --verbose Verbose output
--version Show version
DESCRIPTION
Create, run, test, and deploy Adobe I/O Apps
```
_See code: [src/commands/app/index.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/index.js)_
## `aio app add`
Add a new component to an existing Adobe I/O App
```
USAGE
$ aio app add [-v] [--version]
FLAGS
-v, --verbose Verbose output
--version Show version
DESCRIPTION
Add a new component to an existing Adobe I/O App
```
_See code: [src/commands/app/add/index.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/add/index.js)_
## `aio app add action`
Add new actions
```
USAGE
$ aio app add action [-v] [--version] [--install] [-y] [-e ]
FLAGS
-e, --extension= Add actions to a specific extension
-v, --verbose Verbose output
-y, --yes Skip questions, and use all default values
--[no-]install [default: true] Run npm installation after files are created
--version Show version
DESCRIPTION
Add new actions
ALIASES
$ aio app add actions
```
_See code: [src/commands/app/add/action.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/add/action.js)_
## `aio app add ci`
Add CI files
```
USAGE
$ aio app add ci [-v] [--version]
FLAGS
-v, --verbose Verbose output
--version Show version
DESCRIPTION
Add CI files
```
_See code: [src/commands/app/add/ci.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/add/ci.js)_
## `aio app add event`
Add a new Adobe I/O Events action
```
USAGE
$ aio app add event [-v] [--version] [--install] [-y] [-e ]
FLAGS
-e, --extension= Add events to a specific extension
-v, --verbose Verbose output
-y, --yes Skip questions, and use all default values
--[no-]install [default: true] Run npm installation after files are created
--version Show version
DESCRIPTION
Add a new Adobe I/O Events action
ALIASES
$ aio app add events
```
_See code: [src/commands/app/add/event.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/add/event.js)_
## `aio app add extension`
Add new extensions to the project
```
USAGE
$ aio app add extension [-v] [--version] [--install] [-y] [-e ]
FLAGS
-e, --extension=... Specify extensions to add, skips selection prompt
-v, --verbose Verbose output
-y, --yes Skip questions, and use all default values
--[no-]install [default: true] Run npm installation after files are created
--version Show version
DESCRIPTION
Add new extensions to the project
ALIASES
$ aio app add ext
$ aio app add extensions
```
_See code: [src/commands/app/add/extension.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/add/extension.js)_
## `aio app add service`
Subscribe to Services in the current Workspace
```
USAGE
$ aio app add service [-v] [--version] [--use-jwt]
FLAGS
-v, --verbose Verbose output
--use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating), prefer the JWT
credentials
--version Show version
DESCRIPTION
Subscribe to Services in the current Workspace
ALIASES
$ aio app add services
```
_See code: [src/commands/app/add/service.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/add/service.js)_
## `aio app add web-assets`
Add web assets support
```
USAGE
$ aio app add web-assets [-v] [--version] [--install] [-y] [-e ]
FLAGS
-e, --extension= Add web-assets to a specific extension
-v, --verbose Verbose output
-y, --yes Skip questions, and use all default values
--[no-]install [default: true] Run npm installation after files are created
--version Show version
DESCRIPTION
Add web assets support
```
_See code: [src/commands/app/add/web-assets.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/add/web-assets.js)_
## `aio app build`
Build an Adobe I/O App
```
USAGE
$ aio app build [-v] [--version] [--actions | -a ] [--web-assets] [--force-build] [--content-hash]
[--web-optimize] [-e | ]
FLAGS
-a, --action=... Build only a specific action, the flags can be specified multiple times, this will set
--no-publish
-e, --extension=... Build only a specific extension point, the flags can be specified multiple times
-v, --verbose Verbose output
--[no-]actions [default: true] Build actions if any
--[no-]content-hash [default: true] Enable content hashing in browser code
--[no-]force-build [default: true] Force a build even if one already exists
--version Show version
--[no-]web-assets [default: true] Build web-assets if any
--web-optimize [default: false] Enable optimization (minification) of js/css/html
DESCRIPTION
Build an Adobe I/O App
This will always force a rebuild unless --no-force-build is set.
```
_See code: [src/commands/app/build.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/build.js)_
## `aio app create [PATH]`
Create a new Adobe I/O App with default parameters
```
USAGE
$ aio app create [PATH] [-v] [--version] [-i ]
ARGUMENTS
PATH [default: .] Path to the app directory
FLAGS
-i, --import= Import an Adobe I/O Developer Console configuration file
-v, --verbose Verbose output
--version Show version
DESCRIPTION
Create a new Adobe I/O App with default parameters
```
_See code: [src/commands/app/create.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/create.js)_
## `aio app delete`
Delete a component from an existing Adobe I/O App
```
USAGE
$ aio app delete [-v] [--version]
FLAGS
-v, --verbose Verbose output
--version Show version
DESCRIPTION
Delete a component from an existing Adobe I/O App
```
_See code: [src/commands/app/delete/index.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/delete/index.js)_
## `aio app delete action [ACTION-NAME]`
Delete existing actions
```
USAGE
$ aio app delete action [ACTION-NAME] [-v] [--version] [-y]
ARGUMENTS
ACTION-NAME Action `pkg/name` to delete, you can specify multiple actions via a comma separated list
FLAGS
-v, --verbose Verbose output
-y, --yes Skip questions, and use all default values
--version Show version
DESCRIPTION
Delete existing actions
ALIASES
$ aio app delete actions
```
_See code: [src/commands/app/delete/action.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/delete/action.js)_
## `aio app delete ci`
Delete existing CI files
```
USAGE
$ aio app delete ci [-v] [--version] [-y]
FLAGS
-v, --verbose Verbose output
-y, --yes Skip questions, and use all default values
--version Show version
DESCRIPTION
Delete existing CI files
```
_See code: [src/commands/app/delete/ci.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/delete/ci.js)_
## `aio app delete extension`
Delete existing extensions
```
USAGE
$ aio app delete extension [-v] [--version] [-y] [--install] [-e ]
FLAGS
-e, --extension=... Specify extensions to delete, skips selection prompt
-v, --verbose Verbose output
-y, --yes Skip questions, and use all default values
--[no-]install [default: true] Run npm installation after files are created
--version Show version
DESCRIPTION
Delete existing extensions
ALIASES
$ aio app delete ext
$ aio app delete extensions
```
_See code: [src/commands/app/delete/extension.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/delete/extension.js)_
## `aio app delete service`
Delete Services in the current Workspace
```
USAGE
$ aio app delete service [-v] [--version] [--use-jwt]
FLAGS
-v, --verbose Verbose output
--use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating), prefer the JWT
credentials
--version Show version
DESCRIPTION
Delete Services in the current Workspace
ALIASES
$ aio app delete services
```
_See code: [src/commands/app/delete/service.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/delete/service.js)_
## `aio app delete web-assets`
Delete existing web assets
```
USAGE
$ aio app delete web-assets [-v] [--version] [-y]
FLAGS
-v, --verbose Verbose output
-y, --yes Skip questions, and use all default values
--version Show version
DESCRIPTION
Delete existing web assets
```
_See code: [src/commands/app/delete/web-assets.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/delete/web-assets.js)_
## `aio app deploy`
Build and deploy an Adobe I/O App
```
USAGE
$ aio app deploy [-v] [--version] [--actions | -a ] [--web-assets] [--force-build | ] [--content-hash]
[--web-optimize] [-e | ] [--build] [--open] [--force-deploy | --publish | --force-publish] [--force-events |
| ] [--log-forwarding-update]
FLAGS
-a, --action=... Deploy only a specific action, the flags can be specified multiple times, this will set
--no-publish
-e, --extension=... Deploy only a specific extension, the flags can be specified multiple times
-v, --verbose Verbose output
--[no-]actions [default: true] Deploy actions if any
--[no-]build [default: true] Run the build phase before deployment
--[no-]content-hash [default: true] Enable content hashing in browser code
--[no-]force-build [default: true] Force a build even if one already exists
--force-deploy [default: false] Force deploy changes, regardless of production Workspace being
published in Exchange.
--[no-]force-events [default: false] Force event registrations and delete any registrations not part of the
config file
--force-publish [default: false] Force publish extension(s) to Exchange, delete previously published
extension points
--[no-]log-forwarding-update [default: true] Update log forwarding configuration on server
--open Open the default web browser after a successful deploy, only valid if your app has a
front-end
--[no-]publish [default: true] Publish extension(s) to Exchange
--version Show version
--[no-]web-assets [default: true] Deploy web-assets if any
--web-optimize [default: false] Enable optimization (minification) of web js/css/html
DESCRIPTION
Build and deploy an Adobe I/O App
This will always force a rebuild unless --no-force-build is set.
```
_See code: [src/commands/app/deploy.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/deploy.js)_
## `aio app get-url [ACTION]`
Get action URLs
```
USAGE
$ aio app get-url [ACTION] [-v] [--version] [--cdn] [-j] [-h] [-y] [--local]
FLAGS
-h, --hson Output human readable json
-j, --json Output json
-v, --verbose Verbose output
-y, --yml Output yml
--cdn Display CDN based action URLs
--local Display locally based action URLs
--version Show version
DESCRIPTION
Get action URLs
```
_See code: [src/commands/app/get-url.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/get-url.js)_
## `aio app info`
Display settings/configuration in use by an Adobe I/O App
```
USAGE
$ aio app info [-v] [--version] [-j | -h | -y] [--mask]
FLAGS
-h, --hson Output human readable json
-j, --json Output json
-v, --verbose Verbose output
-y, --yml Output yml
--[no-]mask Hide known private info
--version Show version
DESCRIPTION
Display settings/configuration in use by an Adobe I/O App
```
_See code: [src/commands/app/info.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/info.js)_
## `aio app init [PATH]`
Create a new Adobe I/O App
```
USAGE
$ aio app init [PATH] [-v] [--version] [--install] [-y] [--login] [-e | -t | --repo ]
[--standalone-app | | ] [-w | -i ] [--confirm-new-workspace] [--use-jwt] [--github-pat ]
[--linter none|basic|adobe-recommended]
ARGUMENTS
PATH [default: .] Path to the app directory
FLAGS
-e, --extension=... Extension point(s) to implement
-i, --import= Import an Adobe I/O Developer Console configuration file
-t, --template=... Specify a link to a template that will be installed
-v, --verbose Verbose output
-w, --workspace= [default: Stage] Specify the Adobe Developer Console Workspace to init from, defaults to
Stage
-y, --yes Skip questions, and use all default values
--[no-]confirm-new-workspace Prompt to confirm before creating a new workspace
--github-pat= github personal access token to use for downloading private quickstart repos
--[no-]install [default: true] Run npm installation after files are created
--linter= [default: basic] Specify the linter to use for the project
--[no-]login Login using your Adobe ID for interacting with Adobe I/O Developer Console
--repo= Init from gh quick-start repo. Expected to be of the form //
--standalone-app Create a stand-alone application
--use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating),
prefer the JWT credentials
--version Show version
DESCRIPTION
Create a new Adobe I/O App
```
_See code: [src/commands/app/init.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/init.js)_
## `aio app install PATH`
This command will support installing apps packaged by 'aio app pack'.
```
USAGE
$ aio app install PATH [-v] [--version] [-o ] [--tests]
ARGUMENTS
PATH Path to the app package to install
FLAGS
-o, --output= [default: .] The packaged app output folder path
-v, --verbose Verbose output
--[no-]tests Run packaged app unit tests (e.g. aio app:test)
--version Show version
DESCRIPTION
This command will support installing apps packaged by 'aio app pack'.
```
_See code: [src/commands/app/install.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/install.js)_
## `aio app list`
List components for Adobe I/O App
```
USAGE
$ aio app list [-v] [--version]
FLAGS
-v, --verbose Verbose output
--version Show version
DESCRIPTION
List components for Adobe I/O App
```
_See code: [src/commands/app/list/index.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/list/index.js)_
## `aio app list extension`
List implemented extensions
```
USAGE
$ aio app list extension [-v] [--version] [-j] [-y]
FLAGS
-j, --json Output json
-v, --verbose Verbose output
-y, --yml Output yml
--version Show version
DESCRIPTION
List implemented extensions
ALIASES
$ aio app list ext
$ aio app list extensions
```
_See code: [src/commands/app/list/extension.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/list/extension.js)_
## `aio app logs`
Fetch logs for an Adobe I/O App
```
USAGE
$ aio app logs [-v] [--version] [-l ] [-a ] [-r] [-t | -w | -o]
FLAGS
-a, --action=... Fetch logs for a specific action
-l, --limit= [default: 1] Limit number of activations to fetch logs from ( 1-50 )
-o, --poll Fetch logs continuously
-r, --strip strip timestamp information and output first line only
-t, --tail Fetch logs continuously
-v, --verbose Verbose output
-w, --watch Fetch logs continuously
--version Show version
DESCRIPTION
Fetch logs for an Adobe I/O App
```
_See code: [src/commands/app/logs.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/logs.js)_
## `aio app pack [PATH]`
This command will support packaging apps for redistribution.
```
USAGE
$ aio app pack [PATH] [-v] [--version] [-o ]
ARGUMENTS
PATH [default: .] Path to the app directory to package
FLAGS
-o, --output= [default: dist/app.zip] The packaged app output file path
-v, --verbose Verbose output
--version Show version
DESCRIPTION
This command will support packaging apps for redistribution.
```
_See code: [src/commands/app/pack.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/pack.js)_
## `aio app run`
Run an Adobe I/O App
```
USAGE
$ aio app run [-v] [--version] [--local | ] [--serve] [--actions] [--open] [-e ]
FLAGS
-e, --extension= Run only a specific extension, this flag can only be specified once
-v, --verbose Verbose output
--[no-]actions [default: true] Run actions, defaults to true, to skip actions use --no-actions
--local [deprecated] Run/debug actions locally (requires Docker running, not available on Apple
Silicon Macs)
--open Open the default web browser after a successful run, only valid if your app has a front-end
--[no-]serve [default: true] Start frontend server (experimental)
--version Show version
DESCRIPTION
Run an Adobe I/O App
```
_See code: [src/commands/app/run.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/run.js)_
## `aio app test`
Run tests for an Adobe I/O App
```
USAGE
$ aio app test [-v] [--version] [-e | -a ] [--all] [--e2e] [--unit]
FLAGS
-a, --action=... the action(s) to test
-e, --extension=... the extension(s) to test
-v, --verbose Verbose output
--all run both unit and e2e tests
--e2e run e2e tests
--unit run unit tests
--version Show version
DESCRIPTION
Run tests for an Adobe I/O App
If no flags are specified, by default only unit-tests are run.
For the --action flag, it tries a substring search on the 'package-name/action-name' pair for an action.
For the --extension flag, it tries a substring search on the 'extension-name' only.
If the extension has a hook called 'test' in its 'ext.config.yaml', the script specified will be run instead.
```
_See code: [src/commands/app/test.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/test.js)_
## `aio app undeploy`
Undeploys an Adobe I/O App
```
USAGE
$ aio app undeploy [-v] [--version] [--actions] [--events] [--web-assets] [-e ] [--force-unpublish |
--unpublish]
FLAGS
-e, --extension=... Undeploy only a specific extension, the flags can be specified multiple times
-v, --verbose Verbose output
--[no-]actions [default: true] Undeploy actions if any
--[no-]events [default: true] Undeploy (unregister) events if any
--force-unpublish Force unpublish extension(s) from Exchange, will delete all extension points
--[no-]unpublish [default: true] Unpublish selected extension(s) from Exchange
--version Show version
--[no-]web-assets [default: true] Undeploy web-assets if any
DESCRIPTION
Undeploys an Adobe I/O App
```
_See code: [src/commands/app/undeploy.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/undeploy.js)_
## `aio app use [CONFIG_FILE_PATH]`
Import an Adobe Developer Console configuration file.
```
USAGE
$ aio app use [CONFIG_FILE_PATH] [-v] [--version] [--overwrite | -m] [-g | -w ]
[--confirm-new-workspace] [--no-service-sync | --confirm-service-sync] [--no-input] [--use-jwt]
ARGUMENTS
CONFIG_FILE_PATH path to an Adobe I/O Developer Console configuration file
FLAGS
-g, --global Use the global Adobe Developer Console Org / Project / Workspace configuration, which
can be set via `aio console` commands
-m, --merge Merge any .aio and .env files during import of the Adobe Developer Console configuration
file
-v, --verbose Verbose output
-w, --workspace= Specify the Adobe Developer Console Workspace name or Workspace id to import the
configuration from
--[no-]confirm-new-workspace Prompt to confirm before creating a new workspace
--confirm-service-sync Skip the Service sync prompt and overwrite Service subscriptions in the new Workspace
with current subscriptions
--no-input Skip user prompts by setting --no-service-sync and --merge. Requires one of
config_file_path or --global or --workspace
--no-service-sync Skip the Service sync prompt and do not attach current Service subscriptions to the new
Workspace
--overwrite Overwrite any .aio and .env files during import of the Adobe Developer Console
configuration file
--use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating),
prefer the JWT credentials
--version Show version
DESCRIPTION
Import an Adobe Developer Console configuration file.
If the optional configuration file is not set, this command will retrieve the console org, project, and workspace
settings from the global config.
To set these global config values, see the help text for 'aio console --help'.
To download the configuration file for your project, select the 'Download' button in the toolbar of your project's
page in https://developer.adobe.com/console/
```
_See code: [src/commands/app/use.js](https://github.com/adobe/aio-cli-plugin-app/blob/12.2.4/src/commands/app/use.js)_