fix: add docs for plugins:install with github

oclif · Jun 1, 2018 · 15d00b2 · 15d00b2
1 parent 9085a74
commit 15d00b2
Showing 1 changed file with 8 additions and 2 deletions.
diff --git a/src/commands/plugins/install.ts b/src/commands/plugins/install.ts
@@ -5,9 +5,15 @@ import cli from 'cli-ux'
 import Plugins from '../../plugins'
 
 export default class PluginsInstall extends Command {
-  static description = 'installs a plugin into the CLI'
+  static description = `installs a plugin into the CLI
+Can be installed from npm or a git url.
+`
   static usage = 'plugins:install PLUGIN...'
-  static examples = ['$ <%= config.bin %> plugins:install <%- config.pjson.oclif.examplePlugin || "myplugin" %> ']
+  static 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',
+  ]
   static strict = false
   static args = [{name: 'plugin', description: 'plugin to install', required: true}]
   static flags = {