update README with --qr option

This commit is contained in:
scito 2022-12-31 16:42:12 +01:00
parent 1f04dd71e2
commit 5225af0621

View file

@ -57,25 +57,27 @@ cd extract_otp_secret_keys
## Program help: arguments and options ## Program help: arguments and options
<pre>usage: extract_otp_secrets.py [-h] [--camera NUMBER] [--json FILE] [--csv FILE] [--keepass FILE] [--printqr] [--saveqr DIR] [--verbose | --quiet] [infile ...] <pre>usage: extract_otp_secrets.py [-h] [--camera NUMBER] [--qr {QREADER,DEEP_QREADER,ZBAR,CV2,WECHAT}] [--json FILE] [--csv FILE] [--keepass FILE] [--printqr] [--saveqr DIR] [--verbose | --quiet] [infile ...]
Extracts one time password (OTP) secret keys from QR codes, e.g. from Google Authenticator app. Extracts one time password (OTP) secret keys from QR codes, e.g. from Google Authenticator app.
If no infiles are provided, the QR codes are interactively captured from the camera. If no infiles are provided, the QR codes are interactively captured from the camera.
positional arguments: positional arguments:
infile a) file or - for stdin with 'otpauth-migration://...' URLs separated by newlines, lines starting with # are ignored; infile a) file or - for stdin with 'otpauth-migration://...' URLs separated by newlines, lines starting with # are ignored;
b) image file containing a QR code or = for stdin for an image containing a QR code b) image file containing a QR code or = for stdin for an image containing a QR code
options: options:
-h, --help show this help message and exit -h, --help show this help message and exit
--camera NUMBER, -C NUMBER camera number of system (default camera: 0) --camera NUMBER, -C NUMBER camera number of system (default camera: 0)
--json FILE, -j FILE export json file or - for stdout --qr {QREADER,DEEP_QREADER,ZBAR,CV2,WECHAT}, -Q {QREADER,DEEP_QREADER,ZBAR,CV2,WECHAT}
--csv FILE, -c FILE export csv file or - for stdout QR reader (default: ZBAR)
--keepass FILE, -k FILE export totp/hotp csv file(s) for KeePass, - for stdout --json FILE, -j FILE export json file or - for stdout
--printqr, -p print QR code(s) as text to the terminal (requires qrcode module) --csv FILE, -c FILE export csv file or - for stdout
--saveqr DIR, -s DIR save QR code(s) as images to the given folder (requires qrcode module) --keepass FILE, -k FILE export totp/hotp csv file(s) for KeePass, - for stdout
--verbose, -v verbose output --printqr, -p print QR code(s) as text to the terminal (requires qrcode module)
--quiet, -q no stdout output, except output set by - --saveqr DIR, -s DIR save QR code(s) as images to the given folder (requires qrcode module)
--verbose, -v verbose output
--quiet, -q no stdout output, except output set by -
examples: examples:
python extract_otp_secrets.py python extract_otp_secrets.py