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

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: vaux_cli-0.1.9.tar.gz
  • Upload date:
  • Size: 14.6 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.9.tar.gz
Algorithm Hash digest
SHA256 bad28f24b2f7fbc9bdf4c07089ff545e6100af5485fe4ea2bc30a705120c124f
MD5 a05736edb68b7334641a6bb62ab403f6
BLAKE2b-256 908a5e104e0734d4441de630e2b193b4087447a1596b9037689eff12e0a4c87f

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vaux_cli-0.1.9-py3-none-any.whl
  • Upload date:
  • Size: 14.7 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.9-py3-none-any.whl
Algorithm Hash digest
SHA256 2e3e193ffb245931f246ea46721b4f140eb678f7a16b03931eaabab0ac8d144b
MD5 514a38a5647a6a7538d7ef869db6b888
BLAKE2b-256 8cc9b4e753ba399803ee400f8eb22336377630d87f155cc66278f1c27a741c83

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