diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2020-02-27 22:55:30 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-02-27 22:55:30 +0100 |
| commit | 18ee5dffdc57bb9219ee96b40da006704ac37df1 (patch) | |
| tree | e1fe420cf18fa7a916d5d43c408c6f92ed33b62d /plugins/knife_ssh/README.md | |
| parent | d81cd753e0b3a845e8f3549da245dbad102a6e4c (diff) | |
| parent | 368198b7616eb69b396de86d9ec4ff0f35bd72f0 (diff) | |
| download | zsh-18ee5dffdc57bb9219ee96b40da006704ac37df1.tar.gz zsh-18ee5dffdc57bb9219ee96b40da006704ac37df1.tar.bz2 zsh-18ee5dffdc57bb9219ee96b40da006704ac37df1.zip | |
Merge branch 'master' into clipboard
Diffstat (limited to 'plugins/knife_ssh/README.md')
| -rw-r--r-- | plugins/knife_ssh/README.md | 14 |
1 files changed, 14 insertions, 0 deletions
diff --git a/plugins/knife_ssh/README.md b/plugins/knife_ssh/README.md new file mode 100644 index 000000000..cb836b7f3 --- /dev/null +++ b/plugins/knife_ssh/README.md @@ -0,0 +1,14 @@ +# knife_ssh plugin + +This plugin adds a `knife_ssh` function as well as completion for it, to allow +connecting via ssh to servers managed with [Chef](https://www.chef.io/). + +To use it, add `knife_ssh` to the plugins array in your zshrc file: +```zsh +plugins=(... knife_ssh) +``` + +The plugin creates a cache of the Chef node list via `knife`, and stores it +in `$HOME/.knife_comp~`, when first triggering knife_ssh completion. + +**Requirements:** `knife` has to be installed. |