jepler/textual-totp
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Refine the README

Browse source
This commit is contained in:
Jeff Epler 2023-12-04 19:32:26 -06:00
parent 1784ede3a3
commit 938c652053
No known key found for this signature in database
GPG key ID: D5BF15AB975AB4DE
1 changed files with 21 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -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. 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. The command to start textual-totp is `ttotp`.
To reveal a code, tab to the desired line and press "s". It has several options which can be shown with `ttotp --help`.
When the code expires, it will be replaced with "\*\*\*\*\*\*" again.
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. The code will be cleared from the clipboard after 30 seconds.
Your Operating System may report that `ttotp` "pasted from the clipboard". Your Operating System may report that `ttotp` "pasted from the clipboard".
This is because `ttotp` tries to only clear values that it set, 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. 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 # In-memory storage of TOTPs
As long as `ttotp` is open, the TOTP secret values are stored in memory in plain text. 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) (but your otp-command might! check any related documentation carefully)