@oclif/plugin-plugins - npm Package Compare versions

Comparing version 1.3.1 to 1.3.2

CHANGELOG.md

@@ -0,1 +1,9 @@
+<a name="1.3.2"></a>
+## [1.3.2](https://github.com/oclif/plugin-plugins/compare/v1.3.1...v1.3.2) (2018-06-01)
+
+
+### Bug Fixes
+
+* add docs for plugins:install with github ([15d00b2](https://github.com/oclif/plugin-plugins/commit/15d00b2))
+
 <a name="1.3.1"></a>
@@ -2,0 +10,0 @@ ## [1.3.1](https://github.com/oclif/plugin-plugins/compare/v1.3.0...v1.3.1) (2018-06-01)

lib/commands/plugins/install.js

@@ -30,5 +30,11 @@ "use strict";
 }
-PluginsInstall.description = 'installs a plugin into the CLI';
+PluginsInstall.description = `installs a plugin into the CLI
+Can be installed from npm or a git url.
+`;
 PluginsInstall.usage = 'plugins:install PLUGIN...';
-PluginsInstall.examples = ['$ <%= config.bin %> plugins:install <%- config.pjson.oclif.examplePlugin || "myplugin" %> '];
+PluginsInstall.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',
+];
 PluginsInstall.strict = false;
@@ -35,0 +41,0 @@ PluginsInstall.args = [{ name: 'plugin', description: 'plugin to install', required: true }];

oclif.manifest.json

@@ -1,1 +0,1 @@
-{"version":"1.3.1","commands":{"plugins":{"id":"plugins","description":"list installed plugins","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":[],"examples":["$ <%- config.bin %> plugins"],"flags":{"core":{"name":"core","type":"boolean","description":"show core plugins"}},"args":[]},"plugins:install":{"id":"plugins:install","description":"installs a plugin into the CLI","usage":"plugins:install PLUGIN...","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":["plugins:add"],"examples":["$ <%= config.bin %> plugins:install <%- config.pjson.oclif.examplePlugin || \"myplugin\" %> "],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help"},"verbose":{"name":"verbose","type":"boolean","char":"v"}},"args":[{"name":"plugin","description":"plugin to install","required":true}]},"plugins:link":{"id":"plugins:link","description":"links a plugin into the CLI for development","usage":"plugins:link PLUGIN","pluginName":"@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"},"verbose":{"name":"verbose","type":"boolean","char":"v"}},"args":[{"name":"path","description":"path to plugin","required":true,"default":"."}]},"plugins:uninstall":{"id":"plugins:uninstall","description":"removes a plugin from the CLI","usage":"plugins:uninstall PLUGIN...","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":["plugins:unlink","plugins:remove"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help"},"verbose":{"name":"verbose","type":"boolean","char":"v"}},"args":[{"name":"plugin","description":"plugin to uninstall"}]},"plugins:update":{"id":"plugins:update","description":"update installed plugins","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help"},"verbose":{"name":"verbose","type":"boolean","char":"v"}},"args":[]}}}
+{"version":"1.3.2","commands":{"plugins":{"id":"plugins","description":"list installed plugins","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":[],"examples":["$ <%- config.bin %> plugins"],"flags":{"core":{"name":"core","type":"boolean","description":"show core plugins"}},"args":[]},"plugins:install":{"id":"plugins:install","description":"installs a plugin into the CLI\nCan be installed from npm or a git url.\n","usage":"plugins:install PLUGIN...","pluginName":"@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"},"verbose":{"name":"verbose","type":"boolean","char":"v"}},"args":[{"name":"plugin","description":"plugin to install","required":true}]},"plugins:link":{"id":"plugins:link","description":"links a plugin into the CLI for development","usage":"plugins:link PLUGIN","pluginName":"@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"},"verbose":{"name":"verbose","type":"boolean","char":"v"}},"args":[{"name":"path","description":"path to plugin","required":true,"default":"."}]},"plugins:uninstall":{"id":"plugins:uninstall","description":"removes a plugin from the CLI","usage":"plugins:uninstall PLUGIN...","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":["plugins:unlink","plugins:remove"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help"},"verbose":{"name":"verbose","type":"boolean","char":"v"}},"args":[{"name":"plugin","description":"plugin to uninstall"}]},"plugins:update":{"id":"plugins:update","description":"update installed plugins","pluginName":"@oclif/plugin-plugins","pluginType":"core","aliases":[],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help"},"verbose":{"name":"verbose","type":"boolean","char":"v"}},"args":[]}}}

package.json

 {
   "name": "@oclif/plugin-plugins",
   "description": "plugins plugin for oclif",
-  "version": "1.3.1",
+  "version": "1.3.2",
   "author": "Jeff Dickey @jdxcode",
@@ -6,0 +6,0 @@ "bugs": "https://github.com/oclif/plugin-plugins/issues",

README.md

@@ -81,3 +81,3 @@ @oclif/plugin-plugins
 
-_See code: [src/commands/plugins/index.ts](https://github.com/oclif/plugin-plugins/blob/v1.3.1/src/commands/plugins/index.ts)_
+_See code: [src/commands/plugins/index.ts](https://github.com/oclif/plugin-plugins/blob/v1.3.2/src/commands/plugins/index.ts)_
 
@@ -99,10 +99,15 @@ ## `mycli plugins:install PLUGIN...`
 
+DESCRIPTION
+  Can be installed from npm or a git url.
+
 ALIASES
   $ mycli plugins:add
 
-EXAMPLE
-  $ mycli plugins:install myplugin
+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/v1.3.1/src/commands/plugins/install.ts)_
+_See code: [src/commands/plugins/install.ts](https://github.com/oclif/plugin-plugins/blob/v1.3.2/src/commands/plugins/install.ts)_
 
@@ -128,3 +133,3 @@ ## `mycli plugins:link PLUGIN`
 
-_See code: [src/commands/plugins/link.ts](https://github.com/oclif/plugin-plugins/blob/v1.3.1/src/commands/plugins/link.ts)_
+_See code: [src/commands/plugins/link.ts](https://github.com/oclif/plugin-plugins/blob/v1.3.2/src/commands/plugins/link.ts)_
 
@@ -151,3 +156,3 @@ ## `mycli plugins:uninstall PLUGIN...`
 
-_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/v1.3.1/src/commands/plugins/uninstall.ts)_
+_See code: [src/commands/plugins/uninstall.ts](https://github.com/oclif/plugin-plugins/blob/v1.3.2/src/commands/plugins/uninstall.ts)_
 
@@ -167,3 +172,3 @@ ## `mycli plugins:update`
 
-_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/v1.3.1/src/commands/plugins/update.ts)_
+_See code: [src/commands/plugins/update.ts](https://github.com/oclif/plugin-plugins/blob/v1.3.2/src/commands/plugins/update.ts)_
 <!-- commandsstop -->

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

49905

increased by1.58%

Lines of code

662

increased by0.91%

Number of lines in readme file

170

increased by3.03%

No dependency changes