Plugins commands

To install and manage your plugins, use the commands below. You can click any command to see its usage options and additional details about the command.

nr1 plugins:install

Install a plugin

Installs a plugin into the CLI. You can install plugins from npm or a Git URL.

Please note that installing a plugin will override the core plugin.

For example, if you've a core plugin that has a hello command, then installing a plugin with a hello command will override the core plugin implementation. This is useful if you want to update the core plugin functionality without patching and updating the whole CLI.

Usage

$ nr1 plugins:install PLUGIN

Arguments

• PLUGIN: the name, path, or URL of the plugin you want to install. This is required .

Options

Examples

• $ nr1 plugins:install myplugin
• $ nr1 plugins:install https://github.com/someuser/someplugin
• $ nr1 plugins:install someuser/someplugin

Aliases

• $ nr1 plugins:add

nr1 plugins:link

Link your plugin

Links a local plugin into the CLI for development.

Please note that linking a plugin will override your user-installed plugin or core plugin.

For example, if you've a user-installed or core plugin that has a hello command, linking a plugin with a hello command will override the user-installed or core plugin implementation. This is useful for development work.

Usage

$ nr1 plugins:link PLUGIN

Arguments

• PLUGIN: the name, path, or URL of the plugin you want to link. This is required .

Options

Examples

• $ nr1 plugins:link myplugin
• $ nr1 plugins:link someuser/someplugin

nr1 plugins:uninstall

Uninstall your plugin

Removes a plugin from the CLI.

Usage

$ nr1 plugins:uninstall PLUGIN

Arguments

• PLUGIN: the name of the plugin you want to uninstall. This is required .

Options

Aliases

• $ nr1 plugins:unlink
• $ nr1 plugins:remove

nr1 plugins:update

Update your plugins

Updates all of your installed plugins.

Usage

$ nr1 plugins:update

Options