Skip to content

Commit ab13f43

Browse files
authored
docs: add first basic instructions (#441)
2 parents d0ffc31 + 9c67637 commit ab13f43

File tree

2 files changed

+35
-12
lines changed

2 files changed

+35
-12
lines changed

README.md

Lines changed: 35 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,44 @@ minimalist, secure, desktop accessible software to manage my two-factor authenti
1313

1414
## Interface
1515

16-
cotp is written with simplicity in mind, the interface is quite minimalist and intuitive as command line apps should be.
16+
<p align="center"><img src="/img/cotp_demo.gif?raw=true"/></p>
1717

18-
[![asciicast](https://asciinema.org/a/459912.svg)](https://asciinema.org/a/459912)
18+
Type `i` to get some instruction. Otherwise just enter `cotp --help`.
19+
In the first run you will be prompted to insert a password to initialize the database.
1920

20-
If you are familiar with the command line interface using cotp will not be a problem. Just type `cotp` to enter the TUI
21-
dashboard. Type `i` to get some instruction. Otherwise just enter `cotp --help`.
21+
## TL;DR
2222

23-
In the first run you will be prompted to insert a password to initialize the database.
23+
```bash
24+
# Display all the OTP codes in the interactive dashboard
25+
cotp # select any code with arrow keys, press enter to copy into the clipboard, even in an SSH remote shell
26+
27+
# Add a new TOTP code from a BASE32 secret key
28+
cotp add --label [email protected] --issuer Google
29+
30+
# Add a new HOTP code with custom algorithm, digits and counter
31+
cotp add --label example --type hotp --algorithm SHA256 --digits 8 --counter 10
32+
33+
# Edit the digits of the 4th OTP code
34+
cotp edit --index 4 --digits 8
35+
36+
# List all the codes in JSON format passing password through stdin
37+
echo "mysecretpassword" | cotp --password-stdin list --json
38+
39+
# Extract the first matching OTP code with "google" issuer and copy it into the clipboard
40+
echo "mysecretpassword" | cotp extract --issuer google --copy-clipboard
41+
42+
# Import an encrypted Aegis Database backup
43+
cotp import --path my_db.json --aegis-encrypted
44+
45+
# Export the cotp database
46+
cotp export
47+
```
48+
49+
## Compatibility
50+
51+
cotp can generate both **TOTP** and **HOTP** codes, compliant with **rfc6238** and **rfc4226** specifications. Also, it is possible to customize settings like **HMAC algorithm** and **digits**, to provide compatibility to other two-factor authentication systems.
52+
53+
Latest releases also include support for **Steam**, **Yandex**, **MOTP** codes.
2454

2555
## Encryption
2656

@@ -30,13 +60,6 @@ and [Argon2id](https://en.wikipedia.org/wiki/Argon2) for key derivation.
3060

3161
It also uses [AES-GCM](https://docs.rs/aes-gcm/latest/aes_gcm/) to import from encrypted Aegis backups.
3262

33-
## Compatibility
34-
35-
cotp can generate both **TOTP** and **HOTP** codes, compliant with **rfc6238** and **rfc4226** specifications. Also, it
36-
is possible to customize settings like **HMAC algorithm** and **digits**, to provide compatibility to other two-factor
37-
authentication systems.
38-
39-
Latest releases also include support for Steam, Yandex, MOTP codes and code copying from SSH Remote Shell.
4063

4164
## Cross Plaform
4265

img/cotp_demo.gif

2.63 MB
Loading

0 commit comments

Comments
 (0)