mirror of
https://github.com/ohmyzsh/ohmyzsh.git
synced 2024-12-19 20:29:45 +01:00
knife_ssh: add README
This commit is contained in:
parent
132607447d
commit
9c0ceb7a52
1 changed files with 14 additions and 0 deletions
14
plugins/knife_ssh/README.md
Normal file
14
plugins/knife_ssh/README.md
Normal file
|
@ -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.
|
Loading…
Reference in a new issue