diff options
| author | Marc Cornellà <marc.cornella@live.com> | 2019-12-27 00:56:03 +0100 |
|---|---|---|
| committer | Marc Cornellà <marc.cornella@live.com> | 2019-12-27 00:56:03 +0100 |
| commit | 9c0ceb7a5291950551d95d9314573c26c73e6b0e (patch) | |
| tree | fad37187ef3153b5aec005e8347ae754ced98298 /plugins/knife_ssh | |
| parent | 132607447d24477bcedac7e0accd3fe83b9b6a1a (diff) | |
| download | zsh-9c0ceb7a5291950551d95d9314573c26c73e6b0e.tar.gz zsh-9c0ceb7a5291950551d95d9314573c26c73e6b0e.tar.bz2 zsh-9c0ceb7a5291950551d95d9314573c26c73e6b0e.zip | |
knife_ssh: add README
Diffstat (limited to 'plugins/knife_ssh')
| -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. |