Skip to content

Repository files navigation

Chess-CLI - A repl to read, edit and analyse chess games in the terminal

A REPL for editing and analysing chess games. See manual here and changelog here.

Building

Prerequisites

You need Python 3.12 or 3.13 and uv. Install uv using the instructions linked below.

On GNU/Linux, you also need ffmpeg and portaudio installed, on Windows, these things are bundeled with the source files.

Running in Development Environment

Install the virtual environment with:

$ uv sync

And run it with:

$ uv run chess-cli

Building Python Package

Just run:

$ uv build
# The result is in the dist directory, install with:
$ pip install dist/*.whl

Building a Windows Installer

Inside Powershell, run:

$ uv run nuitka chess-cli.py

The resulting executable should be chess-cli.dist/chess-cli.exe.

To build the installer, you need to install NSIS. Then, right click windows_setup.nsi in Windowrs Explorer and choose "Compile NSIS Script". The resulting installation file is called Chess-CLI-setup.exe.

Usage

If you managed to run the program with uv run chess-cli (as described above), you will land in a REPL with the initial prompt "start: ". To get a list of all commands, enter "help" followed by enter. To get help information about a specific command, run <COMMAND> --help.

See a more complete manual here.

About

A repl to edit and analyse chess games.

Resources

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages