Installation

PyNydus

Requires Python 3.10+.

pip install pynydus

Verify the installation:

nydus --help

You should see commands such as spawn, hatch, env, inspect, extract, diff, delete, keygen, push, pull, register, login, and logout.

Supported platforms

Platform	Spawn	Hatch
OpenClaw	Yes	Yes
ZeroClaw	Yes	Yes
Letta	Yes	Yes

Gitleaks (external)

Spawning with REDACT true (the default) requires gitleaks for secret scanning.

# macOS
brew install gitleaks

# Linux (replace VERSION with a current tag from the releases page)
VERSION=8.21.2
curl -sSL "https://github.com/gitleaks/gitleaks/releases/download/v${VERSION}/gitleaks_${VERSION}_linux_x64.tar.gz" \
  | tar xz -C /usr/local/bin gitleaks

# From source (requires Go 1.22+)
go install github.com/gitleaks/gitleaks/v8@latest

Verify: gitleaks version (v8.18+ recommended).

If the binary is not on $PATH, set NYDUS_GITLEAKS_PATH:

export NYDUS_GITLEAKS_PATH=/path/to/gitleaks

When is gitleaks needed?

Operation	Gitleaks required?
nydus spawn with REDACT true (default)	Yes
nydus spawn with REDACT false	No
nydus spawn with FROM only (no SOURCE)	No
nydus hatch	No
nydus env, inspect, extract, diff, delete, keygen, push, pull, register, login, logout	No

Optional: LLM refinement

To enable LLM-backed refinement during spawn and hatch, set two environment variables:

export NYDUS_LLM_TYPE=anthropic/claude-haiku-4-5-20251001
export NYDUS_LLM_API_KEY=sk-your-key

If both are unset, refinement is skipped (no error). See Configuration for all environment variables.

Next steps

Continue to the Quickstart to spawn and hatch your first Egg.