Skip to main content

Dmenu/Rofi frontend for Bitwarden CLI tool

Project description

Bitwarden-menu

PyPI - Python Version PyPI GitHub contributors

Dmenu/Rofi frontend for managing Bitwarden vaults. Uses the Bitwarden CLI tool to interact with the Bitwarden database.

This project is not associated with the Bitwarden project nor 8bit Solutions LLC.

Installation

pip install --user bitwarden-menu

Ensure ~/.local/bin is in your $PATH. Run bwm and enter your database path, keyfile path, and password.

NOTE: Initial login to some servers, including vault.bitwarden.com, will require the client_secret from your account settings page. Ensure this is in your clipboard and ready to paste prior to first run. Once logged in for the first time, you will not need this value again.

For full installation documention see the [installation docs][docs/install.md].

Full Documentation

Installation - Configuration - Usage

Requirements

  1. Python 3.7+
  2. Bitwarden CLI. Ensure the bw command is in $PATH
  3. Pynput and Xdg
  4. Dmenu, Rofi, Wofi or Bemenu
  5. xsel or wl-copy
  6. (optional) Pinentry.
  7. (optional) xdotool, ydotool(>= 1.0.0)/wtype (for Wayland).

Features

  • Supports multiple bitwarden.com and self-hosted Vaultwarden accounts. Accounts can be switched on the fly.
  • Auto-type username and/or password on selection. Select to clipboard if desired (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 custom Keepass 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 or ydotool/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 multiple collections.
  • Hide selected folders from the default and 'View/Type Individual entries' views.
  • Configure the characters and groups of characters used during password generation.
  • Optional Pinentry support for secure passphrase entry.
  • Add, edit and type TOTP codes.

License

  • MIT

Usage

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 detailed usage information.
  • Screencast (Using Bemenu on Sway):

Screencast

Tests

To run tests in a venv: make test (not implemented yet)

Development

  • 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 and hatch build/publish work as usual.

Planned features

  • Unit tests
  • Notifications for syncing status (e.g. when a sync is complete)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bitwarden_menu-0.4.4.tar.gz (27.5 kB view details)

Uploaded Source

Built Distribution

bitwarden_menu-0.4.4-py2.py3-none-any.whl (253.9 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file bitwarden_menu-0.4.4.tar.gz.

File metadata

  • Download URL: bitwarden_menu-0.4.4.tar.gz
  • Upload date:
  • Size: 27.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.7

File hashes

Hashes for bitwarden_menu-0.4.4.tar.gz
Algorithm Hash digest
SHA256 8a3e5bad16631f3c7eb02f3662e7077af00295fa8848d1d124f7ff640daaf99f
MD5 ec3433ef7f9f7f411ab7cd6bf4ef7c48
BLAKE2b-256 fd508cad0af63409f4b40bd57f8a5a364ee0f3ed79d61719c57f17e54d6b8afb

See more details on using hashes here.

Provenance

The following attestation bundles were made for bitwarden_menu-0.4.4.tar.gz:

Publisher: main.yml on firecat53/bitwarden-menu

Attestations:

File details

Details for the file bitwarden_menu-0.4.4-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for bitwarden_menu-0.4.4-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fc3348bad59a60c8fde3629eaadd23e773ebc1b997f04067a86f0dc63fb75dc7
MD5 4d7c1ae20292749310ccda7ae8ac2338
BLAKE2b-256 6fdf2783a9c8d00f82995a7c9a3b7b5e7986e7a61e083494ddaaa4ae5497ff11

See more details on using hashes here.

Provenance

The following attestation bundles were made for bitwarden_menu-0.4.4-py2.py3-none-any.whl:

Publisher: main.yml on firecat53/bitwarden-menu

Attestations:

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page