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, Playlists, and Genres
  • Search your Plex music library
  • Queue tracks, albums, artists, playlists, and genres
  • 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
  • Genres

Press Enter to drill down into artists, albums, playlists, and genres. Genre browsing offers "By Artist" and "By Album" groupings before listing tracks. 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/genre artist/genre album immediately and replace queue
a Append focused track/album/artist/playlist/genre artist/genre album 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.2.0.tar.gz (12.8 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.2.0-py3-none-any.whl (15.5 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for plexbar-1.2.0.tar.gz
Algorithm Hash digest
SHA256 20f14623ce2d3ab5f823fa1817b29aa93fb51ecc217d72948115846007e9d7f6
MD5 1577d9e91d9a23dd97944e637211686a
BLAKE2b-256 69b2335cd43b8d44ebcb9004853404d310adfe95a2f7f68b410a06f49f054a3f

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: plexbar-1.2.0-py3-none-any.whl
  • Upload date:
  • Size: 15.5 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.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e92c8160fe51b56215c52d1802f246bfdb65e5640113d2fc9843fb051d608a8
MD5 ef58e7e392510c6bac6404561884c9e5
BLAKE2b-256 d4f909032bb71e241a4bad29d5b4179e2a7dc451d621dd9717782d8c413d14fc

See more details on using hashes here.

Provenance

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