chore: update README.md
continuous-integration/drone/push Build is passing
Details
continuous-integration/drone/push Build is passing
Details
This commit is contained in:
parent
e56aa8db6d
commit
b56b3cc3ce
34
README.md
34
README.md
|
@ -1,31 +1,39 @@
|
||||||
### gootp
|
### gootp
|
||||||
|
|
||||||
gootp is a terminal-based 2FA (Two-Factor Authentication) app.
|
|
||||||
|
|
||||||
[![asciicast](https://asciinema.org/a/s9eF7EbqgnCkoLVwbv0TE0a8Y.svg)](https://asciinema.org/a/s9eF7EbqgnCkoLVwbv0TE0a8Y)
|
[![asciicast](https://asciinema.org/a/s9eF7EbqgnCkoLVwbv0TE0a8Y.svg)](https://asciinema.org/a/s9eF7EbqgnCkoLVwbv0TE0a8Y)
|
||||||
|
|
||||||
|
gootp is a terminal-based 2FA (Two-Factor Authentication) app.
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
- Supported algorithms: TOTP
|
- Supported algorithms: TOTP
|
||||||
- Compatible with [andOTP](https://github.com/andOTP/andOTP) file format
|
- Compatible with [andOTP](https://github.com/andOTP/andOTP) backup file format
|
||||||
- Allows to encrypt/decrypt andOTP files on your PC
|
- Encrypt/decrypt andOTP backup files on your PC
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
Requirements:
|
Prerequisites:
|
||||||
1. Go 1.19+
|
1. Go 1.19+
|
||||||
2. [Exported andOTP file](https://github.com/andOTP/andOTP#backups=)
|
2. [Backup file](https://github.com/andOTP/andOTP#backups=)
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
go install gitea.dwysokinski.me/Kichiyaki/gootp@latest
|
go install gitea.dwysokinski.me/Kichiyaki/gootp@latest
|
||||||
cp /path/to/andotp/file ~/.otp_accounts.json # !IMPORTANT! this file must be encrypted
|
cp /path/to/andotp/file ~/.otp_accounts.json # !IMPORTANT! this backup file must be encrypted
|
||||||
```
|
```
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
```shell
|
```shell
|
||||||
gootp # show OTP list
|
gootp # start gootp
|
||||||
gootp -h # help for gootp
|
gootp -h # show a list of commands
|
||||||
gootp -p /path/to/andotp/file/.otp_accounts.json # override default path
|
gootp -p /path/to/andotp/file/.otp_accounts.json # override the default path
|
||||||
gootp --password xxx # specify encryption password via flag
|
gootp --password xxx # specify an encryption password via flag
|
||||||
gootp -p /path/to/andotp/file/.otp_accounts.json encrypt -o /output/.otp_accounts.json.aes # encrypt file
|
gootp -p /path/to/andotp/file/.otp_accounts.json encrypt -o /output/.otp_accounts.json.aes # encrypt a file
|
||||||
gootp -p /path/to/andotp/file/.otp_accounts.json decrypt -o /output/.otp_accounts.json.aes # decrypt file
|
gootp -p /path/to/andotp/file/.otp_accounts.json decrypt -o /output/.otp_accounts.json.aes # decrypt a file
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Distributed under the MIT License. See ``LICENSE`` for more information.
|
||||||
|
|
||||||
|
## Contact
|
||||||
|
|
||||||
|
Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me)
|
||||||
|
|
Reference in New Issue