OpenZFS on OS X

A macOS ZFS driver and utilities for managing ZFS storage, with filesystem mounts accessible in Finder.

CaskDrivers & HardwareApple silicon · Intel

Homepage

From homebrew/cask

30-day installs34#1060 in App

1-year installs1.8KLast 365 days

Latest version2.4.14 days ago · Oct 7

Download size—arm64 / x86_64 · pkg

Release cadenceIrregular0 releases in 30 days

System and architecture

System requirements: Not confirmed

Platform availability

macOS 27 · Intel · 2.4.1 Not confirmed
macOS 27 · Apple chip · 2.4.1 Not confirmed
macOS 26 · Intel · 2.4.1 Not confirmed
macOS 26 · Apple chip · 2.4.1 Not confirmed
macOS 15 · Intel · 2.4.1 Not confirmed
macOS 15 · Apple chip · 2.4.1 Not confirmed
macOS 14 · Intel · 2.4.1 Not confirmed
macOS 14 · Apple chip · 2.4.1 Not confirmed
macOS 13 · Intel · 2.3.1 Not confirmed
macOS 13 · Apple chip · 2.3.1 Not confirmed
macOS 12 · Intel · 2.4.1 Not confirmed
macOS 12 · Apple chip · 2.4.1 Not confirmed
macOS 11 · Intel · 2.3.1 Not confirmed

View full declaration

{
  "macos": {}
}

Tap: homebrew/cask
Also known as: OpenZFS on OS X · openzfs
Installer packages: OpenZFSonOsX-2.4.1-Tahoe.26-26.pkg
Download URL: github.com/openzfsonosx/openzfs-fork/releases/download/zfs-macOS-2.4.1/OpenZFSonOsX-2.4.1-Tahoe.26-26.pkg
SHA-256: 24c2867bcaaac770…
Homebrew definition: github.com/homebrew/homebrew-cask/blob/HEAD/Casks/o/openzfs.rb
formulae.brew.sh: formulae.brew.sh/cask/openzfs
Source code: github.com/openzfsonosx/openzfs-fork

Installation and removal contents

Uninstall uninstall_preflight_steps

View full declaration

{
  "uninstall_preflight_steps": [
    {
      "steps": [
        {
          "args": [
            "export",
            "-af"
          ],
          "command": {
            "path": "/usr/local/zfs/bin/zpool"
          },
          "guards": [
            {
              "condition": "if_exists",
              "id": "1",
              "path": "/dev/zfs"
            }
          ],
          "sudo": true,
          "type": "run"
        }
      ]
    }
  ]
}

Uninstall uninstall

View full declaration

{
  "uninstall": [
    {
      "launchctl": [
        "org.openzfsonosx.InvariantDisks",
        "org.openzfsonosx.zconfigd",
        "org.openzfsonosx.zed",
        "org.openzfsonosx.zpool-import",
        "org.openzfsonosx.zpool-import-all"
      ],
      "pkgutil": "org.openzfsonosx.zfs"
    }
  ]
}

Install pkg
Source file: OpenZFSonOsX-2.4.1-Tahoe.26-26.pkg
View full declaration
```
{
  "pkg": [
    "OpenZFSonOsX-2.4.1-Tahoe.26-26.pkg"
  ]
}
```
Install bash_completion
Source file: /etc/bash_completion.d/zfs
Declared destination: $HOMEBREW_PREFIX/etc/bash_completion.d/zfs
View full declaration
```
{
  "bash_completion": [
    "/etc/bash_completion.d/zfs"
  ],
  "target": "$HOMEBREW_PREFIX/etc/bash_completion.d/zfs"
}
```
Install bash_completion
Source file: /etc/bash_completion.d/zpool
Declared destination: $HOMEBREW_PREFIX/etc/bash_completion.d/zpool
View full declaration
```
{
  "bash_completion": [
    "/etc/bash_completion.d/zpool"
  ],
  "target": "$HOMEBREW_PREFIX/etc/bash_completion.d/zpool"
}
```

Install postflight_steps

View full declaration

{
  "postflight_steps": [
    {
      "steps": [
        {
          "paths": [
            {
              "path": "/usr/local/zfs"
            }
          ],
          "type": "set_ownership"
        }
      ]
    }
  ]
}

Remove user data zap

View full declaration

{
  "zap": [
    {
      "trash": [
        "~/Library/LaunchDaemons/org.openzfsonosx.InvariantDisks.plist",
        "~/Library/LaunchDaemons/org.openzfsonosx.zconfigd.plist",
        "~/Library/LaunchDaemons/org.openzfsonosx.zed.plist",
        "~/Library/LaunchDaemons/org.openzfsonosx.zpool-import-all.plist",
        "~/Library/LaunchDaemons/org.openzfsonosx.zpool-import.plist"
      ]
    }
  ]
}

Caveats

openzfs requires a kernel extension to work.
If the installation fails, retry after you enable it in:
  System Settings → Privacy & Security

For more information, refer to vendor documentation or this Apple Technical Note:
  https://developer.apple.com/library/content/technotes/tn2459/_index.html