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
+38-9Lines changed: 38 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -1,3 +1,4 @@
1
+
1
2
# cotp - command line totp authenticator
2
3
3
4
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
7
8
8
9
The interface is quite minimalist and intuitive, by typing `cotp -h` you can see all the program features.
9
10
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))
11
12
12
13
## Installation
13
14
@@ -29,10 +30,40 @@ Then choose how you want to proceed
29
30
makepkg -si
30
31
```
31
32
### Other distributions
32
-
You can use prebuilt binaries or [build cotp](##building) yourself
33
+
You can use prebuilt binaries or [build cotp](#building) yourself
33
34
Go to [releases page](https://github.com/replydev/cotp/releases/) and get the latest version.
34
35
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**|
36
67
## Building
37
68
First of all install the rust toolchain:
38
69
@@ -47,17 +78,15 @@ You will find the compiled binary in **target/release** folder
47
78
48
79
## Planned features
49
80
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:
53
84
- [x] Aegis
54
85
- [x] andOTP
55
86
- [ ] Authy
56
87
- [ ] Google Authenticator
57
88
- [ ] FreeOTP
58
-
- Graphical User Interface
89
+
-[ ]Graphical User Interface
59
90
60
91
## Contribution
61
92
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.
0 commit comments