@noprotocol/np-cli

np-cli

The NoProtocol Command Line Interface

• Usage
• Commands

Usage

$ npm install -g @noprotocol/np-cli
$ np COMMAND
running command...
$ np (-v|--version|version)
@noprotocol/np-cli/0.2.2 darwin-x64 node-v12.4.0
$ np --help [COMMAND]
USAGE
  $ np COMMAND
...

Commands

• np autocomplete [SHELL]
• np commands
• np hello
• np help [COMMAND]
• np plugins
• np plugins:install PLUGIN...
• np plugins:link PLUGIN
• np plugins:uninstall PLUGIN...
• np plugins:update
• np update [CHANNEL]

np autocomplete [SHELL]

display autocomplete installation instructions

USAGE
  $ np autocomplete [SHELL]

ARGUMENTS
  SHELL  shell type

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

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

See code: @oclif/plugin-autocomplete

np commands

list all the commands

USAGE
  $ np commands

OPTIONS
  -h, --help  show CLI help
  -j, --json  output in json format
  --hidden    also show hidden commands

See code: @oclif/plugin-commands

np hello

Describe the command here

USAGE
  $ np hello

OPTIONS
  -n, --name=name  name to print

DESCRIPTION
  ...
  Extra documentation goes here

See code: src/commands/hello.js

np help [COMMAND]

display help for np

USAGE
  $ np help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

np plugins

list installed plugins

USAGE
  $ np plugins

OPTIONS
  --core  show core plugins

EXAMPLE
  $ np plugins

See code: @oclif/plugin-plugins

np plugins:install PLUGIN...

installs a plugin into the CLI

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

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

See code: @oclif/plugin-plugins

np plugins:link PLUGIN

links a plugin into the CLI for development

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

See code: @oclif/plugin-plugins

np plugins:uninstall PLUGIN...

removes a plugin from the CLI

USAGE
  $ np plugins:uninstall PLUGIN...

ARGUMENTS
  PLUGIN  plugin to uninstall

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

ALIASES
  $ np plugins:unlink
  $ np plugins:remove

See code: @oclif/plugin-plugins

np plugins:update

update installed plugins

USAGE
  $ np plugins:update

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

See code: @oclif/plugin-plugins

np update [CHANNEL]

update the np CLI

USAGE
  $ np update [CHANNEL]

See code: @oclif/plugin-update