This install path is advanced and not part of the primary support path. Use Docker or Podman for a fully supported setup.
The recommended way to run gensparx with Nix is via nix-gensparx — a batteries-included Home Manager module.
Quick Start
Paste this to your AI agent (Claude, Cursor, etc.):
📦 Full guide: github.com/gensparx/nix-gensparx
The nix-gensparx repo is the source of truth for Nix installation. This page is just a quick overview.
What you get
- Gateway + macOS app + tools (whisper, spotify, cameras) — all pinned
- Launchd service that survives reboots
- Plugin system with declarative config
- Instant rollback:
home-manager switch --rollback
Nix Mode Runtime Behavior
When GENSPARX_NIX_MODE=1 is set (automatic with nix-gensparx):
gensparx supports a Nix mode that makes configuration deterministic and disables auto-install flows.
Enable it by exporting:
On macOS, the GUI app does not automatically inherit shell env vars. You can
also enable Nix mode via defaults:
Config + state paths
gensparx reads JSON5 config from GENSPARX_CONFIG_PATH and stores mutable data in GENSPARX_STATE_DIR.
When needed, you can also set GENSPARX_HOME to control the base home directory used for internal path resolution.
GENSPARX_HOME (default precedence: HOME / USERPROFILE / os.homedir())
GENSPARX_STATE_DIR (default: ~/.gensparx)
GENSPARX_CONFIG_PATH (default: $GENSPARX_STATE_DIR/gensparx.json)
When running under Nix, set these explicitly to Nix-managed locations so runtime state and config
stay out of the immutable store.
Runtime behavior in Nix mode
- Auto-install and self-mutation flows are disabled
- Missing dependencies surface Nix-specific remediation messages
- UI surfaces a read-only Nix mode banner when present
Packaging note (macOS)
The macOS packaging flow expects a stable Info.plist template at:
scripts/package-mac-app.sh copies this template into the app bundle and patches dynamic fields
(bundle ID, version/build, Git SHA, Sparkle keys). This keeps the plist deterministic for SwiftPM
packaging and Nix builds (which do not rely on a full Xcode toolchain).