Skip to content

tage64/chess-cli

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 later and Poetry. You can install the latter with:

$ pip install poetry

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:

$ poetry install

And run it with:

$ poetry run chess-cli

Building Python Package

Just run:

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

Building a Windows Installer

Inside Powershell, run:

$ poetry 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 poetry 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.