lyriterm

module
v0.0.0-...-7e23508 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 24, 2026 License: MIT

README

LyriTerm

Synced lyrics in your terminal for the currently playing song (MPRIS via playerctl, lyrics from LRCLIB). Preview

Features

  • synced auto-scrolling lyrics
  • karaoke-style highlighting when timing is available
  • themes: spotify, nord, dracula, gruvbox, monokai, arch
  • offset control (ms) to fix drift

Requirements

  • playerctl
  • an MPRIS-capable player (Spotify, VLC, etc.)
Install playerctl

Arch

sudo pacman -S playerctl

Debian/Ubuntu

sudo apt install playerctl

Fedora

sudo dnf install playerctl

Install

Arch (AUR)
yay -S lyriterm-git
Go
go install github.com/Kryptos-s/LyriTerm/cmd/lyriterm@latest

Make sure Go’s bin dir is in your PATH:

export PATH="$PATH:$(go env GOPATH)/bin"
Build from source
git clone https://github.com/Kryptos-s/LyriTerm.git
cd LyriTerm
go build -trimpath -o lyriterm ./cmd/lyriterm
sudo install -m755 lyriterm /usr/local/bin/lyriterm

Usage

Start music in your player, then run:

lyriterm

Keybinds

Key Action
q / Ctrl+C quit
s open settings
o offset +100ms
p offset -100ms
Esc close settings

Config

Config file:

  • ~/.config/lyriterm/config.json

Example:

{
  "theme": "spotify",
  "offset_ms": 0,
  "show_progress": true,
  "karaoke_mode": true,
  "dim_inactive": true
}

Options:

Field Type Default Notes
theme string spotify spotify,nord,dracula,gruvbox,monokai,arch
offset_ms number 0 + delays lyrics, - advances
show_progress bool true progress bar
karaoke_mode bool true needs word timing data
dim_inactive bool true dims non-current lines

Troubleshooting

  • No player detected: run playerctl status. if it fails, your player is not exposing MPRIS.
  • Lyrics not found: track may not exist on LRCLIB or has no timed lyrics.
  • Drift: adjust offset with o / p, then set offset_ms in config.

License

MIT

Directories

Path Synopsis
cmd
lyriterm command
internal
ui

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL