Skip to content

Quick Start Guide

Quick Start Guide

Installation

Choose the method that matches your operating system:

🐧 Linux (Arch Linux)

zelph is available in the AUR: 

pikaur -S zelph

🐧 Linux (Other Distributions)

Download the latest zelph-linux.zip from Releases, extract it, and run the binary directly. Alternatively, see Building zelph to compile from source.

🍏 macOS (via Homebrew)

brew tap acrion/zelph
brew install zelph

🪟 Windows (via Chocolatey)

choco install zelph

(Note: During the initial review period, the additional argument --version 0.9.2 is required. Once approved, choco install zelph will suffice.)

Basic Usage

Once installed, you can run zelph in interactive mode simply by typing zelph in your terminal. (If you downloaded a binary manually without installing, run ./zelph from the extraction directory).

Let’s try a basic example:

Berlin "is capital of" Germany
Germany "is located in" Europe
X is capital of Y, Y is located in Z => X is located in Z

After entering these statements, zelph will automatically infer that Berlin is located in Europe:

«Berlin» «is located in» «Europe» ⇐ («Germany» «is located in» «Europe»), («Berlin» «is capital of» «Germany»)

Note that none of the items used in the above statements are predefined, i.e. all are made known to zelph by these statements. In section Semantic Network Structure you’ll find details about the core concepts, including syntactic details.

Using Sample Scripts

zelph comes with sample scripts to demonstrate its capabilities:

# Run with the English examples script
./build/bin/zelph sample_scripts/english.zph

# Or try the Wikidata integration script
./build/bin/zelph sample_scripts/wikidata.zph

Importing Wikidata

zelph can import and process data from Wikidata:

# Within the zelph CLI
.wikidata path/to/wikidata-dump.json

For more details on Wikidata integration, see Working with Wikidata.

What’s Next?