tui-term

A pseudoterminal widget for the ratatui crate.

Status

[!NOTE] This project is currently in active development and should be considered a work in progress. The goal of tui-term is to provide a robust and well-tested pseudoterminal widget for users of the ratatui crate.

Installation

To use tui-term, simply add it as a dependency in your Cargo.toml file:

[dependencies]
tui-term = "0.1.6"

or use cargo add:

cargo add tui-term

Examples

Check out the examples directory, for more information, or run an example:

cargo run --example simple_ls_rw

Controller

The controller is an experimental feature helping with managing the lifecycle of commands that are spawned inside a pseudoterminal. Currently the support is limited to oneshot commands.

To activate the feature:

cargo add tui-term -F unstable

Chat Room

Join our matrix chat room, for possibly synchronous communication.

Architecture

For a top-level understanding of the architecture of tui-term and the design choices made, please refer to the Architecture document.

Contributing

We welcome contributions from the community! If you're interested in contributing to tui-term, please refer to the contribution guidelines for instructions on how to get started.

How to contribute.

Changes

Changelog

License

MIT