summaryrefslogtreecommitdiff
path: root/plugins/ssh/README.md
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2026-01-04 22:47:54 -0800
committerTuowen Zhao <ztuowen@gmail.com>2026-01-04 22:47:54 -0800
commit2aa4cb7a52b28722816ecfd55f3b06293332c55c (patch)
treef02a9f3d59d109c70caf932a24e43368994e0e8c /plugins/ssh/README.md
parent7e951c254e779ff0620537cf43ca69dd878387b4 (diff)
parentd23d3ea69fdb839088e6e5589557cce77b34aaf8 (diff)
downloadzsh-2aa4cb7a52b28722816ecfd55f3b06293332c55c.tar.gz
zsh-2aa4cb7a52b28722816ecfd55f3b06293332c55c.tar.bz2
zsh-2aa4cb7a52b28722816ecfd55f3b06293332c55c.zip
Merge remote-tracking branch 'github/master'HEADmaster
Diffstat (limited to 'plugins/ssh/README.md')
-rw-r--r--plugins/ssh/README.md16
1 files changed, 16 insertions, 0 deletions
diff --git a/plugins/ssh/README.md b/plugins/ssh/README.md
new file mode 100644
index 000000000..3dd32ec76
--- /dev/null
+++ b/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.