@adobe/aio-cli

aio-cli

Adobe I/O Extensible CLI

• Development
• Usage
• Commands

Development

$ npm install
$ npm link 

Usage

$ npm install -g @adobe/aio-cli
$ aio COMMAND
running command...
$ aio (-v|--version|version)
@adobe/aio-cli/1.4.0 darwin-x64 node-v8.14.0
$ aio --help [COMMAND]
USAGE
  $ aio COMMAND
...

Commands

• aio autocomplete [SHELL]
• aio config
• aio config:clear [KEY]
• aio config:delete [KEY]
• aio config:get [KEY]
• aio config:set [KEY] [VALUE]
• aio console SUB-COMMAND
• aio console:list-integrations
• aio console:reset-integration [INTEGRATION_ID]
• aio console:select-integration [INTEGRATION_ID]
• aio help [COMMAND]
• aio jwt-auth:access-token
• aio plugins
• aio plugins:install PLUGIN...
• aio plugins:link PLUGIN
• aio plugins:uninstall PLUGIN...
• aio plugins:update

aio autocomplete [SHELL]

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 config

get, set, delete, and clear persistent configuration data

USAGE
  $ aio config

EXAMPLES
  $ aio config:get KEY
  $ aio config:set KEY VALUE
  $ aio config:delete KEY
  $ aio config:del KEY
  $ aio config:clear

See code: @adobe/aio-cli-plugin-config

aio config:clear [KEY]

clears all persistent config values, or for a specific key

USAGE
  $ aio config:clear [KEY]

See code: @adobe/aio-cli-plugin-config

aio config:delete [KEY]

delete a persistent config value

USAGE
  $ aio config:delete [KEY]

ALIASES
  $ aio config:del

See code: @adobe/aio-cli-plugin-config

aio config:get [KEY]

gets a persistent config value

USAGE
  $ aio config:get [KEY]

See code: @adobe/aio-cli-plugin-config

aio config:set [KEY] [VALUE]

sets a persistent configuration value

USAGE
  $ aio config:set [KEY] [VALUE]

OPTIONS
  -f, --file                 the value is a path to a file to read the config value from

  -t, --mime-type=mime-type  the mime-type of the file path with --file/-f (defaults to plain text, available:
                             application/json)

See code: @adobe/aio-cli-plugin-config

aio console SUB-COMMAND

List or select console integrations for the Adobe I/O Runtime

USAGE
  $ aio console SUB-COMMAND

EXAMPLES
  $ aio console:list-integrations
  $ aio console:ls
  $ aio console list-integrations
  $ aio console:select-integration INTEGRATION_ID
  $ aio console:sel INTEGRATION_ID
  $ aio console select-integration INTEGRATION_ID
  $ aio console:reset-integration INTEGRATION_ID
  $ aio console:reset INTEGRATION_ID
  $ aio console reset-integration INTEGRATION_ID

See code: @adobe/aio-cli-plugin-console

aio console:list-integrations

lists integrations for use with Adobe I/O Runtime serverless functions

USAGE
  $ aio console:list-integrations

OPTIONS
  -p, --page=page              [default: 1] page number
  -r, --passphrase=passphrase  the passphrase for the private-key
  -s, --pageSize=pageSize      [default: 20] size of a page (max 50)

ALIASES
  $ aio console:ls

See code: @adobe/aio-cli-plugin-console

aio console:reset-integration [INTEGRATION_ID]

resets an integration's .wskprops auth hash.

USAGE
  $ aio console:reset-integration [INTEGRATION_ID]

DESCRIPTION
  after running this command all clients will need to run `console:select-integration` 
  to get a new auth hash in their .wskprops file

ALIASES
  $ aio console:reset

See code: @adobe/aio-cli-plugin-console

aio console:select-integration [INTEGRATION_ID]

selects an integration and writes the .wskprops file to the local machine

USAGE
  $ aio console:select-integration [INTEGRATION_ID]

OPTIONS
  -p, --passphrase=passphrase  the passphrase for the private-key
  -w, --overwrite              overwrite the .wskprops file if it exists

DESCRIPTION
  Run 'console:ls' to get a list of integrations to select from.
  The .wskprops file will be written to your home folder, and you will be prompted whether you want to overwrite an 
  existing file.

ALIASES
  $ aio console:sel

See code: @adobe/aio-cli-plugin-console

aio help [COMMAND]

display help for aio

USAGE
  $ aio help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

aio jwt-auth:access-token

get the access token for the Adobe I/O Console

USAGE
  $ aio jwt-auth:access-token

OPTIONS
  -p, --passphrase=passphrase  the passphrase for the private-key

DESCRIPTION
  You must have a 'jwt-auth' key in your config, that has all your config data in .json format:
       aio config:set jwt-auth path/to/your/config.json --file --mime-type=application/json

EXAMPLE

  jwt_auth:
  {
     "client_id": "...",
     "client_secret": "...",
     "token_exchange_url": "...",
     "jwt_payload": {
       "iss": "...",
       "sub": "...",
       "...": true,
       "aud": "..."
     },
     "jwt_private_key": [
       "-----BEGIN RSA PRIVATE KEY-----",
       "...",
       "...",
       "...==",
       "-----END RSA PRIVATE KEY-----"
     ],
     "console_get_orgs_url":"...",
     "console_get_namespaces_url":"..."
  }

See code: @adobe/aio-cli-plugin-jwt-auth

aio plugins

list installed plugins

USAGE
  $ aio plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ aio plugins

See code: @oclif/plugin-plugins

aio plugins:install PLUGIN...

installs a plugin into the CLI

USAGE
  $ aio plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  plugin to install

OPTIONS
  -f, --force    yarn install with force flag
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Can be installed from npm or a git url.

  Installation of a user-installed plugin will override a core plugin.

  e.g. If you have a core plugin that has a 'hello' command, installing a user-installed plugin with a 'hello' command 
  will override the core plugin implementation. This is useful if a user needs to update core plugin functionality in 
  the CLI without the need to patch and update the whole CLI.

ALIASES
  $ aio plugins:add

EXAMPLES
  $ aio plugins:install myplugin 
  $ aio plugins:install https://github.com/someuser/someplugin
  $ aio plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

aio plugins:link PLUGIN

links a plugin into the CLI for development

USAGE
  $ aio plugins:link PLUGIN

ARGUMENTS
  PATH  [default: .] path to plugin

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

DESCRIPTION
  Installation of a linked plugin will override a user-installed or core plugin.

  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello' 
  command will override the user-installed or core plugin implementation. This is useful for development work.

EXAMPLE
  $ aio plugins:link myplugin

See code: @oclif/plugin-plugins

aio plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ aio plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

ALIASES
  $ aio plugins:unlink
  $ aio plugins:remove

See code: @oclif/plugin-plugins

aio plugins:update

update installed plugins

USAGE
  $ aio plugins:update

OPTIONS
  -h, --help     show CLI help
  -v, --verbose

See code: @oclif/plugin-plugins