From b967fd501938776da74293cca316a333754aac20 Mon Sep 17 00:00:00 2001 From: Shazron Abdullah <36107+shazron@users.noreply.github.com> Date: Tue, 16 May 2023 14:38:24 +0800 Subject: [PATCH] 10.2.0 --- README.md | 661 +++++++++++++++++++++++++++++++++++++++++++++++++++ package.json | 2 +- 2 files changed, 662 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 52d66b66..5c9660d9 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,9 @@ Create, Build and Deploy Adobe I/O Apps * [Usage](#usage) * [Commands](#commands) +* [Usage](#usage) +* [Commands](#commands) + # Usage ```sh-session @@ -71,6 +74,664 @@ 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/10.2.0/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 +``` + +## `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 +``` + +## `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 +``` + +## `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 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 a new Adobe I/O Events action + + +ALIASES + $ aio app add events +``` + +## `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 +``` + +## `aio app add service` + +Subscribe to Services in the current Workspace + +``` +USAGE + $ aio app add service [-v] [--version] + +FLAGS + -v, --verbose Verbose output + --version Show version + +DESCRIPTION + Subscribe to Services in the current Workspace + + +ALIASES + $ aio app add services +``` + +## `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 +``` + +## `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. +``` + +## `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 +``` + +## `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 +``` + +## `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 +``` + +## `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 +``` + +## `aio app delete event [EVENT-ACTION-NAME]` + +Delete existing Adobe I/O Events actions + +``` +USAGE + $ aio app delete event [EVENT-ACTION-NAME] [-v] [--version] [-y] + +ARGUMENTS + EVENT-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 Adobe I/O Events actions + + +ALIASES + $ aio app delete events +``` + +## `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 +``` + +## `aio app delete service` + +Delete Services in the current Workspace + +``` +USAGE + $ aio app delete service [-v] [--version] + +FLAGS + -v, --verbose Verbose output + --version Show version + +DESCRIPTION + Delete Services in the current Workspace + + +ALIASES + $ aio app delete services +``` + +## `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 +``` + +## `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] [--force-publish | | --publish] + [--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. + --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. +``` + +## `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 +``` + +## `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 +``` + +## `aio app init [PATH]` + +Create a new Adobe I/O App + +``` +USAGE + $ aio app init [PATH] [-v] [--version] [--install] [-y] [--login] [-e | -t ] + [--standalone-app | ] [-w | -i ] [--confirm-new-workspace] + +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 + --confirm-new-workspace Skip and confirm prompt for creating a new workspace + --[no-]install [default: true] Run npm installation after files are created + --[no-]login Login using your Adobe ID for interacting with Adobe I/O Developer Console + --standalone-app Create a stand-alone application + --version Show version + +DESCRIPTION + Create a new Adobe I/O App +``` + +## `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 +``` + +## `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 +``` + +## `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 +``` + +## `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 Run/debug actions locally (requires Docker running) + --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 +``` + +## `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. +``` + +## `aio app undeploy` + +Undeploys an Adobe I/O App + +``` +USAGE + $ aio app undeploy [-v] [--version] [--actions] [--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 + --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 +``` + +## `aio app use [CONFIG_FILE_PATH]` + +Import an Adobe Developer Console configuration file. + +``` +USAGE + $ aio app use [CONFIG_FILE_PATH] [-v] [--version] [--overwrite | --merge] [--confirm-new-workspace] [-w + | [-g | -w ] | ] [--no-service-sync | --confirm-service-sync] [--no-input] + +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 + -v, --verbose Verbose output + -w, --workspace= Specify the Adobe Developer Console Workspace name or Workspace id to import the + configuration from + -w, --workspace-name= [DEPRECATED]: please use --workspace instead + --confirm-new-workspace Skip and confirm prompt for creating a new workspace + --confirm-service-sync Skip the Service sync prompt and overwrite Service subscriptions in the new Workspace + with current subscriptions + --merge Merge any .aio and .env files during import of the Adobe Developer Console configuration + file + --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 + --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://console.adobe.io +``` + +* [`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 event [EVENT-ACTION-NAME]`](#aio-app-delete-event-event-action-name) +* [`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 list`](#aio-app-list) +* [`aio app list extension`](#aio-app-list-extension) +* [`aio app logs`](#aio-app-logs) +* [`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/10.1.1/src/commands/app/index.js)_ ## `aio app add` diff --git a/package.json b/package.json index a9c2749f..9a918fd6 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@adobe/aio-cli-plugin-app", "description": "Create, Build and Deploy Adobe I/O Applications", - "version": "10.1.1", + "version": "10.2.0", "author": "Adobe Inc.", "bugs": "https://github.com/adobe/aio-cli-plugin-app/issues", "dependencies": {