Install

nuthatch is one static binary. No Postgres, no Docker, no IPFS, no account - install it and you’re done.

The one-liner

curl -fsSL https://nuthatch-indexer.com/install.sh | sh

The script detects your platform, downloads the matching release binary, verifies its checksum, and puts nuthatch on your PATH. It’s short and readable on GitHub - audit it first if curl | sh makes you itch.

Prebuilt binaries cover macOS (Apple Silicon) and Linux x86_64. Intel Mac is deliberately not built. Checksums ship with every release. Every v3 artifact also has a GitHub build-provenance attestation, which establishes the producing repository and workflow rather than merely the integrity of bytes in transit:

gh attestation verify nuthatch-x86_64-unknown-linux-gnu.tar.gz --repo nightswatchhq/nuthatch

The --repo constraint matters. Without it, an attestation from any repository may be accepted.

Container image

docker run --rm ghcr.io/nightswatchhq/nuthatch:3.1.0 --version

linux/amd64 only for now. The image carries the same binary attached to the GitHub Release, so the two cannot drift. Scaled mode needs the -scaled tag: the default image is the embedded build and carries no database driver. See Deploy it for running it properly.

From source

Only needed on a platform we do not publish a binary for. The toolchain pin is required, not advisory:

rustup toolchain install 1.95.0
cargo +1.95.0 install --git https://github.com/nightswatchhq/nuthatch nuthatch

rust-toolchain.toml pins 1.95.0 because dbsp hits a next-trait-solver ICE on 1.97 - and that file does not apply to cargo install --git, which builds in a temporary directory of its own. So the pin cannot protect this path and you have to ask for it. Without +1.95.0, a 1.97 default toolchain fails after a full dependency build with error: could not compile dbsp and installs nothing.

This page previously said a plain cargo install on recent stable worked. It does not, and has not since rustc 1.97 - see #534.

Verify

nuthatch --version

Then take the two-minute path: Quickstart - from a contract address to a live, queryable API.

nuthatch init 0xA0b86991c6218b36c1D19D4a2e9Eb0cE3606eB48   # USDC - chain auto-detected
nuthatch dev

Nothing phones home: no telemetry, no API token, no gated data service. AI features are BYO-key or local models and degrade gracefully offline.