- Notifications
You must be signed in to change notification settings - Fork5
Dmenu/Rofi frontend for managing Bitwarden vault using the Bitwarden CLI tool.
License
firecat53/bitwarden-menu
Folders and files
Name | Name | Last commit message | Last commit date | |
---|---|---|---|---|
Repository files navigation
Dmenu/Rofi frontend for managing Bitwarden vaults. Uses theBitwarden CLItool to interact with the Bitwarden database.
This project is not associated with the Bitwarden project nor 8bit SolutionsLLC.
pip install --user bitwarden-menu
Ensure~/.local/bin
is in your$PATH
. Runbwm
and enter your databasepath, keyfile path, and password.
NOTE:Initial login to some servers, including vault.bitwarden.com, willrequire theclient_secret
from your account settings page. Ensure this is inyour clipboard and ready to paste prior to first run. Once logged in for thefirst time, you will not need this value again.
For full installation documention see the [installation docs][docs/install.md].
Installation -Configuration -Usage
- Python 3.7+
- Bitwarden CLI. Ensure the
bw
command is in$PATH
- Pynput andXdg
- Dmenu,Rofi,Wofi orBemenu
- xsel or wl-copy
- (optional) Pinentry.
- (optional) xdotool, ydotool(>= 1.0.0)/wtype (for Wayland).
- Supports multiplebitwarden.com and self-hostedVaultwarden accounts. Accounts can be switched on the fly.
- Auto-type username and/or password on selection. Select to clipboard ifdesired (clipboard clears after 30 sec on X11 or after 1 paste on Wayland).
- Supports login with 2FA code from Authenticator(TOTP), Email, or Yubikey.
- Background process allows selectable time-out for locking the database.
- Use a customKeepass 2.x style auto-type sequence.
- Type, view or edit any field.
- Open the URL in the default web browser.
- Non U.S. English keyboard languages and layouts supported via xdotool orydotool/wtype (for Wayland).
- Edit notes using terminal or gui editor.
- Add and Delete entries
- Rename, move, delete and add folders and collections
- Move any item to or from an organization, including support for multiplecollections.
- Hide selected folders from the default and 'View/Type Individual entries'views.
- Configure the characters and groups of characters used during passwordgeneration.
- Optional Pinentry support for secure passphrase entry.
- Add, edit and type TOTP codes.
- MIT
bwm [-h] [-v VAULT] [-l LOGIN] [-k] [-a AUTOTYPE] [-C]
- Run
bwm
or bind to keystroke combination. - Enter account URL on first run.
- Start typing to match entries.
- Configure ~/.config/bwm/config.ini as desired.
- More detailedusage information.
- Screencast (Using Bemenu on Sway):
To run tests in a venv:make test
(not implemented yet)
To install bitwarden-menu in a venv:
make
Build man page from Markdown source:
make man
Using
hatch
:hatch shell
: provies venv with editable installation.hatch build
&&hatch publish
: build and publish to Pypi.
Using
nix
:nix develop
: Provides development shell with all dependencies.make test
andhatch build/publish
work as usual.
GitHub Action will upload to TestPyPi on each push to
main
. To create aGitHub and PyPi release, create a new tag (formatting below) and push tags.<tag name on first line> * Release note 1 * Release note 2 * ...
- Unit tests
- Notifications for syncing status (e.g. when a sync is complete)
About
Dmenu/Rofi frontend for managing Bitwarden vault using the Bitwarden CLI tool.