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.

Features

  • First-run Plex connection setup
  • Browse by Artists, Albums, Tracks, and Playlists
  • Search your Plex music library
  • Queue tracks, albums, artists, and playlists
  • 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 token

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 token
  3. Default music library

The config file is written to:

~/.config/plexbar/config.toml

Plexbar writes this file with user-only permissions where supported. Do not commit or share your Plex token.

Finding your Plex token

One common method:

  1. Open Plex Web and sign in.
  2. Open browser developer tools.
  3. Go to the Network tab.
  4. Refresh Plex Web or browse to a media item.
  5. Search requests for X-Plex-Token.
  6. Copy the token value only.

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.2.tar.gz (9.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.2-py3-none-any.whl (11.6 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: plexbar-0.1.2.tar.gz
  • Upload date:
  • Size: 9.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.2.tar.gz
Algorithm Hash digest
SHA256 dd2e4d5b1a2885d2923e1d2b4e857f32f3c38cf6d1cd605623e889618a5da611
MD5 3734a1c40be2fa1117cd019959e9933a
BLAKE2b-256 9d6195fcb07ba2a8b7317df65252881fc88605a7a7ff572068bd1d19cdbb4813

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: plexbar-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 11.6 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 2625439b2ef7799d5f0495df06588ad2057e0e00b453e214b19a9abba2724ca3
MD5 7916611501148ff38b1e72c0691ebd98
BLAKE2b-256 ab8b8a78c2b5aa44a34f134354c9229789f0c2afd4dd707e9a82568843b4662a

See more details on using hashes here.

Provenance

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