Files
app__cliphoard/README.md

1.7 KiB

Clipb(h)oard

Clipb(h)oard is a small, local-only, keyboard-first clipboard history utility for Linux/X11.

The core is implemented in Rust with SQLite persistence and TOML configuration. The default build intentionally keeps the GTK/X11 desktop integration behind the gui feature so the data model and persistence tests can run on machines without GTK development libraries.

Development

cargo test
cargo run -- --diagnostics

To build the desktop application on Debian/Ubuntu, install the native dependencies first:

sudo apt install libgtk-4-dev libx11-dev libxfixes-dev pkg-config
cargo run --features gui

The repository also includes an isolated Docker build that installs all build headers, runs tests, compiles the GTK/X11 backend, and creates an installable .deb:

docker build -t clipbhoard-builder .
docker run --rm -v "$PWD/target:/out" clipbhoard-builder

The resulting package declares its runtime libraries, so Debian/Ubuntu users can install it with sudo apt install ./target/clipbhoard_0.1.0_amd64.deb and the package manager will resolve GTK/X11 runtime dependencies automatically.

Once installed, Clipb(h)oard runs as a background process. Super+V opens the popup, and clipbhoard --show requests it without keeping the invoking shell blocked. On Cinnamon, a StatusNotifier tray icon provides another way to open the popup when the desktop panel exposes tray icons.

Runtime files follow XDG conventions:

  • database: ~/.local/share/clipbhoard/clipbhoard.db
  • configuration: ~/.config/clipbhoard/config.toml
  • log state: ~/.local/state/clipbhoard/

The full product contract is in .agents/BIBLE.md.