Skip to main content

A terminal client for vaux listening rooms.

Project description

Vaux CLI

A terminal client for vaux listening rooms. Listen to YouTube audio in perfectly synchronized harmony with your friends directly from your terminal.

Built with Textual and powered by mpv.

Features

  • Synchronized Playback: Everyone in the room hears the exact same timestamp.
  • Shared Queue: Search YouTube directly from the terminal and add tracks.
  • Live Voting: Vote tracks up (ctrl+u) or down (ctrl+d) to re-sort the queue.
  • Live Chat: Talk with friends right next to the music.
  • Host Controls: Pause, play, skip, and manage the room.
  • Zero-Quota: No YouTube API keys required. Audio streams are dynamically extracted by the Vaux server.

Installation

pip install vaux-cli

Note: The CLI requires mpv to play audio. If you are on Windows, the app will automatically offer to download a portable version of mpv for you on first run! Linux/macOS users should install mpv via their package manager (e.g., apt install mpv or brew install mpv).

Usage

Launch the interactive lobby:

vaux

Or bypass the lobby to join a room directly:

vaux <room-id> -u <your-name>

Keyboard Shortcuts

Key Action
Ctrl+S Focus Search
Ctrl+T Focus Chat
Ctrl+O Play / Pause (Host only)
Ctrl+N Skip Track (Host only)
Ctrl+U Vote Up selected track
Ctrl+D Vote Down selected track
- / = Volume Down / Up
Ctrl+C Quit

Host

The room host can:

  • Play tracks
  • Pause playback
  • Resume playback
  • Skip tracks
  • Transfer host privileges
  • Control room playback state

Listener

Listeners can:

  • Search tracks
  • Add songs to the queue
  • Vote on songs
  • Participate in chat

Host Transfer

Hosts can transfer control to another user directly from chat:

/host username

Example:

/host john

Project Links

Repository: https://github.com/itsvee0120/vaux Issues: https://github.com/itsvee0120/vaux/issues


Contact:

https://itsvee0120.github.io/violet-website/

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

vaux_cli-0.1.2.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

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

vaux_cli-0.1.2-py3-none-any.whl (13.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vaux_cli-0.1.2.tar.gz
  • Upload date:
  • Size: 13.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for vaux_cli-0.1.2.tar.gz
Algorithm Hash digest
SHA256 f5f8252f1a2a7f0497a73d522da9ad238e7167786b7f3465cfbfb7efb74443b2
MD5 c2e45d23b2809d59e6ce62a7bad3810a
BLAKE2b-256 917c1dd9245da139f9d2775dbe84995791179918c79a1f5a7e0a010b150fb0df

See more details on using hashes here.

File details

Details for the file vaux_cli-0.1.2-py3-none-any.whl.

File metadata

  • Download URL: vaux_cli-0.1.2-py3-none-any.whl
  • Upload date:
  • Size: 13.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.7

File hashes

Hashes for vaux_cli-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 86e2bbd2e677fd12f79829cba4d7ec839262b9fac6e9798a79f4924ca73d984b
MD5 ce1f3f51e3a8771a4b5d1cb4ed1fc642
BLAKE2b-256 099feac8d524bb35daf98b9d54db3c7503acd9ff409c1c5ef6a73dbdab59d229

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