> ## Documentation Index
> Fetch the complete documentation index at: https://zju-a00451d9-feat-personal-agent-team.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Nix

# Nix Installation

Install Velaclaw declaratively with **[nix-velaclaw](https://github.com/velaclaw/nix-velaclaw)** -- a batteries-included Home Manager module.

<Info>
  The [nix-velaclaw](https://github.com/velaclaw/nix-velaclaw) repo is the source of truth for Nix installation. This page is a quick overview.
</Info>

## 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`

## Quick Start

<Steps>
  <Step title="Install Determinate Nix">
    If Nix is not already installed, follow the [Determinate Nix installer](https://github.com/DeterminateSystems/nix-installer) instructions.
  </Step>

  <Step title="Create a local flake">
    Use the agent-first template from the nix-velaclaw repo:

    ```bash theme={null}
    mkdir -p ~/code/velaclaw-local
    # Copy templates/agent-first/flake.nix from the nix-velaclaw repo
    ```
  </Step>

  <Step title="Configure secrets">
    Set up your messaging bot token and model provider API key. Plain files at `~/.secrets/` work fine.
  </Step>

  <Step title="Fill in template placeholders and switch">
    ```bash theme={null}
    home-manager switch
    ```
  </Step>

  <Step title="Verify">
    Confirm the launchd service is running and your bot responds to messages.
  </Step>
</Steps>

See the [nix-velaclaw README](https://github.com/velaclaw/nix-velaclaw) for full module options and examples.

## Nix Mode Runtime Behavior

When `VELACLAW_NIX_MODE=1` is set (automatic with nix-velaclaw), Velaclaw enters a deterministic mode that disables auto-install flows.

You can also set it manually:

```bash theme={null}
export VELACLAW_NIX_MODE=1
```

On macOS, the GUI app does not automatically inherit shell environment variables. Enable Nix mode via defaults instead:

```bash theme={null}
defaults write ai.velaclaw.mac velaclaw.nixMode -bool true
```

### What changes 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

### Config and state paths

Velaclaw reads JSON5 config from `VELACLAW_CONFIG_PATH` and stores mutable data in `VELACLAW_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                                 |
| ---------------------- | --------------------------------------- |
| `VELACLAW_HOME`        | `HOME` / `USERPROFILE` / `os.homedir()` |
| `VELACLAW_STATE_DIR`   | `~/.velaclaw`                           |
| `VELACLAW_CONFIG_PATH` | `$VELACLAW_STATE_DIR/velaclaw.json`     |

## Related

* [nix-velaclaw](https://github.com/velaclaw/nix-velaclaw) -- full setup guide
* [Wizard](/start/wizard) -- non-Nix CLI setup
* [Docker](/install/docker) -- containerized setup