Documentation 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; a Homebrew tap and detached release signatures are on the roadmap.

Container image

docker run --rm ghcr.io/nightswatchhq/nuthatch:1.0.2 --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

Any platform with a Rust toolchain:

cargo install --git https://github.com/nightswatchhq/nuthatch nuthatch

The pinned toolchain is in the repo’s rust-toolchain.toml; a plain cargo install against a recent stable Rust works.

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.