Crossterm is a pure-rust, terminal manipulation library that makes it possible to write cross-platform text-based interfaces (see features). It supports all UNIX and Windows terminals down to Windows 7 (not all terminals are tested, see Tested Terminals for more info).
This crate supports all UNIX terminals and Windows terminals down to Windows 7; however, not all of the terminals have been tested. If you have used this library for a terminal other than the above list without issues, then feel free to add it to the above list - I really would appreciate it!
see the examples directory and documentation for more advanced examples.
Click to show Cargo.toml.
toml
[dependencies]
crossterm = "0.17"
```rust use std::io::{stdout, Write};
use crossterm::{ execute, style::{Color, Print, ResetColor, SetBackgroundColor, SetForegroundColor}, ExecutableCommand, Result, event, };
fn main() -> Result<()> { // using the macro execute!( stdout(), SetForegroundColor(Color::Blue), SetBackgroundColor(Color::Red), Print("Styled text here."), ResetColor )?;
// or using functions
stdout()
.execute(SetForegroundColor(Color::Blue))?
.execute(SetBackgroundColor(Color::Red))?
.execute(Print("Styled text here."))?
.execute(ResetColor)?;
Ok(())
} ```
Checkout this list with all possible commands.
To optional feature flags.
toml
[dependencies.crossterm]
version = "0.17"
features = ["event-stream"]
| Feature | Description |
| :-- | :-- |
| event-stream | futures::Stream producing Result<Event>.|
We highly appreciate when anyone contributes to this crate. Before you do, please, read the Contributing guidelines.
This project, crossterm and all its sub-crates: crossterm_screen, crossterm_cursor, crossterm_style,
crossterm_input, crossterm_terminal, crossterm_winapi, crossterm_utils are licensed under the MIT
License - see the LICENSE file for details.