navid.sassan/bw-menu
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
bw-menu/CLAUDE.md

2.1 KiB
Raw Blame History

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Project Overview

bw-menu is a rofi/fzf frontend for Bitwarden via the rbw CLI. It lets users interactively search vault entries, select one, and copy a field (password, username, or TOTP) to the clipboard. It maintains a selection history so recent entries appear first.

Commands

uv sync              # install dependencies and set up virtualenv
bw-menu select       # run with rofi (default)
bw-menu select --selector fzf  # run with fzf
uv run pre-commit run --all-files  # run linting/formatting/type-checking

Linting (ruff), formatting (ruff-format), and type checking (pyright) are configured via pre-commit. No tests.

Architecture

Entry point: bw-menu console script → src/bw_menu/__main__.py:main()

Two subcommands:

  • select — interactive vault entry selection via rofi or fzf
  • history — list/get from recently selected entries

Key data flow for select:

  1. cli.py parses args → __main__.py creates a selector via selector.create_selector()
  2. Selector fetches entries from rbw.list_entries() and history from history.load()
  3. History entries appear first (marked distinctly per selector), then remaining entries sorted by folder/name
  4. On selection, rbw.get_field(entry, field) retrieves the secret, entry is added to history
  5. Result is printed or copied via clipboard.copy()

Rofi script mode: RofiSelector uses rofi's script mode protocol — rofi invokes bw-menu select repeatedly. ROFI_RETV env var distinguishes initial list generation (0) from selection handling (1). Entry identity survives the round-trip via ROFI_INFO using ASCII record separator (\x1e) encoding.

External tools (called via subprocess): rbw (vault access), rofi/fzf (selection UI), wl-copy/xclip (clipboard).

Python dependency: pyyaml (for config parsing). All external tool interaction is via subprocess calls.

Build System

  • uv for environment/package management
  • hatchling as build backend
  • Source layout: src/bw_menu/