@convenia/cli

@convenia/cli

• Usage
• Commands

Usage

$ npm install -g @convenia/cli
$ convenia COMMAND
running command...
$ convenia (-v|--version|version)
@convenia/cli/1.0.1 linux-x64 node-v11.1.0
$ convenia --help [COMMAND]
USAGE
  $ convenia COMMAND
...

Commands

• convenia addons:addon
• convenia addons:available
• convenia addons:enabled
• convenia help [COMMAND]
• convenia plugins
• convenia plugins:install PLUGIN...
• convenia plugins:link PLUGIN
• convenia plugins:uninstall PLUGIN...
• convenia plugins:update

convenia addons:addon

USAGE
  $ convenia addons:addon

See code: src/commands/addons/addon.ts

convenia addons:available

list available addons.

USAGE
  $ convenia addons:available

See code: src/commands/addons/available.ts

convenia addons:enabled

list enabled addons.

USAGE
  $ convenia addons:enabled

See code: src/commands/addons/enabled.ts

convenia help [COMMAND]

display help for convenia

USAGE
  $ convenia help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

convenia plugins

list installed plugins

USAGE
  $ convenia plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ convenia plugins

See code: @oclif/plugin-plugins

convenia plugins:install PLUGIN...

installs a plugin into the CLI

USAGE
  $ convenia plugins:install PLUGIN...

ARGUMENTS
  PLUGIN  plugin to install

OPTIONS
  -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
  $ convenia plugins:add

EXAMPLES
  $ convenia plugins:install myplugin 

  $ convenia plugins:install https://github.com/someuser/someplugin

  $ convenia plugins:install someuser/someplugin

See code: @oclif/plugin-plugins

convenia plugins:link PLUGIN

links a plugin into the CLI for development

USAGE
  $ convenia 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
  $ convenia plugins:link myplugin

See code: @oclif/plugin-plugins

convenia plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ convenia plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

ALIASES
  $ convenia plugins:unlink
  $ convenia plugins:remove

See code: @oclif/plugin-plugins

convenia plugins:update

update installed plugins

USAGE
  $ convenia plugins:update

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

See code: @oclif/plugin-plugins