Skip to main content

Chess Analyzer TUI

Interactive terminal chess analysis, with Stockfish as the default and support for other UCI engines.

Piece rendering adapted from Thomas Mauran's chess-tui. Full renderer credits and license information are below.

Install and run

Requires Python 3.11+.

Once published on PyPI, install the chess-analyzer-tui package with either tool manager. Both install the chess-analyzer command (the command name is not a separate PyPI package):

uv tool install chess-analyzer-tui   # or: pipx install chess-analyzer-tui
chess-analyzer
chess-analyzer --pgn game.pgn
chess-analyzer --white "Supi" --black "Carlsen" "2kr2nr/1pp2ppp/3b4/1P3q2/2Pp1B2/5Q1P/RP3PP1/R5K1 w - - 0 1"

The command works from any directory. If it isn't on PATH, use uv tool update-shell (or pipx ensurepath) and restart your shell.

Alternatively, pass a quoted FEN.

Options:

  • --ascii — use ASCII pieces
  • --time 0.5 — set analysis time
  • --lines 3 — show multiple lines
  • --threads 2 — set engine threads, if supported
  • --hash 256 — set engine hash size, if supported
  • --engine /path/to/engine — choose a UCI engine executable
  • --white "Supi" / --black "Carlsen" — label the players (override PGN names)

Stockfish

Stockfish is the default engine and is installed separately. If it isn't found, the app detects your OS (and Linux distribution) and suggests an installation command:

Platform Command
Debian/Ubuntu and derivatives (e.g. Linux Mint) sudo apt install stockfish
Arch and derivatives (e.g. Manjaro) sudo pacman -S stockfish
Fedora sudo dnf install stockfish
macOS (Homebrew) brew install stockfish
Windows (WinGet) winget install --id Stockfish.Stockfish --exact

Other distros/platforms get the official download link.

After installation, make sure stockfish (stockfish.exe on Windows) is on PATH: add the executable’s directory to PATH and restart your shell if needed. Alternatively, pass an executable with chess-analyzer --engine /path/to/stockfish (on Windows: chess-analyzer --engine "C:\path\to\stockfish.exe").

Stockfish is found on PATH or beside the application module as stockfish (stockfish.exe on Windows). Other UCI engines can be selected with --engine /path/to/engine—for example, Leela Chess Zero (Lc0) with --engine /path/to/lc0. Configure engine-specific files and settings, such as Lc0's network weights and backend, separately. The app applies thread, hash, and multiple-line settings only when the engine supports them.

Navigation

PGNs open at the final position and use their White/Black headers for player labels when present. Use --white and --black to set or override names, including for FENs.

  • ↑/↓ — choose an original move or engine alternative
  • →/Enter — follow the selected move; ← — step back
  • Esc — return from an explored line to its game position
  • f — flip board; r — reanalyze; q — quit

Moves, the return link, and any original-game move (or Start) are clickable. Branches are retained, and navigation never waits for analysis.

Use at least 40×24 terminal cells. Larger boards use multiline pieces; smaller ones use chess glyphs. Narrow layouts stack the panels; scroll with the mouse wheel or Page Up/Down. Blue highlights the selected move, yellow the previous move, and red a checked king.

Renderer credits

The piece artwork and size-adaptive rendering approach are adapted from Thomas Mauran's chess-tui, using its piece designs. The artwork is used under the MIT License; the full notice is preserved in licenses/chess-tui-MIT.txt. The rest of this project is released under MIT.

Verify

With Stockfish installed: uv run python -m unittest discover -s tests -v.

Metadata

Release files for chess-analyzer-tui 0.1.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for chess-analyzer-tui 0.1.1
File Size Uploaded
chess_analyzer_tui-0.1.1.tar.gz 15.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for chess-analyzer-tui 0.1.1
File Interpreter ABI Platform
chess_analyzer_tui-0.1.1-py3-none-any.whl Python 3 none any Details

Total release size: 29.2 kB

Release files / chess_analyzer_tui-0.1.1.tar.gz

Download URL chess_analyzer_tui-0.1.1.tar.gz
Size 15.4 kB
Tags Source
SHA-256 checksum
How to use checksums
a037db298cc41cbbda2f660ae0ea346dd52d60540dd45c03803cad6e750c19b2
BLAKE2b-256 checksum
How to use checksums
dd428f7fb6b4e72ad09c22fa28d4950db8b2e57df84bf35f4b563092d1514cda
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / chess_analyzer_tui-0.1.1-py3-none-any.whl

Download URL chess_analyzer_tui-0.1.1-py3-none-any.whl
Size 13.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
3a2c88dd8734bc68f78993427d0a0e63a6c2804255903bf869fbee295319c9fc
BLAKE2b-256 checksum
How to use checksums
43ebfa5d692c3defad8aec66742e20b58a7ca985aad123f3d0a97e857a1a7082
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

0.2.6

2 release files

0.2.5

2 release files

0.2.4

2 release files

0.2.3

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.4

2 release files

0.1.3

2 release files

0.1.2

2 release files

This release

0.1.1 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page