diff --git a/CHANGELOG.md b/CHANGELOG.md index 9577a3ea..3a16f5f2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,9 @@ +## [4.3.10](https://github.com/oclif/plugin-plugins/compare/4.3.9...4.3.10) (2024-03-25) + +### Bug Fixes + +- remove docs directory ([4d3ffd2](https://github.com/oclif/plugin-plugins/commit/4d3ffd27bf864337d1bbe031fd4fbb07889c7111)) + ## [4.3.9](https://github.com/oclif/plugin-plugins/compare/4.3.8...4.3.9) (2024-03-24) ### Bug Fixes diff --git a/README.md b/README.md index a233c279..2ad929af 100644 --- a/README.md +++ b/README.md @@ -15,7 +15,6 @@ plugins plugin for oclif - [Aliases](#aliases) - [Environment Variables](#environment-variables) - [Commands](#commands) -- [Command Topics](#command-topics) - [Contributing](#contributing) @@ -89,9 +88,198 @@ For removing plugins that are no longer needed (either because they're sunset or -# Command Topics +- [`mycli plugins`](#mycli-plugins) +- [`mycli plugins:inspect PLUGIN...`](#mycli-pluginsinspect-plugin) +- [`mycli plugins:install PLUGIN...`](#mycli-pluginsinstall-plugin) +- [`mycli plugins:link PLUGIN`](#mycli-pluginslink-plugin) +- [`mycli plugins reset`](#mycli-plugins-reset) +- [`mycli plugins:uninstall PLUGIN...`](#mycli-pluginsuninstall-plugin) +- [`mycli plugins update`](#mycli-plugins-update) -- [`mycli plugins`](docs/plugins.md) - List installed plugins. +## `mycli plugins` + +List installed plugins. + +``` +USAGE + $ mycli plugins [--json] [--core] + +FLAGS + --core Show core plugins. + +GLOBAL FLAGS + --json Format output as json. + +DESCRIPTION + List installed plugins. + +EXAMPLES + $ mycli plugins +``` + +_See code: [src/commands/plugins/index.ts](https://github.com/oclif/plugin-plugins/blob/4.3.10/src/commands/plugins/index.ts)_ + +## `mycli plugins:inspect PLUGIN...` + +Displays installation properties of a plugin. + +``` +USAGE + $ mycli plugins inspect PLUGIN... + +ARGUMENTS + PLUGIN... [default: .] Plugin to inspect. + +FLAGS + -h, --help Show CLI help. + -v, --verbose + +GLOBAL FLAGS + --json Format output as json. + +DESCRIPTION + Displays installation properties of a plugin. + +EXAMPLES + $ mycli plugins inspect myplugin +``` + +_See code: [src/commands/plugins/inspect.ts](https://github.com/oclif/plugin-plugins/blob/4.3.10/src/commands/plugins/inspect.ts)_ + +## `mycli plugins:install PLUGIN...` + +Installs a plugin into the CLI. + +``` +USAGE + $ mycli plugins install PLUGIN... + +ARGUMENTS + PLUGIN... Plugin to install. + +FLAGS + -f, --force Run yarn install with force flag. + -h, --help Show CLI help. + -s, --silent Silences yarn output. + -v, --verbose Show verbose yarn output. + +GLOBAL FLAGS + --json Format output as json. + +DESCRIPTION + Installs a plugin into the CLI. + 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 + $ mycli plugins add + +EXAMPLES + $ mycli plugins install myplugin + + $ mycli plugins install https://github.com/someuser/someplugin + + $ mycli plugins install someuser/someplugin +``` + +_See code: [src/commands/plugins/install.ts](https://github.com/oclif/plugin-plugins/blob/4.3.10/src/commands/plugins/install.ts)_ + +## `mycli plugins:link PLUGIN` + +Links a plugin into the CLI for development. + +``` +USAGE + $ mycli plugins link PLUGIN + +ARGUMENTS + PATH [default: .] path to plugin + +FLAGS + -h, --help Show CLI help. + -v, --verbose + --[no-]install Install dependencies after linking the plugin. + +DESCRIPTION + Links a plugin into the CLI for development. + 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. + + +EXAMPLES + $ mycli plugins link myplugin +``` + +_See code: [src/commands/plugins/link.ts](https://github.com/oclif/plugin-plugins/blob/4.3.10/src/commands/plugins/link.ts)_ + +## `mycli plugins reset` + +Remove all user-installed and linked plugins. + +``` +USAGE + $ mycli plugins reset [--hard] [--reinstall] + +FLAGS + --hard Delete node_modules and package manager related files in addition to uninstalling plugins. + --reinstall Reinstall all plugins after uninstalling. +``` + +_See code: [src/commands/plugins/reset.ts](https://github.com/oclif/plugin-plugins/blob/4.3.10/src/commands/plugins/reset.ts)_ + +## `mycli plugins:uninstall PLUGIN...` + +Removes a plugin from the CLI. + +``` +USAGE + $ mycli plugins uninstall PLUGIN... + +ARGUMENTS + PLUGIN... plugin to uninstall + +FLAGS + -h, --help Show CLI help. + -v, --verbose + +DESCRIPTION + Removes a plugin from the CLI. + +ALIASES + $ mycli plugins unlink + $ mycli plugins remove + +EXAMPLES + $ mycli plugins uninstall myplugin +``` + +_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/4.3.10/src/commands/plugins/uninstall.ts)_ + +## `mycli plugins update` + +Update installed plugins. + +``` +USAGE + $ mycli plugins update [-h] [-v] + +FLAGS + -h, --help Show CLI help. + -v, --verbose + +DESCRIPTION + Update installed plugins. +``` + +_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/4.3.10/src/commands/plugins/update.ts)_ diff --git a/package.json b/package.json index bfaf1b9a..a0f7ab9d 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "@oclif/plugin-plugins", "description": "plugins plugin for oclif", - "version": "4.3.9", + "version": "4.3.10", "author": "Salesforce", "bugs": "https://github.com/oclif/plugin-plugins/issues", "dependencies": {