README
aio-cli
Adobe I/O Extensible CLI
aio cli health
Health badges for the aio-cli and its plugins and modules
Module | Version | Downloads | Build Status | Coverage | Issues | Pull Requests |
---|---|---|---|---|---|---|
@adobe/aio-cli | ||||||
@adobe/aio-cli-plugin-config | ||||||
@adobe/aio-cli-plugin-console | ||||||
@adobe/aio-cli-plugin-runtime | ||||||
@adobe/aio-cli-plugin-app | ||||||
@adobe/aio-cli-plugin-auth | ||||||
@adobe/aio-cli-plugin-certificate | ||||||
@adobe/aio-cli-plugin-info | ||||||
@adobe/aio-cli-plugin-events | ||||||
@adobe/generator-aio-app | ||||||
@adobe/generator-aio-console | ||||||
Getting started
See the Adobe Developer App Builder docs
Technical requirements
See the App Builder Setting up Your Environment
doc
Usage
$ npm install -g @adobe/aio-cli
$ aio COMMAND
running command...
$ aio (-v|--version|version)
@adobe/aio-cli/8.2.0 darwin-x64 node-v14.17.4
$ aio --help [COMMAND]
USAGE
$ aio COMMAND
...
Commands
aio app
aio app:add
aio app:add:action
aio app:add:ci
aio app:add:event
aio app:add:extension
aio app:add:service
aio app:add:web-assets
aio app:build
aio app:create [PATH]
aio app:delete
aio app:delete:action [ACTION-NAME]
aio app:delete:ci
aio app:delete:event [EVENT-ACTION-NAME]
aio app:delete:extension
aio app:delete:service
aio app:delete:web-assets
aio app:deploy
aio app:get-url [ACTION]
aio app:info
aio app:init [PATH]
aio app:list
aio app:list:extension
aio app:list:extension-points
aio app:logs
aio app:run
aio app:test
aio app:undeploy
aio app:use [CONFIG_FILE_PATH]
aio auth
aio auth:ctx
aio auth:login
aio auth:logout
aio autocomplete [SHELL]
aio certificate
aio certificate:generate
aio certificate:verify FILE
aio config
aio config:clear
aio config:delete KEYS...
aio config:edit
aio config:get KEY
aio config:list
aio config set key 'a value' # set key to 'a value'
aio console
aio console:org
aio console:org:list
aio console:org:select [ORGCODE]
aio console:project
aio console:project:list
aio console:project:select [PROJECTIDORNAME]
aio console:where
aio console:workspace
aio console:workspace:download [DESTINATION]
aio console:workspace:list
aio console:workspace:select [WORKSPACEIDORNAME]
aio discover
aio event
aio event:eventmetadata
aio event:eventmetadata:create PROVIDERID
aio event:eventmetadata:delete PROVIDERID [EVENTCODE]
aio event:eventmetadata:get PROVIDERID EVENTCODE
aio event:eventmetadata:list PROVIDERID
aio event:eventmetadata:update PROVIDERID EVENTCODE
aio event:provider
aio event:provider:create
aio event:provider:delete PROVIDERID
aio event:provider:get PROVIDERID
aio event:provider:list
aio event:provider:update PROVIDERID
aio event:registration
aio event:registration:create BODYJSONFILE
aio event:registration:delete REGISTRATIONID
aio event:registration:get REGISTRATIONID
aio event:registration:list
aio help [COMMAND]
aio info
aio plugins
aio plugins:inspect PLUGIN...
aio plugins:install PLUGIN...
aio plugins:link PLUGIN
aio plugins:uninstall PLUGIN...
aio plugins:update
aio report
aio rollback
aio runtime
aio runtime:action
aio runtime:action:create ACTIONNAME [ACTIONPATH]
aio runtime:action:delete ACTIONNAME
aio runtime:action:get ACTIONNAME
aio runtime:action:invoke ACTIONNAME
aio runtime:action:list [PACKAGENAME]
aio runtime:action:update ACTIONNAME [ACTIONPATH]
aio runtime:activation
aio runtime:activation:get [ACTIVATIONID]
aio runtime:activation:list [ACTIVATION_NAME]
aio runtime:activation:logs [ACTIVATIONID]
aio runtime:activation:result [ACTIVATIONID]
aio runtime:deploy
aio runtime:deploy:export
aio runtime:deploy:report
aio runtime:deploy:sync
aio runtime:deploy:undeploy
aio runtime:deploy:version
aio runtime:namespace
aio runtime:namespace:get
aio runtime:namespace:list
aio runtime:namespace:log-forwarding
aio runtime:namespace:log-forwarding:get
aio runtime:namespace:log-forwarding:set
aio runtime:namespace:log-forwarding:set:adobe-io-runtime
aio runtime:namespace:log-forwarding:set:azure-log-analytics
aio runtime:namespace:log-forwarding:set:splunk-hec
aio runtime:package
aio runtime:package:bind PACKAGENAME BINDPACKAGENAME
aio runtime:package:create PACKAGENAME
aio runtime:package:delete PACKAGENAME
aio runtime:package:get PACKAGENAME
aio runtime:package:list [NAMESPACE]
aio runtime:package:update PACKAGENAME
aio runtime:property
aio runtime:property:get
aio runtime:property:set
aio runtime:property:unset
aio runtime:route
aio runtime:route:create [BASEPATH] [RELPATH] [APIVERB] [ACTION]
aio runtime:route:delete BASEPATHORAPINAME [RELPATH] [APIVERB]
aio runtime:route:get BASEPATHORAPINAME
aio runtime:route:list [BASEPATH] [RELPATH] [APIVERB]
aio runtime:rule
aio runtime:rule:create NAME TRIGGER ACTION
aio runtime:rule:delete NAME
aio runtime:rule:disable NAME
aio runtime:rule:enable NAME
aio runtime:rule:get NAME
aio runtime:rule:list
aio runtime:rule:status NAME
aio runtime:rule:update NAME TRIGGER ACTION
aio runtime:trigger
aio runtime:trigger:create TRIGGERNAME
aio runtime:trigger:delete TRIGGERPATH
aio runtime:trigger:fire TRIGGERNAME
aio runtime:trigger:get TRIGGERPATH
aio runtime:trigger:list
aio runtime:trigger:update TRIGGERNAME
aio update
aio app
Create, run, test, and deploy Adobe I/O Apps
Create, run, test, and deploy Adobe I/O Apps
USAGE
$ aio app
OPTIONS
-v, --verbose Verbose output
--version Show version
See code: @adobe/aio-cli-plugin-app
aio app:add
Add a new component to an existing Adobe I/O App
Add a new component to an existing Adobe I/O App
USAGE
$ aio app:add
OPTIONS
-v, --verbose Verbose output
--version Show version
See code: @adobe/aio-cli-plugin-app
aio app:add:action
Add new actions
Add new actions
USAGE
$ aio app:add:action
OPTIONS
-e, --extension=extension Add actions to a specific extension
-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
ALIASES
$ aio app:add:actions
See code: @adobe/aio-cli-plugin-app
aio app:add:ci
Add CI files
Add CI files
USAGE
$ aio app:add:ci
OPTIONS
-v, --verbose Verbose output
--version Show version
See code: @adobe/aio-cli-plugin-app
aio app:add:event
Add a new Adobe I/O Events action
Add a new Adobe I/O Events action
USAGE
$ aio app:add:event
OPTIONS
-e, --extension=extension Add actions to a specific extension
-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
ALIASES
$ aio app:add:events
See code: @adobe/aio-cli-plugin-app
aio app:add:extension
Add new extensions or a standalone application to the project
Add new extensions or a standalone application to the project
USAGE
$ aio app:add:extension
OPTIONS
-e, --extension=extension Specify extensions to add, 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
ALIASES
$ aio app:add:ext
$ aio app:add:extensions
See code: @adobe/aio-cli-plugin-app
aio app:add:service
Subscribe to Services in the current Workspace
Subscribe to Services in the current Workspace
USAGE
$ aio app:add:service
OPTIONS
-v, --verbose Verbose output
--version Show version
ALIASES
$ aio app:add:services
See code: @adobe/aio-cli-plugin-app
aio app:add:web-assets
Add web assets support
Add web assets support
USAGE
$ aio app:add:web-assets
OPTIONS
-e, --extension=extension Add web-assets to a specific extension
-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
See code: @adobe/aio-cli-plugin-app
aio app:build
Build an Adobe I/O App
Build an Adobe I/O App
This will always force a rebuild unless --no-force-build is set.
USAGE
$ aio app:build
OPTIONS
-a, --action=action Build only a specific action, the flags can be specified multiple times, this will set
--no-publish
-e, --extension=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
This will always force a rebuild unless --no-force-build is set.
See code: @adobe/aio-cli-plugin-app
aio app:create [PATH]
Create a new Adobe I/O App with default parameters
Create a new Adobe I/O App with default parameters
USAGE
$ aio app:create [PATH]
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
See code: @adobe/aio-cli-plugin-app
aio app:delete
Delete a component from an existing Adobe I/O App
Delete a component from an existing Adobe I/O App
USAGE
$ aio app:delete
OPTIONS
-v, --verbose Verbose output
--version Show version
See code: @adobe/aio-cli-plugin-app
aio app:delete:action [ACTION-NAME]
Delete existing actions
Delete existing actions
USAGE
$ aio app:delete:action [ACTION-NAME]
ARGUMENTS
ACTION-NAME Action `pkg/name` to delete, you can specify multiple actions via a comma separated list
OPTIONS
-v, --verbose Verbose output
-y, --yes Skip questions, and use all default values
--version Show version
ALIASES
$ aio app:delete:actions
See code: @adobe/aio-cli-plugin-app
aio app:delete:ci
Delete existing CI files
Delete existing CI files
USAGE
$ aio app:delete:ci
OPTIONS
-v, --verbose Verbose output
-y, --yes Skip questions, and use all default values
--version Show version
See code: @adobe/aio-cli-plugin-app
aio app:delete:event [EVENT-ACTION-NAME]
Delete existing Adobe I/O Events actions
Delete existing Adobe I/O Events actions
USAGE
$ aio app:delete:event [EVENT-ACTION-NAME]
ARGUMENTS
EVENT-ACTION-NAME Action `pkg/name` to delete, you can specify multiple actions via a comma separated list
OPTIONS
-v, --verbose Verbose output
-y, --yes Skip questions, and use all default values
--version Show version
ALIASES
$ aio app:delete:events
See code: @adobe/aio-cli-plugin-app
aio app:delete:extension
Add new extensions or a standalone application to the project
Add new extensions or a standalone application to the project
USAGE
$ aio app:delete:extension
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
ALIASES
$ aio app:delete:ext
$ aio app:delete:extensions
See code: @adobe/aio-cli-plugin-app
aio app:delete:service
Delete Services in the current Workspace
Delete Services in the current Workspace
USAGE
$ aio app:delete:service
OPTIONS
-v, --verbose Verbose output
--version Show version
ALIASES
$ aio app:delete:services
See code: @adobe/aio-cli-plugin-app
aio app:delete:web-assets
Delete existing web assets
Delete existing web assets
USAGE
$ aio app:delete:web-assets
OPTIONS
-v, --verbose Verbose output
-y, --yes Skip questions, and use all default values
--version Show version
See code: @adobe/aio-cli-plugin-app
aio app:deploy
Build and deploy an Adobe I/O App
Build and deploy an Adobe I/O App
This will always force a rebuild unless --no-force-build is set.
USAGE
$ aio app:deploy
OPTIONS
-a, --action=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
-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
--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
This will always force a rebuild unless --no-force-build is set.
See code: @adobe/aio-cli-plugin-app
aio app:get-url [ACTION]
Get action URLs
Get action URLs
USAGE
$ aio app:get-url [ACTION]
OPTIONS
-h, --hson Output human readable json
-j, --json Output json
-v, --verbose Verbose output
-y, --yml Output yml
--cdn Display CDN based action URLs
--version Show version
See code: @adobe/aio-cli-plugin-app
aio app:info
Display settings/configuration in use by an Adobe I/O App
Display settings/configuration in use by an Adobe I/O App
USAGE
$ aio app:info
OPTIONS
-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
See code: @adobe/aio-cli-plugin-app
aio app:init [PATH]
Create a new Adobe I/O App
Create a new Adobe I/O App
USAGE
$ aio app:init [PATH]
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 Skip npm installation after files are created
-v, --verbose Verbose output
-w, --workspace=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-]extensions Use --no-extensions to create a blank application that does not integrate with Exchange
--[no-]login Login using your Adobe ID for interacting with Adobe I/O Developer Console
--version Show version
See code: @adobe/aio-cli-plugin-app
aio app:list
List components for Adobe I/O App
List components for Adobe I/O App
USAGE
$ aio app:list
OPTIONS
-v, --verbose Verbose output
--version Show version
See code: @adobe/aio-cli-plugin-app
aio app:list:extension
List implemented extensions
List implemented extensions
USAGE
$ aio app:list:extension
OPTIONS
-j, --json Output json
-v, --verbose Verbose output
-y, --yml Output yml
--version Show version
ALIASES
$ aio app:list:ext
$ aio app:list:extensions
See code: @adobe/aio-cli-plugin-app
aio app:list:extension-points
List all extension points for the selected org
List all extension points for the selected org
USAGE
$ aio app:list:extension-points
OPTIONS
-j, --json Output json
-v, --verbose Verbose output
-y, --yml Output yml
--version Show version
ALIASES
$ aio app:list:ext-points
$ aio app:list:extension-points
See code: @adobe/aio-cli-plugin-app
aio app:logs
Fetch logs for an Adobe I/O App
Fetch logs for an Adobe I/O App
USAGE
$ aio app:logs
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
See code: @adobe/aio-cli-plugin-app
aio app:run
Run an Adobe I/O App
Run an Adobe I/O App
USAGE
$ aio app:run
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
See code: @adobe/aio-cli-plugin-app
aio app:test
Run tests for an Adobe I/O App
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.
USAGE
$ aio app:test
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
DESCRIPTION
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: @adobe/aio-cli-plugin-app
aio app:undeploy
Undeploys an Adobe I/O App
Undeploys an Adobe I/O App
USAGE
$ aio app:undeploy
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
See code: @adobe/aio-cli-plugin-app
aio app:use [CONFIG_FILE_PATH]
Import an Adobe Developer Console configuration file.
Import an Adobe Developer Console configuration file.
If the optional configuration file is not set, this command will retrieve the console org, project, and workspace settings from the global config.
To set these global config values, see the help text for 'aio console --help'.
To download the configuration file for your project, select the 'Download' button in the toolbar of your project's page in https://console.adobe.io
USAGE
$ aio app:use [CONFIG_FILE_PATH]
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 to import the configuration
from
-w, --workspace-name=workspace-name [DEPRECATED]: please use --workspace instead
--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
settings from the global config.
To set these global config values, see the help text for 'aio console --help'.
To download the configuration file for your project, select the 'Download' button in the toolbar of your project's
page in https://console.adobe.io
See code: @adobe/aio-cli-plugin-app
aio auth
Adobe IMS commands to login and logout.
Adobe IMS commands to login and logout.
The main commands are auth:login to get or create an access token and
auth:logout to invalidate an access token and thus log out from Adobe IMS.
Logging in and out is based on configuration of which there may be
multiple. Each set of configuration properties, called an Adobe IMS context,
can be individually addressed by a label.
Configuration for the Adobe IMS commands is stored in the "ims"
configuration property. The special property "ims.config.current" contains the
label of the current configuration which can be set using the
"aio auth ctx -s <label>" command.
Each set of properties in a labeled Adobe IMS context configurations has
configuration properties depending on the kind of access that is
supported. The below example shows the configuration for OAuth2
based (graphical SUSI) login.
The "env" property is optional and designates the Adobe IMS environment
used for authentication. Possible values are "stage" and "prod".
If the property is missing or any other value, it defaults to "prod".
All commands allow their normal output to be formatted in either
HJSON (default), JSON, or YAML.
USAGE
$ aio auth
DESCRIPTION
The main commands are auth:login to get or create an access token and
auth:logout to invalidate an access token and thus log out from Adobe IMS.
Logging in and out is based on configuration of which there may be
multiple. Each set of configuration properties, called an Adobe IMS context,
can be individually addressed by a label.
Configuration for the Adobe IMS commands is stored in the "ims"
configuration property. The special property "ims.config.current" contains the
label of the current configuration which can be set using the
"aio auth ctx -s <label>" command.
Each set of properties in a labeled Adobe IMS context configurations has
configuration properties depending on the kind of access that is
supported. The below example shows the configuration for OAuth2
based (graphical SUSI) login.
The "env" property is optional and designates the Adobe IMS environment
used for authentication. Possible values are "stage" and "prod".
If the property is missing or any other value, it defaults to "prod".
All commands allow their normal output to be formatted in either
HJSON (default), JSON, or YAML.
EXAMPLE
{
ims: {
contexts: {
postman: {
env: "stage",
callback_url: "https://callback.example.com",
client_id: "example.com-client-id",
client_secret: "XXXXXXXX",
scope: "openid AdobeID additional_info.projectedProductContext read_organizations",
state: ""
}
},
config: {
current: "postman"
}
}
}
See code: @adobe/aio-cli-plugin-auth
aio auth:ctx
Manage Adobe IMS contexts.
Manage Adobe IMS contexts.
The following options exist for this command:
* List the names of the configured Adobe IMS contexts
* Print the name of the current Adobe IMS context
* Set the name of the current Adobe IMS context
* Print the configuration of the current or a named Adobe IMS context
Currently it is not possible to update the Adobe Adobe IMS context configuration
using this command. Use the "aio config" commands for this.
e.g. aio config:set ims.contexts.your_context.your_context_key "your_context_value"
Please note, that the following IMS context label names is reserved: `cli`
and should not be used as an IMS context name.
Also note that the current context can only be set locally.
USAGE
$ aio auth:ctx
OPTIONS
-c, --ctx=ctx Name of the Adobe IMS context to use. Default is the current Adobe IMS context
-g, --global global config
-l, --local local config
-s, --set=set Sets the name of the current local Adobe IMS context
-v, --verbose Verbose output
--debug=debug Debug level output
--list Names of the Adobe IMS contexts as an array
--value Prints named or current Adobe IMS context data
DESCRIPTION
The following options exist for this command:
* List the names of the configured Adobe IMS contexts
* Print the name of the current Adobe IMS context
* Set the name of the current Adobe IMS context
* Print the configuration of the current or a named Adobe IMS context
Currently it is not possible to update the Adobe Adobe IMS context configuration
using this command. Use the "aio config" commands for this.
e.g. aio config:set ims.contexts.your_context.your_context_key "your_context_value"
Please note, that the following IMS context label names is reserved: `cli`
and should not be used as an IMS context name.
Also note that the current context can only be set locally.
ALIASES
$ aio ctx
$ aio context
See code: @adobe/aio-cli-plugin-auth
aio auth:login
Log in with a certain Adobe IMS context and returns the access token.
Log in with a certain Adobe IMS context and returns the access token.
If the Adobe IMS context already has a valid access token set (valid meaning
at least 10 minutes before expiry), that token is returned.
Otherwise, if the Adobe IMS context has a valid refresh token set (valid
meaning at least 10 minutes before expiry) that refresh token is
exchanged for an access token before returning the access token.
Lastly, if the Adobe IMS context properties are supported by one of the
Adobe IMS login plugins, that login plugin is called to guide through
the IMS login process.
The currently supported Adobe IMS login plugins are:
* aio-lib-ims-jwt for JWT token based login supporting
Adobe I/O Console service integrations.
* aio-lib-ims-oauth for browser based OAuth2 login. This
plugin will launch a Chromium browser to guide the user through the
login process. The plugin itself will *never* see the user's
password but only receive the authorization token after the
user authenticated with Adobe IMS.
USAGE
$ aio auth:login
OPTIONS
-b, --bare print access token only
-c, --ctx=ctx Name of the Adobe IMS context to use. Default is the current Adobe IMS context
-d, --decode Decode and display access token data
-f, --force Force logging in. This causes a forced logout on the context first and makes sure to not use any cached
data when calling the plugin.
-g, --global global config
-l, --local local config
-v, --verbose Verbose output
--debug=debug Debug level output
DESCRIPTION
If the Adobe IMS context already has a valid access token set (valid meaning
at least 10 minutes before expiry), that token is returned.
Otherwise, if the Adobe IMS context has a valid refresh token set (valid
meaning at least 10 minutes before expiry) that refresh token is
exchanged for an access token before returning the access token.
Lastly, if the Adobe IMS context properties are supported by one of the
Adobe IMS login plugins, that login plugin is called to guide through
the IMS login process.
The currently supported Adobe IMS login plugins are:
* aio-lib-ims-jwt for JWT token based login supporting
Adobe I/O Console service integrations.
* aio-lib-ims-oauth for browser based OAuth2 login. This
plugin will launch a Chromium browser to guide the user through the
login process. The plugin itself will *never* see the user's
password but only receive the authorization token after the
user authenticated with Adobe IMS.
ALIASES
$ aio login
See code: @adobe/aio-cli-plugin-auth
aio auth:logout
Log out the current or a named Adobe IMS context.
Log out the current or a named Adobe IMS context.
This command can be called multiple times on the same Adobe IMS context with
out causing any errors. The assumption is that after calling this command
without an error, the Adobe IMS context's access and refresh tokens have been
invalidated and removed from persistent storage. Repeatedly calling this
command will just do nothing.
USAGE
$ aio auth:logout
OPTIONS
-c, --ctx=ctx Name of the Adobe IMS context to use. Default is the current Adobe IMS context
-f, --force Invalidate the refresh token as well as all access tokens.
Otherwise only the access token is invalidated. For Adobe IMS
contexts not supporting refresh tokens, this flag has no
effect.
-g, --global global config
-l, --local local config
-v, --verbose Verbose output
--debug=debug Debug level output
DESCRIPTION
This command can be called multiple times on the same Adobe IMS context with
out causing any errors. The assumption is that after calling this command
without an error, the Adobe IMS context's access and refresh tokens have been
invalidated and removed from persistent storage. Repeatedly calling this
command will just do nothing.
ALIASES
$ aio logout
See code: @adobe/aio-cli-plugin-auth
aio autocomplete [SHELL]
display autocomplete installation instructions
display autocomplete installation instructions
USAGE
$ aio autocomplete [SHELL]
ARGUMENTS
SHELL shell type
OPTIONS
-r, --refresh-cache Refresh cache (ignores displaying instructions)
EXAMPLES
$ aio autocomplete
$ aio autocomplete bash
$ aio autocomplete zsh
$ aio autocomplete --refresh-cache
See code: @oclif/plugin-autocomplete
aio certificate
Generate or verify a certificate for use with Adobe I/O
Generate or verify a certificate for use with Adobe I/O
USAGE
$ aio certificate
See code: @adobe/aio-cli-plugin-certificate
aio certificate:generate
Generate a new private/public key pair
Generate a new private/public key pair
Generate a self-signed certificate to enable https:// on localhost or signing jwt payloads for interacting with Adobe services.
USAGE
$ aio certificate:generate
OPTIONS
-c, --country=country Country Name
-l, --locality=locality Locality, or city name
-n, --name=name [default: selfsign.localhost] Common Name: typically a host domain name, like
www.mysite.com
-o, --organization=organization Organization name
-s, --state=state State or Province
-u, --unit=unit Organizational unit or department
--days=days [default: 365] Number of days the certificate should be valid for. (Max 365)
--keyout=keyout [default: private.key] file to send the key to
--out=out [default: certificate_pub.crt] output file
DESCRIPTION
Generate a self-signed certificate to enable https:// on localhost or signing jwt payloads for interacting with Adobe
services.
See code: @adobe/aio-cli-plugin-certificate
aio certificate:verify FILE
Verify a certificate for use with Adobe I/O
Verify a certificate for use with Adobe I/O
Verifies that the certificate is valid, and/or will not expire in [--days] days from now.
USAGE
$ aio certificate:verify FILE
ARGUMENTS
FILE file path to certificate to verify
OPTIONS
--days=days +- is certificate valid in --days
DESCRIPTION
Verifies that the certificate is valid, and/or will not expire in [--days] days from now.
See code: @adobe/aio-cli-plugin-certificate
aio config
list, get, set, delete, and edit persistent configuration data
list, get, set, delete, and edit persistent configuration data
USAGE
$ aio config
OPTIONS
-e, --env environment variables
-g, --global global config
-j, --json output in json
-l, --local local config
-y, --yaml output in yaml
--verbose show all config values
ALIASES
$ aio config:ls
EXAMPLES
$ aio config:list
$ aio config:get KEY
$ aio config:set KEY VALUE
$ aio config:delete KEY
$ aio config:clear
See code: @adobe/aio-cli-plugin-config
aio config:clear
clears all persistent config values
clears all persistent config values
USAGE
$ aio config:clear
OPTIONS
-f, --force do not prompt for confirmation
-g, --global global config
-l, --local local config
See code: @adobe/aio-cli-plugin-config
aio config:delete KEYS...
deletes persistent config values
deletes persistent config values
USAGE
$ aio config:delete KEYS...
OPTIONS
-g, --global global config
-l, --local local config
ALIASES
$ aio config:del
$ aio config:rm
See code: @adobe/aio-cli-plugin-config
aio config:edit
edit config file
edit config file
USAGE
$ aio config:edit
OPTIONS
-g, --global global config
-l, --local local config
See code: @adobe/aio-cli-plugin-config
aio config:get KEY
gets a persistent config value
gets a persistent config value
USAGE
$ aio config:get KEY
OPTIONS
-e, --env environment variables
-g, --global global config
-j, --json output in json
-l, --local local config
-y, --yaml output in yaml
See code: @adobe/aio-cli-plugin-config
aio config:list
lists all persistent config values
lists all persistent config values
USAGE
$ aio config:list
OPTIONS
-e, --env environment variables
-g, --global global config
-j, --json output in json
-l, --local local config
-y, --yaml output in yaml
--verbose show all config values
ALIASES
$ aio config:ls
See code: @adobe/aio-cli-plugin-config
aio config set key 'a value' # set key to 'a value'
sets a persistent config value
sets a persistent config value
USAGE
$ aio config set key 'a value' # set key to 'a value'
$ aio config set key -f value.json # set key to the json found in the file value.json
$ aio config set -j key < value.json # set key to the json found in the file value.json
OPTIONS
-f, --file value is a path to a file
-g, --global global config
-i, --interactive prompt for value
-j, --json value is json
-l, --local local config
-y, --yaml value is yaml
See code: @adobe/aio-cli-plugin-config
aio console
Console plugin for the Adobe I/O CLI
Console plugin for the Adobe I/O CLI
USAGE
$ aio console
OPTIONS
--help Show help
See code: @adobe/aio-cli-plugin-console
aio console:org
Manage your Adobe I/O Console Organizations
Manage your Adobe I/O Console Organizations
USAGE
$ aio console:org
OPTIONS
--help Show help
See code: @adobe/aio-cli-plugin-console
aio console:org:list
List your Organizations
List your Organizations
USAGE
$ aio console:org:list
OPTIONS
-j, --json Output json
-y, --yml Output yml
--help Show help
ALIASES
$ aio console:org:ls
See code: @adobe/aio-cli-plugin-console
aio console:org:select [ORGCODE]
Select an Organization
Select an Organization
USAGE
$ aio console:org:select [ORGCODE]
ARGUMENTS
ORGCODE Adobe Developer Console Org code
OPTIONS
--help Show help
ALIASES
$ aio console:org:sel
See code: @adobe/aio-cli-plugin-console
aio console:project
Manage your Adobe I/O Console Projects
Manage your Adobe I/O Console Projects
USAGE
$ aio console:project
OPTIONS
--help Show help
See code: @adobe/aio-cli-plugin-console
aio console:project:list
List your Projects for the selected Organization
List your Projects for the selected Organization
USAGE
$ aio console:project:list
OPTIONS
-j, --json Output json
-y, --yml Output yml
--help Show help
--orgId=orgId OrgID for listing projects
ALIASES
$ aio console:project:ls
See code: @adobe/aio-cli-plugin-console
aio console:project:select [PROJECTIDORNAME]
Select a Project for the selected Organization
Select a Project for the selected Organization
USAGE
$ aio console:project:select [PROJECTIDORNAME]
ARGUMENTS
PROJECTIDORNAME Adobe Developer Console Project id or Project name
OPTIONS
--help Show help
--orgId=orgId Organization id of the Console Project to select
ALIASES
$ aio console:project:sel
See code: @adobe/aio-cli-plugin-console
aio console:where
Show the currently selected Organization, Project and Workspace
Show the currently selected Organization, Project and Workspace
USAGE
$ aio console:where
OPTIONS
-j, --json Output json
-y, --yml Output yml
--help Show help
ALIASES
$ aio where
See code: @adobe/aio-cli-plugin-console
aio console:workspace
Manage your Adobe I/O Console Workspaces
Manage your Adobe I/O Console Workspaces
USAGE
$ aio console:workspace
OPTIONS
--help Show help
ALIASES
$ aio console:ws
See code: @adobe/aio-cli-plugin-console
aio console:workspace:download [DESTINATION]
Downloads the configuration for the selected Workspace
Downloads the configuration for the selected Workspace
USAGE
$ aio console:workspace:download [DESTINATION]
ARGUMENTS
DESTINATION Output file name or folder name where the Console Workspace configuration file should be saved
OPTIONS
--help Show help
--orgId=orgId Organization id of the Console Workspace configuration to download
--projectId=projectId Project id of the Console Workspace configuration to download
--workspaceId=workspaceId Workspace id of the Console Workspace configuration to download
ALIASES
$ aio console:workspace:dl
$ aio console:ws:download
$ aio console:ws:dl
See code: @adobe/aio-cli-plugin-console
aio console:workspace:list
List your Workspaces for your selected Project
List your Workspaces for your selected Project
USAGE
$ aio console:workspace:list
OPTIONS
-j, --json Output json
-y, --yml Output yml
--help Show help
--orgId=orgId Organization id of the Console Workspaces to list
--projectId=projectId Project id of the Console Workspaces to list
ALIASES
$ aio console:workspace:ls
$ aio console:ws:list
$ aio console:ws:ls
See code: @adobe/aio-cli-plugin-console
aio console:workspace:select [WORKSPACEIDORNAME]
Select a Workspace for the selected Project
Select a Workspace for the selected Project
USAGE
$ aio console:workspace:select [WORKSPACEIDORNAME]
ARGUMENTS
WORKSPACEIDORNAME Adobe Developer Console Workspace id or Workspace name
OPTIONS
--help Show help
--orgId=orgId Organization id of the Console Workspace to select
--projectId=projectId Project id of the Console Workspace to select
ALIASES
$ aio console:workspace:sel
$ aio console:ws:select
$ aio console:ws:sel
See code: @adobe/aio-cli-plugin-console
aio discover
Discover plugins to install
Discover plugins to install
To install a plugin, run 'aio plugins install NAME'
USAGE
$ aio discover
OPTIONS
-f, --sort-field=date|name [default: date] which column to sort, use the sort-order flag to specify sort direction
-i, --install interactive install mode
-o, --sort-order=asc|desc [default: desc] sort order for a column, use the sort-field flag to specify which column
to sort
DESCRIPTION
To install a plugin, run 'aio plugins install NAME'
ALIASES
$ aio plugins:discover
See code: src/commands/discover.js
aio event
Manage your Adobe I/O Events
Manage your Adobe I/O Events
U