diff options
| author | Marc Cornellà <marc@mcornella.com> | 2024-08-09 09:44:46 +0200 |
|---|---|---|
| committer | Marc Cornellà <marc@mcornella.com> | 2024-08-09 09:44:46 +0200 |
| commit | efafef8495f030501e0df59ccb76a598bbce3ae1 (patch) | |
| tree | 561eaba6adf7cd198d0b8d5b3c07dcd724572b72 /plugins/ssh | |
| parent | fccaaf2fc60149baab966acaeae35f55325e6f98 (diff) | |
| download | zsh-efafef8495f030501e0df59ccb76a598bbce3ae1.tar.gz zsh-efafef8495f030501e0df59ccb76a598bbce3ae1.tar.bz2 zsh-efafef8495f030501e0df59ccb76a598bbce3ae1.zip | |
docs: improve several plugin READMEs and add one for `ssh` plugin
Diffstat (limited to 'plugins/ssh')
| -rw-r--r-- | plugins/ssh/README.md | 16 |
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. |