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.10.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.10-py3-none-any.whl (14.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vaux_cli-0.1.10.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.10.tar.gz
Algorithm Hash digest
SHA256 0437b188c25d7d5f0a44c2bee46d9a1baef7da58aa575da49b3c1f967a75c946
MD5 dc88b57891e1864bddd49941ceb88da2
BLAKE2b-256 e5006468756d3bbe3584fee7abc4ccdaaa3d57bdd72d7479ff970e6f60793bad

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vaux_cli-0.1.10-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.10-py3-none-any.whl
Algorithm Hash digest
SHA256 86f82d3d57b1ef4c2a91792cc3eba97ea06f223d51d497fe6ca2bca26a5e97db
MD5 19fa4aa55cbb2820f1f95ff770720658
BLAKE2b-256 c4046953a855112572ea30f0d3065163ffa04465534f678227c2367d5fd3faa8

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