ohmyzsh/plugins/ssh-agent

ssh-agent plugin

This plugin starts automatically ssh-agent to set up and load whichever
credentials you want for ssh connections.

To enable it, add ssh-agent to your plugins:

plugins=(... ssh-agent)

Settings

IMPORTANT: put these settings before the line that sources oh-my-zsh

To enable agent forwarding support add the following to your zshrc file:

zstyle :omz:plugins:ssh-agent agent-forwarding on

---

To load multiple identities use the identities style, For example:

zstyle :omz:plugins:ssh-agent identities id_rsa id_rsa2 id_github

NOTE: the identities may be an absolute path if they are somewhere other than
~/.ssh. For example:

zstyle :omz:plugins:ssh-agent identities ~/.config/ssh/id_rsa ~/.config/ssh/id_rsa2 ~/.config/ssh/id_github
# which can be simplified to
zstyle :omz:plugins:ssh-agent identities ~/.config/ssh/{id_rsa,id_rsa2,id_github}

---

To set the maximum lifetime of the identities, use the lifetime style.
The lifetime may be specified in seconds or as described in sshd_config(5)
(see TIME FORMATS). If left unspecified, the default lifetime is forever.

zstyle :omz:plugins:ssh-agent lifetime 4h

---

To pass arguments to the ssh-add command that adds the identities on startup,
use the ssh-add-args setting. You can pass multiple arguments separated by spaces:

zstyle :omz:plugins:ssh-agent ssh-add-args -K -c -a /run/user/1000/ssh-auth

These will then be passed the the ssh-add call as if written directly. The example
above will turn into:

ssh-add -K -c -a /run/user/1000/ssh-auth <identities>

For valid ssh-add arguments run ssh-add --help or man ssh-add.

---

To set an external helper to ask for the passwords and possibly store
them in the system keychain use the helper style. For example:

zstyle :omz:plugins:ssh-agent helper ksshaskpass

Credits

Based on code from Joseph M. Reagle: https://www.cygwin.com/ml/cygwin/2001-06/msg00537.html

Agent-forwarding support based on ideas from Florent Thoumie and Jonas Pfenniger