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

Playback

Plexbar keeps a persistent mpv process running and controls it through mpv's JSON IPC interface for responsive pause/resume, stop, and track changes.

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-1.0.0.tar.gz (11.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-1.0.0-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for plexbar-1.0.0.tar.gz
Algorithm Hash digest
SHA256 3b8df08b1db305fa81231d7cb45b540c7e9d14e654bcb7c467caea1ae2471bb4
MD5 8ed7e03404630be06239bae089831c29
BLAKE2b-256 0f3fc209d08547a12465d4bbd3dad24ad68c0db78a7af583a57e204d0406f6de

See more details on using hashes here.

Provenance

The following attestation bundles were made for plexbar-1.0.0.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-1.0.0-py3-none-any.whl.

File metadata

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

File hashes

Hashes for plexbar-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d462e372d39c27f0369c5851ce3c9b6e65be8e6c63e323e6f56cde0747c32a66
MD5 2786ebe83d0b55a0ee9dd933f80f38ad
BLAKE2b-256 86ecfde55f4ccc7b64e9f5a0793ec353568f5a74afc60cf8d3cdbfc5e1181e80

See more details on using hashes here.

Provenance

The following attestation bundles were made for plexbar-1.0.0-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