summaryrefslogtreecommitdiff
path: root/oh-my-zsh/plugins/knife_ssh/README.md
diff options
context:
space:
mode:
authorAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
committerAditya <bluenerd@protonmail.com>2023-02-27 20:04:56 +0530
commitedc449275b6c04445f58b108ca0937a87c1e8430 (patch)
tree9fd484d58145b616f29a78857cc0b1c8b1c18f05 /oh-my-zsh/plugins/knife_ssh/README.md
parent6f5424ca96c4221ef433f545642669e9c104d0ed (diff)
add zsh
Diffstat (limited to 'oh-my-zsh/plugins/knife_ssh/README.md')
-rw-r--r--oh-my-zsh/plugins/knife_ssh/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/oh-my-zsh/plugins/knife_ssh/README.md b/oh-my-zsh/plugins/knife_ssh/README.md
new file mode 100644
index 0000000..cb836b7
--- /dev/null
+++ b/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.