https://github.com/a-kenji/tui-term

A pseudoterminal widget library for ratatui
https://github.com/a-kenji/tui-term

ratatui rust terminal tui widget

Last synced: 15 days ago
JSON representation

A pseudoterminal widget library for ratatui

• Host: GitHub
• URL: https://github.com/a-kenji/tui-term
• Owner: a-kenji
• License: mit
• Created: 2023-05-17T14:24:40.000Z (almost 2 years ago)
• Default Branch: development
• Last Pushed: 2024-10-29T18:45:34.000Z (6 months ago)
• Last Synced: 2024-10-29T19:59:36.799Z (6 months ago)
• Topics: ratatui, rust, terminal, tui, widget
• Language: Rust
• Homepage:
• Size: 490 KB
• Stars: 123
• Watchers: 3
• Forks: 8
• Open Issues: 13
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: docs/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# tui-term

[![Crates](https://img.shields.io/crates/v/tui-term?style=flat-square)](https://crates.io/crates/tui-term)

[![Documentation](https://img.shields.io/badge/tui_term-documentation-fc0060?style=flat-square)](https://docs.rs/tui-term)

[![Matrix Chat Room](https://img.shields.io/badge/chat-on%20matrix-1d7e64?logo=matrix&style=flat-square)](https://matrix.to/#/#tui-term-main:matrix.org)

A pseudoterminal widget for the  [ratatui](https://github.com/tui-rs-revival/ratatui) crate.

![Demo of tui-term](https://vhs.charm.sh/vhs-4zK1zlTOSueAmlOkZlssBr.gif)

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

```sh

[dependencies]

tui-term = "0.2.0"

```

or use `cargo add`:

```sh

cargo add tui-term

```

## Examples

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

```sh

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:

```sh

cargo add tui-term -F unstable

```

## Chat Room

Join our [matrix chat room](https://matrix.to/#/#tui-term-main:matrix.org), for possibly synchronous communication.

## Architecture

For an overview of `tui-term`'s architecture and design principles, please refer to the [Architecture](docs/ARCHITECTURE.md) documentation.

## Contributing

We welcome contributions from the community!

Check out the [Contributing Guidelines](./docs/CONTRIBUTING.md) on how to get started.

## Release Notes

Stay updated with the latest changes by viewing the [Changelog](./CHANGELOG.md).

## License

`tui-term` is available under the MIT license. See [LICENCE](LICENSE) for more information.