How to install chess-tui on Ubuntu?

Use the .deb package from the latest release via curl and dpkg, or install with Cargo. The README provides a script for downloading and installing the .deb file automatically.

chess-tui vs xboard for terminal chess?

chess-tui offers modern TUI design with integrated Lichess play and online multiplayer, while xboard is older with broader engine support but lacks direct online features and a polished interface.

How to configure Stockfish with chess-tui?

Run chess-tui with the -e flag followed by the Stockfish path, e.g., `chess-tui -e /usr/bin/stockfish`. Additional options like depth can be set via command-line flags or config files.

Can I play chess-tui online with friends?

Yes, it supports online multiplayer over LAN or the internet using tunneling tools like bore. The Multiplayer documentation details how to set up and join games remotely.

How to change skins in chess-tui?

Edit the skins.json file in the config directory (e.g., ~/.config/chess-tui/) to customize styles, or press 's' in-game to cycle through available skins instantly.

Does chess-tui support analysis mode?

No, it focuses on gameplay rather than post-game analysis. While you can play against engines, it lacks dedicated analysis boards or move review features found in GUI clients.

chess-tui

MITRust2.7.1

A free, cross-platform terminal chess game supporting local play, UCI engines like Stockfish, and online Lichess integration.

Visit Website

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.

Target Audience

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.

Value Proposition

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.

Related Projects

Community-curated · Updated weekly · 100% open source

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.

Submit a project Star on GitHub

GitHub

1.1k stars71 forks0 contributors

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

Cross-Platform Availability

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.

Comprehensive Game Modes

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.

Strong Lichess Integration

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.

Customizable Interface

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.

Lightweight Terminal Experience

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

External Dependency Setup

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.

Lichess Token Requirement

Online play via Lichess necessitates obtaining and managing an API token separately, adding an extra step that native Lichess clients or web interfaces avoid.

Limited Visual Feedback

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.

Separate Documentation

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

Home

Rust

Arnis

Generate any location from the real world in Minecraft with a high level of detail.

A work-in-progress, open-source, multi-player city simulation game.

Stars8,121

Forks356

Last commit3 years ago

Ludusavi

Backup tool for PC game saves

Stars5,715

Forks118

Last commit1 month ago

rust-doom

A Doom Renderer written in Rust.

Stars2,409

Forks105

Last commit2 years ago

#terminal-application