onyx_online/vban-cli
1
0
Fork 0
mirror of https://github.com/onyx-and-iris/vban-cli.git synced 2026-03-02 21:19:11 +00:00
Code Issues Packages Projects Releases Wiki Activity

upd use section in README

Browse Source
This commit is contained in:
onyx-and-iris 2026-02-28 15:39:39 +00:00
parent c7365bfe4e
commit b62ee185c3
1 changed files with 28 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -5,6 +5,8 @@
---
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
@ -47,24 +49,35 @@ export VBAN_CLI_STREAMNAME=Command1
## Use
```console
Usage: vban-cli COMMAND
### Strip Command
╭─ Commands ───────────────────────────────────────────────────────────────────────────────────────╮
│ bus Control the bus parameters. │
│ strip Control the strip parameters. │
│ --help (-h) Display this message and exit. │
│ --version Display application version. │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Parameters ─────────────────────────────────────────────────────────────────────────────────────╮
│ --kind Kind of Voicemeeter [env var: VBAN_CLI_KIND] [default: potato] │
│ --host VBAN host [env var: VBAN_CLI_HOST] [default: localhost] │
│ --port VBAN port [env var: VBAN_CLI_PORT] [default: 6980] │
│ --streamname VBAN stream name [env var: VBAN_CLI_STREAMNAME] [default: Command1] │
╰──────────────────────────────────────────────────────────────────────────────────────────────────╯
Usage: vban-cli strip <index> COMMAND [ARGS]
examples:
```console
vban-cli strip 0 mute true
vban-cli strip 1 A1 true
vban-cli strip 2 gain -18.7
```
For every command and subcommand there exists a `--help` flag for further usage information.
see `vban-cli strip --help` for more info.
### Bus Command
Usage: vban-cli bus <index> COMMAND [ARGS]
examples:
```console
vban-cli bus mode normal
vban-cli bus mute true
```
see `vban-cli bus --help` for more info.
---