Get Nuthatch running.

Embedded mode is a single static binary with no external services. Pick whichever route you trust. Every one lands you at the same place: nuthatch init, then nuthatch dev.

Nuthatch is pre-release. There are no published binaries yet and the shell installer is a placeholder; the routes below describe the intended install surface. To try it today, build from source with cargo. The Homebrew tap and the Docker (scaled-mode) stack are planned.

Shell script planned

Will detect your platform, download the matching static binary, verify its checksum, and put it on your PATH. Today it prints a pre-release notice.

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

Piping to a shell asks for trust. Read it first: the script is short and on GitHub, or download it, read it, then run it.

Cargo

If you have a Rust toolchain, build from source. No prebuilt binary in the trust path.

cargo install nuthatch

Homebrew planned

macOS and Linuxbrew, once a tap is published.

brew install nuthatch

Docker โ€” scaled mode planned

Embedded mode needs no Docker. The compose stack is for scaled mode โ€” where Postgres replaces the embedded hot store and DataFusion federates hot and cold behind one SQL surface. That mode, and this stack, are not built yet.

curl -fsSL https://nuthatch-indexer.com/docker-compose.yml -o docker-compose.yml && docker compose up

First run

Point it at a contract and go. Public RPC defaults; no key required.

nuthatch init 0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48 --chain mainnet
nuthatch dev

init writes a config, the resolved ABI, an llms.txt, and a Claude Code skill. dev follows the tip and serves entities, read-only SQL, balances, and MCP on one local endpoint.


Verify what you downloaded

Binaries ship with a SHA-256 checksum file and a detached signature. The shell script checks the sum for you; do it yourself for the other routes.

sha256sum -c nuthatch-<version>-<target>.tar.gz.sha256

Then verify the signature against the release signing key:

gpg --verify nuthatch-<version>-<target>.tar.gz.sig
Release signing key 0xNUTHATCH0000000000000000000000000000000

Placeholder until the first signed release. The key id and fingerprint will be published here and in the repository.