chess-tui
A free, cross-platform terminal chess game supporting local play, UCI engines like Stockfish, and online Lichess integration.
What is chess-tui?
chess-tui is a free, cross-platform terminal user interface (TUI) chess application written in Rust. It enables users to play chess locally against another person, challenge UCI-compatible chess engines like Stockfish, or play online via Lichess integration, all within a text-based command-line interface.
Developers, system administrators, and chess enthusiasts who prefer working in the terminal and want a lightweight, feature-rich chess client without a graphical desktop environment.
Developers choose chess-tui for its comprehensive feature set—including local, engine, and online play—within a minimal, terminal-native application. Its unique selling point is the deep Lichess integration and online multiplayer support, which are uncommon in other terminal-based chess clients.
Overview
Play chess in any terminal. Rust TUI, Stockfish, Lichess.
Use Cases
Best For
- Playing chess against Stockfish or other UCI engines directly from the terminal.
- Accessing Lichess games, puzzles, and online matches via a command-line interface.
- Setting up local two-player chess games on a single machine without a GUI.
- Playing chess online over LAN or the internet with other chess-tui users.
- Customizing terminal chess board and piece appearances with different visual skins.
- Running a cross-platform chess client on macOS, Linux, or Windows from the command line.
Not Ideal For
- Users who prefer graphical chess interfaces with mouse support and rich visual animations.
- Competitive players needing integrated analysis boards, opening databases, or advanced GUI features for game review.
- Environments where terminal access is limited or impractical, such as on mobile devices or in kiosk modes.
- Teams seeking out-of-the-box chess solutions with minimal setup, as configuring engines and Lichess tokens adds complexity.
Pros & Cons
Pros
Available on macOS, Linux, and Windows via multiple package managers like Homebrew, Cargo, and .deb packages, as detailed in the Platforms section, ensuring easy installation across systems.
Supports local two-player, UCI engines like Stockfish, Lichess online play, and LAN multiplayer, all within the terminal, as shown in the Features section with GIF demos.
Allows playing Lichess games, puzzles, and seeking matches directly from the terminal using an API token, a feature highlighted in the Lichess documentation and setup guides.
Offers custom skins for board and pieces configurable via skins.json in the config directory, with in-game skin cycling using the 's' key, as per the Documentation.
Built with Rust and Ratatui for efficient performance, it runs entirely in the terminal with minimal resource usage, avoiding GUI overhead as emphasized in the philosophy.
Cons
Configuring UCI engines requires manual path specification and command-line arguments, as shown in Bot Configuration, which can be cumbersome compared to built-in engines.
Online play via Lichess necessitates obtaining and managing an API token separately, adding an extra step that native Lichess clients or web interfaces avoid.
Being terminal-based, it lacks graphical animations, mouse interactions, and rich visual cues that are standard in modern chess applications, relying on ASCII art and basic skins.
Full documentation is hosted externally on GitHub Pages, which might be less accessible offline or require additional navigation compared to integrated help systems.
Frequently Asked Questions
Related Projects
ArnisGenerate any location from the real world in Minecraft with a high level of detail.
cityboundA work-in-progress, open-source, multi-player city simulation game.
LudusaviBackup tool for PC game saves
rust-doomA Doom Renderer written in Rust.
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.