rust terminal interfaces tui
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
davidhelbig fafad6c961
chore: fix typo in (#619)
4 months ago
.github chore(ci): bump cargo-make to v0.35.16 4 months ago
assets chore: remove scripts 4 years ago
examples chore: add panic hook example (#593) 7 months ago
src chore: fix typo in (#619) 4 months ago
tests feat(widgets/chart): add option to control alignment of axis labels (#568) 12 months ago
.gitignore gitignore 4 years ago Release v0.19.0 4 months ago chore: improve contributing guidelines 2 years ago
Cargo.toml Release v0.19.0 4 months ago
LICENSE Add README, LICENSE and update demo 6 years ago
Makefile.toml chore: enable clippy on all targets 12 months ago chore: add apps using `tui` 4 months ago


Build Status Crate Status Docs Status

Demo cast under Linux Termite with Inconsolata font 12pt

tui-rs is a Rust library to build rich terminal user interfaces and dashboards. It is heavily inspired by the Javascript library blessed-contrib and the Go library termui.

The library supports multiple backends:

The library is based on the principle of immediate rendering with intermediate buffers. This means that at each new frame you should build all widgets that are supposed to be part of the UI. While providing a great flexibility for rich and interactive UI, this may introduce overhead for highly dynamic content. So, the implementation try to minimize the number of ansi escapes sequences generated to draw the updated UI. In practice, given the speed of Rust the overhead rather comes from the terminal emulator than the library itself.

Moreover, the library does not provide any input handling nor any event system and you may rely on the previously cited libraries to achieve such features.

I'm actively looking for help maintaining this crate. See this issue

Rust version requirements

Since version 0.17.0, tui requires rustc version 1.56.1 or greater.



The demo shown in the gif can be run with all available backends.

# crossterm
cargo run --example demo --release -- --tick-rate 200
# termion
cargo run --example demo --no-default-features --features=termion --release -- --tick-rate 200

where tick-rate is the UI refresh rate in ms.

The UI code is in examples/demo/ while the application state is in examples/demo/

If the user interface contains glyphs that are not displayed correctly by your terminal, you may want to run the demo without those symbols:

cargo run --example demo --release -- --tick-rate 200 --enhanced-graphics false


The library comes with the following list of widgets:

Click on each item to see the source of the example. Run the examples with with cargo (e.g. to run the gauge example cargo run --example gauge), and quit by pressing q.

You can run all examples by running cargo make run-examples (require cargo-make that can be installed with cargo install cargo-make).

Third-party widgets

Apps using tui


You might want to checkout Cursive for an alternative solution to build text user interfaces in Rust.