diff options
author | Tuowen Zhao <ztuowen@gmail.com> | 2020-01-02 15:46:19 -0500 |
---|---|---|
committer | Tuowen Zhao <ztuowen@gmail.com> | 2020-01-02 15:46:19 -0500 |
commit | ff9208623b3573c736ae9118947aaf0c7e752998 (patch) | |
tree | 45977b00446155003d486c04c3b891a5b7c88441 /plugins/knife_ssh/README.md | |
parent | 1456610ebd292625fdc34fa3167c9c0f67d85228 (diff) | |
parent | ca627655dbd1d110dbea34ec4a8c1964a1da83d2 (diff) | |
download | zsh-ff9208623b3573c736ae9118947aaf0c7e752998.tar.gz zsh-ff9208623b3573c736ae9118947aaf0c7e752998.tar.bz2 zsh-ff9208623b3573c736ae9118947aaf0c7e752998.zip |
Merge branch 'master' of https://github.com/ohmyzsh/ohmyzsh
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. |