You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+19-11Lines changed: 19 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@
5
5
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.
6
6
7
7
## 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.
9
9
10
10
The interface is quite minimalist and intuitive, by typing `cotp -h` you can see all the program features.
11
11
@@ -21,8 +21,10 @@ Before beginning check you already have the required packages:
21
21
22
22
Then choose how you want to proceed
23
23
24
-
- Using an AUR Helper like [yay]("https://github.com/Jguer/yay"):
24
+
- Using an AUR Helper like [yay](https://github.com/Jguer/yay):
25
25
`yay -S cotp`
26
+
- Or [paru](https://github.com/morganamilo/paru):
27
+
`paru -S cotp`
26
28
- Manually cloning AUR repo and make the pkg
27
29
28
30
```
@@ -36,20 +38,25 @@ Go to [releases page](https://github.com/replydev/cotp/releases/) and get the la
36
38
37
39
## How to use
38
40
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.
39
42
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:
41
44
```
42
-
cotp v0.0.9
45
+
cotp v0.1.1
43
46
written by @replydev
44
47
48
+
USAGE:
49
+
cotp [SUBCOMMAND]
50
+
45
51
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
53
60
```
54
61
Note that in the `--edit` command if you type . instead of argument you are specifying not to modify that specific argument.
55
62
### Example:
@@ -81,6 +88,7 @@ You will find the compiled binary in **target/release** folder
81
88
82
89
-[x] Reduce binary size and improve compilation speed by removing useless dependencies.
0 commit comments