Commit 58841242 authored by Michelle Noorali's avatar Michelle Noorali

ref(docs): update plugin install documentation

parent 5f53c55b
...@@ -33,11 +33,19 @@ type pluginInstallCmd struct { ...@@ -33,11 +33,19 @@ type pluginInstallCmd struct {
out io.Writer out io.Writer
} }
const pluginInstallDesc = `
This command allows you to install a plugin from a url to a VCS repo or a local path.
Example usage:
$ helm plugin install https://github.com/technosophos/helm-template
`
func newPluginInstallCmd(out io.Writer) *cobra.Command { func newPluginInstallCmd(out io.Writer) *cobra.Command {
pcmd := &pluginInstallCmd{out: out} pcmd := &pluginInstallCmd{out: out}
cmd := &cobra.Command{ cmd := &cobra.Command{
Use: "install [options] <path|url>...", Use: "install [options] <path|url>...",
Short: "install one or more Helm plugins", Short: "install one or more Helm plugins",
Long: pluginInstallDesc,
PreRunE: func(cmd *cobra.Command, args []string) error { PreRunE: func(cmd *cobra.Command, args []string) error {
return pcmd.complete(args) return pcmd.complete(args)
}, },
......
...@@ -5,7 +5,12 @@ install one or more Helm plugins ...@@ -5,7 +5,12 @@ install one or more Helm plugins
### Synopsis ### Synopsis
install one or more Helm plugins
This command allows you to install a plugin from a url to a VCS repo or a local path.
Example usage:
$ helm plugin install https://github.com/technosophos/helm-template
``` ```
helm plugin install [options] <path|url>... helm plugin install [options] <path|url>...
...@@ -31,4 +36,4 @@ helm plugin install [options] <path|url>... ...@@ -31,4 +36,4 @@ helm plugin install [options] <path|url>...
### SEE ALSO ### SEE ALSO
* [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins * [helm plugin](helm_plugin.md) - add, list, or remove Helm plugins
###### Auto generated by spf13/cobra on 7-Nov-2017 ###### Auto generated by spf13/cobra on 20-Nov-2017
...@@ -31,11 +31,10 @@ plugins do the "detail work" of performing a desired action. ...@@ -31,11 +31,10 @@ plugins do the "detail work" of performing a desired action.
## Installing a Plugin ## Installing a Plugin
A Helm plugin management system is in the works. But in the short term, plugins Plugins are installed using the `$ helm plugin install <path|url> command. You can pass in a path to a plugin on your local file system or a url of a remote VCS repo. The `helm plugin install` command clones or copies the plugin at the path/url given into `$ (helm home)/plugins`
are installed by copying the plugin directory into `$(helm home)/plugins`.
```console ```console
$ cp -a myplugin/ $(helm home)/plugins/ $ helm plugin install https://github.com/technosophos/helm-template
``` ```
If you have a plugin tar distribution, simply untar the plugin into the If you have a plugin tar distribution, simply untar the plugin into the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment