BoxMux

A YAML-driven terminal UI framework for creating rich, interactive CLI applications and dashboards.

Get Started View on GitHub

Documentation

Set up your development environment and learn the fundamental concepts.

Setup and installation

Installation and basic configuration.

Get started

API reference

Socket API documentation and function reference.

API docs

Configuration reference

YAML configuration options and examples.

Browse configs

Quick Installation

1

Install BoxMux

cargo install boxmux

2

Create your first interface

# Create hello.yaml
boxmux hello.yaml

3

Start building

# Try example configs
boxmux examples/dashboard.yaml

Key Features

Core functionality for building terminal interfaces.

YAML Configuration

Define interface structure using YAML configuration files.

Real-time Updates

Configurable refresh intervals and live data streaming.

Interactive Elements

Keyboard navigation, menu selection, and custom keybindings.

Socket API

External control and data injection via Unix sockets.

Variable System

Hierarchical variable substitution with environment integration.

Cross-platform

Works on macOS, Linux, and other Unix-like systems.