Skip to content

Commit fa44bb4

Browse files
author
replydev
committed
Update README.md
1 parent cc2db6e commit fa44bb4

File tree

1 file changed

+19
-11
lines changed

1 file changed

+19
-11
lines changed

README.md

Lines changed: 19 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
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.
66

77
## Overview
8-
cotp is written with simplicity in mind, it relies on only one database file, encrypted with XChaCha20Poly1305 authenticated encryption and scryptsalsa208sha256 for key derivation. Use of argon2id13 KDF is planned.
8+
cotp is written with simplicity in mind, it relies on only one database file, encrypted with XChaCha20Poly1305 authenticated encryption and argon2id13 for key derivation.
99

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

@@ -21,8 +21,10 @@ Before beginning check you already have the required packages:
2121

2222
Then choose how you want to proceed
2323

24-
- Using an AUR Helper like [yay]("https://github.com/Jguer/yay"):
24+
- Using an AUR Helper like [yay](https://github.com/Jguer/yay):
2525
`yay -S cotp`
26+
- Or [paru](https://github.com/morganamilo/paru):
27+
`paru -S cotp`
2628
- Manually cloning AUR repo and make the pkg
2729

2830
```
@@ -36,20 +38,25 @@ Go to [releases page](https://github.com/replydev/cotp/releases/) and get the la
3638

3739
## How to use
3840
If you are familiar with the command line interface using cotp will not be a problem.
41+
Please note that cotp requires at least an 8 chars length password.
3942
As i said before, if you type `cotp -h` you get some instruction on how to use cotp utilities.
40-
For example, the version 0.0.9 prints out this help screen:
43+
For example, the version 0.1.1 prints out this help screen:
4144
```
42-
cotp v0.0.9
45+
cotp v0.1.1
4346
written by @replydev
4447
48+
USAGE:
49+
cotp [SUBCOMMAND]
50+
4551
ARGUMENTS:
46-
-a,--add <secret> <issuer> <label> | Add a new OTP code
47-
-r,--remove <secret> <issuer> <label> | Remove an OTP code
48-
-e,--edit <id> <secret> <issuer> <label> | Edit an OTP code
49-
-i,--import aegis,andotp <filename> | Import a backup from a given application
50-
-ex,--export | Export the entire database in a plaintext json format
51-
-j,--json | Print results in json format
52-
-h,--help | Print this help
52+
-a,--add [SECRET] [ISSUER] [LABEL] | Add a new OTP code
53+
-e,--edit [ID] [SECRET] [ISSUER] [LABEL] | Edit an OTP code
54+
-r,--remove [ID] | Remove an OTP code
55+
-i,--import [APPNAME] [PATH] | Import a backup from a given application
56+
-ex,--export | Export the entire database in a plaintext json format
57+
-j,--json | Print results in json format
58+
-s,--single | Print OTP codes in single mode
59+
-h,--help | Print this help
5360
```
5461
Note that in the `--edit` command if you type . instead of argument you are specifying not to modify that specific argument.
5562
### Example:
@@ -81,6 +88,7 @@ You will find the compiled binary in **target/release** folder
8188

8289
- [x] Reduce binary size and improve compilation speed by removing useless dependencies.
8390
- [x] Use argon2id13 for key derivation
91+
- [x] CLI Dashboard
8492
- [ ] Backup compatibility with:
8593
- [x] Aegis
8694
- [x] andOTP

0 commit comments

Comments
 (0)