furumi-tui/README.md

furumi

Your music. Your devices. Your network.

Furumi is a federated P2P player for your personal music library. Every running player is a complete, self-sufficient music library: it can import, organize, search, and play your collection without an account, a cloud backend, or a central service.

Connect Furumi on your desktop, laptop, or another device and they become one personal music network. Playback, likes, playlists, and library state can move between your devices, while missing tracks can be requested directly from another player.

Furumi runs on Linux, macOS, and Windows.

Why Furumi?

Music you own should not disappear because a subscription ended, a catalog changed, a service was censored, or a server went offline.

Furumi is built around a different model:

• your library remains under your control;
• every player works independently;
• there is no central account or single point of failure;
• connecting more players improves availability instead of creating a new dependency;
• federation is optional and simple to configure.

A single Furumi instance is already useful. A group of instances becomes a resilient network for your music.

How it works

Each player maintains its own local library and publishes a searchable view of it into Furumi's DHT network. Discovery does not depend on a central index.

Clients connect directly over P2P transport built on iroh. Furumi adds a synchronization protocol on top of that transport to keep trusted devices consistent even when they are not always online.

In practice:

1. Import music into any Furumi player.
2. Pair your other players or join a federation network.
3. Devices discover available libraries through the DHT.
4. Likes, playlists, playback state, and library metadata synchronize between trusted clients.
5. If a track is missing locally, Furumi can fetch it directly from another client.

There is no coordination server in the middle. Local players remain usable when peers are offline, and the network becomes more capable as peers appear.

The player

Furumi includes a full-featured terminal interface for browsing artists and releases, searching, managing playlists and the queue, controlling playback, inspecting connected devices, and configuring federation.

The interface supports keyboard-driven navigation, multi-key combinations, context-aware bindings, and user-defined rebinding through TOML. Built-in audio visualizations, OS media controls, gapless queue playback, and local library management are included. Visualizations are runtime-loadable Rhai scripts executed in a resource-limited sandbox, so they can be added or edited without rebuilding the player.

Optional similarity search calculates versioned embeddings for local tracks in the background and keeps them in SQLite. It works offline; after a separate privacy consent it can also ask a bounded set of federation peers for matches. Compatible peers are selected through signed, anonymous LSH summaries in a decentralized DHT; no central recommendation index or shared calibration file is required. The first selectable model is downloaded on demand and is licensed separately by MTG under CC BY-NC-SA 4.0 (a proprietary license is also available from MTG); Furumi itself remains WTFPL.

Install

macOS

On Apple Silicon Macs, install Furumi from the Homebrew tap:

brew install house-of-vanity/tap/furumi

Run it with:

furumi

Linux, Windows, and other platforms

Download a prebuilt archive from the GitHub releases, or build Furumi from source with Rust 1.97 or newer:

cargo build --release --locked
./target/release/furumi

On Debian or Ubuntu, install the Linux audio build dependencies first:

sudo apt install libasound2-dev pkg-config

Equivalent ALSA development packages are required on other Linux distributions. macOS and Windows require no additional system packages.

Import a music directory from Furumi's command line:

:import /path/to/music

Federation, trusted-device pairing, and key bindings are configured directly inside the player.

Manual updates

In Settings → Additional settings → Updates, select Check for updates, then Install update when a newer stable GitHub release is available. Downloads run in the background. After installation, restart furumi to use the new version; playback is not restarted automatically. Wait for an active update operation to finish before quitting.

Updates replace the running executable in its installation directory, which must be writable by your user. Release archives must include a matching entry in the release's SHA256SUMS asset. Older releases without it cannot be installed through this feature. The updater checks SHA-256 and the executable's format and architecture before replacing it. Checksums provide integrity checking, not publisher signatures. Settings and the local library are preserved.

There are no automatic startup checks. Only the existing release asset naming scheme is supported; missing or incompatible platform builds are rejected.

The Additional settings window also contains the music save directory and visualization controls. Use Up/Down (or j/k) to navigate, Enter to select, and Esc to return to Settings. Long lists scroll with the selection.

Now playing in tmux

While Furumi is running, a second invocation can print a cheap, single-line playback snapshot without opening the TUI or library:

furumi --status
# ▶ Artist — Track 1:23/4:05

For example, add this to .tmux.conf:

set -g status-interval 1
set -g status-right '#(furumi --status) | %H:%M'

furumi --status-json returns the same snapshot as JSON, including playback state, title, artist, album, position, duration, and volume. Both commands print nothing when Furumi is stopped or no track is loaded. On Linux, Furumi also exposes the existing MPRIS player cy.hexor.furumi, which can be queried with tools such as playerctl.

Architecture

Furumi is a Rust application built with:

• ratatui and crossterm for the cross-platform TUI;
• rodio for local audio playback;
• SQLite for the personal library and synchronization state;
• tract ONNX inference for optional local music embeddings;
• a dedicated DHT for decentralized discovery;
• iroh-based P2P streams for client-to-client communication;
• an offline-tolerant operation log for trusted-device synchronization;
• Rhai for programmable audio visualizations.

More detail is available in ARCHITECTURE.md.

Contributing

Bug reports, design discussions, and patches are welcome. Before submitting a change, run:

cargo fmt --all -- --check
cargo check --all-targets
cargo test --all-targets

License

Furumi is released under the Do What The Fuck You Want To Public License, Version 2.