UNPKG

@oclif/plugin-plugins

Version:
227 lines 6.83 kB
{ "version": "3.8.0", "commands": { "plugins": { "id": "plugins", "description": "List installed plugins.", "strict": true, "pluginName": "@oclif/plugin-plugins", "pluginAlias": "@oclif/plugin-plugins", "pluginType": "core", "aliases": [], "examples": [ "$ <%- config.bin %> plugins" ], "flags": { "json": { "name": "json", "type": "boolean", "description": "Format output as json.", "helpGroup": "GLOBAL", "allowNo": false }, "core": { "name": "core", "type": "boolean", "description": "Show core plugins.", "allowNo": false } }, "args": {} }, "plugins:inspect": { "id": "plugins:inspect", "description": "Displays installation properties of a plugin.", "strict": false, "usage": "plugins:inspect PLUGIN...", "pluginName": "@oclif/plugin-plugins", "pluginAlias": "@oclif/plugin-plugins", "pluginType": "core", "aliases": [], "examples": [ "$ <%= config.bin %> plugins:inspect <%- config.pjson.oclif.examplePlugin || \"myplugin\" %> " ], "flags": { "json": { "name": "json", "type": "boolean", "description": "Format output as json.", "helpGroup": "GLOBAL", "allowNo": false }, "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "verbose": { "name": "verbose", "type": "boolean", "char": "v", "allowNo": false } }, "args": { "plugin": { "name": "plugin", "description": "Plugin to inspect.", "required": true, "default": "." } } }, "plugins:install": { "id": "plugins:install", "description": "Installs a plugin into the CLI.\nCan be installed from npm or a git url.\n\nInstallation of a user-installed plugin will override a core plugin.\n\ne.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.\n", "strict": false, "usage": "plugins:install PLUGIN...", "pluginName": "@oclif/plugin-plugins", "pluginAlias": "@oclif/plugin-plugins", "pluginType": "core", "aliases": [ "plugins:add" ], "examples": [ "$ <%= config.bin %> plugins:install <%- config.pjson.oclif.examplePlugin || \"myplugin\" %> ", "$ <%= config.bin %> plugins:install https://github.com/someuser/someplugin", "$ <%= config.bin %> plugins:install someuser/someplugin" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "verbose": { "name": "verbose", "type": "boolean", "char": "v", "allowNo": false }, "force": { "name": "force", "type": "boolean", "char": "f", "description": "Run yarn install with force flag.", "allowNo": false }, "jit": { "name": "jit", "type": "boolean", "hidden": true, "allowNo": false } }, "args": { "plugin": { "name": "plugin", "description": "Plugin to install.", "required": true } } }, "plugins:link": { "id": "plugins:link", "description": "Links a plugin into the CLI for development.\nInstallation of a linked plugin will override a user-installed or core plugin.\n\ne.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.\n", "strict": true, "usage": "plugins:link PLUGIN", "pluginName": "@oclif/plugin-plugins", "pluginAlias": "@oclif/plugin-plugins", "pluginType": "core", "aliases": [], "examples": [ "$ <%= config.bin %> plugins:link <%- config.pjson.oclif.examplePlugin || \"myplugin\" %> " ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "verbose": { "name": "verbose", "type": "boolean", "char": "v", "allowNo": false } }, "args": { "path": { "name": "path", "description": "path to plugin", "required": true, "default": "." } } }, "plugins:uninstall": { "id": "plugins:uninstall", "description": "Removes a plugin from the CLI.", "strict": true, "usage": "plugins:uninstall PLUGIN...", "pluginName": "@oclif/plugin-plugins", "pluginAlias": "@oclif/plugin-plugins", "pluginType": "core", "aliases": [ "plugins:unlink", "plugins:remove" ], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "verbose": { "name": "verbose", "type": "boolean", "char": "v", "allowNo": false } }, "args": { "plugin": { "name": "plugin", "description": "plugin to uninstall" } }, "help": "\n Example:\n $ <%- config.bin %> plugins:uninstall <%- config.pjson.oclif.examplePlugin || \"myplugin\" %>\n ", "variableArgs": true }, "plugins:update": { "id": "plugins:update", "description": "Update installed plugins.", "strict": true, "pluginName": "@oclif/plugin-plugins", "pluginAlias": "@oclif/plugin-plugins", "pluginType": "core", "aliases": [], "flags": { "help": { "name": "help", "type": "boolean", "char": "h", "description": "Show CLI help.", "allowNo": false }, "verbose": { "name": "verbose", "type": "boolean", "char": "v", "allowNo": false } }, "args": {}, "topic": "plugins", "command": "update" } } }