Browse Source

update help/readme

master
Andrew Kaiser 6 years ago
parent
commit
e2c002c47a
4 changed files with 17 additions and 15 deletions
  1. +10
    -9
      README.md
  2. +5
    -4
      bin/cli.js
  3. +1
    -1
      package-lock.json
  4. +1
    -1
      package.json

+ 10
- 9
README.md View File

@ -18,21 +18,23 @@ The DMENU_PATH environment variable can be used to point to an alternative dmenu
Options: Options:
--bw-list-args Arbitrary arguments to pass to bitwarden's 'list' command --bw-list-args Arbitrary arguments to pass to bitwarden's 'list' command
Defaults to nothing. Defaults to nothing.
--clear-clipboard Number of seconds to keep selected field in the clipboard.
Defaults to 15s.
--dmenu-args Sets arbitrary arguments to pass to dmenu --dmenu-args Sets arbitrary arguments to pass to dmenu
Defaults to nothing. Defaults to nothing.
--dmenu-pswd-args Sets arbitrary arguments to pass to the dmenu password prompt --dmenu-pswd-args Sets arbitrary arguments to pass to the dmenu password prompt
Defaults to nothing. Defaults to nothing.
--clear-clipboard Number of seconds to keep selected field in the clipboard.
Defaults to 15s.
--session-timeout Number of seconds after an unlock that the menu can be accessed --session-timeout Number of seconds after an unlock that the menu can be accessed
without providing a password again. Defaults to 0s. without providing a password again. Defaults to 0s.
--stdout Prints the password and username to stdout
--sync-vault-after Number of seconds allowable between last bitwarden sync and --sync-vault-after Number of seconds allowable between last bitwarden sync and
current time. Defaults to 0s. current time. Defaults to 0s.
--on-error Arbitrary command to run if the program fails. The thrown error --on-error Arbitrary command to run if the program fails. The thrown error
is piped to the given command. Defaults to none. is piped to the given command. Defaults to none.
--verbose Show extra logs useful for debugging.
--stdout Prints the password and username to stdout
--debug Show extra logs useful for debugging.
--debug-unsafe Show debug logs WITHOUT obfuscating your sensitive info. Do not share!
``` ```
By default, this program runs at its most secure. No session is stored for any time period, the vault is updated By default, this program runs at its most secure. No session is stored for any time period, the vault is updated
@ -40,7 +42,7 @@ every time it is used, and the clipboard is cleared every 15 seconds. In reality
little more lenient. Here is the command I use in my personal i3wm config. little more lenient. Here is the command I use in my personal i3wm config.
```bash ```bash
bitwarden-dmenu --clear-clipboard 30 --session-timeout 100 --sync-vault-after 3600 --on-error 'xargs notify-send --urgency=low'
bitwarden-dmenu --dmenu-args '-i' --clear-clipboard 30 --session-timeout 100 --sync-vault-after 3600 --on-error 'xargs notify-send --urgency=low'
``` ```
`bitwarden-dmenu` will prompt for a login if you are logged out. `bitwarden-dmenu` will prompt for a login if you are logged out.
@ -51,11 +53,10 @@ bitwarden-dmenu --clear-clipboard 30 --session-timeout 100 --sync-vault-after 36
npm i -g bitwarden-dmenu npm i -g bitwarden-dmenu
``` ```
## Depends on
## Depends On
- [dmenu](https://tools.suckless.org/dmenu/)
- [bitwarden-cli](https://help.bitwarden.com/article/cli/)
[dmenu](https://tools.suckless.org/dmenu/)
## Credits ## Credits
Inspired by the no longer maintained [keepass-dmenu](https://github.com/gustavnikolaj/keepass-dmenu)
Inspired by the (now) deprecated [keepass-dmenu](https://github.com/gustavnikolaj/keepass-dmenu)

+ 5
- 4
bin/cli.js View File

@ -27,20 +27,21 @@ The DMENU_PATH environment variable can be used to point to an alternative dmenu
Options: Options:
--bw-list-args Arbitrary arguments to pass to bitwarden's 'list' command --bw-list-args Arbitrary arguments to pass to bitwarden's 'list' command
Defaults to nothing. Defaults to nothing.
--clear-clipboard Number of seconds to keep selected field in the clipboard.
Defaults to ${cachePasswordDefault}s.
--dmenu-args Sets arbitrary arguments to pass to dmenu --dmenu-args Sets arbitrary arguments to pass to dmenu
Defaults to nothing. Defaults to nothing.
--dmenu-pswd-args Sets arbitrary arguments to pass to the dmenu password prompt --dmenu-pswd-args Sets arbitrary arguments to pass to the dmenu password prompt
Defaults to nothing. Defaults to nothing.
--clear-clipboard Number of seconds to keep selected field in the clipboard.
Defaults to ${cachePasswordDefault}s.
--session-timeout Number of seconds after an unlock that the menu can be accessed --session-timeout Number of seconds after an unlock that the menu can be accessed
without providing a password again. Defaults to ${sessionTimeoutDefault}s. without providing a password again. Defaults to ${sessionTimeoutDefault}s.
--stdout Prints the password and username to stdout
--sync-vault-after Number of seconds allowable between last bitwarden sync and --sync-vault-after Number of seconds allowable between last bitwarden sync and
current time. Defaults to ${syncVaultAfterDefault}s. current time. Defaults to ${syncVaultAfterDefault}s.
--on-error Arbitrary command to run if the program fails. The thrown error --on-error Arbitrary command to run if the program fails. The thrown error
is piped to the given command. Defaults to none. is piped to the given command. Defaults to none.
--stdout Prints the password and username to stdout
--debug Show extra logs useful for debugging. --debug Show extra logs useful for debugging.
--debug-unsafe Show debug logs WITHOUT obfuscating your sensitive info. Do not share! --debug-unsafe Show debug logs WITHOUT obfuscating your sensitive info. Do not share!
` `


+ 1
- 1
package-lock.json View File

@ -1,6 +1,6 @@
{ {
"name": "bitwarden-dmenu", "name": "bitwarden-dmenu",
"version": "1.4.0",
"version": "1.5.1",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
"dependencies": { "dependencies": {


+ 1
- 1
package.json View File

@ -1,6 +1,6 @@
{ {
"name": "bitwarden-dmenu", "name": "bitwarden-dmenu",
"version": "1.5.1",
"version": "1.5.2",
"description": "dmenu for bitwarden password manager.", "description": "dmenu for bitwarden password manager.",
"keywords": [ "keywords": [
"bitwarden", "bitwarden",


Loading…
Cancel
Save