Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added clarifications to the behaviour of plugin:install and plugin:link #45

Merged
merged 1 commit into from
May 24, 2018
Merged

Added clarifications to the behaviour of plugin:install and plugin:link #45

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 10 additions & 0 deletions README.md
View file
Open in desktop
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