# vfa-tui
Enterprise-grade terminal UI for the **Vanguard Frontier Agentic** marketplace catalog.
[](https://crates.io/crates/vfa-tui)
[](#license)
> **Status: v0.1.0** — Functional, secure, and tested. APIs and UI may change before 1.0.
## Installation
```bash
cargo install vfa-tui
```
Requires Rust 1.75 or later.
## Important Limitations
**`vfa-tui` is designed for use inside the [`vanguard-frontier-agentic`](https://github.com/Raishin/vanguard-frontier-agentic) monorepo.** The binary auto-detects the workspace root by walking up from the current directory and looking for the `catalog/` directory and `package.json`. Running it outside a checked-out copy of the repository will produce an error at startup.
**Library API stability:** The `vfa_tui` library crate is an internal implementation detail. All modules are marked `pub` only to allow integration and property tests in sibling crates to import them directly. The library API is **not covered by semver guarantees** — it may change between any releases.
## Pre-built Binaries
Tagged releases publish pre-compiled binaries for all supported platforms via GitHub Releases. Download from [Releases](https://github.com/Raishin/vanguard-frontier-agentic/releases) and place the binary on your `$PATH`.
Available targets per release:
| `vfa-tui-x86_64-linux-gnu.tar.gz` | `x86_64-unknown-linux-gnu` |
| `vfa-tui-aarch64-linux-gnu.tar.gz` | `aarch64-unknown-linux-gnu` |
| `vfa-tui-x86_64-linux-musl.tar.gz` | `x86_64-unknown-linux-musl` (static) |
| `vfa-tui-x86_64-macos.tar.gz` | `x86_64-apple-darwin` |
| `vfa-tui-aarch64-macos.tar.gz` | `aarch64-apple-darwin` |
Each release also includes a `checksums.sha256` file and an SPDX 2.3 SBOM (`vfa-tui.spdx.json`).
## Overview
`vfa-tui` provides a fast, keyboard-driven terminal interface for browsing the VFA catalog of 300+ security agents across 30+ providers. It supports fuzzy search, provider/harness filtering, role-based views, validation gate execution with real-time streaming output, export command building with dry-run preview, and structured audit logging.
Key capabilities:
- Browse agents, skills, roles, providers, MCP references, and rules interactively
- Fuzzy search across all catalog entities (powered by nucleo-matcher)
- Run any of the 17+ validation gates with streaming output
- Build and preview export commands before execution
- View asset integrity manifests with SHA-256 hashes
- Full audit trail via structured tracing logs
The TUI is a read-first interface — it parses catalog JSON files directly for browsing and wraps existing Node.js/Python validation and export scripts via subprocess execution. Write operations (exports) require explicit operator confirmation with dry-run as the default.
## Usage
Run from anywhere inside the checked-out repository (workspace is auto-detected):
```bash
vfa-tui
```
Or specify the workspace explicitly:
```bash
vfa-tui --workspace /path/to/vanguard-frontier-agentic
```
### CLI Flags
| `--workspace <PATH>` | Path to the workspace root | Auto-detected from CWD |
| `--report <TYPE>` | Headless report (no TUI): `summary`, `coverage`, `all` | — |
| `--validate-config` | Validate config files and exit (0=ok, 2=invalid) | — |
| `--export-audit <FMT> <PATH>` | Export audit log to file | — |
| `--log-file <PATH>` | Path to the structured audit log file | None (stderr only) |
| `--log-level <LEVEL>` | Verbosity: `trace`, `debug`, `info`, `warn`, `error` | `info` |
| `--no-color` | Disable ANSI color codes in all output | `false` |
| `--theme <MODE>` | Color theme: `auto`, `dark`, `light` | `auto` |
| `--quiet` | Suppress informational messages | `false` |
| `--help` | Show help message and exit | — |
| `--version` | Show version and exit | — |
### Keyboard Navigation
| `↑`/`↓` or `j`/`k` | Move up/down in lists |
| `g`/`G` | Jump to top/bottom of list |
| `Enter` | Select item / confirm action |
| `Escape` | Go back / cancel |
| `Tab` | Switch between panels |
| `/` | Activate search |
| `p` | Cycle provider filter (agent list) |
| `h` | Cycle harness filter (agent list) |
| `?` | Toggle keyboard shortcut overlay |
| `q` or `Ctrl+C` | Quit |
### Examples
```bash
# Basic launch — auto-detects workspace
vfa-tui
# Headless report (no TUI, exits immediately)
vfa-tui --report summary
# Run with debug logging to a file
vfa-tui --log-level debug --log-file /tmp/vfa-tui.log
# Run without color (useful for piping or screen readers)
vfa-tui --no-color
# Validate configuration files and exit
vfa-tui --validate-config
# Export audit log to JSON
vfa-tui --export-audit json /tmp/audit.json
```
## Supported Platforms
| `x86_64-unknown-linux-gnu` | Linux x86_64 | Primary development target |
| `aarch64-unknown-linux-gnu` | Linux aarch64 | ARM64 Linux (Graviton, RPi) |
| `x86_64-apple-darwin` | macOS x86_64 | Intel Macs |
| `aarch64-apple-darwin` | macOS aarch64 | Apple Silicon (M1/M2/M3) |
| `x86_64-unknown-linux-musl` | Linux musl | Static binary for WSL and containers |
### WSL Notes
Build with `--target x86_64-unknown-linux-musl` for a fully static binary. Windows Terminal provides the best experience (true color, proper resize events). Use `--no-color` for terminals with limited color support.
## Architecture
```
┌─────────────────────────────────────────────────────┐
│ Presentation Layer │
│ Terminal Manager (crossterm) ← UI Renderer (ratatui)│
│ Navigation State Machine ← Keybinding Dispatcher │
├─────────────────────────────────────────────────────┤
│ Application Layer │
│ Browse Controller │ Validation Controller │
│ Export Controller │ Search Engine (nucleo-matcher) │
├─────────────────────────────────────────────────────┤
│ Domain Layer │
│ Catalog Store (in-memory, read-only) │
│ Data Models (serde structs, deny_unknown_fields) │
│ Security Module (sanitize + validate + redact) │
├─────────────────────────────────────────────────────┤
│ Infrastructure Layer │
│ Subprocess Manager (tokio::process) │
│ Workspace Detector │ Audit Logger (tracing) │
│ Terminal Manager (setup/restore/panic hook) │
└─────────────────────────────────────────────────────┘
```
### Design Principles
1. **No business logic duplication** — wraps existing scripts via subprocess; never re-implements validation or export logic.
2. **Read-first, confirm-before-write** — catalog access is read-only. Exports require explicit confirmation with dry-run default.
3. **Security by construction** — no shell interpolation, no network access, no credential exposure, terminal escape sanitization on all rendered content.
4. **Deterministic rendering** — same inputs produce same outputs.
5. **Graceful degradation** — partial catalog loading on file errors; never panics on recoverable errors.
### Technology Stack
| Terminal rendering | `ratatui` 0.30 | Immediate-mode TUI framework |
| Terminal backend | `crossterm` 0.28 | Cross-platform terminal abstraction |
| CLI parsing | `clap` 4.x (derive) | Type-safe argument handling |
| JSON deserialization | `serde` + `serde_json` | Strict schema validation |
| Async runtime | `tokio` (rt-multi-thread) | Subprocess management |
| Structured logging | `tracing` + `tracing-subscriber` | Audit events |
| Error handling | `thiserror` + `anyhow` | Domain + application errors |
| Fuzzy matching | `nucleo-matcher` 0.3 | High-performance search |
| SQLite | `rusqlite` (bundled) | Audit log persistence |
| Property testing | `proptest` (dev) | Correctness verification |
## Development
### Prerequisites
- Rust 1.75+
- A checkout of the `vanguard-frontier-agentic` repository
- Node.js 18+ (for validation gate and export command execution)
### Build
```bash
cd tools/vfa-tui
cargo build --release
```
For a statically-linked binary:
```bash
cargo build --release --target x86_64-unknown-linux-musl
```
### Running Tests
```bash
cd tools/vfa-tui
cargo test
```
Property tests live in `tests/property/` and cover catalog loading, search invariants, security sanitization, workspace detection, and deterministic rendering across randomized inputs:
```bash
PROPTEST_CASES=1000 cargo test
```
### Linting and Formatting
```bash
cargo fmt --check # Check only
cargo fmt # Auto-format
cargo clippy -- -D warnings
```
### Full CI Check (local)
```bash
cd tools/vfa-tui
cargo fmt --check
cargo clippy -- -D warnings
cargo test
cargo build --release
cargo publish --dry-run
```
## Security
The TUI enforces several security invariants:
- **No shell interpolation** — all subprocesses are spawned with arguments as arrays, never concatenated strings
- **No network access** — the binary makes zero network requests under any circumstance
- **No credential exposure** — secret environment variables are stripped before subprocess spawning and redacted from all output
- **Terminal escape sanitization** — all catalog data and subprocess output is sanitized against terminal injection attacks
- **Path validation** — all user-provided paths are canonicalized and checked for directory traversal
See [SECURITY.md](SECURITY.md) for the vulnerability disclosure policy.
## License
Licensed under either of:
- MIT License ([LICENSE-MIT](LICENSE-MIT))
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE))
at your option.