README.md

Crossterm Terminal

The crossterm_terminal 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 perform terminal related actions cross-platform e.g clearing, resizing etc. It supports all UNIX and Windows terminals down to Windows 7 (not all terminals are tested, see Tested Terminals for more info).

crossterm_terminal 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 terminal feature enabled.

Features

• Cross-platform
• Multi-threaded (send, sync)
• Detailed Documentation
• Few Dependencies
• Terminal
  • Clear (all lines, current line, from cursor down and up, until new line)
  • Scroll up, down
  • Set/get the terminal size
  • Exit current process

Getting Started

Click to show Cargo.toml.

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

use std::io::{stdout, Write};  
use crossterm::{execute, SetSize, ScrollUp, Result};

fn main() -> Result<()> {
    execute!(stdout(), SetSize(10, 10), ScrollUp(5))
}

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