From 3d3a3d0f3db1fbd1509d58dcb099619b556b2f5c Mon Sep 17 00:00:00 2001 From: AluminumTank Date: Mon, 30 Mar 2020 20:26:11 -0400 Subject: [PATCH] update README --- README.md | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index e0eede1..b068985 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,11 @@ # wofi-pass +``` +Usage: wofi-pass [options] + -h, --help show this help message + -s, --squash-choice don't show field choice if password file only contains password + -t, --type type the selection instead of copying to clipboard +``` + Since `wofi` isn't a drop-in replacement for `rofi`, I couldn't use [rofi-pass](https://github.com/carnager/rofi-pass) anymore. So, I just made a version of `passmenu` that accomplishes everything I needed from `rofi-pass`. @@ -13,12 +20,7 @@ that lets the user choose which field to copy/print. It also assumes that [pass-otp](https://github.com/tadfisher/pass-otp) is installed if an `otpauth://...` string is present in a password file. -The script assumes several things: -1. The password is on the first line; -2. The rest of the lines are formatted as key:value pairs. - -See the following example: - +The script assumes password files are formatted like the following: ``` Th3Gr3at3stPassw0rd username: JohnDoe @@ -26,6 +28,15 @@ email: john@example.com otpauth://totp/example?secret=ABCDCBABCDCBABCD pin: 1234 ``` +Note that the password is **ALWAYS** on the first line. +The `-s | --squash` flag tells `wofi-pass` to "intelligently" skip +the field choice dialogue when there is only a password in the file. + +The `-t | --type` flag tells `wofi-pass` to type the choice instead of copying +to clipboard. This also enables the autotype choice which types +`username :tab password`. + +## Disclaimer??? I know this script needs some work; it was mostly hacked together in an afternoon to get the minimum functionality I needed.