Warning

This project is provided for educational and experimental purposes only. It is not intended for production or commercial use and may violate the terms of service of third‑party music platforms. Use of this software is at your own risk; the authors provide no warranties and accept no liability for any consequences arising from its use.

LRX-CLI

A CLI tool for fetching LRC lyrics on Linux. Automatically detects the currently playing track via MPRIS/DBus and retrieves the best-matching lyrics from multiple sources, ranked by confidence scoring.

Sources

Sources are queried in order. High-confidence results (exact match or manual insert) terminate the pipeline early; otherwise all sources are tried and the highest-confidence result wins.

Local — sidecar .lrc files or embedded audio metadata (FLAC, MP3)
Cache Search — fuzzy cross-album lookup in local cache
Spotify — synced lyrics via Spotify's API (requires SPOTIFY_SP_DC and Spotify trackid)
LRCLIB — exact match from lrclib.net (requires full metadata)
Musixmatch (Spotify) — Musixmatch API with Spotify trackid (requires Spotify trackid)
LRCLIB Search — fuzzy search from lrclib.net (requires at least a title)
Musixmatch — Musixmatch API with metadata search (requires at least a title)
Netease — Netease Cloud Music public API
QQ Music — QQ Music via self-hosted API proxy (requires QQ_MUSIC_API_URL that provides the same interface as tooplick/qq-music-api)

I'm aware that Spotify's lyrics are provided by Musixmatch, but the fact is that Musixmatch's own search will yield different (and more) results than Spotify's, so I treat them as separate sources.

Usage

See lrx --help for full command reference. Common use cases:

Fetch lyrics for the currently playing track:
```
lrx fetch
```
targeting a specific player and a source to fetch from:
```
lrx fetch --player mpd --method lrclib-search
```

Search by metadata (bypasses MPRIS):

lrx search -t "My Love" -a "Westlife"
lrx search --trackid "5p0ietGkLNEqx1Z7ijkw5g"

or by path to a local audio file:

lrx search --path "/path/to/Westlife - My Love.flac"

Export to sidecar .lrc file (or .txt with --plain):

lrx export
lrx export --plain
lrx export --output /path/to/lyrics.lrc

Cache management:

lrx cache stats                    # statistics with source×status table and confidence distribution
lrx cache query                    # inspect cache entries for current track
lrx cache clear                    # clear cache of current track
lrx cache clear --all              # clear entire cache
lrx cache confidence spotify 100   # manually set confidence for a source

Configuration

Set credentials via environment variable or .env file:

~/.config/lrx/.env — user-level
.env in working directory — project-local
Shell environment — highest priority

SPOTIFY_SP_DC=your_cookie_value
MUSIXMATCH_USERTOKEN=your_musixmatch_usertoken
QQ_MUSIC_API_URL=https://api.example.com
PREFERRED_PLAYER=spotify

SPOTIFY_SP_DC — required for Spotify source. Defaults to empty (disabled Spotify source).
MUSIXMATCH_USERTOKEN — optional for Musixmatch sources (Curators Settings Page -> Login (if required) -> "Copy debug info"). If not set, an anonymous token will be fetched at runtime.
QQ_MUSIC_API_URL — required for QQ Music source. Defaults to empty (disabled QQ Music source).
PREFERRED_PLAYER — preferred MPRIS player when multiple are active. Defaults to spotify. Only used when no --player flag is given and more than one player (or none of them) is currently playing.

Shell completion (zsh/fish/bash):

lrx --install-completion

Development

Clone this repository:

git clone https://github.com/Uyanide/LRX-CLI.git
cd LRX-CLI

Create a virtual environment and install dependencies (for example, using uv):

uv venv .venv
uv sync

Run tests without network calls

uv run pytest -m "not network"

or full tests:

uv run pytest

Run the CLI:

uv run lrx --help

Install to user-level (optional):

uv tool install .

README.md Unescape Escape

LRX-CLI

Sources

Usage

Configuration

Development

Credits

README.md