https://github.com/syedibrahim/gauthy
Cli based Google Authenticator TOTP Generator
https://github.com/syedibrahim/gauthy
click googleauthenticator hacktoberfest python totp typer typer-cli
Last synced: 11 months ago
JSON representation
Cli based Google Authenticator TOTP Generator
- Host: GitHub
- URL: https://github.com/syedibrahim/gauthy
- Owner: syedibrahim
- License: apache-2.0
- Created: 2021-10-16T12:33:04.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2022-10-29T19:48:40.000Z (over 3 years ago)
- Last Synced: 2025-06-05T06:49:09.570Z (11 months ago)
- Topics: click, googleauthenticator, hacktoberfest, python, totp, typer, typer-cli
- Language: Python
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# GAuthy
Cli based Google Authenticator TOTP Generator
## Prerequisites
1. Requires **Python 3.6+**
2. Install requirements using poetry
```commandline
poetry install
```
3.Install **zbar** package
```commandline
pip install zbar
```
For mac user
```commandline
brew install zbar
```
# How to ?
---
### Usage:
```commandline
python gauthy generate [--key/-k Authenticator_Key | --qr/-q Path_To_Qr_Image | --file/-f Storage_File] [--current/-c]
```
## Generate TOTP using Key or QR code:
---
### To generate TOTP using Authenticator Key
```commandline
python gauthy generate -k YOURAUTHKEYHERE
python gauthy generate --key YOURAUTHKEYHERE
```
### To generate TOTP using Authenticator QR code Image
```commandline
python gauthy generate -q path/to/image
python gauthy generate --qr path/to/image
```
## Save and Generate TOTP using file
---
### Usage:
```commandline
# To save to a file
python gauthy save path/to/file [--key/-k Authenticator_Key|--qr/-q Path_To_Qr_Image]
# To generate from a file
python gauthy generate [--file/-f Storage_File] [--current/-c]
```
### To add TOTPs to file
```commandline
# To add Auth key to file
python gauthy save path/to/file -k YOURAUTHKEYHERE
# To add URI from QR image to file
python gauthy save path/to/file -q path/to/image
```
### To generate TOTP using file
```commandline
python gauthy generate -f path/to/file
python gauthy generate --file path/to/file
```
### Other options
1. To display just current TOTP
- Use **_-c / --curent_** flag to display just current TOTP
- Example:
```commandline
python gauthy -q path/to/image --current
python gauthy --key YOURAUTHKEYHERE -c
```
---
### For help
```commandline
python gauthy --help
```