vban-cli/README.md

vban-cli

---

This CLI is still in an early stage of development with many more things that could be implemented. However, the commands that are implemented should be working without issues.

Install

With uv

uv tool install vban-cli

With pipx

pipx install vban-cli

The CLI should now be discoverable as vban-cli

---

Configuration

Flags

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

Environment Variables

example .envrc:

#!/usr/bin/env bash

export VBAN_CLI_HOST="localhost"
export VBAN_CLI_PORT=6980
export VBAN_CLI_STREAMNAME=Command1

---

Use

Strip Command

Usage: vban-cli strip <index> COMMAND [ARGS]

examples:

vban-cli strip 0 mute true

vban-cli strip 1 A1 true

vban-cli strip 2 gain -18.7

see vban-cli strip --help for more info.

Strip EQ

Usage: vban-cli strip <index> eq COMMAND [OPTIONS]

examples:

vban-cli strip 0 eq on true

see vban-cli strip eq --help for more info.

Strip EQ Cell Command

Usage: vban-cli strip <index> eq cell <band> COMMAND [ARGS]

examples:

vban-cli strip 0 eq cell 0 on false

vban-cli strip 3 eq cell 2 freq 1500

vban-cli strip 4 eq cell 5 type 5

see vban-cli strip eq cell --help for more info.

Strip Gainlayer Command

Usage: vban-cli strip <index> gainlayer <gainlayer_index> COMMAND [OPTIONS] [ARGS]

examples:

vban-cli strip 0 gainlayer 0 level

vban-cli strip 3 gainlayer 2 level -13.5

see vban-cli strip gainlayer --help for more info.

Bus Command

Usage: vban-cli bus <index> COMMAND [ARGS]

examples:

vban-cli bus 0 mode tvmix

vban-cli bus 1 mute true

see vban-cli bus --help for more info.

Command Command

Usage: vban-cli command COMMAND

examples:

vban-cli command show

vban-cli command restart

see vban-cli command --help for more info.

Recorder Command

Usage: vban-cli recorder COMMAND

examples:

vban-cli recorder play

vban-cli recorder rew

vban-cli recorder replay

see vban-cli recorder --help for more info.

Sendtext Command

Usage: vban-cli sendtext TEXT

examples:

To Voicemeeter

vban-cli sendtext 'Strip[0].Mute=1;Bus[0].Mono=2'

To Matrix

vban-cli sendtext 'Command.Version = ?'

vban-cli sendtext 'Point(ASIO128.IN[1..4],ASIO128.OUT[1]).dBGain = -3.0'

see vban-cli sendtext --help for more info.

---

Implementation Notes

1. The VBAN TEXT subprotocol defines two packet structures ident:0 and ident:1. Neither of them contain the data for Bus EQ parameters.
2. Packet structure with ident:1 is emitted by the VBAN server only on pdirty events. This means we do not receive the current state of those parameters on initial subscription. Therefore any commands which are intended to fetch the value of parameters defined in packet ident:1 will not work in this CLI.
3. Packet structure with ident:1 defines parameteric EQ data only for the first channel.

---

Further Notes

I've made the effort to set up the basic skeletal structure of the CLI as well as demonstrate how to combine subcommand groups with subcommand groups so more can be implemented, it just needs doing. There may be restrictions on some things however, for example, retrieving values is only possible for parameters defined in the protocol. Setting parameters can be done for anything possible by a string request.

Shell completion scripts are available (for zsh, bash and fish) but they haven't been thoroughly tested.

If there's something missing that you would like to see added the best bet is to submit a PR. You may raise an issue and if it's quick and simple to do I may (or may not) do it.

---

License

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