Repository files navigation

Crossterm is a pure-rust, terminal manipulation library that makes it possible to write cross-platform text-based interfaces (seefeatures). It supports all UNIX and Windows terminals down to Windows 7 (not all terminals are tested,seeTested Terminals for more info).

• Cross-platform Terminal Manipulation Library
  • Table of Contents
  • Features
    • Tested Terminals
  • Getting Started
    • Feature Flags
    • Dependency Justification
    • Other Resources
  • Used By
  • Contributing
  • Authors
  • License

• Cross-platform
• Multi-threaded (send, sync)
• Detailed documentation
• Few dependencies
• Full control over writing and flushing output buffer
• Is tty
• Cursor
  • Move the cursor N times (up, down, left, right)
  • Move to previous / next line
  • Move to column
  • Set/get the cursor position
  • Store the cursor position and restore to it later
  • Hide/show the cursor
  • Enable/disable cursor blinking (not all terminals do support this feature)
• Styled output
  • Foreground color (16 base colors)
  • Background color (16 base colors)
  • 256 (ANSI) color support (Windows 10 and UNIX only)
  • RGB color support (Windows 10 and UNIX only)
  • Text attributes like bold, italic, underscore, crossed, etc
• 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
  • Alternate screen
  • Raw screen
  • Set terminal title
  • Enable/disable line wrapping
• Event
  • Input Events
  • Mouse Events (press, release, position, button, drag)
  • Terminal Resize Events
  • Advanced modifier (SHIFT | ALT | CTRL) support for both mouse and key events and
  • futures Stream (feature 'event-stream')
  • Poll/read API

• Console Host
  • Windows 10 (Pro)
  • Windows 8.1 (N)
• Windows Terminal
  • Windows 10 x86_64 (Enterprise)
  • Windows 11 arm64 (Enterprise)
• Ubuntu Desktop Terminal
  • Ubuntu 23.04 64-bit
  • Ubuntu 17.10
  • Pop!_OS ( Ubuntu ) 20.04
• (Arch, Manjaro) KDE Konsole
• (Arch, NixOS) Kitty
• Linux Mint
• (OpenSuse) Alacritty
• (Chrome OS) Crostini
• Apple
  • macOS Monterey 12.7.1 (Intel-Chip)
  • macOS Sonoma 14.4 (M1 Max, Apple Silicon-Chip)

This crate supports all UNIX terminals and Windows terminals down to Windows 7; however, not all of theterminals have been tested. If you have used this library for a terminal other than the above list withoutissues, then feel free to add it to the above list - I really would appreciate it!

see theexamples directory anddocumentation for more advanced examples.

[dependencies]crossterm ="0.27"

use std::io::{stdout,Write};use crossterm::{    execute,    style::{Color,Print,ResetColor,SetBackgroundColor,SetForegroundColor},ExecutableCommand,    event,};fnmain() -> std::io::Result<()>{// using the macroexecute!(        stdout(),SetForegroundColor(Color::Blue),SetBackgroundColor(Color::Red),Print("Styled text here."),ResetColor)?;// or using functionsstdout().execute(SetForegroundColor(Color::Blue))?.execute(SetBackgroundColor(Color::Red))?.execute(Print("Styled text here."))?.execute(ResetColor)?;Ok(())}

Checkout thislist with all possible commands.

[dependencies.crossterm]version ="0.27"features = ["event-stream"]

To use crossterm as a very thin layer you can disable theevents feature or usefiledescriptor feature.This can disablemio /signal-hook /signal-hook-mio dependencies.

• API documentation
• Deprecated examples repository

• Broot
• Cursive
• Ratatui
• Rust-sloth
• Rusty-rain

We highly appreciate when anyone contributes to this crate. Before you do, please,read theContributing guidelines.

• Timon Post -Project Owner & creator

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 MITLicense - see theLICENSE file for details.