Skip to content

Commit

Permalink
docs: Added clarifications to the behaviour of plugin:install and plu…
Browse files Browse the repository at this point in the history
…gin:link (#45)
  • Loading branch information
shazron authored and jdx committed May 24, 2018
1 parent 268fb5b commit 761f251
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,11 @@ EXAMPLE

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

**NOTE**:

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.

## `mycli plugins:link PLUGIN`

links a plugin into the CLI for development
Expand All @@ -125,6 +130,11 @@ EXAMPLE

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

**NOTE**:

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.

## `mycli plugins:uninstall PLUGIN...`

removes a plugin from the CLI
Expand Down

0 comments on commit 761f251

Please sign in to comment.