Skip to main content

A command-line TUI music player for Plex

Project description

Plexbar

Plexbar is a keyboard-driven terminal music player for Plex. It gives you a simple Textual TUI for browsing and playing your Plex music library without opening a web browser.

PlexBar screenshot

Features

  • First-run Plex connection setup
  • Browse by Artists, Albums, Tracks, and Playlists
  • Search your Plex music library
  • Queue tracks, albums, artists, and playlists
  • Show cover art for the currently playing track or album
  • Play, pause/resume, stop, and skip with keyboard shortcuts
  • Local playback through mpv

Requirements

  • Python 3.12+
  • uv
  • mpv installed and available on PATH
  • A Plex server with at least one music library
  • A Plex account that can access your Plex server

Installation

Install Plexbar as a standalone command with uv:

uv tool install plexbar

Run Plexbar:

plexbar

Installation for development

Clone the repository and sync dependencies with uv:

git clone git@github.com:feoh/plexbar.git
cd plexbar
uv sync

Run Plexbar from the project checkout:

uv run plexbar

First-run setup

If ~/.config/plexbar/config.toml does not exist, Plexbar opens a setup screen and prompts for:

  1. Plex base URL, for example http://puppy:32400 or http://127.0.0.1:32400
  2. Plex sign-in authorization in your browser
  3. Default music library

The config file is written to:

~/.config/plexbar/config.toml

Plexbar writes this file with user-only permissions where supported. During setup, Plexbar receives a Plex token from Plex after browser authorization and saves only that token. It does not ask for or store your Plex password. Do not commit or share your Plex token.

Usage

The top-level browser contains:

  • Artists
  • Albums
  • Tracks
  • Playlists

Press Enter to drill down into artists, albums, and playlists. Press Enter on a track to enqueue it.

Keybindings

Key Action
/ Search Plex music
Enter Select/drill down, or enqueue focused track
p Play focused track/album/artist/playlist immediately and replace queue
a Append focused track/album/artist/playlist to queue
Space Pause/resume
n Next track
s Stop playback
q Quit

Local validation

uv run ruff check .
uv run ruff format --check .
uv run pytest
uv run mypy src/plexbar tests

Current limitations

Plexbar currently launches mpv as a subprocess for each track. Future versions may switch to mpv IPC for richer playback state and automatic end-of-track advancement.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

plexbar-0.1.5.tar.gz (10.1 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

plexbar-0.1.5-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file plexbar-0.1.5.tar.gz.

File metadata

  • Download URL: plexbar-0.1.5.tar.gz
  • Upload date:
  • Size: 10.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for plexbar-0.1.5.tar.gz
Algorithm Hash digest
SHA256 86f3b96106b501b497271e28f53e050b9650259700ad54e31c7445a2328cca5b
MD5 c6461d7f732f7ec23bb440b238d3769a
BLAKE2b-256 e78dd81bd7679bf24d2b91525f6cf69d6c37cdf833ca8a337a34da3ee1306db1

See more details on using hashes here.

Provenance

The following attestation bundles were made for plexbar-0.1.5.tar.gz:

Publisher: publish.yml on feoh/plexbar

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file plexbar-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: plexbar-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for plexbar-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 21c012a90f6f4a159311e62e2944137b3e9100482758af547e74781789dd54ee
MD5 9b8a07c9af91e521701cbf682e378a25
BLAKE2b-256 36bdc420f51dfe77a2538c4ee5ca1a88a91c9f108e6fe126856e679bd750b71a

See more details on using hashes here.

Provenance

The following attestation bundles were made for plexbar-0.1.5-py3-none-any.whl:

Publisher: publish.yml on feoh/plexbar

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page