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

   1 # otp plugin
   2
   3 This plugin allows you to create one-time passwords using [`oathtool`](https://www.nongnu.org/oath-toolkit/man-oathtool.html),
   4 able to replace MFA devices. The oathtool key is kept in a GPG-encrypted file so the codes
   5 can only be generated by a user able to decrypt it.
   6
   7 To use it, add `otp` to the plugins array in your zshrc file:
   8 ```zsh
   9 plugins=(... otp)
  10 ```
  11
  12 Provided aliases:
  13
  14 - `otp_add_device`: creates a new encrypted storage for an oathtool key and stores it
  15   on the disk. For encrypting the key, it will ask for a GPG user ID (your GPG key's
  16   email address). Then the OTP key needs to be pasted, followed by a CTRL+D character
  17   inserted on an empty line.
  18
  19 - `ot`: generates a MFA code based on the given key and copies it to the clipboard
  20   (on Linux it relies on xsel, on MacOS X it uses pbcopy instead).
  21
  22 The plugin uses `$HOME/.otp` to store its internal files.