diff --git a/.github/workflows/daily-install-cli.yml b/.github/workflows/daily-install-cli.yml index 8b8edd69..2d6ad64b 100644 --- a/.github/workflows/daily-install-cli.yml +++ b/.github/workflows/daily-install-cli.yml @@ -14,7 +14,7 @@ jobs: runs-on: ${{ matrix.os }} strategy: matrix: - node: [14, 16] + node: [18, 20, 22, 24] os: [ubuntu-latest] steps: diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml index b2bf157e..6b629948 100644 --- a/.github/workflows/node.js.yml +++ b/.github/workflows/node.js.yml @@ -15,7 +15,7 @@ jobs: runs-on: ${{ matrix.os }} strategy: matrix: - node-version: [14.x, 16.x] + node-version: [18.x, 20.x, 22.x, 24.x] os: [ubuntu-latest, windows-latest] steps: @@ -40,6 +40,8 @@ jobs: ./bin/run runtime --help - name: upload coverage if: success() - uses: codecov/codecov-action@v3.1.1 + uses: codecov/codecov-action@v4 with: name: ${{ runner.os }} node.js ${{ matrix.node-version }} + token: ${{ secrets.CODECOV_TOKEN }} + fail_ci_if_error: false \ No newline at end of file diff --git a/.github/workflows/npm-audit.yml b/.github/workflows/npm-audit.yml index 208f3b23..03716932 100644 --- a/.github/workflows/npm-audit.yml +++ b/.github/workflows/npm-audit.yml @@ -11,7 +11,7 @@ jobs: runs-on: ${{ matrix.os }} strategy: matrix: - node: [16] + node: [22, 24] os: [ubuntu-latest] steps: diff --git a/.github/workflows/on-push-publish-to-npm.yml b/.github/workflows/on-push-publish-to-npm.yml index fdbf362d..8871ecf6 100644 --- a/.github/workflows/on-push-publish-to-npm.yml +++ b/.github/workflows/on-push-publish-to-npm.yml @@ -13,9 +13,10 @@ jobs: - uses: actions/checkout@v2 - uses: actions/setup-node@v1 with: - node-version: 16 + node-version: 22 - run: npm install - run: npm test - uses: JS-DevTools/npm-publish@v1 with: token: ${{ secrets.ADOBE_BOT_NPM_TOKEN }} + access: 'public' diff --git a/.github/workflows/prerelease-main.yml b/.github/workflows/prerelease-main.yml index 79b4a88a..57d4112b 100644 --- a/.github/workflows/prerelease-main.yml +++ b/.github/workflows/prerelease-main.yml @@ -30,7 +30,7 @@ jobs: git branch - uses: actions/setup-node@v1 with: - node-version: 16 + node-version: 22 - run: | npm pkg set name=${{ github.event.inputs.package-name }} npm pkg set bin.aio-next="./bin/run" diff --git a/.github/workflows/prerelease.yml b/.github/workflows/prerelease.yml index 25017c20..c9f0114c 100644 --- a/.github/workflows/prerelease.yml +++ b/.github/workflows/prerelease.yml @@ -17,7 +17,7 @@ on: dependencies-to-update: description: 'csv of dependencies to update with the dist-tag' required: false - default: '@adobe/aio-cli-plugin-app,@adobe/aio-cli-plugin-auth,@adobe/aio-cli-plugin-certificate,@adobe/aio-cli-plugin-config,@adobe/aio-cli-plugin-console,@adobe/aio-cli-plugin-events,@adobe/aio-cli-plugin-info,@adobe/aio-cli-plugin-runtime,@adobe/aio-cli-plugin-telemetry' + default: '@adobe/aio-cli-plugin-app,@adobe/aio-cli-plugin-auth,@adobe/aio-cli-plugin-certificate,@adobe/aio-cli-plugin-config,@adobe/aio-cli-plugin-console,@adobe/aio-cli-plugin-events,@adobe/aio-cli-plugin-info,@adobe/aio-cli-plugin-runtime,@adobe/aio-cli-plugin-telemetry,@adobe/aio-cli-plugin-app-templates' package-name: description: 'npm package name that pre-release testers will `npm install`' required: false @@ -34,7 +34,7 @@ jobs: git branch - uses: actions/setup-node@v1 with: - node-version: 16 + node-version: 22 - run: | npm pkg set name=${{ github.event.inputs.package-name }} npm pkg set bin.aio-next="./bin/run" diff --git a/.github/workflows/version-bump-publish.yml b/.github/workflows/version-bump-publish.yml index 05705aa1..49bfb6b5 100644 --- a/.github/workflows/version-bump-publish.yml +++ b/.github/workflows/version-bump-publish.yml @@ -22,7 +22,7 @@ jobs: git config user.email github-actions@github.com - uses: actions/setup-node@v1 with: - node-version: 16 + node-version: 22 - run: | npm install npm test diff --git a/README.md b/README.md index 53945d39..ac92a396 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,5 @@ +aio-cli +======= + +Adobe I/O Extensible CLI + [![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io) [![Version](https://img.shields.io/npm/v/@adobe/aio-cli.svg)](https://npmjs.org/package/@adobe/aio-cli) [![Downloads/week](https://img.shields.io/npm/dw/@adobe/aio-cli.svg)](https://npmjs.org/package/@adobe/aio-cli) @@ -17,20 +22,8 @@ governing permissions and limitations under the License. [![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-cli/master.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-cli/) -aio-cli -======= - -Adobe I/O Extensible CLI - -* [aio cli health](#aio-cli-health) -* [Getting started](#getting-started) -* [Technical requirements](#technical-requirements) -* [Proxy Support](#proxy-support) -* [Usage](#usage) -* [Commands](#commands) - -* [aio cli health](#aio-cli-health) +* [health](#health) * [Getting started](#getting-started) * [Technical requirements](#technical-requirements) * [Proxy Support](#proxy-support) @@ -38,14 +31,14 @@ Adobe I/O Extensible CLI * [Commands](#commands) +# health - -# aio cli health Health badges for the aio-cli and its plugins and modules + | Module | Version | Downloads | Build Status | Coverage | Issues | Pull Requests | |---|---|---|---|---|---|---| @@ -54,6 +47,7 @@ run gen-health-table.js with `npm run gen-health` | [@adobe/aio-cli-plugin-console](https://github.com/adobe/aio-cli-plugin-console) | [![Version](https://img.shields.io/npm/v/@adobe/aio-cli-plugin-console.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-console)| [![Downloads/week](https://img.shields.io/npm/dw/@adobe/aio-cli-plugin-console.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-console)| [![Node.js CI](https://github.com/adobe/aio-cli-plugin-console/actions/workflows/node.js.yml/badge.svg)](https://github.com/adobe/aio-cli-plugin-console/actions/workflows/node.js.yml)| [![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-cli-plugin-console/master.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-cli-plugin-console/)| [![Github Issues](https://img.shields.io/github/issues/adobe/aio-cli-plugin-console.svg)](https://github.com/adobe/aio-cli-plugin-console/issues)| [![Github Pull Requests](https://img.shields.io/github/issues-pr/adobe/aio-cli-plugin-console.svg)](https://github.com/adobe/aio-cli-plugin-console/pulls)| | [@adobe/aio-cli-plugin-runtime](https://github.com/adobe/aio-cli-plugin-runtime) | [![Version](https://img.shields.io/npm/v/@adobe/aio-cli-plugin-runtime.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-runtime)| [![Downloads/week](https://img.shields.io/npm/dw/@adobe/aio-cli-plugin-runtime.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-runtime)| [![Node.js CI](https://github.com/adobe/aio-cli-plugin-runtime/actions/workflows/node.js.yml/badge.svg)](https://github.com/adobe/aio-cli-plugin-runtime/actions/workflows/node.js.yml)| [![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-cli-plugin-runtime/master.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-cli-plugin-runtime/)| [![Github Issues](https://img.shields.io/github/issues/adobe/aio-cli-plugin-runtime.svg)](https://github.com/adobe/aio-cli-plugin-runtime/issues)| [![Github Pull Requests](https://img.shields.io/github/issues-pr/adobe/aio-cli-plugin-runtime.svg)](https://github.com/adobe/aio-cli-plugin-runtime/pulls)| | [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app) | [![Version](https://img.shields.io/npm/v/@adobe/aio-cli-plugin-app.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-app)| [![Downloads/week](https://img.shields.io/npm/dw/@adobe/aio-cli-plugin-app.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-app)| [![Node.js CI](https://github.com/adobe/aio-cli-plugin-app/actions/workflows/node.js.yml/badge.svg)](https://github.com/adobe/aio-cli-plugin-app/actions/workflows/node.js.yml)| [![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-cli-plugin-app/master.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-cli-plugin-app/)| [![Github Issues](https://img.shields.io/github/issues/adobe/aio-cli-plugin-app.svg)](https://github.com/adobe/aio-cli-plugin-app/issues)| [![Github Pull Requests](https://img.shields.io/github/issues-pr/adobe/aio-cli-plugin-app.svg)](https://github.com/adobe/aio-cli-plugin-app/pulls)| +| [@adobe/aio-cli-plugin-app-templates](https://github.com/adobe/aio-cli-plugin-app-templates) | [![Version](https://img.shields.io/npm/v/@adobe/aio-cli-plugin-app-templates.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-app-templates)| [![Downloads/week](https://img.shields.io/npm/dw/@adobe/aio-cli-plugin-app-templates.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-app-templates)| [![Node.js CI](https://github.com/adobe/aio-cli-plugin-app-templates/actions/workflows/node.js.yml/badge.svg)](https://github.com/adobe/aio-cli-plugin-app-templates/actions/workflows/node.js.yml)| [![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-cli-plugin-app-templates/master.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-cli-plugin-app-templates/)| [![Github Issues](https://img.shields.io/github/issues/adobe/aio-cli-plugin-app-templates.svg)](https://github.com/adobe/aio-cli-plugin-app-templates/issues)| [![Github Pull Requests](https://img.shields.io/github/issues-pr/adobe/aio-cli-plugin-app-templates.svg)](https://github.com/adobe/aio-cli-plugin-app-templates/pulls)| | [@adobe/aio-cli-plugin-auth](https://github.com/adobe/aio-cli-plugin-auth) | [![Version](https://img.shields.io/npm/v/@adobe/aio-cli-plugin-auth.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-auth)| [![Downloads/week](https://img.shields.io/npm/dw/@adobe/aio-cli-plugin-auth.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-auth)| [![Node.js CI](https://github.com/adobe/aio-cli-plugin-auth/actions/workflows/node.js.yml/badge.svg)](https://github.com/adobe/aio-cli-plugin-auth/actions/workflows/node.js.yml)| [![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-cli-plugin-auth/master.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-cli-plugin-auth/)| [![Github Issues](https://img.shields.io/github/issues/adobe/aio-cli-plugin-auth.svg)](https://github.com/adobe/aio-cli-plugin-auth/issues)| [![Github Pull Requests](https://img.shields.io/github/issues-pr/adobe/aio-cli-plugin-auth.svg)](https://github.com/adobe/aio-cli-plugin-auth/pulls)| | [@adobe/aio-cli-plugin-certificate](https://github.com/adobe/aio-cli-plugin-certificate) | [![Version](https://img.shields.io/npm/v/@adobe/aio-cli-plugin-certificate.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-certificate)| [![Downloads/week](https://img.shields.io/npm/dw/@adobe/aio-cli-plugin-certificate.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-certificate)| [![Node.js CI](https://github.com/adobe/aio-cli-plugin-certificate/actions/workflows/node.js.yml/badge.svg)](https://github.com/adobe/aio-cli-plugin-certificate/actions/workflows/node.js.yml)| [![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-cli-plugin-certificate/master.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-cli-plugin-certificate/)| [![Github Issues](https://img.shields.io/github/issues/adobe/aio-cli-plugin-certificate.svg)](https://github.com/adobe/aio-cli-plugin-certificate/issues)| [![Github Pull Requests](https://img.shields.io/github/issues-pr/adobe/aio-cli-plugin-certificate.svg)](https://github.com/adobe/aio-cli-plugin-certificate/pulls)| | [@adobe/aio-cli-plugin-info](https://github.com/adobe/aio-cli-plugin-info) | [![Version](https://img.shields.io/npm/v/@adobe/aio-cli-plugin-info.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-info)| [![Downloads/week](https://img.shields.io/npm/dw/@adobe/aio-cli-plugin-info.svg)](https://npmjs.org/package/@adobe/aio-cli-plugin-info)| [![Node.js CI](https://github.com/adobe/aio-cli-plugin-info/actions/workflows/node.js.yml/badge.svg)](https://github.com/adobe/aio-cli-plugin-info/actions/workflows/node.js.yml)| [![Codecov Coverage](https://img.shields.io/codecov/c/github/adobe/aio-cli-plugin-info/master.svg?style=flat-square)](https://codecov.io/gh/adobe/aio-cli-plugin-info/)| [![Github Issues](https://img.shields.io/github/issues/adobe/aio-cli-plugin-info.svg)](https://github.com/adobe/aio-cli-plugin-info/issues)| [![Github Pull Requests](https://img.shields.io/github/issues-pr/adobe/aio-cli-plugin-info.svg)](https://github.com/adobe/aio-cli-plugin-info/pulls)| @@ -65,58 +59,53 @@ run gen-health-table.js with `npm run gen-health` # Getting started -See the [Adobe Developer App Builder docs](https://www.adobe.io/apis/experienceplatform/project-firefly/docs.html) +See the [Adobe Developer App Builder docs](https://developer.adobe.com/app-builder/docs/overview/) # Technical requirements -See the [App Builder `Setting up Your Environment` doc](https://www.adobe.io/apis/experienceplatform/project-firefly/docs.html#!AdobeDocs/project-firefly/master/getting_started/setup.md) +See the [App Builder `Setting up Your Environment` doc](https://developer.adobe.com/app-builder/docs/getting_started/) # Proxy Support Set these environment variables, to use proxies (case sensitive): + 1. `HTTP_PROXY` 2. `HTTPS_PROXY` The appropriate proxy will be used to proxy http/https urls respectively. If your proxy requires basic authentication, embed the username and password in the url itself. For example, if your server is `https://example.com` and username is `user` and password is `password`, the url should look like this: -``` + +```sh https://user:password@example.com ``` + If your username or password contains non-alphanumeric characters, they **must** be url-encoded. You can verify if you set the proxy info properly by running: -``` + +```sh aio info ``` # Usage + ```sh-session $ npm install -g @adobe/aio-cli $ aio COMMAND running command... $ aio (--version|-v) -@adobe/aio-cli/9.4.1 win32-x64 node-v16.19.1 -$ aio --help [COMMAND] -USAGE - $ aio COMMAND -... -``` - -```sh-session -$ npm install -g @adobe/aio-cli -$ aio COMMAND -running command... -$ aio (--version) -@adobe/aio-cli/9.2.0 darwin-x64 node-v14.18.3 +@adobe/aio-cli/11.0.1 darwin-arm64 node-v24.9.0 $ aio --help [COMMAND] USAGE $ aio COMMAND ... ``` + # Commands + * [`aio app`](#aio-app) * [`aio app add`](#aio-app-add) @@ -132,6 +121,7 @@ USAGE * [`aio app add services`](#aio-app-add-services) * [`aio app add web-assets`](#aio-app-add-web-assets) * [`aio app build`](#aio-app-build) +* [`aio app clean`](#aio-app-clean) * [`aio app config`](#aio-app-config) * [`aio app config get`](#aio-app-config-get) * [`aio app config get lf`](#aio-app-config-get-lf) @@ -153,9 +143,11 @@ USAGE * [`aio app delete services`](#aio-app-delete-services) * [`aio app delete web-assets`](#aio-app-delete-web-assets) * [`aio app deploy`](#aio-app-deploy) +* [`aio app dev`](#aio-app-dev) * [`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 ext`](#aio-app-list-ext) * [`aio app list ext-points`](#aio-app-list-ext-points) @@ -163,7 +155,17 @@ USAGE * [`aio app list extension-points`](#aio-app-list-extension-points) * [`aio app list extensions`](#aio-app-list-extensions) * [`aio app logs`](#aio-app-logs) +* [`aio app pack [PATH]`](#aio-app-pack-path) * [`aio app run`](#aio-app-run) +* [`aio app state del [KEYS]`](#aio-app-state-del-keys) +* [`aio app state delete [KEYS]`](#aio-app-state-delete-keys) +* [`aio app state get KEY`](#aio-app-state-get-key) +* [`aio app state list`](#aio-app-state-list) +* [`aio app state ls`](#aio-app-state-ls) +* [`aio app state put KEY VALUE`](#aio-app-state-put-key-value) +* [`aio app state remove [KEYS]`](#aio-app-state-remove-keys) +* [`aio app state rm [KEYS]`](#aio-app-state-rm-keys) +* [`aio app state stats`](#aio-app-state-stats) * [`aio app test`](#aio-app-test) * [`aio app undeploy`](#aio-app-undeploy) * [`aio app use [CONFIG_FILE_PATH]`](#aio-app-use-config_file_path) @@ -247,20 +249,21 @@ USAGE * [`aio event registration get REGISTRATIONID`](#aio-event-registration-get-registrationid) * [`aio event registration list`](#aio-event-registration-list) * [`aio event registration ls`](#aio-event-registration-ls) -* [`aio help [COMMANDS]`](#aio-help-commands) +* [`aio help [COMMAND]`](#aio-help-command) * [`aio info`](#aio-info) * [`aio login`](#aio-login) * [`aio logout`](#aio-logout) * [`aio open`](#aio-open) * [`aio plugins`](#aio-plugins) -* [`aio plugins:install PLUGIN...`](#aio-pluginsinstall-plugin) +* [`aio plugins add PLUGIN`](#aio-plugins-add-plugin) * [`aio plugins discover`](#aio-plugins-discover) * [`aio plugins:inspect PLUGIN...`](#aio-pluginsinspect-plugin) -* [`aio plugins:install PLUGIN...`](#aio-pluginsinstall-plugin-1) -* [`aio plugins:link PLUGIN`](#aio-pluginslink-plugin) -* [`aio plugins:uninstall PLUGIN...`](#aio-pluginsuninstall-plugin) -* [`aio plugins:uninstall PLUGIN...`](#aio-pluginsuninstall-plugin-1) -* [`aio plugins:uninstall PLUGIN...`](#aio-pluginsuninstall-plugin-2) +* [`aio plugins install PLUGIN`](#aio-plugins-install-plugin) +* [`aio plugins link PATH`](#aio-plugins-link-path) +* [`aio plugins remove [PLUGIN]`](#aio-plugins-remove-plugin) +* [`aio plugins reset`](#aio-plugins-reset) +* [`aio plugins uninstall [PLUGIN]`](#aio-plugins-uninstall-plugin) +* [`aio plugins unlink [PLUGIN]`](#aio-plugins-unlink-plugin) * [`aio plugins update`](#aio-plugins-update) * [`aio report`](#aio-report) * [`aio rollback`](#aio-rollback) @@ -309,6 +312,7 @@ USAGE * [`aio rt namespace lf set`](#aio-rt-namespace-lf-set) * [`aio rt namespace lf set adobe-io-runtime`](#aio-rt-namespace-lf-set-adobe-io-runtime) * [`aio rt namespace lf set azure-log-analytics`](#aio-rt-namespace-lf-set-azure-log-analytics) +* [`aio rt namespace lf set new-relic`](#aio-rt-namespace-lf-set-new-relic) * [`aio rt namespace lf set splunk-hec`](#aio-rt-namespace-lf-set-splunk-hec) * [`aio rt namespace list`](#aio-rt-namespace-list) * [`aio rt namespace log-forwarding`](#aio-rt-namespace-log-forwarding) @@ -317,6 +321,7 @@ USAGE * [`aio rt namespace log-forwarding set`](#aio-rt-namespace-log-forwarding-set) * [`aio rt namespace log-forwarding set adobe-io-runtime`](#aio-rt-namespace-log-forwarding-set-adobe-io-runtime) * [`aio rt namespace log-forwarding set azure-log-analytics`](#aio-rt-namespace-log-forwarding-set-azure-log-analytics) +* [`aio rt namespace log-forwarding set new-relic`](#aio-rt-namespace-log-forwarding-set-new-relic) * [`aio rt namespace log-forwarding set splunk-hec`](#aio-rt-namespace-log-forwarding-set-splunk-hec) * [`aio rt namespace ls`](#aio-rt-namespace-ls) * [`aio rt ns`](#aio-rt-ns) @@ -326,6 +331,7 @@ USAGE * [`aio rt ns lf set`](#aio-rt-ns-lf-set) * [`aio rt ns lf set adobe-io-runtime`](#aio-rt-ns-lf-set-adobe-io-runtime) * [`aio rt ns lf set azure-log-analytics`](#aio-rt-ns-lf-set-azure-log-analytics) +* [`aio rt ns lf set new-relic`](#aio-rt-ns-lf-set-new-relic) * [`aio rt ns lf set splunk-hec`](#aio-rt-ns-lf-set-splunk-hec) * [`aio rt ns list`](#aio-rt-ns-list) * [`aio rt ns log-forwarding`](#aio-rt-ns-log-forwarding) @@ -334,6 +340,7 @@ USAGE * [`aio rt ns log-forwarding set`](#aio-rt-ns-log-forwarding-set) * [`aio rt ns log-forwarding set adobe-io-runtime`](#aio-rt-ns-log-forwarding-set-adobe-io-runtime) * [`aio rt ns log-forwarding set azure-log-analytics`](#aio-rt-ns-log-forwarding-set-azure-log-analytics) +* [`aio rt ns log-forwarding set new-relic`](#aio-rt-ns-log-forwarding-set-new-relic) * [`aio rt ns log-forwarding set splunk-hec`](#aio-rt-ns-log-forwarding-set-splunk-hec) * [`aio rt ns ls`](#aio-rt-ns-ls) * [`aio rt package`](#aio-rt-package) @@ -429,6 +436,7 @@ USAGE * [`aio runtime namespace lf set`](#aio-runtime-namespace-lf-set) * [`aio runtime namespace lf set adobe-io-runtime`](#aio-runtime-namespace-lf-set-adobe-io-runtime) * [`aio runtime namespace lf set azure-log-analytics`](#aio-runtime-namespace-lf-set-azure-log-analytics) +* [`aio runtime namespace lf set new-relic`](#aio-runtime-namespace-lf-set-new-relic) * [`aio runtime namespace lf set splunk-hec`](#aio-runtime-namespace-lf-set-splunk-hec) * [`aio runtime namespace list`](#aio-runtime-namespace-list) * [`aio runtime namespace log-forwarding`](#aio-runtime-namespace-log-forwarding) @@ -437,6 +445,7 @@ USAGE * [`aio runtime namespace log-forwarding set`](#aio-runtime-namespace-log-forwarding-set) * [`aio runtime namespace log-forwarding set adobe-io-runtime`](#aio-runtime-namespace-log-forwarding-set-adobe-io-runtime) * [`aio runtime namespace log-forwarding set azure-log-analytics`](#aio-runtime-namespace-log-forwarding-set-azure-log-analytics) +* [`aio runtime namespace log-forwarding set new-relic`](#aio-runtime-namespace-log-forwarding-set-new-relic) * [`aio runtime namespace log-forwarding set splunk-hec`](#aio-runtime-namespace-log-forwarding-set-splunk-hec) * [`aio runtime namespace ls`](#aio-runtime-namespace-ls) * [`aio runtime ns`](#aio-runtime-ns) @@ -446,6 +455,7 @@ USAGE * [`aio runtime ns lf set`](#aio-runtime-ns-lf-set) * [`aio runtime ns lf set adobe-io-runtime`](#aio-runtime-ns-lf-set-adobe-io-runtime) * [`aio runtime ns lf set azure-log-analytics`](#aio-runtime-ns-lf-set-azure-log-analytics) +* [`aio runtime ns lf set new-relic`](#aio-runtime-ns-lf-set-new-relic) * [`aio runtime ns lf set splunk-hec`](#aio-runtime-ns-lf-set-splunk-hec) * [`aio runtime ns list`](#aio-runtime-ns-list) * [`aio runtime ns log-forwarding`](#aio-runtime-ns-log-forwarding) @@ -454,6 +464,7 @@ USAGE * [`aio runtime ns log-forwarding set`](#aio-runtime-ns-log-forwarding-set) * [`aio runtime ns log-forwarding set adobe-io-runtime`](#aio-runtime-ns-log-forwarding-set-adobe-io-runtime) * [`aio runtime ns log-forwarding set azure-log-analytics`](#aio-runtime-ns-log-forwarding-set-azure-log-analytics) +* [`aio runtime ns log-forwarding set new-relic`](#aio-runtime-ns-log-forwarding-set-new-relic) * [`aio runtime ns log-forwarding set splunk-hec`](#aio-runtime-ns-log-forwarding-set-splunk-hec) * [`aio runtime ns ls`](#aio-runtime-ns-ls) * [`aio runtime package`](#aio-runtime-package) @@ -531,13 +542,13 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Create, run, test, and deploy Adobe I/O Apps ``` -_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/11.0.0/src/commands/app/index.ts)_ +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/index.js)_ ## `aio app add` @@ -549,12 +560,14 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Add a new component to an existing Adobe I/O App ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/add/index.js)_ + ## `aio app add action` Add new actions @@ -567,8 +580,8 @@ 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 + --[no-]install [default: true] Run npm installation after files are created + --version Show version DESCRIPTION Add new actions @@ -578,6 +591,8 @@ ALIASES $ aio app add actions ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/add/action.js)_ + ## `aio app add actions` Add new actions @@ -590,8 +605,8 @@ 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 + --[no-]install [default: true] Run npm installation after files are created + --version Show version DESCRIPTION Add new actions @@ -611,12 +626,14 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Add CI files ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/add/ci.js)_ + ## `aio app add event` Add a new Adobe I/O Events action @@ -629,8 +646,8 @@ 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 + --[no-]install [default: true] Run npm installation after files are created + --version Show version DESCRIPTION Add a new Adobe I/O Events action @@ -640,6 +657,8 @@ ALIASES $ aio app add events ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/add/event.js)_ + ## `aio app add events` Add a new Adobe I/O Events action @@ -652,8 +671,8 @@ 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 + --[no-]install [default: true] Run npm installation after files are created + --version Show version DESCRIPTION Add a new Adobe I/O Events action @@ -669,14 +688,14 @@ Add new extensions to the project ``` USAGE - $ aio app add ext [-v] [--version] [--install] [-y] [-e ] + $ aio app add ext [-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 + --[no-]install [default: true] Run npm installation after files are created + --version Show version DESCRIPTION Add new extensions to the project @@ -693,14 +712,14 @@ Add new extensions to the project ``` USAGE - $ aio app add extension [-v] [--version] [--install] [-y] [-e ] + $ 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 + --[no-]install [default: true] Run npm installation after files are created + --version Show version DESCRIPTION Add new extensions to the project @@ -711,20 +730,22 @@ ALIASES $ aio app add extensions ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/add/extension.js)_ + ## `aio app add extensions` Add new extensions to the project ``` USAGE - $ aio app add extensions [-v] [--version] [--install] [-y] [-e ] + $ aio app add extensions [-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 + --[no-]install [default: true] Run npm installation after files are created + --version Show version DESCRIPTION Add new extensions to the project @@ -745,9 +766,9 @@ USAGE FLAGS -v, --verbose Verbose output - --use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating), prefer the JWT + --use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating), prefer the JWT credentials - --version Show version + --version Show version DESCRIPTION Subscribe to Services in the current Workspace @@ -757,6 +778,8 @@ ALIASES $ aio app add services ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/add/service.js)_ + ## `aio app add services` Subscribe to Services in the current Workspace @@ -767,9 +790,9 @@ USAGE FLAGS -v, --verbose Verbose output - --use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating), prefer the JWT + --use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating), prefer the JWT credentials - --version Show version + --version Show version DESCRIPTION Subscribe to Services in the current Workspace @@ -791,40 +814,70 @@ 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 + --[no-]install [default: true] Run npm installation after files are created + --version Show version DESCRIPTION Add web assets support ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/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 | ] + $ 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 + --[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. + Build the actions and web assets for an Adobe I/O App. Build is optimized to only build what is necessary. + Use the --force-build flag to force a build even if one already exists. +``` + +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/build.js)_ + +## `aio app clean` + +Remove all build artifacts from the local machine + +``` +USAGE + $ aio app clean [-v] [--version] + +FLAGS + -v, --verbose Verbose output + --version Show version + +DESCRIPTION + Remove all build artifacts from the local machine + This command completely cleans all build artifacts from the dist directory including: + - Action build files + - Web assets (both production and development) + - Build tracking files + - Deployment tracking files + + Note that this will require a full rebuild on your next build command. ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/clean.js)_ + ## `aio app config` Manage app config @@ -835,7 +888,7 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Manage app config @@ -845,6 +898,8 @@ ALIASES $ aio app config ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/config/index.js)_ + ## `aio app config get` Get app config @@ -855,7 +910,7 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Get app config @@ -864,6 +919,8 @@ ALIASES $ aio app config get ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/config/get/index.js)_ + ## `aio app config get lf` Get log forwarding destination configuration @@ -874,7 +931,7 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Get log forwarding destination configuration @@ -894,7 +951,7 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Get log forwarding errors @@ -914,7 +971,7 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Get log forwarding destination configuration @@ -924,6 +981,8 @@ ALIASES $ aio app config get lf ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/config/get/log-forwarding.js)_ + ## `aio app config get log-forwarding errors` Get log forwarding errors @@ -934,7 +993,7 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Get log forwarding errors @@ -944,6 +1003,8 @@ ALIASES $ aio app config get lf errors ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/config/get/log-forwarding/errors.js)_ + ## `aio app config set` Set app config @@ -954,7 +1015,7 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Set app config @@ -963,6 +1024,8 @@ ALIASES $ aio app config set ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/config/set/index.js)_ + ## `aio app config set lf` Set log forwarding destination configuration @@ -973,7 +1036,7 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Set log forwarding destination configuration @@ -993,7 +1056,7 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Set log forwarding destination configuration @@ -1003,6 +1066,8 @@ ALIASES $ aio app config set lf ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/config/set/log-forwarding.js)_ + ## `aio app create [PATH]` Create a new Adobe I/O App with default parameters @@ -1017,12 +1082,14 @@ ARGUMENTS FLAGS -i, --import= Import an Adobe I/O Developer Console configuration file -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Create a new Adobe I/O App with default parameters ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/create.js)_ + ## `aio app delete` Delete a component from an existing Adobe I/O App @@ -1033,12 +1100,14 @@ USAGE FLAGS -v, --verbose Verbose output - --version Show version + --version Show version DESCRIPTION Delete a component from an existing Adobe I/O App ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/delete/index.js)_ + ## `aio app delete action [ACTION-NAME]` Delete existing actions @@ -1053,7 +1122,7 @@ ARGUMENTS FLAGS -v, --verbose Verbose output -y, --yes Skip questions, and use all default values - --version Show version + --version Show version DESCRIPTION Delete existing actions @@ -1063,6 +1132,8 @@ ALIASES $ aio app delete actions ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/delete/action.js)_ + ## `aio app delete actions [ACTION-NAME]` Delete existing actions @@ -1077,7 +1148,7 @@ ARGUMENTS FLAGS -v, --verbose Verbose output -y, --yes Skip questions, and use all default values - --version Show version + --version Show version DESCRIPTION Delete existing actions @@ -1098,26 +1169,28 @@ USAGE FLAGS -v, --verbose Verbose output -y, --yes Skip questions, and use all default values - --version Show version + --version Show version DESCRIPTION Delete existing CI files ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/delete/ci.js)_ + ## `aio app delete ext` Delete existing extensions ``` USAGE - $ aio app delete ext [-v] [--version] [-y] [--install] [-e ] + $ aio app delete ext [-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 + --[no-]install [default: true] Run npm installation after files are created + --version Show version DESCRIPTION Delete existing extensions @@ -1134,14 +1207,14 @@ Delete existing extensions ``` USAGE - $ aio app delete extension [-v] [--version] [-y] [--install] [-e ] + $ 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 + --[no-]install [default: true] Run npm installation after files are created + --version Show version DESCRIPTION Delete existing extensions @@ -1152,20 +1225,22 @@ ALIASES $ aio app delete extensions ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/delete/extension.js)_ + ## `aio app delete extensions` Delete existing extensions ``` USAGE - $ aio app delete extensions [-v] [--version] [-y] [--install] [-e ] + $ aio app delete extensions [-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 + --[no-]install [default: true] Run npm installation after files are created + --version Show version DESCRIPTION Delete existing extensions @@ -1186,9 +1261,9 @@ USAGE FLAGS -v, --verbose Verbose output - --use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating), prefer the JWT + --use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating), prefer the JWT credentials - --version Show version + --version Show version DESCRIPTION Delete Services in the current Workspace @@ -1198,6 +1273,8 @@ ALIASES $ aio app delete services ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/delete/service.js)_ + ## `aio app delete services` Delete Services in the current Workspace @@ -1208,9 +1285,9 @@ USAGE FLAGS -v, --verbose Verbose output - --use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating), prefer the JWT + --use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating), prefer the JWT credentials - --version Show version + --version Show version DESCRIPTION Delete Services in the current Workspace @@ -1231,72 +1308,102 @@ USAGE FLAGS -v, --verbose Verbose output -y, --yes Skip questions, and use all default values - --version Show version + --version Show version DESCRIPTION Delete existing web assets ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/delete/web-assets.js)_ + ## `aio app deploy` -Build and deploy an Adobe I/O App +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] - [--force-events | | ] [--log-forwarding-update] + $ 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. + -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 + Deploy an Adobe I/O App + + Deploys the actions and web assets for an Adobe I/O App. + This will also build any changed actions or web assets before deploying. + Use the --force-build flag to force a build even if one already exists. + Deploy is optimized to only deploy what is necessary. Be aware that deploying actions will overwrite any previous + deployments. + Use the --force-deploy flag to force deploy changes, regardless of production Workspace being published in Exchange. +``` + +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/deploy.js)_ + +## `aio app dev` + +Run your App Builder app locally + +``` +USAGE + $ aio app dev [-v] [--version] [-o] [-e ] + +FLAGS + -e, --extension= Run only a specific extension, this flag can only be specified once + -o, --open Open the default web browser after a successful run, only valid if your app has a front-end + -v, --verbose Verbose output + --version Show version + +DESCRIPTION + Run your App Builder app locally ``` +_See code: [@adobe/aio-cli-plugin-app-dev](https://github.com/adobe/aio-cli-plugin-app-dev/blob/2.1.2/src/commands/app/dev/index.js)_ + ## `aio app get-url [ACTION]` Get action URLs ``` USAGE - $ aio app get-url [ACTION] [-v] [--version] [--cdn] [-j] [-h] [-y] [--local] + $ aio app get-url [ACTION] [-v] [--version] [--cdn] [-j] [-h] [-y] 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 + --cdn Display CDN based action URLs + --version Show version DESCRIPTION Get action URLs ``` +_See code: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/src/commands/app/get-url.js)_ + ## `aio app info` Display settings/configuration in use by an Adobe I/O App @@ -1306,49 +1413,81 @@ 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 + -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: [@adobe/aio-cli-plugin-app](https://github.com/adobe/aio-cli-plugin-app/blob/14.1.2/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 ] - [--standalone-app | ] [-w | -i ] [--confirm-new-workspace] [--use-jwt] + $ 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 - --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 - --use-jwt if the config has both jwt and OAuth Server to Server Credentials (while migrating), - prefer the JWT credentials - --version Show version + -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=