Skip to content

Commit b12d5a7

Browse files
authored
Update README.md
1 parent 67ca8b1 commit b12d5a7

File tree

1 file changed

+41
-1
lines changed

1 file changed

+41
-1
lines changed

README.md

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,42 @@
11
# go-andotp
2-
CLI program to encrypt/decrypt andOTP files
2+
CLI program to encrypt/decrypt [andOTP](https://github.com/andOTP/andOTP) files.
3+
4+
## Installation
5+
```
6+
$ go get github.com/grijul/go-andotp
7+
```
8+
9+
## Usage
10+
```
11+
Usage: go-andotp -i <INPUT_FILE> {-e|-d} [-o <OUT_FILE>] [-p PASSWORD]
12+
13+
-d Decrypt file
14+
-e Encrypt file.
15+
-i string
16+
Input File
17+
-o string
18+
Output File. If no file is provided, output is printed to STDOUT
19+
-p string
20+
Encryption Password. This option can be skipped to get password prompt.
21+
```
22+
23+
## Examples
24+
- Encrypt JSON file (Password is asked after hitting ```Enter```. Password is not echoed)
25+
```
26+
$ go-andotp -e -i file.json -o file.json.aes
27+
```
28+
- Encrypt JSON file (Password is entered through CLI)
29+
```
30+
$ go-andotp -e -i file.json -o file.json.aes -p testpass
31+
```
32+
- Decrypt JSON file
33+
```
34+
$ go-andotp -d -i file.aes.json -o file.json
35+
```
36+
- Decrypt JSON file and print json to console
37+
```
38+
$ go-andotp -d -i file.aes.json
39+
```
40+
41+
# License
42+
[MIT](https://github.com/grijul/go-andotp/blob/main/LICENSE)

0 commit comments

Comments
 (0)