mirror of
https://github.com/onyx-and-iris/vban-tui.git
synced 2026-04-13 04:23:37 +00:00
initial commit
This commit is contained in:
44
README.md
Normal file
44
README.md
Normal file
@@ -0,0 +1,44 @@
|
||||
# vban-tui
|
||||
|
||||
[](https://github.com/astral-sh/uv)
|
||||
[](https://github.com/astral-sh/ruff)
|
||||
|
||||
---
|
||||
|
||||
## Install
|
||||
|
||||
#### With uv
|
||||
|
||||
```console
|
||||
uv tool install vban-tui
|
||||
```
|
||||
|
||||
#### With pipx
|
||||
|
||||
```console
|
||||
pipx install vban-tui
|
||||
```
|
||||
|
||||
The TUI should now be discoverable as `vban-tui`
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
### Flags
|
||||
|
||||
```console
|
||||
vban-tui --host=localhost --port=6980 --streamname=Command1
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
||||
example .envrc:
|
||||
|
||||
```env
|
||||
#!/usr/bin/env bash
|
||||
|
||||
export VBAN_TUI_HOST="localhost"
|
||||
export VBAN_TUI_PORT=6980
|
||||
export VBAN_TUI_STREAMNAME=Command1
|
||||
```
|
||||
Reference in New Issue
Block a user