2022-05-22 08:53:22 +00:00
|
|
|
### gootp
|
|
|
|
|
|
|
|
|
|
[](https://asciinema.org/a/s9eF7EbqgnCkoLVwbv0TE0a8Y)
|
|
|
|
|
|
2022-12-11 09:35:16 +00:00
|
|
|
gootp is a terminal-based 2FA (Two-Factor Authentication) app.
|
|
|
|
|
|
2022-05-22 08:53:22 +00:00
|
|
|
## Features
|
|
|
|
|
- Supported algorithms: TOTP
|
2022-12-11 09:35:16 +00:00
|
|
|
- Compatible with [andOTP](https://github.com/andOTP/andOTP) backup file format
|
|
|
|
|
- Encrypt/decrypt andOTP backup files on your PC
|
2022-05-22 08:53:22 +00:00
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
2022-12-11 09:35:16 +00:00
|
|
|
Prerequisites:
|
2023-08-20 05:36:08 +00:00
|
|
|
1. Go 1.21+
|
2022-12-11 09:35:16 +00:00
|
|
|
2. [Backup file](https://github.com/andOTP/andOTP#backups=)
|
2022-05-22 08:53:22 +00:00
|
|
|
|
|
|
|
|
```shell
|
2022-09-04 08:05:35 +00:00
|
|
|
go install gitea.dwysokinski.me/Kichiyaki/gootp@latest
|
2022-12-11 09:35:16 +00:00
|
|
|
cp /path/to/andotp/file ~/.otp_accounts.json # !IMPORTANT! this backup file must be encrypted
|
2022-05-22 08:53:22 +00:00
|
|
|
```
|
|
|
|
|
## Examples
|
|
|
|
|
|
|
|
|
|
```shell
|
2022-12-11 09:35:16 +00:00
|
|
|
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
|
2022-12-11 09:41:31 +00:00
|
|
|
gootp -p /path/to/andotp/file/.otp_accounts.json.aes decrypt -o /output/.otp_accounts.json # decrypt a file
|
2022-05-22 08:53:22 +00:00
|
|
|
```
|
2022-12-11 09:35:16 +00:00
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
|
|
Distributed under the MIT License. See ``LICENSE`` for more information.
|
|
|
|
|
|
|
|
|
|
## Contact
|
|
|
|
|
|
|
|
|
|
Dawid Wysokiński - [contact@dwysokinski.me](mailto:contact@dwysokinski.me)
|
