Skip to main content
Version: 0.12.0

Command-line client (CLI)

lucenia is a command-line client for Lucenia search clusters. It wraps the Go client (lucenia-go) and exposes a kubectl-style command tree, replacing ad-hoc curl usage with typed, discoverable subcommands. A raw escape hatch covers any REST endpoint the typed tree doesn't yet model.

The CLI is built for both operators and developers:

  • Discoverable — lucenia <TAB> teaches the API surface through shell completion.
  • Scriptable — emits JSON in pipelines and returns deterministic exit codes.
  • Safe — destructive commands require confirmation or an explicit --yes.
  • Portable — a single static binary for linux, darwin, and windows on both amd64 and arm64.

Compatibility​

The CLI is versioned independently from the Lucenia engine. Because it speaks the standard Lucenia REST API, any recent CLI release works against any supported cluster version. Check GitHub Releases for the current version.

Installation​

Choose the method that fits your platform. After installing, jump to CLI configuration to point the client at a cluster.

Homebrew (macOS / Linux)​

brew install lucenia/tap/lucenia

Debian / Ubuntu (apt repository)​

Add the signing key and repository, then install with apt:

sudo install -d -m 0755 /etc/apt/keyrings
# Dearmor the ASCII-armored key into the binary keyring apt expects.
curl -fsSL https://artifacts.lucenia.io/apt/lucenia.gpg \
  | sudo gpg --dearmor -o /etc/apt/keyrings/lucenia.gpg
echo "deb [signed-by=/etc/apt/keyrings/lucenia.gpg] https://artifacts.lucenia.io/apt stable main" \
  | sudo tee /etc/apt/sources.list.d/lucenia.list
sudo apt update
sudo apt install lucenia

Direct .deb / .rpm download (no repository)​

Substitute the current <TAG> (for example v0.1.3) and <VERSION> (0.1.3) from GitHub Releases:

TAG=v0.1.3 VERSION=0.1.3

# Debian / Ubuntu
curl -fsSL -o lucenia.deb "https://artifacts.lucenia.io/releases/cli/${TAG}/lucenia_${VERSION}_amd64.deb"
sudo dpkg -i lucenia.deb

# RHEL / Fedora
curl -fsSL -o lucenia.rpm "https://artifacts.lucenia.io/releases/cli/${TAG}/lucenia-${VERSION}-1.x86_64.rpm"
sudo rpm -i lucenia.rpm

Binary download​

Grab the archive for your platform from GitHub Releases (or https://artifacts.lucenia.io/releases/cli/<tag>/) and extract the lucenia binary onto your $PATH.

Verify the installation​

lucenia version

Build from source​

The CLI links against the github.com/lucenia/lucenia-go module, which is distributed privately. Building from source therefore requires access credentials from the Lucenia team — reach out for the module registry configuration if you need it. Most users should install a pre-built release using one of the methods above.

Prerequisites​

  • Go 1.25.9 or newer (matches go.mod)
  • git
  • Access to the private lucenia-go module
  • Docker (only if you plan to run the integration suite)

Build​

git clone https://github.com/lucenia/lucenia-cli.git
cd lucenia-cli
make build              # → bin/lucenia
./bin/lucenia version

Move bin/lucenia onto your $PATH (or symlink it) when you're done.

Next steps​