> ## Documentation Index
> Fetch the complete documentation index at: https://docs2.openclaw.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Nix

使用 **[nix-openclaw](https://github.com/openclaw/nix-openclaw)** 声明式安装 OpenClaw，这是官方、功能齐备的 Home Manager 模块。

<Info>
  [nix-openclaw](https://github.com/openclaw/nix-openclaw) 仓库是 Nix 安装的权威来源。此页面是快速概览。
</Info>

## 你将获得

* Gateway 网关 + macOS 应用 + 工具（whisper、spotify、cameras），全部固定版本
* 可在重启后继续运行的 launchd 服务
* 支持声明式配置的插件系统
* 即时回滚：`home-manager switch --rollback`

## 快速开始

<Steps>
  <Step title="安装 Determinate Nix">
    如果尚未安装 Nix，请按照 [Determinate Nix 安装器](https://github.com/DeterminateSystems/nix-installer)说明操作。
  </Step>

  <Step title="创建本地 flake">
    使用 nix-openclaw 仓库中的 agent-first 模板：

    ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
    mkdir -p ~/code/openclaw-local
    # Copy templates/agent-first/flake.nix from the nix-openclaw repo
    ```
  </Step>

  <Step title="配置密钥">
    设置你的消息 Bot token 和模型提供商 API key。放在 `~/.secrets/` 下的普通文件即可。
  </Step>

  <Step title="填入模板占位符并切换">
    ```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
    home-manager switch
    ```
  </Step>

  <Step title="验证">
    确认 launchd 服务正在运行，并且你的 Bot 会响应消息。
  </Step>
</Steps>

请参阅 [nix-openclaw README](https://github.com/openclaw/nix-openclaw)，了解完整模块选项和示例。

## Nix 模式运行时行为

设置 `OPENCLAW_NIX_MODE=1` 后（使用 nix-openclaw 时会自动设置），OpenClaw 会进入适用于 Nix 托管安装的确定性模式。其他 Nix 包也可以设置同一模式；nix-openclaw 是官方参考实现。

你也可以手动设置：

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
export OPENCLAW_NIX_MODE=1
```

在 macOS 上，GUI 应用不会继承 shell 环境变量。请改用 `defaults` 启用 Nix 模式：

```bash theme={"theme":{"light":"min-light","dark":"min-dark"}}
defaults write ai.openclaw.mac openclaw.nixMode -bool true
```

### Nix 模式下的变化

* 自动安装和自我变更流程会被禁用。
* `openclaw.json` 会被视为不可变。启动时派生的默认值只保留在运行时中，配置写入器（设置、新手引导、会变更配置的 `openclaw update`、插件安装/更新/卸载/启用、`doctor --fix`、`doctor --generate-gateway-token`、`openclaw config set`）会拒绝编辑该文件。
* 请改为编辑 Nix 源。对于 nix-openclaw，请使用 agent-first [快速开始](https://github.com/openclaw/nix-openclaw#quick-start)，并在 `programs.openclaw.config` 或 `instances.<name>.config` 下设置配置。
* 缺失依赖会显示 Nix 专用的修复提示。
* UI 会显示只读 Nix 模式横幅。

### 配置和状态路径

OpenClaw 从 `OPENCLAW_CONFIG_PATH` 读取 JSON5 配置，并将可变数据存储在 `OPENCLAW_STATE_DIR` 中。在 Nix 下，请将这些路径显式设置为 Nix 托管的位置，以便运行时状态和配置不会进入不可变存储。

| 变量                     | 默认值                                     |
| ---------------------- | --------------------------------------- |
| `OPENCLAW_HOME`        | `HOME` / `USERPROFILE` / `os.homedir()` |
| `OPENCLAW_STATE_DIR`   | `~/.openclaw`                           |
| `OPENCLAW_CONFIG_PATH` | `$OPENCLAW_STATE_DIR/openclaw.json`     |

### 服务 PATH 发现

launchd/systemd Gateway 网关服务会自动发现 Nix profile 二进制文件，因此需要 shell 调用 `nix` 安装的可执行文件的插件和工具无需手动设置 PATH 即可工作：

* 设置 `NIX_PROFILES` 时，每个条目都会按从右到左的优先级加入服务 PATH（与 Nix shell 优先级一致：最右侧优先）。
* 未设置 `NIX_PROFILES` 时，`~/.nix-profile/bin` 会作为 fallback 添加。

这同时适用于 macOS launchd 和 Linux systemd 服务环境。

## 相关内容

<CardGroup cols={2}>
  <Card title="nix-openclaw" href="https://github.com/openclaw/nix-openclaw" icon="arrow-up-right-from-square">
    权威的 Home Manager 模块和完整设置指南。
  </Card>

  <Card title="设置向导" href="/zh-CN/start/wizard" icon="wand-magic-sparkles">
    非 Nix CLI 设置演练。
  </Card>

  <Card title="Docker" href="/zh-CN/install/docker" icon="docker">
    作为非 Nix 替代方案的容器化设置。
  </Card>

  <Card title="更新" href="/zh-CN/install/updating" icon="arrow-up-right-from-square">
    随包一起更新 Home Manager 托管的安装。
  </Card>
</CardGroup>