@blueeast/bluerain-cli

CLI tool to make life with BlueRain easier!

• Usage
• Commands

Usage

$ npm install -g @blueeast/bluerain-cli
$ bluerain COMMAND
running command...
$ bluerain (-v|--version|version)
@blueeast/bluerain-cli/4.0.0-aplha.4 darwin-x64 node-v10.8.0
$ bluerain --help [COMMAND]
USAGE
  $ bluerain COMMAND
...

Commands

• bluerain hello [FILE]
• bluerain help [COMMAND]
• bluerain plugins
• bluerain plugins:install PLUGIN...
• bluerain plugins:link PLUGIN
• bluerain plugins:uninstall PLUGIN...
• bluerain plugins:update

bluerain hello [FILE]

describe the command here

USAGE
  $ bluerain hello [FILE]

OPTIONS
  -f, --force
  -h, --help       show CLI help
  -n, --name=name  name to print

EXAMPLE
  $ bluerain hello
  hello world from ./src/hello.ts!

See code: src/commands/hello.ts

bluerain help [COMMAND]

display help for bluerain

USAGE
  $ bluerain help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

bluerain plugins

list installed plugins

USAGE
  $ bluerain plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ bluerain plugins

See code: @oclif/plugin-plugins

bluerain plugins:install PLUGIN...

installs a plugin into the CLI

USAGE
  $ bluerain 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
  $ bluerain plugins:add

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

See code: @oclif/plugin-plugins

bluerain plugins:link PLUGIN

links a plugin into the CLI for development

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

See code: @oclif/plugin-plugins

bluerain plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ bluerain plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

ALIASES
  $ bluerain plugins:unlink
  $ bluerain plugins:remove

See code: @oclif/plugin-plugins

bluerain plugins:update

update installed plugins

USAGE
  $ bluerain plugins:update

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

See code: @oclif/plugin-plugins