Install¶

There are no pre-built binaries. You need git, the Odin compiler, make, and a C compiler (cc, clang, or gcc). Linux, macOS, and Windows (Git Bash) are supported.

Install script¶

curl -fsSL https://nullray.xyz/install | sh

The script clones the repo into ~/.local/src/nullray (or updates that checkout), builds, and installs into ~/.local. It warns and exits if git or Odin is missing. Re-run to pull and rebuild. Override paths with NULLRAY_SRC_DIR, NULLRAY_PREFIX, NULLRAY_REF, and NULLRAY_REPO.

Build from source¶

make first builds lib/libnullray_tls.a from vendored Mbed TLS, nghttp2, and mlkem-native, then builds bin/nullray.

git clone https://github.com/Quad4-Software/nullray.git
cd nullray
make
make test
./bin/nullray --self-test

Install system-wide or into a user prefix:

make install                      # PREFIX=/usr/local
make install PREFIX="$HOME/.local"

make install also drops the man page under share/man/man1 and shell completions. Later updates:

git -C ~/.local/src/nullray pull
make -C ~/.local/src/nullray install PREFIX="$HOME/.local"

Verify¶

nullray --self-test
nullray --doctor

--self-test runs a headless smoke of tools, MCP, drawing, and the shell deny path. --doctor prints config paths, detected keys, sandbox posture, and the latest crash dump.

Completions¶

nullray --completions zsh  > ~/.zsh/completions/_nullray
nullray --completions bash > ~/.bash_completion.d/nullray

Supported shells: bash, zsh, fish, powershell, elvish, nushell.

Man page¶

man nullray            # after make install
nullray --man | man -l -