cmus-lyric

README

cmus-lyric

English | 中文

A terminal-based synced lyrics viewer for cmus, built with Bubble Tea.

Inspired by rockagen/cmus-lyric, rewritten from scratch with a modern Go stack.

Overview

cmus-lyric connects to your running cmus instance via cmus-remote -Q, reads the current track, and displays time-synced lyrics in a beautiful TUI. If no local .lrc file is found, it automatically fetches lyrics from LRCLIB or Netease Music.

Features:

• Real-time synced lyric scrolling with highlight
• Auto-fetch from LRCLIB and Netease Music
• Translation lyrics support (.tlrc / .tlyric side-by-side)
• GBK/UTF-8 auto-detection
• Progress bar and playback status
• Minimal, distraction-free UI

Install

Homebrew (macOS / Linux)

brew install index-null/tap/lyrics

Shell script

curl -fsSL https://raw.githubusercontent.com/index-null/cmus-lyric/master/install.sh | bash

Or install to a custom directory:

INSTALL_DIR=~/.local/bin curl -fsSL https://raw.githubusercontent.com/index-null/cmus-lyric/master/install.sh | bash

Go

go install github.com/index-null/cmus-lyric/cmd/lyrics@latest

Manual download

Download the binary for your platform from the Releases page, extract and move to your PATH:

tar xzf cmus-lyric_*_darwin_arm64.tar.gz
sudo install -m 755 lyrics /usr/local/bin/lyrics

From source

git clone https://github.com/index-null/cmus-lyric.git
cd cmus-lyric
task install   # or: go build -o lyrics ./cmd/lyrics && sudo mv lyrics /usr/local/bin/

Prerequisites

• cmus music player (must be running)

Usage

Start cmus and play a song, then in another terminal:

lyrics

Key	Action
q Ctrl+C	Quit
?	Toggle help

How lyrics are resolved

1. Look for <filename>.lrc or <filename>.lyric next to the audio file
2. If a .tlrc / .tlyric file exists alongside, translation lines are shown below each lyric line
3. If no local file is found, fetch from LRCLIB (preferred) then Netease Music, and save as .lrc

Project Structure

cmus-lyric/
├── cmd/lyrics/           # Application entry point
├── internal/
│   ├── player/           # Bubble Tea model, cmus IPC, lyric rendering
│   └── lyric/            # Lyric fetching (LRCLIB, Netease)
├── .github/workflows/    # CI/CD (auto-release on tag)
├── Taskfile.yml          # Build tasks
├── .golangci.yml         # Linter config
├── .goreleaser.yaml      # Release config
├── install.sh            # One-line install script
└── go.mod

Development

task build          # Build binary to bin/
task run            # Build and run
task lint           # Run golangci-lint
task test           # Run tests
task check          # Full quality check (tidy + lint + test)

[!NOTE] Linting requires golangci-lint. Install with brew install golangci-lint or see the docs.

Release

Releases are fully automated via GitHub Actions. To create a new release:

git tag v0.1.0
git push origin v0.1.0

This triggers the workflow which:

1. Builds binaries for linux/darwin x amd64/arm64
2. Creates a GitHub Release with checksums
3. Updates the Homebrew tap formula

[!TIP] To preview a release locally: goreleaser release --snapshot --clean