Installation¶

Requirements¶

git on your PATH (Git for Windows on Windows)
Windows 10/11 or Linux x86-64 (Ubuntu 22.04+, Debian 12+, Fedora 36+ or similar)

Windows¶

Download kigit-<version>-setup.exe from the Releases page.
Run it. No admin rights are needed.

It adds kigit to your PATH and a kigit entry to the Start menu that opens the GUI.

Warning

The first kigit gui takes about a minute, since it grabs Python and the GUI's packages. After that, it's instant. (The command line doesn't need any of that, so it's quick from the start.)

Portable

The Releases page also has a zip. Unzip it anywhere and run bin\kigit.exe.

Linux¶

Download kigit-<version>-linux-x86_64.tar.gz from the Releases page and unpack it into ~/.local:

tar -xzf kigit-*-linux-x86_64.tar.gz -C ~/.local --strip-components=1
kigit --version    # ~/.local/bin must be on your PATH (it is on most distros)
kigit --help # Shows all optional commands and some example
kigit gui # Launches the GUI for kigit

It brings its own copy of uv for the GUI (in ~/.local/libexec/kigit), so a uv you already have isn't touched.

To uninstall:

rm ~/.local/bin/kigit
rm -r ~/.local/share/kigit ~/.local/libexec/kigit
rm -r ~/.local/state/kigit    # optional: the GUI's Python environment and the logs

Build from source¶

Needs a C++20 compiler and CMake 3.16+. The libraries (nlohmann_json, spdlog, doctest) are git submodules:

git clone --recursive https://github.com/KhalidOwlWalid/kigit.git
cd kigit
cmake -S . -B build
cmake --build build -j
cmake --install build --prefix ~/.local    # optional

On Windows, MSVC (Visual Studio 2022) and MinGW-w64 GCC 11+ both work:

cmake -S . -B build
cmake --build build --config Release
build\Release\kigit.exe gui

The GUI also needs uv on your PATH when built from source.