aio-cli

Adobe I/O Extensible CLI

• aio cli health
• Getting started
• Technical requirements
• Usage
• Commands

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-jwt-auth | | | | | | | | @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/generator-aio-app | | | | | | |

Getting started

See the Project Firefly docs

Technical requirements

See the Project Firefly Setting up Your Environment doc

Usage

$ npm install -g glo-cli
$ aio COMMAND
running command...
$ aio (-v|--version|version)
glo-cli/6.0.1 darwin-x64 node-v12.22.1
$ aio --help [COMMAND]
USAGE
  $ aio COMMAND
...

Commands

• aio autocomplete [SHELL]
• aio discover
• aio help [COMMAND]
• aio plugins
• aio plugins:inspect PLUGIN...
• aio plugins:install PLUGIN...
• aio plugins:link PLUGIN
• aio plugins:uninstall PLUGIN...
• aio plugins:update
• aio rollback
• aio update

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 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 help [COMMAND]

display help for aio

display help for <%= config.bin %>

USAGE
  $ aio help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

aio plugins

list installed plugins

list installed plugins

USAGE
  $ aio plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ aio plugins

See code: @oclif/plugin-plugins

aio plugins:inspect PLUGIN...

displays installation properties of a plugin

displays installation properties of a plugin

USAGE
  $ aio plugins:inspect PLUGIN...

ARGUMENTS
  PLUGIN  [default: .] plugin to inspect

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

EXAMPLE
  $ aio plugins:inspect myplugin

See code: @oclif/plugin-plugins

aio plugins:install PLUGIN...

installs a plugin into the CLI

installs a plugin into the CLI
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.


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

links a plugin into the CLI for development
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.


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

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

update installed plugins

USAGE
  $ aio plugins:update

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

See code: @oclif/plugin-plugins

aio rollback

Clears all installed plugins.

Clears all installed plugins.

USAGE
  $ aio rollback

OPTIONS
  -c, --[no-]confirm  confirmation needed for clear (defaults to true)
  -i, --interactive   interactive clear mode
  -l, --list          list plugins that will be cleared
  -v, --verbose       Verbose output

See code: src/commands/rollback.js

aio update

Update all installed plugins.

Update all installed plugins.
This command will only:
- update core plugins that are from the @adobe namespace
- update all other user-installed plugins


USAGE
  $ aio update

OPTIONS
  -c, --[no-]confirm  confirmation needed for update (defaults to true)
  -i, --interactive   interactive update mode
  -l, --list          list plugins that will be updated
  -v, --verbose       Verbose output

DESCRIPTION
  This command will only:
  - update core plugins that are from the @adobe namespace
  - update all other user-installed plugins

See code: src/commands/update.js