Kichiyaki
/
gootp
Archived
1
0
Fork 0
Code Issues 1 Pull Requests 7 Projects Releases Wiki Activity

chore: update README.md
continuous-integration/drone/push Build is passing Details

This commit is contained in:
Dawid Wysokiński 2022-12-11 10:35:16 +01:00
parent e56aa8db6d
commit b56b3cc3ce
Signed by: Kichiyaki
GPG Key ID: B5445E357FB8B892
1 changed files with 21 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,31 +1,39 @@
### gootp
gootp is a terminal-based 2FA (Two-Factor Authentication) app.
[![asciicast](https://asciinema.org/a/s9eF7EbqgnCkoLVwbv0TE0a8Y.svg)](https://asciinema.org/a/s9eF7EbqgnCkoLVwbv0TE0a8Y)
gootp is a terminal-based 2FA (Two-Factor Authentication) app.
## Features
- Supported algorithms: TOTP
- Compatible with [andOTP](https://github.com/andOTP/andOTP) file format
- Allows to encrypt/decrypt andOTP files on your PC
- Compatible with [andOTP](https://github.com/andOTP/andOTP) backup file format
- Encrypt/decrypt andOTP backup files on your PC
## Installation
Requirements:
Prerequisites:
1. Go 1.19+
2. [Exported andOTP file](https://github.com/andOTP/andOTP#backups=)
2. [Backup file](https://github.com/andOTP/andOTP#backups=)
```shell
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
```shell
gootp # show OTP list
gootp -h # help for gootp
gootp -p /path/to/andotp/file/.otp_accounts.json # override default path
gootp --password xxx # specify 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 decrypt -o /output/.otp_accounts.json.aes # decrypt file
gootp # start gootp
gootp -h # show a list of commands
gootp -p /path/to/andotp/file/.otp_accounts.json # override the default path
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 a 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)