9c0ceb7a5291950551d95d9314573c26c73e6b0e

Author
Marc Cornellà <marc.cornella@live.com>
Committer
Marc Cornellà <marc.cornella@live.com>
Date

Message

knife_ssh: add README

Diff

 1diff --git a/plugins/knife_ssh/README.md b/plugins/knife_ssh/README.md
 2new file mode 100644
 3index 0000000000000000000000000000000000000000..cb836b7f33672d00cf93bbf458653e62c4d2e4b5
 4--- /dev/null
 5+++ b/plugins/knife_ssh/README.md
 6@@ -0,0 +1,14 @@
 7+# knife_ssh plugin
 8+
 9+This plugin adds a `knife_ssh` function as well as completion for it, to allow
10+connecting via ssh to servers managed with [Chef](https://www.chef.io/).
11+
12+To use it, add `knife_ssh` to the plugins array in your zshrc file:
13+```zsh
14+plugins=(... knife_ssh)
15+```
16+
17+The plugin creates a cache of the Chef node list via `knife`, and stores it
18+in `$HOME/.knife_comp~`, when first triggering knife_ssh completion.
19+
20+**Requirements:** `knife` has to be installed.