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.3.1"

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 an overview of tui-term's architecture and design principles, please refer to the Architecture documentation.

Contributing

We welcome contributions from the community! Check out the Contributing Guidelines on how to get started.

Release Notes

Stay updated with the latest changes by viewing the Changelog.

License

tui-term is available under the MIT license. See LICENCE for more information.