README.md

Crossterm Screen

The crossterm_screen crate is deprecated and no longer maintained. The GitHub repository will be archived soon. All the code is being moved to the crossterm crate. You can learn more in the Merge sub-crates to the crossterm crate issue.

This crate allows you to work with alternate and raw screen cross-platform. It supports all UNIX and Windows terminals down to Windows 7 (not all terminals are tested see Tested Terminals for more info)

crossterm_screen is a sub-crate of the crossterm crate. You can use it directly, but it's highly recommended to use the crossterm crate with the screen feature enabled.

Getting Started

Click to show Cargo.toml.

[dependencies]
# All crossterm features are enabled by default.
crossterm = "0.11"

use crossterm::RawScreen;

fn main() -> Result<()> {
    // Enable raw mode
    let _raw = RawScreen::into_raw_mode()?;

    // Do something in the raw mode
} // `_raw` dropped here <- raw mode is disabled

Features

• Cross-platform
• Multi-threaded (send, sync)
• Detailed documentation
• Few dependencies
• Alternate screen
• Raw screen

Other Resources

• API documentation (with other examples)
• Examples repository

Authors

• Timon Post - Project Owner & creator

License

This project is licensed under the MIT License - see the LICENSE file for details