Skip to main content

Stealth TUI YouTube audio player - stream music while looking productive

Project description

wrkmon

Terminal-based YouTube Music Player - Listen to music right from your terminal!

A beautiful TUI (Terminal User Interface) for streaming YouTube audio. No browser needed, just your terminal.

License Python Platform PyPI

Features

  • Search and stream YouTube audio
  • Beautiful terminal interface
  • Queue management with shuffle/repeat
  • Play history and playlists
  • Keyboard-driven controls
  • Cross-platform (Windows, macOS, Linux)

Installation

pip (Recommended)

pip install wrkmon

Note: You also need mpv installed:

  • Windows: winget install mpv
  • macOS: brew install mpv
  • Linux: sudo apt install mpv

Quick Install Scripts

Windows (PowerShell):

irm https://raw.githubusercontent.com/Umar-Khan-Yousafzai/Wrkmon-TUI-Youtube/main/install.ps1 | iex

macOS / Linux:

curl -sSL https://raw.githubusercontent.com/Umar-Khan-Yousafzai/Wrkmon-TUI-Youtube/main/install.sh | bash

Package Managers

# Windows (Chocolatey)
choco install wrkmon

# macOS (Homebrew) - coming soon
brew install wrkmon

# Linux (Snap) - coming soon
sudo snap install wrkmon

Usage

wrkmon              # Launch the TUI
wrkmon search "q"   # Quick search
wrkmon play <id>    # Play a video
wrkmon history      # View history

Keyboard Controls

Key Action
F1 Search view
F2 Queue view
F3 History view
F4 Playlists view
F5 Play / Pause
F6 Volume down
F7 Volume up
F8 Next track
F9 Stop
F10 Add to queue
/ Focus search
Enter Play selected
a Add to queue
Ctrl+C Quit

Screenshots

┌─────────────────────────────────────────────────────────┐
│  wrkmon                                    [Search]     │
├─────────────────────────────────────────────────────────┤
│  Search: lofi beats                                     │
├─────────────────────────────────────────────────────────┤
│  #   Title                              Channel Duration│
│  1   Lofi Hip Hop Radio               ChilledCow 3:24:15│
│  2   Jazz Lofi Beats                  Lofi Girl 2:45:00│
│  3   Study Music Playlist             Study     1:30:22│
├─────────────────────────────────────────────────────────┤
│  ▶ Now Playing: Lofi Beats              advancement █████░░░░░ 1:23:45 │
│  F1 Search  F2 Queue  F5 Play/Pause  F9 Stop            │
└─────────────────────────────────────────────────────────┘

Requirements

  • Python 3.10+
  • mpv media player

Development

git clone https://github.com/Umar-Khan-Yousafzai/Wrkmon-TUI-Youtube.git
cd Wrkmon-TUI-Youtube
pip install -e ".[dev]"
pytest

License

MIT License - see LICENSE for details.

Author

Umar Khan Yousafzai


Enjoy your music!

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

wrkmon-1.0.1.tar.gz (46.0 kB view details)

Uploaded Source

Built Distribution

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

wrkmon-1.0.1-py3-none-any.whl (56.9 kB view details)

Uploaded Python 3

File details

Details for the file wrkmon-1.0.1.tar.gz.

File metadata

  • Download URL: wrkmon-1.0.1.tar.gz
  • Upload date:
  • Size: 46.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.0

File hashes

Hashes for wrkmon-1.0.1.tar.gz
Algorithm Hash digest
SHA256 b9967fefaef066d304e6099c2f86d1cb4e1f2a1c6228c0a6189e965e29f735f0
MD5 1b0e75ca1578923d00afd74da8faefe0
BLAKE2b-256 73a0222247c4cfbd9ec1a0d09ce2c4cf2b3dc24f1ad1a1558857b84b2f99cdfb

See more details on using hashes here.

File details

Details for the file wrkmon-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: wrkmon-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 56.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.0

File hashes

Hashes for wrkmon-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 fab39bd5f24a1f84e582fde61bda0a4ee06dc140755c7c22d289484804d9e8da
MD5 9000508a0be4c4fc5a81acb04a252222
BLAKE2b-256 98fb2b6f3dc1f3bdbdbcaf378103c0b68d3c04a4b68440fa11eb4d4f4dc67998

See more details on using hashes here.

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