rms/totp
1
0
Fork 0
mirror of https://github.com/arcanericky/totp.git synced 2026-05-17 07:55:45 +03:00
Code Issues Packages Projects Releases Wiki Activity

updates to main landing page (#31)

Browse Source 
* refine README (#29)

* dependabot target branch to dev (#30)
This commit is contained in:
Ricky Pike
2022-11-16 08:44:28 -06:00
committed by GitHub
parent b1fc36c2f9
commit 7640794860
2 changed files with 23 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.github/dependabot.yml vendored
View File

@@ -5,6 +5,7 @@ updates:
schedule:
interval: weekly
open-pull-requests-limit: 5
target-branch: dev
- package-ecosystem: github-actions
directory: /
schedule:

30
README.md
View File

@@ -18,7 +18,7 @@ Every copy of your two-factor credentials increases your risk profile. Using thi
**Add TOTP secrets** to the TOTP configuration file with the `config add` option, specifying the name and secret value. Note the secret names are **case sensitive**.
```sh
totp config add mysecretname seed
totp config add mysecretname NV4XGZLDOJSXICQ
```
**Generate TOTP codes** using the `totp` command to specify the secret name. Note that because `totp` reserves the use of the words `config` and `version` for commands, don't use them to name a secret. If you've generated and installed `totp` completions for for your shell, pressing tab on a partially completed secret name will trigger autocomplete.
@@ -38,7 +38,7 @@ Aliases are `ls` and `l`.
**Update secret entries** using the `config update` command. Note that `config update` and `config add` are actually the same command and can be used interchangeably.
```sh
totp config update mysecretname newseed
totp config update mysecretname NV4XGZLDOJSXICQ
```
**Rename the secret entries** with the `config rename` command
@@ -66,7 +66,7 @@ totp config reset
**Use an ad-hoc secret** to generate a code by using the `--secret` option
```sh
totp --secret seed
totp --secret NV4XGZLDOJSXICQ
```
**Continuous code output** can be generated with the `--follow` option.
@@ -75,6 +75,20 @@ totp --secret seed
totp --follow mysecretname
```
**Use a QR Code** to move an entry into your mobile device.
```sh
totp --qrcode mysecretname
```
will output a QR code suitable for scanning into a mobile device app such as Google Authenticator or Authy.
A one-off QR code can also be generated by providing both the name and the secret, for example:
```sh
totp --qrcode --secret NV4XGZLDOJSXICQ mysecretname
```
**For help** on any of the above, use the `--help` option. Examples are
```sh
@@ -111,9 +125,9 @@ Examples with `--time`:
```sh
$ date '+%FT%T%:z'
2019-06-01T19:58:47-05:00
$ totp --time $(date '+%FT%T%:z') --secret seed
$ totp --time $(date '+%FT%T%:z') --secret NV4XGZLDOJSXICQ
931665
$ totp --time 2019-06-01T20:00:00-05:00 --secret seed
$ totp --time 2019-06-01T20:00:00-05:00 --secret NV4XGZLDOJSXICQ
526171
```
@@ -122,16 +136,16 @@ The `--forward` and `--backward` options move the current time forward and backw
Examples with `--forward` and `--backward`
```sh
$ totp --time 2019-06-01T20:00:00-05:00 --backward 3m --secret seed
$ totp --time 2019-06-01T20:00:00-05:00 --backward 3m --secret NV4XGZLDOJSXICQ
222296
$ totp --time 2019-06-01T20:00:00-05:00 --forward 30s --secret seed
$ totp --time 2019-06-01T20:00:00-05:00 --forward 30s --secret NV4XGZLDOJSXICQ
820148
```
The `--follow` option is also compatible with the time machine.
```sh
totp --time 2001-10-31T20:00:00-05:00 --follow --secret seed
totp --time 2001-10-31T20:00:00-05:00 --follow --secret NV4XGZLDOJSXICQ
877737
208737
```