Skip to main content

A Textual-based TUI for VBAN Text

Project description

vban-tui

uv Ruff


screenshot

Install

With uv

uv tool install vban-tui

With pipx

pipx install vban-tui

The TUI should now be discoverable as vban-tui


Configuration

Flags

vban-tui --host=localhost --port=6980 --streamname=Command1

Additional Flags:

  • --rich_log/--no-rich_log: Use this to disable the RichLog window.
    • This is useful if you're sending commands to Voicemeeter because you won't receive any responses anyway.

Environment Variables

example .envrc:

#!/usr/bin/env bash

export VBAN_TUI_HOST="localhost"
export VBAN_TUI_PORT=6980
export VBAN_TUI_STREAMNAME=Command1

Use

The TUI should load with the request input focused. Simply type in your request and press ENTER.

If you enter the request clear the output log will be cleared.

Press Ctrl+q to exit from the TUI.

Command History

Press up/down while focused on the request input to scroll through the command history.


Notes

This TUI supports the following:

  • Sending requests for Voicemeeter
  • Sending requests and receiving responses for Matrix

If you need to send requests and receive responses for Voicemeeter check out vban-cli


License

vban-tui is distributed under the terms of the MIT license.

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

vban_tui-0.2.0.tar.gz (4.4 kB view details)

Uploaded Source

Built Distribution

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

vban_tui-0.2.0-py3-none-any.whl (6.6 kB view details)

Uploaded Python 3

File details

Details for the file vban_tui-0.2.0.tar.gz.

File metadata

  • Download URL: vban_tui-0.2.0.tar.gz
  • Upload date:
  • Size: 4.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for vban_tui-0.2.0.tar.gz
Algorithm Hash digest
SHA256 866ea3d13d24849493f6dc60f2b713b66d800768fabfeb80f3f90609c1a10f73
MD5 a193775fe200c5c0f659e53226fdce77
BLAKE2b-256 56225a3efec1bbf59a26e7c32393a71077b70ab06859009af9157343731edef7

See more details on using hashes here.

File details

Details for the file vban_tui-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: vban_tui-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 6.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.12 {"installer":{"name":"uv","version":"0.10.12","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

File hashes

Hashes for vban_tui-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d708a993633a7fdf5f2e1d2ceca9115124ad10c99aa0db269acb0a7bd286e1bd
MD5 1ee5f45d32142ad20155ff840c94165f
BLAKE2b-256 cdb3e11fb8a1f56ed90baba8597015bbfdcded4a0df3a220d1b1a0b77d554735

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