#event #color #cli #input #terminal


An crossplatform terminal library for manipulating terminals

48 releases (17 breaking)

0.18.0 Sep 29, 2020
0.17.7 Jul 13, 2020
0.17.1 Mar 28, 2020
0.14.1 Dec 17, 2019
0.2.0 Jan 27, 2018

#3 in Command-line interface

Download history 7076/week @ 2020-06-30 8008/week @ 2020-07-07 9364/week @ 2020-07-14 7830/week @ 2020-07-21 8006/week @ 2020-07-28 8330/week @ 2020-08-04 10143/week @ 2020-08-11 7501/week @ 2020-08-18 8426/week @ 2020-08-25 8347/week @ 2020-09-01 8968/week @ 2020-09-08 8371/week @ 2020-09-15 7587/week @ 2020-09-22 11263/week @ 2020-09-29 12785/week @ 2020-10-06 11840/week @ 2020-10-13

35,441 downloads per month
Used in 204 crates (164 directly)

MIT license


Donate Travis Latest Version MIT docs Lines of Code Join us on Discord

Cross-platform Terminal Manipulation Library

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).

Table of Contents


  • 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

Tested Terminals

  • Console Host
    • Windows 10 (Pro)
    • Windows 8.1 (N)
  • Ubuntu Desktop Terminal
    • Ubuntu 17.10
    • Pop!_OS ( Ubuntu ) 20.04
  • (Arch, Manjaro) KDE Konsole
  • (Arch) Kitty
  • Linux Mint

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!

Getting Started

see the examples directory and documentation for more advanced examples.

Click to show Cargo.toml.
crossterm = "0.18"

use std::io::{stdout, Write};

use crossterm::{
    style::{Color, Print, ResetColor, SetBackgroundColor, SetForegroundColor},
    ExecutableCommand, Result,

fn main() -> Result<()> {
    // using the macro
        Print("Styled text here."),

    // or using functions
        .execute(Print("Styled text here."))?

Checkout this list with all possible commands.

Feature Flags

To optional feature flags.

version = "0.17"
features = ["event-stream"] 
Feature Description
event-stream futures::Stream producing Result<Event>.

Dependency Justification

Dependency Used for Included
bitflags KeyModifiers, those are differ based on input. always
lazy_static original console color, original terminal mode, saved cursor position, supports ANSI on windows, single event reader per application. always
parking_lot used for an RW LOCK. always
libc UNIX terminal_size/raw modes/set_title and several other lowlevel functionality. UNIX only
Mio event readiness polling, waking up poller UNIX only
signal-hook signalhook is used to handle terminal resize SIGNAL with Mio. UNIX only
winapi Used for low-level windows system calls which ANSI codes can't replace windows only
futures Can be used to for async stream of events only with a feature flag
serde Se/dese/realizing of events only with a feature flag

Other Resources

Used By


We highly appreciate when anyone contributes to this crate. Before you do, please, read the Contributing 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 MIT License - see the LICENSE file for details.


~22K SLoC