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-0.1.6.tar.gz (11.0 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.6-py3-none-any.whl (13.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: plexbar-0.1.6.tar.gz
  • Upload date:
  • Size: 11.0 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.6.tar.gz
Algorithm Hash digest
SHA256 b142f38d0778e29b61cf77805195e0e19d8bef7a6fffa8c14527f7d92c501517
MD5 8568e96d939a467182ef8700f56a2b74
BLAKE2b-256 092d6756095797f4c80be62ee229541ed3a5e34c6a54866e6127755f834c9f4a

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: plexbar-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 13.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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 2cc879cb418aff79c366c65b74562f4843c98299b6a1d84eba2d60bc8552cd73
MD5 814837997301ec0242acb1a56870361d
BLAKE2b-256 aaef8845e8fea6845278b83fb49c202b7961bc22f5ec15b2841eee2394f1078e

See more details on using hashes here.

Provenance

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