opennomad/bwzy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

spelling etc

Browse source
This commit is contained in:
Matthias Johnson 2025-10-05 15:27:25 -06:00
parent f467d3a4c0
commit 1e2fd637b3
1 changed files with 22 additions and 23 deletions
Download patch file Download diff file Expand all files Collapse all files

45
README.md
View file

@ -1,38 +1,37 @@
# bwzy - bitwarden ... fuzzy
bwzy is a fuzzy finder and auto-filler for Bitwarden using the official bitwarden cli (read-only at present).
bwzy is a fuzzy finder and auto-filler for Bitwarden (read-only at present).
It runs in the terminal and uses the official bitwarden CLI.
The `bw` cli is great, but not very user-friendly.
`bwzy` tries to make this quicker by caching the information and presenting it via the magnificient [fzf](https://junegunn.github.io/fzf/).
`bwzy` also adds an archive mode which lets you hide entries based on a string.
# current features
- READ-ONLY terminal UI
- filter based on name (i.e. "hide archives")
- more user-friendly than the `bw` command line client
- search based on name and folder
- hide based on name (i.e. "hide archives")
- copy user/pass/totp
- cache the items in shared memory (`/dev/shm/`) to make it fast
- cache does not persist through reboots (by default)
- local cache for speed
- refresh/flush cache
- preview items in `YAML` form
- auto-fill for hyprland
- auto-fill (currently working in hyprland)
- terminal UI
# requirements
The following software is needed by `bwzy`:
- [fzf](https://junegunn.github.io/fzf/) for fuzzy finding
- [bitwarden cli client](https://contributing.bitwarden.com/getting-started/clients/cli) to access bitwarden
- [fzf](https://junegunn.github.io/fzf/) for fuzzy finding
- [jq](https://jqlang.github.io/jq/) to work with the JSON
- [OATH Toolkit](https://www.nongnu.org/oath-toolkit/) allows generating TOTP tokens
- [charmbracelet - gum](https://github.com/charmbracelet/gum) for the loading spinner and color
it also expects `grep`, `sed` and `awk` to be available
It also expects `grep`, `sed` and `awk` to be available
Additinally, you will need clipboard and keyboard automation such as `wtype` and `wl-copy` under wayland.
Additionally, you will need clipboard and keyboard automation such as `wtype` and `wl-copy` under wayland.
## configuration
@ -41,24 +40,24 @@ All configuration is done via environment variables, with defaults shown
```bash
# functional settings
BWZY_CACHE=`/dev/shm/bwzy-cache` # where the passwords are cached
BWZY_KEEP_CACHE='true' # set to false and cache will be purged
BWZY_KEEP_CACHE='true' # set to false and cache will be purged on exit
BWZY_COPY_CMD='wl-copy' # the command to copy something to the clipboard
BWZY_TYPE_CMD='wtype' # the command used to type / send keyboard events
BWZY_HIDE_CMD='' # the command to hide bwzy.desktop
BWZY_REFOCUS_CMD='' # the command to refocuse the previous window
BWZY_HIDE_CMD='' # the command to hide bwzy.desktop or a terminal named `bwzy`
BWZY_REFOCUS_CMD='' # the command to refocus the previous window
BWZY_COPY_AND_HIDE='true' # set to 'false' to not hide bwzy on copy - does not affect auto-fill
BWZY_NOTIFY_CMD='notify-send -i bitwarden' # send a notification (optional, but nice to know if a TOTP has been copied)
BWZY_FILTER="-zz~ " # exclude items with this string in name of folder
# cosmetic overrides which adjust the looks
BWZY_USER_SYMBOL='u+' # new prompt on user copy
BWZY_PASS_SYMBOL='p+' # new prompt on password copy
BWZY_TOTP_SYMBOL='t+' # new prompt on TOTP copy
BWZY_LINK_SYMBOL='l+' # new prompt on link copy
BWZY_AUTO_SYMBOL='a+' # new prompt on auto-fill
BWZY_FOLDER_SYMBOL='/' # new symbol used for a folder
BWZY_USER_SYMBOL='u+' # new prompt on user copy
BWZY_PASS_SYMBOL='p+' # new prompt on password copy
BWZY_TOTP_SYMBOL='t+' # new prompt on TOTP copy
BWZY_LINK_SYMBOL='l+' # new prompt on link copy
BWZY_AUTO_SYMBOL='a+' # new prompt on auto-fill
BWZY_FOLDER_SYMBOL='/' # new symbol used for a folder
BWZY_POINTER_SYMBOL='> ' # the line marker used by FZF
BWZY_PROMPT_SYMBOL='? ' # the prompt symbol used by FZF
BWZY_PROMPT_SYMBOL='? ' # the prompt symbol used by FZF
```
`bwzy` is being tested as my daily driver under [Hyprland](https://hypr.land/) and [Wayland](https://wayland.freedesktop.org/) only, but may be adaptable by the intrepid adventurer. The configuration items to look at are:
@ -80,7 +79,7 @@ This hides the bwzy window, a terminal window with the title set to `bwzy`, to a
The [bwzy.desktop](./bwzy.desktop) file shows the way I launch it.
If you have a font and terminal with support for unicode, you can use fancy symbols. Here's mine:
If you have a font and terminal with support for unicode, you can use fancy symbols. Here are mine:
```bash
BWZY_USER_SYMBOL=' '
@ -95,7 +94,7 @@ BWZY_PROMPT_SYMBOL=' '
# tips and tricks
By default the cache is removed on reboot since it lives in `/dev/shm/`. if you have a secure encrypted file system you can override the cache location so that it persists during reboots. Be safe and know your risks.
By default the cache is removed on reboot since it lives in `/dev/shm/`. If you have a secure encrypted file system you can override the cache location so that it persists during reboots. I use this often as I'm often completely offline, but still need access to my passwords for offline work. Be safe and know your risks.
# feature ideas
- ~~auto-fill~~ (done)