Getting Started

Welcome to the chess-tui documentation!

Chess-tui is a simple chess game you can play from your terminal. It supports local 2 players mode, online multiplayer, playing against any UCI compatible chess engine, Lichess integration, custom skins and more!

This documentation will guide you through the different features of the game and how to install it. For keyboard shortcuts, see the Keyboard Shortcuts page.

Quick Install

Homebrew:

brew install thomas-mauran/tap/chess-tui

Debian/Ubuntu:

DEB_URL=$(curl -s "https://api.github.com/repos/thomas-mauran/chess-tui/releases/latest" | jq -r '.assets[] | select(.name | endswith(".deb")) | .browser_download_url') && curl -LO "$DEB_URL" && sudo dpkg -i "$(basename "$DEB_URL")" && sudo apt-get install -f

Cargo:

cargo install chess-tui

For installation via package managers or other methods, see the Installation Guide.

---

Logo and illustrations by everwinter. See the full Credits page.