Installation

Gelex can be installed via package managers (recommended for users) or built from source (recommended for developers).

Note

Currently, Gelex only supports Linux x86_64 architectures. Support for other platforms is planned for future releases.

Build from Source

If you want to contribute to development or use the latest features, you can build Gelex from source.

Prerequisites

  • Pixi: We use Pixi to manage dependencies and build environments. Install it from pixi.sh.

  • C++ Compiler: A compiler with C++23 support (e.g., GCC 13+, Clang 16+).

Build Steps

  1. Clone the repository:

    git clone https://github.com/r1cheu/gelex.git
    cd gelex
    
  2. Install dependencies and build:

    # Install all dependencies via pixi
    pixi install
    
    # Build the debug version (includes tests)
    pixi run build-debug
    
    # Build the release version (optimized)
    pixi run build-release
    
  3. Install to your local system:

    # Install the release binary to ~/.local/bin
    pixi run install-release
    

Verification

After installation, verify that Gelex is working correctly:

gelex --help