npm package: @rocketmakers/nebula-cli
Description: Nebula CLI allows one to create resources to significantly improve dev experience and code quality
Author: Jonny
Latest version: 0.0.11

nebula-cli
==========

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

[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
[![Version](https://img.shields.io/npm/v/nebula-cli.svg)](https://npmjs.org/package/nebula-cli)
[![Downloads/week](https://img.shields.io/npm/dw/nebula-cli.svg)](https://npmjs.org/package/nebula-cli)
[![License](https://img.shields.io/npm/l/nebula-cli.svg)](https://github.com/jonnydg/nebula-cli/blob/master/package.json)

<!-- toc -->
* [Documentation](#documentation)
* [Usage](#usage)
* [Commands](#commands)
<!-- tocstop -->

# Documentation

A link to the full documentation can be found [here](https://gitlab.com/rocketmakers/platform/nebula)

# Usage
<!-- usage -->
```sh-session
$ 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
...
```
<!-- usagestop -->
# Commands
<!-- commands -->
* [`nebula autocomplete [SHELL]`](#nebula-autocomplete-shell)
* [`nebula commands`](#nebula-commands)
* [`nebula help [COMMAND]`](#nebula-help-command)
* [`nebula platform:build [FILE]`](#nebula-platformbuild-file)
* [`nebula platform:destroy [FILE]`](#nebula-platformdestroy-file)
* [`nebula platform:start [FILE]`](#nebula-platformstart-file)
* [`nebula plugins`](#nebula-plugins)
* [`nebula plugins:install PLUGIN...`](#nebula-pluginsinstall-plugin)
* [`nebula plugins:link PLUGIN`](#nebula-pluginslink-plugin)
* [`nebula plugins:uninstall PLUGIN...`](#nebula-pluginsuninstall-plugin)
* [`nebula plugins:update`](#nebula-pluginsupdate)
* [`nebula update [CHANNEL]`](#nebula-update-channel)
* [`nebula which COMMAND`](#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](https://github.com/oclif/plugin-autocomplete/blob/v0.2.0/src/commands/autocomplete/index.ts)_

## `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](https://github.com/oclif/plugin-commands/blob/v1.3.0/src/commands/commands.ts)_

## `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](https://github.com/oclif/plugin-help/blob/v3.2.0/src/commands/help.ts)_

## `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](https://gitlab.com/jonnydg/nebula/blob/v0.0.11/lib/commands/platform/build.js)_

## `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](https://gitlab.com/jonnydg/nebula/blob/v0.0.11/lib/commands/platform/destroy.js)_

## `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](https://gitlab.com/jonnydg/nebula/blob/v0.0.11/lib/commands/platform/start.js)_

## `nebula plugins`

list installed plugins

```
USAGE
  $ nebula plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ nebula plugins
```

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.1/src/commands/plugins/index.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v1.9.1/src/commands/plugins/install.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v1.9.1/src/commands/plugins/link.ts)_

## `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](https://github.com/oclif/plugin-plugins/blob/v1.9.1/src/commands/plugins/uninstall.ts)_

## `nebula plugins:update`

update installed plugins

```
USAGE
  $ nebula plugins:update

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

_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.9.1/src/commands/plugins/update.ts)_

## `nebula update [CHANNEL]`

update the nebula CLI

```
USAGE
  $ nebula update [CHANNEL]
```

_See code: [@oclif/plugin-update](https://github.com/oclif/plugin-update/blob/v1.3.10/src/commands/update.ts)_

## `nebula which COMMAND`

show which plugin a command is in

```
USAGE
  $ nebula which COMMAND
```

_See code: [@oclif/plugin-which](https://github.com/oclif/plugin-which/blob/v1.0.3/src/commands/which.ts)_
<!-- commandsstop -->