docs/install/nix.md
Install OpenClaw declaratively with nix-openclaw - the first-party, batteries-included Home Manager module.
<Info> The [nix-openclaw](https://github.com/openclaw/nix-openclaw) repo is the source of truth for Nix installation. This page is a quick overview. </Info>home-manager switch --rollbackSee the nix-openclaw README for full module options and examples.
When OPENCLAW_NIX_MODE=1 is set (automatic with nix-openclaw), OpenClaw enters a deterministic mode for Nix-managed installs. Other Nix packages can set the same mode; nix-openclaw is the first-party reference.
You can also set it manually:
export OPENCLAW_NIX_MODE=1
On macOS, the GUI app does not automatically inherit shell environment variables. Enable Nix mode via defaults instead:
defaults write ai.openclaw.mac openclaw.nixMode -bool true
openclaw.json is treated as immutable. Startup-derived defaults stay runtime-only, and config writers such as setup, onboarding, mutating openclaw update, plugin install/update/uninstall/enable, doctor --fix, doctor --generate-gateway-token, and openclaw config set refuse to edit the file.programs.openclaw.config or instances.<name>.config.OpenClaw reads JSON5 config from OPENCLAW_CONFIG_PATH and stores mutable data in OPENCLAW_STATE_DIR. When running under Nix, set these explicitly to Nix-managed locations so runtime state and config stay out of the immutable store.
| Variable | Default |
|---|---|
OPENCLAW_HOME | HOME / USERPROFILE / os.homedir() |
OPENCLAW_STATE_DIR | ~/.openclaw |
OPENCLAW_CONFIG_PATH | $OPENCLAW_STATE_DIR/openclaw.json |
The launchd/systemd gateway service auto-discovers Nix-profile binaries so
plugins and tools that shell out to nix-installed executables work without
manual PATH setup:
NIX_PROFILES is set, every entry is added to the service PATH in
right-to-left precedence (matches Nix shell precedence - rightmost wins).NIX_PROFILES is unset, ~/.nix-profile/bin is added as a fallback.This applies to both macOS launchd and Linux systemd service environments.