Ratatui ORG

Rust library that's all about cooking up terminal user interfaces (TUIs). 👨‍🍳🐀 Successor of tui-rs.

21 repos
838 followers
0 following

Rust 94%
Shell 6%

Table of Contents Quickstart Documentation Templates Built with Ratatui Alternatives Contributing Acknowledgements License [![Crate Badge]][Crate] [![Repo Badge]][Repo] [![Docs Badge]][Docs] [![License Badge]][License] \ [![CI Badge]][CI] [![Deps Badge]][Deps] [![Codecov Badge]][Codecov] [![Sponsors Badge]][Sponsors]…

Table of Contents

[Quickstart](#quickstart)
[Documentation](#documentation)
[Templates](#templates)
[Built with Ratatui](#built-with-ratatui)
[Alternatives](#alternatives)
[Contributing](#contributing)
[Acknowledgements](#acknowledgements)
[License](#license)

!Release header

[![Crate Badge]][Crate] [![Repo Badge]][Repo] [![Docs Badge]][Docs] [![License Badge]][License] \
[![CI Badge]][CI] [![Deps Badge]][Deps] [![Codecov Badge]][Codecov] [![Sponsors Badge]][Sponsors] \
[Ratatui Website] · [Docs] · [Widget Examples] · [App Examples] · [Changelog] \
[Breaking Changes] · [Contributing] · [Report a bug] · [Request a Feature]

[Ratatui][Ratatui Website] (_ˌræ.təˈtu.i_) is a Rust crate for cooking up terminal user interfaces
(TUIs). It provides a simple and flexible way to create text-based user interfaces in the terminal,
which can be used for command-line applications, dashboards, and other interactive console programs.

Quickstart

Ratatui has [templates] available to help you get started quickly. You can use the
[cargo-generate] command to create a new project with Ratatui:

shell
cargo install --locked cargo-generate
cargo generate ratatui/templates

Selecting the Hello World template produces the following application:

rust
use color_eyre::Result;
use crossterm::event::{self, Event};
use ratatui::{DefaultTerminal, Frame};

fn main() -&gt; Result&lt;()&gt; {
    color_eyre::install()?;
    let terminal = ratatui::init();
    let result = run(terminal);
    ratatui::restore();
    result
}

fn run(mut terminal: DefaultTerminal) -&gt; Result&lt;()&gt; {
    loop {
        terminal.draw(render)?;
        if matches!(event::read()?, Event::Key(_)) {
            break Ok(());
        }
    }
}

fn render(frame: &amp;mut Frame) {
    frame.render_widget(&quot;hello world&quot;, frame.area());
}

Documentation

[Docs] - the full API documentation for the library on docs.rs.
[Ratatui Website] - explains the library's concepts and provides step-by-step tutorials.
[Ratatui Forum] - a place to ask questions and discuss the library.
[Widget Examples] - a collection of examples that demonstrate how to use the library.
[App Examples] - a collection of more complex examples that demonstrate how to build apps.
[ARCHITECTURE.md] - explains the crate organization and modular workspace structure.
[Changelog] - generated by [git-cliff] utilizing [Conventional Commits].
[Breaking Changes] - a list of breaking changes in the library.

You can also watch the [EuroRust 2024 talk] to learn about common concepts in Ratatui and what's possible to build with it.

Templates

If you're looking to get started quickly, you can use one of the available templates from the
[templates] repository using [cargo-generate]:

shell
cargo generate ratatui/templates

Built with Ratatui

![Awesome][awesome-ratatui]

Check out the [showcase] section of the website, or the [awesome-ratatui] repository for a curated
list of awesome apps and libraries built with Ratatui!

Alternatives

Cursive - a ncurses-based TUI library.
iocraft - a declarative TUI library.

Contributing

[![Discord Badge]][Discord Server] [![Matrix Badge]][Matrix] [![Forum Badge]][Ratatui Forum]

Feel free to join our Discord server for discussions and questions!
There is also a Matrix bridge available at
#ratatui:matrix.org. We have also recently launched the
[Ratatui Forum].

We rely on GitHub for [bugs][Report a bug] and [feature requests][Request a Feature].

Please make sure you read the [contributing](./CONTRIBUTING.md) guidelines before [creating a pull
request][Create a Pull Request]. We accept AI generated code, but please read the [AI Contributions]
guidelines to ensure compliance.

If you'd like to show your support, you can add the Ratatui badge to your project's README:

md
[![Built With Ratatui](https://img.shields.io/badge/Built_With_Ratatui-000?logo=ratatui&amp;logoColor=fff)](https://ratatui.rs/)

![Built With Ratatui](https://ratatui.rs/)

Acknowledgements

Ratatui was forked from the [tui-rs] crate in 2023 in order to continue its development. None of
this could be possible without [Florian Dehau] who originally created [tui-rs] which inspired many
Rust TUIs.

Special thanks to [Pavel Fomchenkov] for his work in designing an awesome logo for the Ratatui
project and organization.

License

This project is licensed under the [MIT License][License].