Get started

Installation

Nexir supports Linux x86_64/ARM64, macOS Intel/Apple Silicon, and Docker. Windows is deferred for the initial public beta.

Linux and macOS

curl --proto '=https' --tlsv1.2 -sSf \
  https://nexir.com/install.sh | sh -s -- --accept-terms

Using --accept-terms affirms that you accept the Nexir Binary License and Use Terms v1.0. The installer records that acceptance, so normal startup is simply nexir.

The installer detects Linux/macOS and x86_64/ARM64, resolves the latest beta version through releases.nexir.com, downloads into a temporary directory, verifies SHA-256, and installs nexir to $NEXIR_INSTALL_DIR or $HOME/.local/bin.

Install a specific version or directory

curl -sSf https://nexir.com/install.sh | \
  sh -s -- --accept-terms --version 0.1.0-beta.5 --install-dir "$HOME/bin"

You can download and inspect the installer before running it:

curl -sSfO https://nexir.com/install.sh
less install.sh
sh install.sh --accept-terms --version 0.1.0-beta.5

Manual binary installation

1. Select the target name from the artifact matrix.
2. Download the versioned archive and its same-name .sha256 sidecar from https://releases.nexir.com/vVERSION/.
3. Verify the digest before extracting.
4. Move nexir into a directory on your user PATH.

Before starting a manually downloaded Official Binary, read the Terms and run nexir --accept-terms once. That command records acceptance and starts the server. Use NEXIR_ACCEPT_TERMS=1 for noninteractive operation.

# Replace VERSION and TARGET
curl -fLO https://releases.nexir.com/vVERSION/nexir-vVERSION-TARGET.tar.gz
curl -fLO https://releases.nexir.com/vVERSION/nexir-vVERSION-TARGET.tar.gz.sha256
shasum -a 256 -c nexir-vVERSION-TARGET.tar.gz.sha256
tar -xzf nexir-vVERSION-TARGET.tar.gz

On Linux, use sha256sum -c if shasum is unavailable.

Docker

The official image supports Linux amd64 and arm64. Pin the beta version for reproducible deployments:

docker run --rm --name nexir-quickstart \
  -p 127.0.0.1:16379:6379 \
  -p 127.0.0.1:15051:50051 \
  -p 127.0.0.1:19090:9090 \
  -e NEXIR_ACCEPT_TERMS=1 \
  -e NEXIR__RAFT__NODE_ID=1 \
-e NEXIR__SERVER__ENABLE_ADMIN_COMMANDS=true \
  -v nexir-quickstart-data:/data/nexir \
  ghcr.io/nexirdb/nexir:v0.1.0-beta.5

Initialize through the mapped client port:

redis-cli --raw -p 16379 INIT 1 \
  http://127.0.0.1:15051 127.0.0.1:16379

Verify

nexir --version
nexir --help
nexir healthcheck

Current verified CLI output reports nexir 0.1.0-beta.5 (beta).

Upgrade

Re-run the installer with no version for the latest published beta, or pass --version. The installer replaces only the executable. Stop Nexir before changing the binary, preserve the data directory, and review release notes because beta storage formats may be incompatible. Beta.5 changes no storage format, but an in-place upgrade from beta.4 was not validated for this release; the conservative path is a fresh cluster with data reloaded at the application level.

Uninstall

rm "$HOME/.local/bin/nexir"

Removing the executable does not remove data. Delete a Nexir storage directory only when you intentionally want to destroy that node's state and understand cluster membership implications.

Checksum model

Each release archive has a sidecar containing one SHA-256 digest and the archive filename. The installer downloads both over HTTPS, calculates the local digest, compares normalized values, and aborts before extraction on any mismatch. Checksums detect corruption; a release-signing policy is still required before general availability.