diff options
Diffstat (limited to 'README.md')
-rw-r--r-- | README.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..a7ba1fd --- /dev/null +++ b/README.md @@ -0,0 +1,26 @@ +addkey +====== + +A simple set of scripts for facilitating SSH key management. Collectively, the result is to always have a single active instance of ssh-agent across shell instances, with the ability to easily add more keys by name. + +## Installation + +Source `ssh-agent-setup.sh` in your shell's config, and add `addkey` to your path. + +Note that you need to have OpenSSH installed, since this uses `ssh-agent`. + +## Usage + +Assuming that `ssh-agent` is running (which it should be if `ssh-agent-setup.sh` was sourced correctly), use `addkey` to add keys from `~/.ssh` to the agent: + +``` +addkey github +``` + +This will attempt to add `~/.ssh/github` to the agent, prompting for a passphrase if necessary. Optionally: + +``` +addkey github 3600 +``` + +Adds the key with a lifetime of 3600 seconds, or 1 hour. |