HeFQUIN Command-Line Programs

HeFQUIN comes with several command-line programs, including:

hefquin - execute queries over a federation,
hefquin-server - start HeFQUIN as a Web service,
hefquin-pg - execute SPARQL queries over a virtual RDF view of a Property Graph, and
hefquin-pgmat - create an RDF representation of a Property Graph.

This page describes how to set up and run these programs ...

by using one of the available releases or
by using the current developer version in the source code repository.

Setting Up the Programs Using an Available Release

As the HeFQUIN programs are Java programs, you need to have a relatively recent version of a Java Runtime Environment installed.

Then, download the latest package from the HeFQUIN release page. After downloading the release package and unpacking it, you can enter the resulting directory in a command-line terminal and run the programs by using the scripts in the ./bin/ subdirectory (or .\bat\ if you are using Windows). For instance, you can execute the following command.

bin/hefquin --help

(or bat\hefquin.bat --help if you are using Windows.)

If you want to be able to start the HeFQUIN programs from within any directory, it is recommended that you define the environment variable HEFQUIN_HOME and add the scripts to the PATH variable, which you can do with the following commands.

On Linux and Mac:

export HEFQUIN_HOME="the directory created when unpacking the HeFQUIN release package"
export PATH=$PATH:$HEFQUIN_HOME/bin

On Windows:

SET HEFQUIN_HOME="the directory created when unpacking the HeFQUIN release package"
SET PATH=%PATH%;%HEFQUIN_HOME%\bat

Setting Up the Programs From the Source Code Repository

To set up the programs from the source code repository you need a Java build environment with Maven, and you need a local clone of the GitHub repository of HeFQUIN.

If you have not cloned the repository already, you can clone it either by using the SSH URL:

git clone git@github.com:LiUSemWeb/HeFQUIN.git

or by using the HTTP URL:

git clone https://github.com/LiUSemWeb/HeFQUIN.git

If you have cloned the repository earlier, make sure that you pull the latest version of the source code into your local clone:

git checkout main
git pull

Within the directory into which you have cloned the repo, you can now compile the source code using Maven by executing the following command.

mvn clean package

Assuming the build finishes successfully, you can run the programs by using the scripts in the ./bin/ (or .\bat\) subdirectory and add the scripts to the PATH variable, exactly as described above.