Metadata-Version: 2.3
Name: vban-tui
Version: 0.1.0
Summary: A Textual-based TUI for VBAN Text
Author: onyx-and-iris
Author-email: onyx-and-iris <code@onyxandiris.online>
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Dist: pydantic-settings>=2.13.1
Requires-Dist: textual>=8.1.1
Requires-Dist: vban-cmd>=2.10.3
Requires-Python: >=3.10
Description-Content-Type: text/markdown

# vban-tui

[![uv](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/uv/main/assets/badge/v0.json)](https://github.com/astral-sh/uv)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)

---

![screenshot](./img/tui.png)

## 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
```

--- 

## 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.

### Command History

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

---

## License

`vban-tui` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.
