Repository files navigation

⚠️August 2023: This crate is no longer maintained. Seehttps://github.com/ratatui-org/ratatui for an actively maintained fork.⚠️

tui-rs is aRust library to build rich terminaluser interfaces and dashboards. It is heavily inspired by theJavascriptlibraryblessed-contrib and theGo librarytermui.

The library supports multiple backends:

• crossterm [default]
• termion

The library is based on the principle of immediate rendering with intermediatebuffers. This means that at each new frame you should build all widgets that aresupposed to be part of the UI. While providing a great flexibility for rich andinteractive UI, this may introduce overhead for highly dynamic content. So, theimplementation try to minimize the number of ansi escapes sequences generated todraw the updated UI. In practice, given the speed ofRust the overhead rathercomes from the terminal emulator than the library itself.

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

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

Since version 0.17.0,tui requiresrustc version 1.56.1 or greater.

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

# crosstermcargo run --example demo --release -- --tick-rate 200# termioncargo run --example demo --no-default-features --features=termion --release -- --tick-rate 200

wheretick-rate is the UI refresh rate in ms.

The UI code is inexamples/demo/ui.rs while theapplication state is inexamples/demo/app.rs.

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

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

The library comes with the following list of widgets:

• Block
• Gauge
• Sparkline
• Chart
• BarChart
• List
• Table
• Paragraph
• Canvas (with line, point cloud, map)
• Tabs

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

You can run all examples by runningcargo make run-examples (requirecargo-make that can be installed withcargo install cargo-make).

• tui-logger
• tui-textarea: simple yet powerful multi-line text editor widget supporting several key shortcuts, undo/redo, text search, etc.
• tui-rs-tree-widgets: widget for tree data structures.

• spotify-tui
• bandwhich
• kmon
• gpg-tui
• ytop
• zenith
• bottom
• oha
• gitui
• rust-sadari-cli
• desed
• diskonaut
• tickrs
• rusty-krab-manager
• termchat
• taskwarrior-tui
• gping
• Vector
• KDash
• xplr
• minesweep
• Battleship.rs
• termscp
• joshuto
• adsb_deku/radar
• hoard
• tokio-console: a diagnostics and debugging tool for asynchronous Rust programs.
• hwatch: a alternative watch command that records the result of command execution and can display its history and diffs.
• ytui-music: listen to music from youtube inside your terminal.
• mqttui: subscribe or publish to a MQTT Topic quickly from the terminal.
• meteo-tui: french weather via the command line.
• picterm: preview images in your terminal.
• gobang: a cross-platform TUI database management tool.
• oxker: a simple tui to view & control docker containers.
• trippy: a network diagnostic tool.
• cotp: a trustworthy, encrypted, command-line TOTP/HOTP authenticator app with import functionality.
• hg-tui: viewhellogithub.com website on the terminal.

You might want to checkoutCursive for analternative solution to build text user interfaces in Rust.

MIT