summaryrefslogtreecommitdiff
path: root/.config/zsh/oh-my-zsh/plugins/ssh/README.md
diff options
context:
space:
mode:
Diffstat (limited to '.config/zsh/oh-my-zsh/plugins/ssh/README.md')
-rw-r--r--.config/zsh/oh-my-zsh/plugins/ssh/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/.config/zsh/oh-my-zsh/plugins/ssh/README.md b/.config/zsh/oh-my-zsh/plugins/ssh/README.md
new file mode 100644
index 0000000..3dd32ec
--- /dev/null
+++ b/.config/zsh/oh-my-zsh/plugins/ssh/README.md
@@ -0,0 +1,16 @@
+# ssh plugin
+
+This plugin provides host completion based off of your `~/.ssh/config` file, and adds
+some utility functions to work with SSH keys.
+
+To use it, add `ssh` to the plugins array in your zshrc file:
+
+```zsh
+plugins=(... ssh)
+```
+
+## Functions
+
+- `ssh_rmhkey`: remove host key from known hosts based on a host section name from `.ssh/config`.
+- `ssh_load_key`: load SSH key into agent.
+- `ssh_unload_key`: remove SSH key from agent.