stow/oh-my-zsh/.oh-my-zsh/plugins/keychain/README.md

   1 # keychain plugin
   2
   3 This plugin starts automatically [`keychain`](https://www.funtoo.org/Keychain)
   4 to set up and load whichever credentials you want for both gpg and ssh
   5 connections.
   6
   7 To enable it, add `keychain` to your plugins:
   8
   9 ```zsh
  10 plugins=(... keychain)
  11 ```
  12
  13 **NOTE**: It is HIGHLY recommended to also enable the `gpg-agent` plugin.
  14
  15 ## Instructions
  16
  17 **IMPORTANT: put these settings _before_ the line that sources oh-my-zsh**
  18
  19 **To adjust the agents** that keychain manages, use the `agents` style as
  20 shown below. By default, only the `gpg` agent is managed.
  21
  22 ```zsh
  23 zstyle :omz:plugins:keychain agents gpg,ssh
  24 ```
  25
  26 To **load multiple identities** use the `identities` style, For example:
  27
  28 ```zsh
  29 zstyle :omz:plugins:keychain identities id_ed25519 id_github 2C5879C2
  30 ```
  31
  32 **To pass additional options** to the `keychain` program, use the
  33 `options` style; for example:
  34
  35 ```zsh
  36 zstyle :omz:plugins:keychain options --quiet
  37 ```
  38
  39 ## Credits
  40
  41 Based on code from the `ssh-agent` plugin.
  42
  43 ## References
  44
  45 - [Keychain](https://www.funtoo.org/Keychain)