lyrcli

Simple CLI tool for displaying synchronized lyrics in the terminal.

Preview

Requirements

• python3
• playerctl

Installation

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

# add "-- --uninstall" to run uninstall script instead.

Usage

Play a song on spotify or youtube, then run lyrcli in the terminal:

# auto-detect player (default)
lyrcli

# target a specific player
lyrcli -p spotify
lyrcli -p firefox
lyrcli -p chromium

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

Configuration

User-configurable settings are stored in:

~/.config/lyrcli/config.conf

[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]
# media player to track: auto, spotify, chromium, firefox, etc.
player = auto

# 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.