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.6.tar.gz (14.0 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.6-py3-none-any.whl (14.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: vaux_cli-0.1.6.tar.gz
  • Upload date:
  • Size: 14.0 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.6.tar.gz
Algorithm Hash digest
SHA256 b9052dfd35970a0901e9463f27e8699fb5a001d18a88aa64d8c345ce0398152f
MD5 8a9967773ae6237c3a230e616a08307a
BLAKE2b-256 67aa3dc0cd7443163ab33871de57a42ff91d7875d766640d3d645fd6bc791a93

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vaux_cli-0.1.6-py3-none-any.whl
  • Upload date:
  • Size: 14.1 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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 bd11c83ce4eb2c283761807498fade9270bf28b698ffe7e02fab3dfe5d47cfc8
MD5 66583641c213099e7d81d6016ceffc83
BLAKE2b-256 ae01f107b2e35113c72b1aae2f05420f2f4676f57720df366895d02af506f41f

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