relix — the command line for Relix

relix runs Relix relational-algebra scripts from the shell, as one stage of an ordinary Unix pipeline:

cat monthly.relix | relix -o csv > monthly.csv
curl -s https://api.example.com/orders | jq -c '.items[]' \
  | relix -i orders=ndjson:- -e 'orders ⋈ Customers' -o ndjson | jq .

It is a front end to the Relix engine, relix-core, and reaches it only through the engine's published API.

Its documentation is the command-line section of the Relix programming guide, in docs/guide/command-line, published on the Relix site.

Status

Released. 0.1.x are stable releases; 1.0.0 is being prepared through release candidates (1.0.0-rcN), which GitHub lists as pre-releases.

Building

Requires Java 21, which the Gradle wrapper provisions if it is missing:

./gradlew build

CONTRIBUTING.md describes what the build checks.

./gradlew releaseArchive builds this platform's archive in build/distributions: a self-contained image (no Java needed to run it) with bin/relix, the man pages in man/man1 and the completion scripts in completions/.

Installing

With Homebrew (version 7 loads a formula from a tap outside Homebrew only once you trust it):

brew tap DarkCollective/relix
brew trust --formula darkcollective/relix/relix
brew install relix

With Scoop:

scoop bucket add relix https://github.com/DarkCollective/scoop-relix
scoop install relix

Homebrew and Scoop install the newest release, a release candidate included: while 1.0.0 is being prepared, relix is the newest 1.0.0-rcN, and the final 1.0.0 replaces it (both order a candidate below its release). To install without a package manager, download the archive for your platform from the releases, check it against checksums.txt, unpack it and put its bin/ on your PATH.

Licence

Apache License 2.0. See CONTRIBUTING.md to take part, and SECURITY.md to report a vulnerability.