docs: improve several plugin READMEs and add one for ssh plugin

This commit is contained in:
Marc Cornellà 2024-08-09 09:44:46 +02:00
commit efafef8495
No known key found for this signature in database
GPG key ID: 0314585E776A9C1B
23 changed files with 124 additions and 91 deletions

16
plugins/ssh/README.md Normal file
View file

@ -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.