Documentation

LoFiBox Zero Docs

This documentation is the public entry point for users, release testers, and automation workflows. It explains the product boundaries, install path, and major command surfaces.

Get Started

Install the preview build, run LoFiBox for the first time, scan a media library, play music, and diagnose the environment.

WebUI

Browser-based remote control for Now Playing, Queue, Library, Sources, EQ, Settings, Diagnostics, and Remix state.

Remix

Realtime Radio, Tape, and Vinyl effects provided by the built-in audio-effect plugin.

GUI

Small-screen graphical menus, library browsing, search, Now Playing, lyrics, EQ, and Remix shortcut display.

TUI

Terminal Dashboard, Lyrics, Spectrum, Queue, EQ, character sets, and themes.

CLI

Human commands, machine output, runtime commands, source/remote, metadata/lyrics, and stable exit codes.

Remote Sources

Supported remote source types, profile configuration, capability probing, directory browsing, and stream resolution.

Metadata and Lyrics

ID3/metadata, lyrics, artwork, and fingerprint lookup, cache, acceptance, and writeback boundaries.

Product Boundaries

LoFiBox Zero follows one core rule: the fact layer, runtime projection layer, and GUI/TUI/CLI presentation layers stay separate. Playback state, queue, EQ, remote connections, lyrics, and library facts belong to the runtime and core domains; WebUI/GUI/TUI/CLI read projections and submit controlled commands.

Source Repository

The application source of truth is vicliu624/LoFiBox-Zero. Use that repository for source code, issues, pull requests, releases, and CI status. This website repository exists to publish the public portal and signed APT repository.

Entry Role Best for
WebUI Browser runtime projection and remote-control surface Phones, tablets, desktop browsers, local LAN control
GUI Low-resolution graphical product interface Cardputer Zero, Raspberry Pi small screens, Linux desktop windows
TUI Native terminal product interface SSH, servers, headless systems, developer and creator terminals
CLI One-shot commands and machine interface Scripts, systemd, tests, MCP/Agents, diagnostics