summaryrefslogtreecommitdiffstats
path: root/.config/zsh/oh-my-zsh/plugins/knife_ssh/README.md
diff options
context:
space:
mode:
authorLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2025-02-13 14:13:49 +0530
committerLibravatarLibravatar Biswakalyan Bhuyan <biswa@surgot.in> 2025-02-13 14:13:49 +0530
commit8a2e1006b3b272126332aa064f3ad95387129544 (patch)
tree944c80ac612a65980d94a54ba11b6c7102037ecf /.config/zsh/oh-my-zsh/plugins/knife_ssh/README.md
parentdcbb16d8b08ff5956abef5e6478b59df2e93ad35 (diff)
downloaddotfiles-master.tar.gz
dotfiles-master.tar.bz2
dotfiles-master.zip
new dot filesHEADmaster
Diffstat (limited to '.config/zsh/oh-my-zsh/plugins/knife_ssh/README.md')
-rw-r--r--.config/zsh/oh-my-zsh/plugins/knife_ssh/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/.config/zsh/oh-my-zsh/plugins/knife_ssh/README.md b/.config/zsh/oh-my-zsh/plugins/knife_ssh/README.md
new file mode 100644
index 0000000..cb836b7
--- /dev/null
+++ b/.config/zsh/oh-my-zsh/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.