Cross platform terminal library rust
Find a file
Richard Alves de206a81d6
docs(terminal): fix raw mode function links (#1170)
The raw mode section of the `terminal` module docs linked to
`terminal::enable_raw_mode` and `terminal::disable_raw_mode` with
non-code labels. Use code-formatted reference links that point at
`crate::terminal::*`. `pub mod terminal` also has an outer doc comment,
so rustdoc resolves these links from the crate root. Bare names would
not resolve there.
History 2026-11-13 04:40:02 -08:00
.github build(deps): bump the github-actions group with 3 updates (#1164) 2026-11-01 01:52:09 -07:00
docs Improve formatting with optional nightly rustfmt (#1137) 2026-10-07 14:10:14 -07:00
examples Update examples Readme (#1153) 2026-10-19 19:20:31 -07:00
src docs(terminal): fix raw mode function links (#1170) 2026-11-13 04:40:02 -08:00
tests fix(style): preserve StyledContent formatting parameters (#1157) 2026-10-24 01:38:58 -07:00
.gitignore Track and refresh locked dependencies (#1078) 2026-07-28 23:40:32 -07:00
.travis.yml Remove all feature flags except event-stream (#322) 2019-11-20 14:03:22 +01:00
Cargo.lock fix(deps): bump rustix and async-executor to clear cargo deny (#1171) 2026-11-13 02:11:56 -08:00
Cargo.toml docs: drop redundant explicit rustdoc link targets (#1172) 2026-11-13 02:13:16 -08:00
CHANGELOG.md fix(cursor): clamp Windows legacy-console cursor moves at the edge (#1112) 2026-10-30 19:09:57 -07:00
deny.toml Enforce dependency and workflow policy (#1084) 2026-07-29 02:08:06 -07:00
justfile fix: keep doctests and Clippy clean in every CI feature combination (#1148) 2026-10-16 00:52:47 -07:00
LICENSE Create LICENSE (#108) 2019-03-24 14:22:58 +01:00
README.md Clean up Readme badges (#1118) 2026-10-19 09:36:03 -07:00
rustfmt.toml Improve formatting with optional nightly rustfmt (#1137) 2026-10-07 14:10:14 -07:00

Donate GitHub Actions Latest Version MIT Docs

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

Features

  • 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)
  • Windows Terminal
    • Windows 10 x86_64 (Enterprise)
    • Windows 11 arm64 (Enterprise)
  • GNOME 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 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.
[dependencies]
crossterm = "0.27"

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

use crossterm::{
    execute,
    style::{Color, Print, ResetColor, SetBackgroundColor, SetForegroundColor},
    ExecutableCommand,
    event,
};

fn main() -> std::io::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.

Feature Flags

[dependencies.crossterm]
version = "0.27"
features = ["event-stream"] 
Feature Description
event-stream futures::Stream producing Result<Event>.
serde (De)serializing of events.
events Reading input/system events (enabled by default)
filedescriptor Use raw filedescriptor for all events rather than mio dependency
osc52 Enables crossterm::clipboard

To use crossterm as a very thin layer you can disable the events feature or use filedescriptor feature. This can disable mio / signal-hook / signal-hook-mio dependencies.

Dependency Justification

Dependency Used for Included
bitflags KeyModifiers, those differ based on input. always
parking_lot locking RwLocks with a timeout, const mutexes. always
rustix UNIX terminal size/raw modes and other low-level functionality. UNIX only
Mio event readiness polling, waking up poller optional (events feature), UNIX only
signal-hook signal-hook is used to handle terminal resize SIGNAL with Mio. optional (events feature),UNIX only
winapi Used for low-level windows system calls which ANSI codes can't replace windows only
futures-core For async stream of events only with event-stream feature flag
serde serializing and deserializing of events only with serde feature flag
base64 Encoding clipboard data for OSC52 sequences in crossterm::clipboard only with osc52 feature flag

Other Resources

Used By

Contributing

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

Authors

  • Timon Post - Project Owner & creator

License

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.