Onboarding Document

The aio cli provides the runtime plugin to create, run and manage Runtime entities like Packages, Actions, Triggers, Rules, APIs, Activations and Property. Each of these entities has subcommands like create , invoke etc. The commands can be used with the following template:

 aio runtime <command> <subcommand> <arguments> <flags>

The runtime plugin also provides the aio runtime deploy command which can be used to deploy entities in a manifest file. The deployment file can be used to bind parameters to the actions and triggers in the manifest file.

The aio runtime plugin is still a work in progress. There are some flags and features that are not currently supported by the runtime plugin. A detailed list of features which are implemented (and not implemented) can be found in the Feature Matrix.

The wskdeploy command expects a manifest file for deployment. If the path to a manifest file is not provided as a flag, wskdeploy checks for manifest.yaml in the current working directory for deployment. If this file is not present, it checks for manifest.yml. The aio runtime deploy command follows the same behavior. A similar behavior is implemented for the path to the deployment file. More details can be found at File Specific Scenarios

In order to use the aio cli runtime plugin, the .wskprops file needs to be set up, or the credentials set in the aio config:

aio config:set runtime.auth MY_RUNTIME_AUTH
aio config:set runtime.namespace MY_RUNTIME_NAMESPACE
aio config:set runtime.apihost https://adobeioruntime.net

The runtime plugin is included with the Adobe I/O CLI

1. Install the aio cli

  npm install -g @adobe/aio-cli

Any Bugs/Issues for the aio cli runtime plugin can be filed here