lyrcli — Terminal Lyrics Display

A simple CLI client for displaying synchronized lyrics in the terminal.

Preview

Requirements

• Python 3
• playerctl (for Spotify controls & track status)
• Spotify only (for now)

Install playerctl:

# Arch Linux
sudo pacman -S playerctl

# Fedora
sudo dnf install playerctl

# Debian / Ubuntu
sudo apt install playerctl

Installation

source <(curl -fsSL https://raw.githubusercontent.com/strob3/lyrcli/main/install.sh)

Uninstall

source <(curl -fsSL https://raw.githubusercontent.com/strob3/lyrcli/main/install.sh) -- --uninstall

Usage

Start Spotify and play a song, then run lyrcli in the terminal.

Keybinds

Key	Action
space	play / pause
- / +	volume down / up
[ / ]	seek back / forward
, / .	lyric offset earlier / later
up / k	scroll plain lyrics up
down / j	scroll plain lyrics down
n	next
p	previous
r	restart current track
?	help
q	quit

Debug Mode

Use -d or --debug to collect debug information on a specific song:

lyrcli -d 

Debug information is collected while the program runs and printed after exiting.

Configuration

User-configurable settings are stored in:

~/.config/lyrcli/config.conf

# keep default values for best experience

[lyrics]
# lyric sync offset in seconds (positive = later, negative = earlier)
time_offset = 0.00

# number of lyric lines displayed before and after the active lyric
lines_before = 5
lines_after = 5

[application]
# main ui loop refresh interval in seconds
loop_interval = 0.05

# interval to poll playerctl for track changes (seconds)
track_check_interval = 0.5

# interval between lyrics retry attempts if not found (seconds)
lyrics_retry_interval = 5.0

# delay before showing "no lyrics found" while searching (seconds)
lyrics_not_found_delay = 20.0

[terminal]
# text alignment: left, center, right, line-center, line-right
alignment = center

License

This project is licensed under the MIT License. See the LICENSE file for details.