Skip to content

Commit 0ab2c77

Browse files
author
replydev
committed
Update README.md: add How to use section and fix section links
1 parent 8302524 commit 0ab2c77

File tree

1 file changed

+38
-9
lines changed

1 file changed

+38
-9
lines changed

README.md

Lines changed: 38 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
12
# cotp - command line totp authenticator
23

34
I believe that security is of paramount importance, especially in this digital world. I created cotp because I needed a minimalist, secure, desktop accessible software to manage my two-factor authentication codes.
@@ -7,7 +8,7 @@ cotp is written with simplicity in mind, it relies on only one database file, en
78

89
The interface is quite minimalist and intuitive, by typing `cotp -h` you can see all the program features.
910

10-
You can also import backup made by [Aegis](https://github.com/beemdevelopment/Aegis) and [andOTP](https://github.com/andOTP/andOTP) Authenticators, but backup compatibility is growing (check [planned features](##planned-features))
11+
You can also import backup made by [Aegis](https://github.com/beemdevelopment/Aegis) and [andOTP](https://github.com/andOTP/andOTP) Authenticators, but backup compatibility is growing (check [planned features](#planned-features))
1112

1213
## Installation
1314

@@ -29,10 +30,40 @@ Then choose how you want to proceed
2930
makepkg -si
3031
```
3132
### Other distributions
32-
You can use prebuilt binaries or [build cotp](##building) yourself
33+
You can use prebuilt binaries or [build cotp](#building) yourself
3334
Go to [releases page](https://github.com/replydev/cotp/releases/) and get the latest version.
3435

35-
36+
## How to use
37+
If you are familiar with the command line interface using cotp will not be a problem.
38+
As i said before, if you type `cotp -h` you get some instruction on how to use cotp utilities.
39+
For example, the version 0.0.9 prints out this help screen:
40+
```
41+
cotp v0.0.9
42+
written by @replydev
43+
44+
ARGUMENTS:
45+
-a,--add <secret> <issuer> <label> | Add a new OTP code
46+
-r,--remove <secret> <issuer> <label> | Remove an OTP code
47+
-e,--edit <id> <secret> <issuer> <label> | Edit an OTP code
48+
-i,--import aegis,andotp <filename> | Import a backup from a given application
49+
-ex,--export | Export the entire database in a plaintext json format
50+
-j,--json | Print results in json format
51+
-h,--help | Print this help
52+
```
53+
Note that in the `--edit` command if you type . instead of argument you are specifying not to modify that specific argument.
54+
### Example:
55+
#### Before:
56+
|index|secret|issuer|label|
57+
|--|--|--|--|
58+
|3|NB2HI4DTHIXS653XO4XHS33VOR2WEZJOMNXW2L3XMF2GG2B7OY6WIULXGR3TSV3HLBRVC | Rick | Asley |
59+
#### Command:
60+
61+
cotp -e 3 . . cotp
62+
63+
#### After:
64+
|index|secret|issuer|label|
65+
|--|--|--|--|
66+
|3|NB2HI4DTHIXS653XO4XHS33VOR2WEZJOMNXW2L3XMF2GG2B7OY6WIULXGR3TSV3HLBRVC | Rick | **cotp** |
3667
## Building
3768
First of all install the rust toolchain:
3869

@@ -47,17 +78,15 @@ You will find the compiled binary in **target/release** folder
4778

4879
## Planned features
4980

50-
- Reduce binary size and improve compilation speed by removing useless dependencies.
51-
- Use argon2id13 for key derivation
52-
- Backup compatibility with:
81+
- [x] Reduce binary size and improve compilation speed by removing useless dependencies.
82+
- [ ] Use argon2id13 for key derivation
83+
- [ ] Backup compatibility with:
5384
- [x] Aegis
5485
- [x] andOTP
5586
- [ ] Authy
5687
- [ ] Google Authenticator
5788
- [ ] FreeOTP
58-
- Graphical User Interface
89+
- [ ] Graphical User Interface
5990

6091
## Contribution
6192
I created this project for my own needs, but I would be happy if this little program is useful to someone else, and I gratefully accept any contributions.
62-
63-

0 commit comments

Comments
 (0)