crossterm-rs/crossterm
Crossterm
Crossterm is a cross-platform Rust library for terminal manipulation, providing a low-level interface for controlling terminal state, cursor movement, and text styling. It acts as a cross-platform TTY interface that handles raw mode, alternate screen buffers, and terminal window metadata across different operating systems.
The library includes an ANSI text styling engine for applying RGB colors and text attributes to console output, as well as a terminal input event handler for capturing keyboard presses, mouse movements, and terminal resize events in real time. It also provides system clipboard integration for copying and pasting text.
The project covers broad capability areas including terminal state management, asynchronous input streaming, and cursor control. It provides tools for environment manipulation, such as clearing lines and updating window titles, and supports terminal state querying to retrieve window size and TTY status.
Features
- Cross-Platform CLI Builders - Provides a cross-platform foundation for building consistent command line tools across Windows, macOS, and Linux.
- Keyboard and Mouse Event Capture - Converts raw byte streams from the terminal into structured keyboard and mouse events.
- Terminal Escape Sequences - Translates high-level commands into ANSI and VT100 escape sequences for terminal control.
- Terminal State Accessors - Retrieves terminal window metadata, including size, pixel dimensions, and TTY status.
- Terminal Mode Managers - Provides APIs for toggling raw mode and managing terminal modes to control display and input processing.
- Cross-Platform TTY Interfaces - Provides a low-level interface for handling raw mode and alternate screen buffers across operating systems.
- Low-Level Terminal Control - Provides precise control over raw mode, alternate screen buffers, and cursor positioning.
- ANSI Escape Sequence Formatting - Implements a system for applying RGB colors and attributes to console output via ANSI escape sequences.
- Terminal Manipulation Libraries - A comprehensive Rust library for controlling terminal state, cursor movement, and text styling.
- Alternate Screen Management - Provides the ability to toggle between primary and alternate terminal screen buffers to isolate application UI.
- Raw Mode Input Handlers - Disables line buffering and echo at the OS level to capture raw keyboard and mouse input.
- Terminal Text Styling - Applies colors and text attributes to terminal output to improve visual hierarchy.
- Terminal User Interfaces - Enables the construction of full-screen interactive terminal user interfaces with custom layouts and mouse support.
- Terminal Text Attributes - Applies RGB/ANSI colors and text attributes like bold or italic to terminal output.
- Terminal Environment Manipulation - Provides tools to clear lines, scroll the view, and update the terminal window title.
- TTY Detection - Checks if the output stream is a terminal to decide between interactive features and plain text fallback.
- Backend Abstractions - Uses a trait system to separate generic terminal operations from platform-specific backend implementations.
- Terminal Event Handlers - Provides an event system for capturing real-time keyboard presses, mouse movements, and resize events.
- Concurrent Terminal Output Coordination - Coordinates output updates to prevent visual flickering and overlapping during screen refreshes.
- Cursor Position Mapping - Calculates absolute and relative screen positions to manage character placement and cursor visibility.
- Cursor Visibility & Positioning - Moves the terminal cursor to specific coordinates and toggles its visibility.
- Asynchronous Input Handlers - Produces asynchronous sequences of input events to process user interactions without blocking the main thread.
- Real-time Input Capture - Captures keyboard and mouse events asynchronously for responsive command line interfaces.
- Terminal Window Titles - Allows dynamically updating the terminal window title and other metadata using standard escape sequences.
