UNPKG

@procore/core-scripts

Version:

A CLI to enhance your development experience

149 lines (101 loc) 3.7 kB
# `core-scripts plugins` list installed plugins - [`core-scripts plugins`](#core-scripts-plugins) - [`core-scripts plugins:inspect PLUGIN...`](#core-scripts-pluginsinspect-plugin) - [`core-scripts plugins:install PLUGIN...`](#core-scripts-pluginsinstall-plugin) - [`core-scripts plugins:link PLUGIN`](#core-scripts-pluginslink-plugin) - [`core-scripts plugins:uninstall PLUGIN...`](#core-scripts-pluginsuninstall-plugin) - [`core-scripts plugins:update`](#core-scripts-pluginsupdate) ## `core-scripts plugins` list installed plugins ``` USAGE $ core-scripts plugins OPTIONS --core show core plugins EXAMPLE $ core-scripts plugins ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.11/src/commands/plugins/index.ts)_ ## `core-scripts plugins:inspect PLUGIN...` displays installation properties of a plugin ``` USAGE $ core-scripts plugins:inspect PLUGIN... ARGUMENTS PLUGIN [default: .] plugin to inspect OPTIONS -h, --help show CLI help -v, --verbose EXAMPLE $ core-scripts plugins:inspect myplugin ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.11/src/commands/plugins/inspect.ts)_ ## `core-scripts plugins:install PLUGIN...` installs a plugin into the CLI ``` USAGE $ core-scripts 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 $ core-scripts plugins:add EXAMPLES $ core-scripts plugins:install myplugin $ core-scripts plugins:install https://github.com/someuser/someplugin $ core-scripts plugins:install someuser/someplugin ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.11/src/commands/plugins/install.ts)_ ## `core-scripts plugins:link PLUGIN` links a plugin into the CLI for development ``` USAGE $ core-scripts 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 $ core-scripts plugins:link myplugin ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.11/src/commands/plugins/link.ts)_ ## `core-scripts plugins:uninstall PLUGIN...` removes a plugin from the CLI ``` USAGE $ core-scripts plugins:uninstall PLUGIN... ARGUMENTS PLUGIN plugin to uninstall OPTIONS -h, --help show CLI help -v, --verbose ALIASES $ core-scripts plugins:unlink $ core-scripts plugins:remove ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.11/src/commands/plugins/uninstall.ts)_ ## `core-scripts plugins:update` update installed plugins ``` USAGE $ core-scripts plugins:update OPTIONS -h, --help show CLI help -v, --verbose ``` _See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v1.10.11/src/commands/plugins/update.ts)_