macOS 14+

Note

macOS 12 and 13 may work, but they are not officially supported.

  • Minimum Requirements

    • macOS 14 (Sonoma)

    • 4th Gen Intel® Core CPU or later

    • 8 GiB of RAM

  • Recommended

    • macOS 14 (Sonoma)

    • Apple M1 or later

    • 16 GiB of RAM

Installing Nix

Simply run this (entire) command in Terminal.app:

$ curl --proto '=https' --tlsv1.2 -fsSL https://artifacts.nixos.org/nix-installer | sh -s -- install--no-confirm --extra-conf "
    extra-substituters = https://nix-cache.fossi-foundation.org
    extra-trusted-public-keys = nix-cache.fossi-foundation.org:3+K59iFwXqKsL7BNu6Guy0v+uTlwsxYQxjspXzqLYQs=
    extra-experimental-features = nix-command flakes
"

Enter your password if prompted. This should take around 5 minutes.

Make sure to close all terminals after you’re done with this step.

If you already have Nix set up…

You will need to enable LibreLane’s Binary Cache manually, as well as the “experimental” nix-command and flakes features.

See https://github.com/fossi-foundation/nix-eda/blob/main/docs/installation.md for more info.

If you do know what this means, the values are as follows:

extra-substituters = https://nix-cache.fossi-foundation.org
extra-trusted-public-keys = nix-cache.fossi-foundation.org:3+K59iFwXqKsL7BNu6Guy0v+uTlwsxYQxjspXzqLYQs=
extra-experimental-features = nix-command flakes

Make sure to restart nix-daemon after updating /etc/nix/nix.conf.

$ sudo pkill nix-daemon

Cloning LibreLane

With git installed, just run the following:

$ git clone https://github.com/librelane/librelane

That’s it. Whenever you want to use LibreLane, nix-shell in the repository root directory and you’ll have a full LibreLane environment. The first time might take around 10 minutes while binaries are pulled from the cache.

To quickly test your installation, simply run librelane --smoke-test in the nix shell.