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.

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
  4. Dmenu, Rofi or Bemenu
  5. (optional) Pinentry.
  6. (optional) xdotool, ydotool(>= 1.0.0)/wtype (for Wayland).

Features

  • Supports bitwarden.com and self-hosted Vaultwarden accounts.
  • Auto-type username and/or password on selection. No clipboard copy/paste involved.
  • 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][6].
  • 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.
  • Define multiple vault URLs in the config file.
  • 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] [-a AUTOTYPE]

  • 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.

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

Planned features

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

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.3.0.tar.gz (31.3 kB view details)

Uploaded Source

Built Distribution

bitwarden_menu-0.3.0-py3-none-any.whl (40.6 kB view details)

Uploaded Python 3

File details

Details for the file bitwarden-menu-0.3.0.tar.gz.

File metadata

  • Download URL: bitwarden-menu-0.3.0.tar.gz
  • Upload date:
  • Size: 31.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for bitwarden-menu-0.3.0.tar.gz
Algorithm Hash digest
SHA256 abb4bf411ddb1aac808a0f5df9162cb519b4fdc1594edf36c51462690d2d9317
MD5 2cc73dd6f4b1619c5fc6cd41b8921db5
BLAKE2b-256 4cd5a2215efe3e833526a3d55459525a3c22d887e93b5ec39495eaa214385e31

See more details on using hashes here.

File details

Details for the file bitwarden_menu-0.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for bitwarden_menu-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 850d5e1c8b4b964b8b81e09a5d4a831e4d15517c012a615fedd988f236375b26
MD5 659ead0f5b7ed4c13cca16977b65a7c3
BLAKE2b-256 eb83c88e843650aff6e2a26c3be2a97f498ce22fabb2cfd35c16d28c34e7ef59

See more details on using hashes here.

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