mp-cli

Crates.iomp-cli
lib.rsmp-cli
version0.2.1
sourcesrc
created_at2023-09-16 20:32:41.217444
updated_at2024-01-14 14:28:58.203312
descriptionA Music Player Daemon (MPD) CLI client implemented in Rust.
homepagehttps://github.com/johnallen3d/mp-cli
repositoryhttps://github.com/johnallen3d/mp-cli.git
max_upload_size
id974616
size33,481
John Allen (johnallen3d)

documentation

README

mp-cli

ci Coverage Status Crate Status

A Music Player Daemon (MPD) CLI client implemented in Rust.

Features

I'm working towards compatibility with mpc over time. See this tracking issue for the current status.

Alternatively, see the help.

Installation

At this time it is necessary to compile and install the crate locally. The simplest way to do this is to install the Rust toolchain.

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Then use cargo to build and install from crates.io.

cargo install mp-cli

Why?

Mostly because I wanted to practice writing Rust. Also, for use with the wonderful macOS bar app SketchyBar. One of the plugins I've created displays the current status (playing/paused) of MPD along with the artist and title. I've used mpc for this purpose in the past but the status output is not well suited for parsing (more for human readability).

With this in mind I decided to implement a client that would provide a more consistent and parseable output.

❯ mp-cli status
volume=100
state=play
artist=King Gizzard & The Lizard Wizard
title=Wah Wah

This format is easily and efficiently parseable in a shell script:

#! /usr/bin/env bash

status=$(mp-cli)

while IFS='=' read -r key value; do
	case "$key" in
	'artist') artist="$value" ;;
	'state') state="$value" ;;
	'title') title="$value" ;;
	'volume') volume="$value" ;;
	esac
done <<<"$status"

echo "${artist}"
echo "${state}"
echo "${title}"
echo "${volume}"

Alternatively the status can be presented as JSON.

❯ mp-cli --format json status | jq
{
  "volume": "100",
  "state": "play",
  "artist": "King Gizzard & The Lizard Wizard",
  "title": "Road Train"
}

Credit

All of the heavy lifting of communicating with the daemon is handled by rust-mpd.

Obviously mpc the real CLI tool for interacting with mpd. For the commands that I have (currently) implemented I've done my best to mirror the interface of mpc. In theory this could be a drop in replacement, for the very limited use-case.

Commit count: 74

cargo fmt