@rocketmakers/nebula-cli

nebula-cli

Nebula CLI allows one to create resources to significantly improve dev experience and code quality

• Documentation
• Usage
• Commands

Documentation

A link to the full documentation can be found here

Usage

$ npm install -g @rocketmakers/nebula-cli
$ nebula COMMAND
running command...
$ nebula (-v|--version|version)
@rocketmakers/nebula-cli/0.0.11 linux-x64 node-v12.14.0
$ nebula --help [COMMAND]
USAGE
  $ nebula COMMAND
...

Commands

• nebula autocomplete [SHELL]
• nebula commands
• nebula help [COMMAND]
• nebula platform:build [FILE]
• nebula platform:destroy [FILE]
• nebula platform:start [FILE]
• nebula plugins
• nebula plugins:install PLUGIN...
• nebula plugins:link PLUGIN
• nebula plugins:uninstall PLUGIN...
• nebula plugins:update
• nebula update [CHANNEL]
• nebula which COMMAND

nebula autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ nebula autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

OPTIONS
  -r, --refresh-cache  Refresh cache (ignores displaying instructions)

EXAMPLES
  $ nebula autocomplete
  $ nebula autocomplete bash
  $ nebula autocomplete zsh
  $ nebula autocomplete --refresh-cache

See code: @oclif/plugin-autocomplete

nebula commands

list all the commands

USAGE
  $ nebula commands

OPTIONS
  -h, --help              show CLI help
  -j, --json              display unfiltered api data in json format
  -x, --extended          show extra columns
  --columns=columns       only show provided columns (comma-separated)
  --csv                   output is csv format [alias: --output=csv]
  --filter=filter         filter property by partial string matching, ex: name=foo
  --hidden                show hidden commands
  --no-header             hide table header from output
  --no-truncate           do not truncate output to fit screen
  --output=csv|json|yaml  output in a more machine friendly format
  --sort=sort             property to sort by (prepend '-' for descending)

See code: @oclif/plugin-commands

nebula help [COMMAND]

display help for nebula

USAGE
  $ nebula help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

nebula platform:build [FILE]

Initiates the build of a Nebula compatible project

USAGE
  $ nebula platform:build [FILE]

OPTIONS
  -c, --config=config                                 Location of the Nebula config JSON. If not specified, it looks for
                                                      a nebula.json in the current working directory

  -h, --help                                          show CLI help

  -l, --loglevel=(fatal|error|warn|info|trace|debug)  [default: info] Log level of display output

  -r, --root=root                                     [default: .] Location of the project root

See code: @rocketmakers/nebula-platform

nebula platform:destroy [FILE]

Destroys the local deployment of a Nebula compatible project

USAGE
  $ nebula platform:destroy [FILE]

OPTIONS
  -c, --config=config                                 Location of the Nebula config JSON. If not specified, it looks for
                                                      a nebula.json in the current working directory

  -h, --help                                          show CLI help

  -l, --loglevel=(fatal|error|warn|info|trace|debug)  [default: info] Log level of display output

  -r, --root=root                                     [default: .] Location of the project root

See code: @rocketmakers/nebula-platform

nebula platform:start [FILE]

Initiates the local deployment of a Nebula compatible project

USAGE
  $ nebula platform:start [FILE]

OPTIONS
  -c, --config=config                                 Location of the Nebula config JSON. If not specified, it looks for
                                                      a nebula.json in the current working directory

  -h, --help                                          show CLI help

  -k, --kind=(all|core|main)                          [default: all] Kind of deployment to start

  -l, --loglevel=(fatal|error|warn|info|trace|debug)  [default: info] Log level of display output

  -r, --root=root                                     [default: .] Location of the project root

See code: @rocketmakers/nebula-platform

nebula plugins

list installed plugins

USAGE
  $ nebula plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ nebula plugins

See code: @oclif/plugin-plugins

nebula plugins:install PLUGIN...

installs a plugin into the CLI

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

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

See code: @oclif/plugin-plugins

nebula plugins:link PLUGIN

links a plugin into the CLI for development

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

See code: @oclif/plugin-plugins

nebula plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ nebula plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

ALIASES
  $ nebula plugins:unlink
  $ nebula plugins:remove

See code: @oclif/plugin-plugins

nebula plugins:update

update installed plugins

USAGE
  $ nebula plugins:update

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

See code: @oclif/plugin-plugins

nebula update [CHANNEL]

update the nebula CLI

USAGE
  $ nebula update [CHANNEL]

See code: @oclif/plugin-update

nebula which COMMAND

show which plugin a command is in

USAGE
  $ nebula which COMMAND

See code: @oclif/plugin-which