rofi-pass/README.md

47 lines
1.6 KiB
Markdown
Raw Normal View History

2015-05-22 15:56:33 -04:00
# rofi-pass
#### bash script to handle pass storages in a convenient way
2015-05-23 00:58:55 -04:00
![rofi-pass](screenshot.png "rofi-pass in action")
2015-05-22 15:56:33 -04:00
## rofi-pass has the following features:
2015-07-16 20:59:40 -04:00
* Open URLs of entries with hotkey
* Add new Entries to Password Storage
* Edit existing Entries
* Support for multiple roots for password-store (e.g. separate work from private passwords)
2015-05-22 15:56:33 -04:00
* Auto Type User and Password. Format of password files are expected to be like:
```
foobarmysecurepassword
UserName: MyUser
2015-05-22 18:01:17 -04:00
URL: http://my.url.foo
2015-05-22 15:56:33 -04:00
```
* Auto Typing of more than one field. This expects a CustomOrder field in password file. (name of the field can be changed in config file - same for URL and Username)
2015-05-22 15:56:33 -04:00
```
foobarmysecurepassword
2015-07-16 20:54:36 -04:00
---
2015-05-22 17:47:23 -04:00
UserName: MyUser
SomeField: foobar
AnotherField: barfoo
2015-05-22 18:02:07 -04:00
URL: http://my.url.foo
2015-07-16 20:54:36 -04:00
CustomOrder: SomeField :tab UserName :tab AnotherField :tab password
2015-05-22 15:56:33 -04:00
```
2015-07-16 20:54:36 -04:00
The `:tab` field has a special meaning. this will hit the tab key, obviously.
2015-05-22 15:56:33 -04:00
## Requirements
2015-05-23 03:47:59 -04:00
* pass (https://github.com/zx2c4/password-store)
2015-05-22 15:56:33 -04:00
* sed
2015-05-23 03:47:59 -04:00
* rofi (https://github.com/DaveDavenport/rofi)
2015-05-22 15:56:33 -04:00
* wmctrl
* xprop
* xdotool
* awk
* bash
2015-07-16 20:59:40 -04:00
## Extras
rofi-pass comes with a tiny helper script, which makes it easier to create new pass entries.
Just run it with `addpass -name "My new Site" -user "zeltak" -branch "branch" -custom "foobar" -CustomOrder "branch :tab user :tab password"`.
You can add as many fields as needed. fieldnames are defined with `-` and the actual value is defined inside the quotations.
Also included is an import script for keepass2 databases. It's the same script that can be downloaded from the pass homepage, with some minor modifications to match rofi-pass structure.