diff --git a/README.md b/README.md index b203b6e7..82f3a879 100644 --- a/README.md +++ b/README.md @@ -29,33 +29,49 @@ $ aio app --help * [`aio app`](#aio-app) * [`aio app:add`](#aio-appadd) * [`aio app:add:action`](#aio-appaddaction) +* [`aio app:add:actions`](#aio-appaddactions) * [`aio app:add:ci`](#aio-appaddci) * [`aio app:add:event`](#aio-appaddevent) +* [`aio app:add:events`](#aio-appaddevents) +* [`aio app:add:ext`](#aio-appaddext) * [`aio app:add:extension`](#aio-appaddextension) +* [`aio app:add:extensions`](#aio-appaddextensions) * [`aio app:add:service`](#aio-appaddservice) +* [`aio app:add:services`](#aio-appaddservices) * [`aio app:add:web-assets`](#aio-appaddweb-assets) * [`aio app:build`](#aio-appbuild) * [`aio app:config`](#aio-appconfig) * [`aio app:config:get`](#aio-appconfigget) +* [`aio app:config:get:lf`](#aio-appconfiggetlf) +* [`aio app:config:get:lf:errors`](#aio-appconfiggetlferrors) * [`aio app:config:get:log-forwarding`](#aio-appconfiggetlog-forwarding) * [`aio app:config:get:log-forwarding:errors`](#aio-appconfiggetlog-forwardingerrors) * [`aio app:config:set`](#aio-appconfigset) +* [`aio app:config:set:lf`](#aio-appconfigsetlf) * [`aio app:config:set:log-forwarding`](#aio-appconfigsetlog-forwarding) * [`aio app:create [PATH]`](#aio-appcreate-path) * [`aio app:delete`](#aio-appdelete) * [`aio app:delete:action [ACTION-NAME]`](#aio-appdeleteaction-action-name) +* [`aio app:delete:actions [ACTION-NAME]`](#aio-appdeleteactions-action-name) * [`aio app:delete:ci`](#aio-appdeleteci) * [`aio app:delete:event [EVENT-ACTION-NAME]`](#aio-appdeleteevent-event-action-name) +* [`aio app:delete:events [EVENT-ACTION-NAME]`](#aio-appdeleteevents-event-action-name) +* [`aio app:delete:ext`](#aio-appdeleteext) * [`aio app:delete:extension`](#aio-appdeleteextension) +* [`aio app:delete:extensions`](#aio-appdeleteextensions) * [`aio app:delete:service`](#aio-appdeleteservice) +* [`aio app:delete:services`](#aio-appdeleteservices) * [`aio app:delete:web-assets`](#aio-appdeleteweb-assets) * [`aio app:deploy`](#aio-appdeploy) * [`aio app:get-url [ACTION]`](#aio-appget-url-action) * [`aio app:info`](#aio-appinfo) * [`aio app:init [PATH]`](#aio-appinit-path) * [`aio app:list`](#aio-applist) +* [`aio app:list:ext`](#aio-applistext) +* [`aio app:list:ext-points`](#aio-applistext-points) * [`aio app:list:extension`](#aio-applistextension) * [`aio app:list:extension-points`](#aio-applistextension-points) +* [`aio app:list:extensions`](#aio-applistextensions) * [`aio app:logs`](#aio-applogs) * [`aio app:run`](#aio-apprun) * [`aio app:test`](#aio-apptest) @@ -68,14 +84,17 @@ Create, run, test, and deploy Adobe I/O Apps ``` USAGE - $ aio app + $ aio app [-v] [--version] -OPTIONS +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/8.6.1/src/commands/app/index.js)_ +_See code: [src/commands/app/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/index.ts)_ ## `aio app:add` @@ -83,14 +102,17 @@ Add a new component to an existing Adobe I/O App ``` USAGE - $ aio app:add + $ aio app:add [-v] [--version] -OPTIONS +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/8.6.1/src/commands/app/add/index.js)_ +_See code: [src/commands/app/add/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/add/index.ts)_ ## `aio app:add:action` @@ -98,21 +120,47 @@ Add new actions ``` USAGE - $ aio app:add:action + $ aio app:add:action [-v] [--version] [-s] [--install] [-y] [-e ] + +FLAGS + -e, --extension= Add actions to a specific extension + -s, --skip-install [deprecated] Please use --no-install + -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 -OPTIONS - -e, --extension=extension Add actions to a specific extension - -s, --skip-install [deprecated] Please use --no-install - -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/8.6.1/src/commands/app/add/action.js)_ +_See code: [src/commands/app/add/action.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/add/action.ts)_ + +## `aio app:add:actions` + +Add new actions + +``` +USAGE + $ aio app:add:actions [-v] [--version] [-s] [--install] [-y] [-e ] + +FLAGS + -e, --extension= Add actions to a specific extension + -s, --skip-install [deprecated] Please use --no-install + -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` @@ -120,14 +168,17 @@ Add CI files ``` USAGE - $ aio app:add:ci + $ aio app:add:ci [-v] [--version] -OPTIONS +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/8.6.1/src/commands/app/add/ci.js)_ +_See code: [src/commands/app/add/ci.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/add/ci.ts)_ ## `aio app:add:event` @@ -135,21 +186,71 @@ Add a new Adobe I/O Events action ``` USAGE - $ aio app:add:event + $ aio app:add:event [-v] [--version] [-s] [--install] [-y] [-e ] -OPTIONS - -e, --extension=extension Add actions to a specific extension - -s, --skip-install [deprecated] Please use --no-install - -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 +FLAGS + -e, --extension= Add actions to a specific extension + -s, --skip-install [deprecated] Please use --no-install + -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/8.6.1/src/commands/app/add/event.js)_ +_See code: [src/commands/app/add/event.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/add/event.ts)_ + +## `aio app:add:events` + +Add a new Adobe I/O Events action + +``` +USAGE + $ aio app:add:events [-v] [--version] [-s] [--install] [-y] [-e ] + +FLAGS + -e, --extension= Add actions to a specific extension + -s, --skip-install [deprecated] Please use --no-install + -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:ext` + +Add new extensions or a standalone application to the project + +``` +USAGE + $ aio app:add:ext [-v] [--version] [-s] [--install] [-y] [-e ] + +FLAGS + -e, --extension=... Specify extensions to add, skips selection prompt + -s, --skip-install [deprecated] Please use --no-install + -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 or a standalone application to the project + +ALIASES + $ aio app:add:ext + $ aio app:add:extensions +``` ## `aio app:add:extension` @@ -157,99 +258,143 @@ Add new extensions or a standalone application to the project ``` USAGE - $ aio app:add:extension + $ aio app:add:extension [-v] [--version] [-s] [--install] [-y] [-e ] + +FLAGS + -e, --extension=... Specify extensions to add, skips selection prompt + -s, --skip-install [deprecated] Please use --no-install + -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 -OPTIONS - -e, --extension=extension Specify extensions to add, skips selection prompt - -s, --skip-install [deprecated] Please use --no-install - -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 or a standalone application 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/8.6.1/src/commands/app/add/extension.js)_ +_See code: [src/commands/app/add/extension.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/add/extension.ts)_ -## `aio app:add:service` +## `aio app:add:extensions` -Subscribe to Services in the current Workspace +Add new extensions or a standalone application to the project ``` USAGE - $ aio app:add:service + $ aio app:add:extensions [-v] [--version] [-s] [--install] [-y] [-e ] -OPTIONS - -v, --verbose Verbose output - --version Show version +FLAGS + -e, --extension=... Specify extensions to add, skips selection prompt + -s, --skip-install [deprecated] Please use --no-install + -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 or a standalone application to the project ALIASES - $ aio app:add:services + $ aio app:add:ext + $ aio app:add:extensions ``` -_See code: [src/commands/app/add/service.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/add/service.js)_ - -## `aio app:add:web-assets` +## `aio app:add:service` -Add web assets support +Subscribe to Services in the current Workspace ``` USAGE - $ aio app:add:web-assets + $ aio app:add:service [-v] [--version] -OPTIONS - -e, --extension=extension Add web-assets to a specific extension - -s, --skip-install [deprecated] Please use --no-install - -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 +FLAGS + -v, --verbose Verbose output + --version Show version + +DESCRIPTION + Subscribe to Services in the current Workspace + +ALIASES + $ aio app:add:services ``` -_See code: [src/commands/app/add/web-assets.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/add/web-assets.js)_ +_See code: [src/commands/app/add/service.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/add/service.ts)_ -## `aio app:build` +## `aio app:add:services` -Build an Adobe I/O App +Subscribe to Services in the current Workspace ``` USAGE - $ aio app:build + $ aio app:add:services [-v] [--version] -OPTIONS - -a, --action=action Build only a specific action, the flags can be specified multiple times, this will set - --no-publish +FLAGS + -v, --verbose Verbose output + --version Show version - -e, --extension=extension Build only a specific extension point, the flags can be specified multiple times +DESCRIPTION + Subscribe to Services in the current Workspace - -v, --verbose Verbose output +ALIASES + $ aio app:add:services +``` - --[no-]actions [default: true] Build actions if any +## `aio app:add:web-assets` - --[no-]content-hash [default: true] Enable content hashing in browser code +Add web assets support - --[no-]force-build [default: true] Force a build even if one already exists +``` +USAGE + $ aio app:add:web-assets [-v] [--version] [-s] [--install] [-y] [-e ] - --skip-actions [deprecated] Please use --no-actions +FLAGS + -e, --extension= Add web-assets to a specific extension + -s, --skip-install [deprecated] Please use --no-install + -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 - --skip-static [deprecated] Please use --no-web-assets +DESCRIPTION + Add web assets support +``` - --skip-web-assets [deprecated] Please use --no-web-assets +_See code: [src/commands/app/add/web-assets.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/add/web-assets.ts)_ - --version Show version +## `aio app:build` - --[no-]web-assets [default: true] Build web-assets if any +Build an Adobe I/O App - --web-optimize [default: false] Enable optimization (minification) of js/css/html +``` +USAGE + $ aio app:build [-v] [--version] [--skip-static] [--skip-web-assets] [--skip-actions] [--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 + --skip-actions [deprecated] Please use --no-actions + --skip-static [deprecated] Please use --no-web-assets + --skip-web-assets [deprecated] Please use --no-web-assets + --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/8.6.1/src/commands/app/build.js)_ +_See code: [src/commands/app/build.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/build.ts)_ ## `aio app:config` @@ -257,18 +402,21 @@ Manage app config ``` USAGE - $ aio app:config + $ aio app:config [-v] [--version] -OPTIONS +FLAGS -v, --verbose Verbose output --version Show version +DESCRIPTION + Manage app config + ALIASES $ aio app:config $ aio app:config ``` -_See code: [src/commands/app/config/index.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/config/index.js)_ +_See code: [src/commands/app/config/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/config/index.ts)_ ## `aio app:config:get` @@ -276,36 +424,82 @@ Get app config ``` USAGE - $ aio app:config:get + $ aio app:config:get [-v] [--version] -OPTIONS +FLAGS -v, --verbose Verbose output --version Show version +DESCRIPTION + Get app config + ALIASES $ aio app:config:get ``` -_See code: [src/commands/app/config/get/index.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/config/get/index.js)_ +_See code: [src/commands/app/config/get/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/config/get/index.ts)_ -## `aio app:config:get:log-forwarding` +## `aio app:config:get:lf` Get log forwarding destination configuration ``` USAGE + $ aio app:config:get:lf [-v] [--version] + +FLAGS + -v, --verbose Verbose output + --version Show version + +DESCRIPTION + Get log forwarding destination configuration + +ALIASES $ aio app:config:get:log-forwarding + $ aio app:config:get:lf +``` + +## `aio app:config:get:lf:errors` + +Get log forwarding errors -OPTIONS +``` +USAGE + $ aio app:config:get:lf:errors [-v] [--version] + +FLAGS + -v, --verbose Verbose output + --version Show version + +DESCRIPTION + Get log forwarding errors + +ALIASES + $ aio app:config:get:log-forwarding:errors + $ aio app:config:get:lf:errors +``` + +## `aio app:config:get:log-forwarding` + +Get log forwarding destination configuration + +``` +USAGE + $ aio app:config:get:log-forwarding [-v] [--version] + +FLAGS -v, --verbose Verbose output --version Show version +DESCRIPTION + Get log forwarding destination configuration + ALIASES $ aio app:config:get:log-forwarding $ aio app:config:get:lf ``` -_See code: [src/commands/app/config/get/log-forwarding.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/config/get/log-forwarding.js)_ +_See code: [src/commands/app/config/get/log-forwarding.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/config/get/log-forwarding.ts)_ ## `aio app:config:get:log-forwarding:errors` @@ -313,18 +507,21 @@ Get log forwarding errors ``` USAGE - $ aio app:config:get:log-forwarding:errors + $ aio app:config:get:log-forwarding:errors [-v] [--version] -OPTIONS +FLAGS -v, --verbose Verbose output --version Show version +DESCRIPTION + Get log forwarding errors + ALIASES $ aio app:config:get:log-forwarding:errors $ aio app:config:get:lf:errors ``` -_See code: [src/commands/app/config/get/log-forwarding/errors.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/config/get/log-forwarding/errors.js)_ +_See code: [src/commands/app/config/get/log-forwarding/errors.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/config/get/log-forwarding/errors.ts)_ ## `aio app:config:set` @@ -332,36 +529,62 @@ Set app config ``` USAGE - $ aio app:config:set + $ aio app:config:set [-v] [--version] -OPTIONS +FLAGS -v, --verbose Verbose output --version Show version +DESCRIPTION + Set app config + ALIASES $ aio app:config:set ``` -_See code: [src/commands/app/config/set/index.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/config/set/index.js)_ +_See code: [src/commands/app/config/set/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/config/set/index.ts)_ -## `aio app:config:set:log-forwarding` +## `aio app:config:set:lf` Set log forwarding destination configuration ``` USAGE + $ aio app:config:set:lf [-v] [--version] + +FLAGS + -v, --verbose Verbose output + --version Show version + +DESCRIPTION + Set log forwarding destination configuration + +ALIASES $ aio app:config:set:log-forwarding + $ aio app:config:set:lf +``` + +## `aio app:config:set:log-forwarding` + +Set log forwarding destination configuration + +``` +USAGE + $ aio app:config:set:log-forwarding [-v] [--version] -OPTIONS +FLAGS -v, --verbose Verbose output --version Show version +DESCRIPTION + Set log forwarding destination configuration + ALIASES $ aio app:config:set:log-forwarding $ aio app:config:set:lf ``` -_See code: [src/commands/app/config/set/log-forwarding.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/config/set/log-forwarding.js)_ +_See code: [src/commands/app/config/set/log-forwarding.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/config/set/log-forwarding.ts)_ ## `aio app:create [PATH]` @@ -369,18 +592,21 @@ Create a new Adobe I/O App with default parameters ``` USAGE - $ aio app:create [PATH] + $ aio app:create [PATH] [-v] [--version] [-i ] ARGUMENTS PATH [default: .] Path to the app directory -OPTIONS - -i, --import=import Import an Adobe I/O Developer Console configuration file - -v, --verbose Verbose output - --version Show version +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/8.6.1/src/commands/app/create.js)_ +_See code: [src/commands/app/create.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/create.ts)_ ## `aio app:delete` @@ -388,14 +614,17 @@ Delete a component from an existing Adobe I/O App ``` USAGE - $ aio app:delete + $ aio app:delete [-v] [--version] -OPTIONS +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/8.6.1/src/commands/app/delete/index.js)_ +_See code: [src/commands/app/delete/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/delete/index.ts)_ ## `aio app:delete:action [ACTION-NAME]` @@ -403,21 +632,47 @@ Delete existing actions ``` USAGE - $ aio app:delete:action [ACTION-NAME] + $ 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 -OPTIONS +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/8.6.1/src/commands/app/delete/action.js)_ +_See code: [src/commands/app/delete/action.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/delete/action.ts)_ + +## `aio app:delete:actions [ACTION-NAME]` + +Delete existing actions + +``` +USAGE + $ aio app:delete:actions [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` @@ -425,15 +680,18 @@ Delete existing CI files ``` USAGE - $ aio app:delete:ci + $ aio app:delete:ci [-v] [--version] [-y] -OPTIONS +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/8.6.1/src/commands/app/delete/ci.js)_ +_See code: [src/commands/app/delete/ci.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/delete/ci.ts)_ ## `aio app:delete:event [EVENT-ACTION-NAME]` @@ -441,21 +699,70 @@ Delete existing Adobe I/O Events actions ``` USAGE - $ aio app:delete:event [EVENT-ACTION-NAME] + $ 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 -OPTIONS +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 ``` -_See code: [src/commands/app/delete/event.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/delete/event.js)_ +_See code: [src/commands/app/delete/event.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/delete/event.ts)_ + +## `aio app:delete:events [EVENT-ACTION-NAME]` + +Delete existing Adobe I/O Events actions + +``` +USAGE + $ aio app:delete:events [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:ext` + +Delete existing extensions + +``` +USAGE + $ aio app:delete:ext [-v] [--version] [-y] [--skip-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 + --skip-install Skip 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:extension` @@ -463,21 +770,47 @@ Delete existing extensions ``` USAGE - $ aio app:delete:extension + $ aio app:delete:extension [-v] [--version] [-y] [--skip-install] [-e ] -OPTIONS - -e, --extension=extension Specify extensions to delete, skips selection prompt - -v, --verbose Verbose output - -y, --yes Skip questions, and use all default values - --skip-install Skip npm installation after files are created - --version Show version +FLAGS + -e, --extension=... Specify extensions to delete, skips selection prompt + -v, --verbose Verbose output + -y, --yes Skip questions, and use all default values + --skip-install Skip 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/8.6.1/src/commands/app/delete/extension.js)_ +_See code: [src/commands/app/delete/extension.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/delete/extension.ts)_ + +## `aio app:delete:extensions` + +Delete existing extensions + +``` +USAGE + $ aio app:delete:extensions [-v] [--version] [-y] [--skip-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 + --skip-install Skip 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` @@ -485,17 +818,39 @@ Delete Services in the current Workspace ``` USAGE - $ aio app:delete:service + $ aio app:delete:service [-v] [--version] -OPTIONS +FLAGS -v, --verbose Verbose output --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/8.6.1/src/commands/app/delete/service.js)_ +_See code: [src/commands/app/delete/service.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/delete/service.ts)_ + +## `aio app:delete:services` + +Delete Services in the current Workspace + +``` +USAGE + $ aio app:delete:services [-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` @@ -503,15 +858,18 @@ Delete existing web assets ``` USAGE - $ aio app:delete:web-assets + $ aio app:delete:web-assets [-v] [--version] [-y] -OPTIONS +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/8.6.1/src/commands/app/delete/web-assets.js)_ +_See code: [src/commands/app/delete/web-assets.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/delete/web-assets.ts)_ ## `aio app:deploy` @@ -519,54 +877,40 @@ Build and deploy an Adobe I/O App ``` USAGE - $ aio app:deploy + $ aio app:deploy [-v] [--version] [--skip-static] [--skip-web-assets] [--skip-actions] [--actions | -a + ] [--web-assets] [--force-build | ] [--content-hash] [--web-optimize] [-e | ] [--skip-build] + [--skip-deploy] [--build] [--open] [--force-publish | | [--publish | ]] [--log-forwarding-update] -OPTIONS - -a, --action=action Deploy only a specific action, the flags can be specified multiple times, this will set +FLAGS + -a, --action=... Deploy only a specific action, the flags can be specified multiple times, this will set --no-publish - - -e, --extension=extension Deploy only a specific extension, the flags can be specified multiple times - + -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-publish 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 - --skip-actions [deprecated] Please use --no-actions - --skip-build [deprecated] Please use --no-build - --skip-deploy [deprecated] Please use 'aio app build' - --skip-static [deprecated] Please use --no-web-assets - --skip-web-assets [deprecated] Please use --no-web-assets - --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/8.6.1/src/commands/app/deploy.js)_ +_See code: [src/commands/app/deploy.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/deploy.ts)_ ## `aio app:get-url [ACTION]` @@ -574,9 +918,9 @@ Get action URLs ``` USAGE - $ aio app:get-url [ACTION] + $ aio app:get-url [ACTION] [-v] [--version] [--cdn] [-j] [-h] [-y] [--local] -OPTIONS +FLAGS -h, --hson Output human readable json -j, --json Output json -v, --verbose Verbose output @@ -584,9 +928,12 @@ OPTIONS --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/8.6.1/src/commands/app/get-url.js)_ +_See code: [src/commands/app/get-url.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/get-url.ts)_ ## `aio app:info` @@ -594,18 +941,21 @@ Display settings/configuration in use by an Adobe I/O App ``` USAGE - $ aio app:info + $ aio app:info [-v] [--version] [-j | -h | -y] [--mask] -OPTIONS +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/8.6.1/src/commands/app/info.js)_ +_See code: [src/commands/app/info.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/info.ts)_ ## `aio app:init [PATH]` @@ -613,49 +963,93 @@ Create a new Adobe I/O App ``` USAGE - $ aio app:init [PATH] + $ aio app:init [PATH] [-v] [--version] [-s] [--install] [-y] [--login] [-e | --extensions] [-w + | -i ] [--confirm-new-workspace] ARGUMENTS PATH [default: .] Path to the app directory -OPTIONS - -e, --extension=extension Extension point(s) to implement - -i, --import=import Import an Adobe I/O Developer Console configuration file - -s, --skip-install [deprecated] Please use --no-install - -v, --verbose Verbose output +FLAGS + -e, --extension=... Extension point(s) to implement + -i, --import= Import an Adobe I/O Developer Console configuration file + -s, --skip-install [deprecated] Please use --no-install + -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-]extensions Use --no-extensions to create a blank application that does not integrate with Exchange + --[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 + --version Show version - -w, --workspace=workspace [default: Stage] Specify the Adobe Developer Console Workspace to init from, defaults to - Stage +DESCRIPTION + Create a new Adobe I/O App +``` - -y, --yes Skip questions, and use all default values +_See code: [src/commands/app/init.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/init.ts)_ - --confirm-new-workspace Skip and confirm prompt for creating a new workspace +## `aio app:list` - --[no-]extensions Use --no-extensions to create a blank application that does not integrate with Exchange +List components for Adobe I/O App - --[no-]install [default: true] Run npm installation after files are created +``` +USAGE + $ aio app:list [-v] [--version] - --[no-]login Login using your Adobe ID for interacting with Adobe I/O Developer Console +FLAGS + -v, --verbose Verbose output + --version Show version - --version Show version +DESCRIPTION + List components for Adobe I/O App ``` -_See code: [src/commands/app/init.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/init.js)_ +_See code: [src/commands/app/list/index.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/list/index.ts)_ -## `aio app:list` +## `aio app:list:ext` -List components for Adobe I/O App +List implemented extensions ``` USAGE - $ aio app:list + $ aio app:list:ext [-v] [--version] [-j] [-y] -OPTIONS +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:list:ext-points` + +List all extension points for the selected org + ``` +USAGE + $ aio app:list:ext-points [-v] [--version] [-j] [-y] -_See code: [src/commands/app/list/index.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/list/index.js)_ +FLAGS + -j, --json Output json + -v, --verbose Verbose output + -y, --yml Output yml + --version Show version + +DESCRIPTION + List all extension points for the selected org + +ALIASES + $ aio app:list:ext-points + $ aio app:list:extension-points +``` ## `aio app:list:extension` @@ -663,20 +1057,23 @@ List implemented extensions ``` USAGE - $ aio app:list:extension + $ aio app:list:extension [-v] [--version] [-j] [-y] -OPTIONS +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/8.6.1/src/commands/app/list/extension.js)_ +_See code: [src/commands/app/list/extension.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/list/extension.ts)_ ## `aio app:list:extension-points` @@ -684,20 +1081,45 @@ List all extension points for the selected org ``` USAGE - $ aio app:list:extension-points + $ aio app:list:extension-points [-v] [--version] [-j] [-y] -OPTIONS +FLAGS -j, --json Output json -v, --verbose Verbose output -y, --yml Output yml --version Show version +DESCRIPTION + List all extension points for the selected org + ALIASES $ aio app:list:ext-points $ aio app:list:extension-points ``` -_See code: [src/commands/app/list/extension-points.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/list/extension-points.js)_ +_See code: [src/commands/app/list/extension-points.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/list/extension-points.ts)_ + +## `aio app:list:extensions` + +List implemented extensions + +``` +USAGE + $ aio app:list:extensions [-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` @@ -705,20 +1127,23 @@ Fetch logs for an Adobe I/O App ``` USAGE - $ aio app:logs + $ 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 -OPTIONS - -a, --action=action Fetch logs for a specific action - -l, --limit=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/8.6.1/src/commands/app/logs.js)_ +_See code: [src/commands/app/logs.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/logs.ts)_ ## `aio app:run` @@ -726,20 +1151,23 @@ Run an Adobe I/O App ``` USAGE - $ aio app:run + $ aio app:run [-v] [--version] [--serve] [--actions | [--local | --skip-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) + --skip-actions [deprecated] Please use --no-actions + --version Show version -OPTIONS - -e, --extension=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) - --skip-actions [deprecated] Please use --no-actions - --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/8.6.1/src/commands/app/run.js)_ +_See code: [src/commands/app/run.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/run.ts)_ ## `aio app:test` @@ -747,24 +1175,30 @@ Run tests for an Adobe I/O App ``` USAGE - $ aio app:test + $ aio app:test [-v] [--version] [-e | -a ] [--all] [--e2e] [--unit] -OPTIONS - -a, --action=action the action(s) to test - -e, --extension=extension the extension(s) to test - --all run both unit and e2e tests - --e2e run e2e tests - --unit run unit tests +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/8.6.1/src/commands/app/test.js)_ +_See code: [src/commands/app/test.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/test.ts)_ ## `aio app:undeploy` @@ -772,22 +1206,26 @@ Undeploys an Adobe I/O App ``` USAGE - $ aio app:undeploy + $ aio app:undeploy [-v] [--version] [--skip-static] [--skip-web-assets] [--skip-actions] [--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 + --skip-actions [deprecated] Please use --no-actions + --skip-static [deprecated] Please use --no-web-assets + --skip-web-assets [deprecated] Please use --no-web-assets + --[no-]unpublish [default: true] Unpublish selected extension(s) from Exchange + --version Show version + --[no-]web-assets [default: true] Undeploy web-assets if any -OPTIONS - -e, --extension=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 - --skip-actions [deprecated] Please use --no-actions - --skip-static [deprecated] Please use --no-web-assets - --skip-web-assets [deprecated] Please use --no-web-assets - --[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/8.6.1/src/commands/app/undeploy.js)_ +_See code: [src/commands/app/undeploy.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/undeploy.ts)_ ## `aio app:use [CONFIG_FILE_PATH]` @@ -795,50 +1233,43 @@ Import an Adobe Developer Console configuration file. ``` USAGE - $ aio app:use [CONFIG_FILE_PATH] + $ 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 -OPTIONS - -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=workspace Specify the Adobe Developer Console Workspace name or Workspace id to import the - configuration from - - -w, --workspace-name=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 +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 - If the optional configuration file is not set, this command will retrieve the console org, project, and workspace + 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 + 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 ``` -_See code: [src/commands/app/use.js](https://github.com/adobe/aio-cli-plugin-app/blob/8.6.1/src/commands/app/use.js)_ +_See code: [src/commands/app/use.ts](https://github.com/adobe/aio-cli-plugin-app/blob/9.0.0/src/commands/app/use.ts)_ diff --git a/package.json b/package.json index e6285c36..41ae684f 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": "8.6.1", + "version": "9.0.0", "author": "Adobe Inc.", "bugs": "https://github.com/adobe/aio-cli-plugin-app/issues", "dependencies": {