LinuxCommandLibrary

termusic

Play music from the terminal

TLDR

Open termusic to a specific directory. (It can be set permanently in ~/.config/termusic/config.toml)

$ termusic [path/to/directory]
copy

Disable showing the album cover for a specific file
$ termusic -c [path/to/music_file]
copy

Display help
$ termusic --help
copy

SYNOPSIS

termusic [options]
termusic scan
termusic config

PARAMETERS

-h, --help
    Prints help information and exits.

-V, --version
    Prints version information and exits.

-c, --config FILE
    Specifies an alternative configuration file path instead of the default.

-d, --debug
    Enables debug logging, which can be useful for troubleshooting issues.

scan
    Executes a one-time scan of your configured music directories, updating the library database with new or removed audio files.

config
    Opens the default configuration file in your preferred text editor (if configured) or prints its path to the console.

DESCRIPTION

termusic is a modern, terminal-based music player and manager written in Rust. It provides a full-featured interface for managing and playing your local music collection directly from the command line. Designed for efficiency and a rich user experience, it supports a variety of audio formats, playlist management, powerful search capabilities, and customizable keybindings. It's an excellent choice for users who prefer to stay within the terminal environment while enjoying their music. It offers features like gapless playback, album art display (in supported terminals), and flexible configuration via a TOML file.

CAVEATS

Terminal compatibility varies; not all terminals fully support true colors or image rendering for album art. termusic relies on an external audio backend (commonly mpv) for playback, which must be installed and accessible in your system's PATH. Initial setup requires configuring music directories in its TOML configuration file.

CONFIGURATION FILE

termusic is highly configurable via a TOML file, typically located at ~/.config/termusic/config.toml. This file allows users to set music directories, customize keybindings, adjust appearance options, and fine-tune playback settings to their preference.

AUDIO BACKEND

For audio playback, termusic acts as a frontend to an external player. The most commonly used and recommended backend is mpv. Users must ensure that mpv or another supported audio player is installed and correctly configured in their system's PATH for playback functionality.

HISTORY

termusic is a relatively modern music player, developed in Rust. Its development began around late 2020, gaining traction as a robust and user-friendly alternative to older terminal-based music players. It leverages Rust's performance and memory safety, focusing on a highly customizable user experience and a rich feature set within the terminal environment.

SEE ALSO

cmus(1), ncmpcpp(1), mpd(1), mpc(1), vlc(1)

Copied to clipboard