Installation

Ratatui 0.30.2 requires Rust 1.88 or newer. Install the current stable Rust toolchain with rustup, then add Ratatui and its default Crossterm backend to a Cargo project:

cargo add ratatui crossterm

The command adds both dependencies to Cargo.toml:

[dependencies]
crossterm = "0.29"
ratatui = "0.30.2"

Ratatui 0.30.2 uses Crossterm 0.29 by default, so these versions match. Keep the direct Crossterm dependency on the same major version Ratatui selects. Cargo can compile two incompatible Crossterm versions into one application, but their event types and terminal state are separate. See Crossterm versions before selecting an older version.

By default, ratatui enables the crossterm feature, but it’s possible to alternatively use termion, termwiz, or termina instead by enabling the appropriate feature and disabling the default features. See Backend for more information.

Note

Ratatui re-exports its selected backend crate, such as ratatui::crossterm. This helps library code refer to the backend version Ratatui uses. For applications, a direct backend dependency and imports such as crossterm::event usually make the source clearer and allow backend-specific features to be selected directly.

For Termion:

cargo add ratatui --no-default-features --features termion
cargo add termion

or in your Cargo.toml:

[dependencies]
ratatui = { version = "0.30.2", default-features = false, features = ["termion"] }
termion = "4"

For Termwiz:

cargo add ratatui --no-default-features --features termwiz
cargo add termwiz

or in your Cargo.toml:

[dependencies]
ratatui = { version = "0.30.2", default-features = false, features = ["termwiz"] }
termwiz = "0.23"

For Termina:

cargo add ratatui --no-default-features --features termina
cargo add termina

or in your Cargo.toml:

[dependencies]
ratatui = { version = "0.30.2", default-features = false, features = ["termina"] }
termina = "0.3"