From 938c65205333a4c3e7a165b23ce6546dd9a48897 Mon Sep 17 00:00:00 2001 From: Jeff Epler Date: Mon, 4 Dec 2023 19:32:26 -0600 Subject: [PATCH] Refine the README --- README.md | 28 +++++++++++++++++++++------- 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 80705b1..7e0772b 100644 --- a/README.md +++ b/README.md @@ -31,22 +31,36 @@ otp-command = "echo 'otpauth://totp/example?algorithm=SHA1&digits=6&secret=IHACD If the command is a string, it is interpreted with the shell; otherwise, the list of arguments is used directly. -# Using the app +# Using textual-totp -Once the app has started, it will show each available TOTP. The code will show as "\*\*\*\*\*\*" until it is revealed. -To reveal a code, tab to the desired line and press "s". -When the code expires, it will be replaced with "\*\*\*\*\*\*" again. +The command to start textual-totp is `ttotp`. +It has several options which can be shown with `ttotp --help`. -You can also copy a code directly to the operating system's clipboard by pressing "c". +`ttotp` will first invoke the `otp-command` to get the list of TOTPs. +This may require interaction +(for instance, the `pass` command may need to request your GPG key passphrase) + +Once the otp-command finishes, `ttotp` will show each available TOTP. +Each code will show as `******` until it is revealed. + +Navigate up/down in several ways: + * up and down keys + * tab and shift-tab keys + * "j" and "k" (vi keys) + +To reveal a code, move to the desired line and press "s". +When the code expires, it will be replaced with `******` again. + +Copy a code directly to the operating system's clipboard by pressing "c". The code will be cleared from the clipboard after 30 seconds. Your Operating System may report that `ttotp` "pasted from the clipboard". This is because `ttotp` tries to only clear values that it set, by checking that the current clipboard value is equal to the value it pasted earlier. -You can exit the app with Ctrl+C. +Exit the app with Ctrl+C. # In-memory storage of TOTPs As long as `ttotp` is open, the TOTP secret values are stored in memory in plain text. -`ttotp` never writes secret values to operating system files or store them in environment variables. +`ttotp` never writes secret values to operating system files or stores them in environment variables. (but your otp-command might! check any related documentation carefully)