nh(1)

📦 version 4.4.2, in nixos 26.05, nixpkgs unstable

💖 NAME 💖

nh — Yet Another Nix Helper — and yes bestie, this is the nh(1) manual page 💅✨

✨ SYNOPSIS ✨

nh [-v|--verbose]... [-q|--quiet]... [-e|--elevation-strategy]
       [-h|--help] [-V|--version] <subcommands>

🦋 DESCRIPTION 🦋

Yet Another Nix Helper — that’s literally the description, and honestly? Iconic minimalism. No cap. 🎀

💅 OPTIONS 💅

Okay so the options section also opens with Yet Another Nix Helper, and then it gives you this usage line:

Usage: nh [OPTIONS] <COMMAND>

Here’s the global option vibe check 👑:

  • -v, --verbose — Increase logging verbosity. [default: 0]
  • -q, --quiet — Decrease logging verbosity. [default: 0]
  • -e, --elevation-strategy — Choose the privilege elevation strategy. It can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without password prompt for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec). [env: NH_ELEVATION_STRATEGY]
  • -h, --help — Print help (see a summary with '-h').
  • -V, --version — Print version.

🍓 SUBCOMMAND 🍓

This one is the NixOS functionality bestie 💜. It implements functionality mostly around but not exclusive to nixos-rebuild — iykyk.

Usage: os [OPTIONS] <COMMAND>

The os subcommand has these options:

  • -v, --verbose — Increase logging verbosity. [default: 0]
  • -q, --quiet — Decrease logging verbosity. [default: 0]
  • -e, --elevation-strategy — Choose the privilege elevation strategy. It can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without password prompt for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec). [env: NH_ELEVATION_STRATEGY]
  • -h, --help — Print help (see a summary with '-h').

🌈 SUBCOMMAND: switch 🌈

Build and activate the new configuration, and make it the boot default. Main character energy fr fr 👑🔥

Usage: switch [OPTIONS] [INSTALLABLE] [-- <EXTRA_ARGS>...]
  • -n, --dry — Only print actions, without performing them. [default: false]
  • -a, --ask — Ask for confirmation. [default: false]

🧚 Which installable to use 🧚

Nix accepts various kinds of installables:

  • [FLAKEREF[#ATTRPATH]] — Flake reference with an optional attribute path. [env: NH_FLAKE=] [env: NH_OS_FLAKE=] [env: NH_HOME_FLAKE=] [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — Path to file with an optional attribute path. [env: NH_FILE=] [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — Nix expression with an optional attribute path.
  • [PATH] — Path or symlink to a /nix/store path.

Now back to the switch option buffet 🍓:

  • --no-nom — Don't use nix-output-monitor for the build process. [default: false]
  • -o, --out-link — Path to save the result link, defaults to using a temporary directory.
  • -d, --diff — Whether to display a package diff. [default: auto]
  • -j, --max-jobs — Number of concurrent jobs Nix should run.
  • --cores — Number of cores Nix should utilize.
  • --log-format — Logging format used by Nix.
  • -k, --keep-going — Continue building despite encountering errors. [default: false]
  • -K, --keep-failed — Keep build outputs from failed builds. [default: false]
  • --fallback — Attempt to build locally if substituters fail. [default: false]
  • --repair — Repair corrupted store paths. [default: false]
  • --builders — Explicitly define remote builders.
  • -I, --include — Paths to include.
  • -L, --print-build-logs — Print build logs directly to stdout. [default: false]
  • -t, --show-trace — Display tracebacks on errors. [default: false]
  • --accept-flake-config — Accept configuration from flakes. [default: false]
  • --refresh — Refresh flakes to the latest revision. [default: false]
  • --impure — Allow impure builds. [default: false]
  • --offline — Build without internet access. [default: false]
  • --no-net — Prohibit network usage. [default: false]
  • --recreate-lock-file — Recreate the flake.lock file entirely. [default: false]
  • --no-update-lock-file — Do not update the flake.lock file. [default: false]
  • --no-write-lock-file — Do not write a lock file. [default: false]
  • --no-use-registries — Do not use registries. [default: false]
  • --no-registries — Do not use registries (deprecated, use --no-use-registries). [default: false]
  • --commit-lock-file — Commit the lock file after updates. [default: false]
  • -Q, --no-build-output — Suppress build output. [default: false]
  • --use-substitutes — Use substitutes when copying. [default: false]
  • --json — Output results in JSON format. [default: false]
  • --option — Set a Nix configuration option (may be given multiple times).
  • --override-input — Override a specific flake input (may be given multiple times).
  • -u, --update — Update all flake inputs. [default: false]
  • -U, --update-input — Update the specified flake input(s).
  • -H, --hostname — When using a flake installable, select this hostname from nixosConfigurations. When unspecified, defaults to the local hostname for local deployments, and hostname of the target machine for remote deployments (see --target-host).
  • -s, --specialisation — Explicitly select some specialisation.
  • -S, --no-specialisation — Ignore specialisations. [default: false]
  • --install-bootloader — Install bootloader for switch and boot commands. [default: false]

Extra arguments passed to nix build — yep, that’s the line, bestie 🫶.

  • -R, --bypass-root-check — Don't panic if calling nh as root. [env: NH_BYPASS_ROOT_CHECK] [default: false]
  • --target-host — Deploy the built configuration to a different host over SSH.
  • --build-host — Build the configuration on a different host over SSH.
  • --no-validate — Skip pre-activation system validation checks. [env: NH_NO_VALIDATE] [default: false]
  • --show-activation-logs — Show activation logs. [env: NH_SHOW_ACTIVATION_LOGS] [default: false]
  • -v, --verbose — Increase logging verbosity. [default: 0]
  • -q, --quiet — Decrease logging verbosity. [default: 0]
  • -e, --elevation-strategy — Choose the privilege elevation strategy. It can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without password prompt for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec). [env: NH_ELEVATION_STRATEGY]
  • -h, --help — Print help (see a summary with '-h').

🛠️ Build the new configuration and make it the boot default

Okay bestie, this is the glow-up moment: build the new config and make it the boot default. The usage is giving:

boot [OPTIONS] [INSTALLABLE] [-- <EXTRA_ARGS>...]
  • -n, --dry — only print actions, without performing them. [default: false] — literally just a vibe check, no actual changes 💅
  • -a, --ask — ask for confirmation before doing the thing. [default: false] — consent is key, periodt 🫶

Which installable to use. Nix accepts various kinds of installables, and yes you have options:

  • [FLAKEREF[#ATTRPATH]] — flake reference with an optional attribute path. Env options: [env: NH_FLAKE=], [env: NH_OS_FLAKE=], [env: NH_HOME_FLAKE=], [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — path to file with an optional attribute path. Env: [env: NH_FILE=], [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — Nix expression with an optional attribute path.
  • [PATH] — path or symlink to a /nix/store path
  • --no-nom — don't use nix-output-monitor for the build process. [default: false] — some of us just prefer the raw feed, no cap 😌
  • -o, --out-link — path to save the result link, defaults to using a temporary directory.
  • -d, --diff — whether to display a package diff. [default: auto] — the diff is lowkey iconic, you might wanna see it.
  • -j, --max-jobs — number of concurrent jobs Nix should run.
  • --cores — number of cores Nix should utilize.
  • --log-format — logging format used by Nix.
  • -k, --keep-going — continue building despite encountering errors. [default: false] — the "we don't stop, we keep going" energy fr fr.
  • -K, --keep-failed — keep build outputs from failed builds. [default: false] — for the forensic girlies 🔍
  • --fallback — attempt to build locally if substituters fail. [default: false] — backup plan activated.
  • --repair — repair corrupted store paths. [default: false] — store paths getting the spa treatment 💆
  • --builders — explicitly define remote builders.
  • -I, --include — paths to include.
  • -L, --print-build-logs — print build logs directly to stdout. [default: false] — no hiding the receipts.
  • -t, --show-trace — display tracebacks on errors. [default: false] — give me the whole story, not just the error.
  • --accept-flake-config — accept configuration from flakes. [default: false]
  • --refresh — refresh flakes to the latest revision. [default: false] — gotta stay fresh ✨
  • --impure — allow impure builds. [default: false] — chaotic energy, but make it intentional.
  • --offline — build without internet access. [default: false]
  • --no-net — prohibit network usage. [default: false]
  • --recreate-lock-file — recreate the flake.lock file entirely. [default: false] — full reset, no crumbs.
  • --no-update-lock-file — do not update the flake.lock file. [default: false]
  • --no-write-lock-file — do not write a lock file. [default: false]
  • --no-use-registries — do not use registries. [default: false]
  • --no-registries — do not use registries. [default: false] — ⚠️ deprecated, use --no-use-registries instead. She's retired but still in the chat.
  • --commit-lock-file — commit the lock file after updates. [default: false]
  • -Q, --no-build-output — suppress build output. [default: false] — silence is golden.
  • --use-substitutes — use substitutes when copying. [default: false]
  • --json — output results in JSON format. [default: false] — for the data girlies.
  • --option — set a Nix configuration option (may be given multiple times).
  • --override-input — override a specific flake input (may be given multiple times).
  • -u, --update — update all flake inputs. [default: false]
  • -U, --update-input — update the specified flake input(s).
  • -H, --hostname — when using a flake installable, select this hostname from nixosConfigurations. When unspecified, defaults to the local hostname for local deployments, and hostname of the target machine for remote deployments (see --target-host). — hostname selection is main character energy 👑
  • -s, --specialisation — explicitly select some specialisation.
  • -S, --no-specialisation — ignore specialisations. [default: false]
  • --install-bootloader — install bootloader for switch and boot commands. [default: false]
Extra arguments passed to nix build — yeah, you can pass those after the -- <EXTRA_ARGS>... in the usage line. Slay.
  • -R, --bypass-root-check — don't panic if calling nh as root. Env: [env: NH_BYPASS_ROOT_CHECK], [default: false]
  • --target-host — deploy the built configuration to a different host over SSH.
  • --build-host — build the configuration on a different host over SSH.
  • --no-validate — skip pre-activation system validation checks. Env: [env: NH_NO_VALIDATE], [default: false] — sometimes you just gotta skip the vibe check, but be careful bestie.
  • --show-activation-logs — show activation logs. Env: [env: NH_SHOW_ACTIVATION_LOGS], [default: false]
  • -v, --verbose — increase logging verbosity. [default: 0] — more tea, more details.
  • -q, --quiet — decrease logging verbosity. [default: 0] — shhh, she's resting.
  • -e, --elevation-strategy — choose the privilege elevation strategy. Can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without password prompt for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec). Env: [env: NH_ELEVATION_STRATEGY] — yes, -e shows up twice in this whole installable/elevation situation; I don't make the rules, I just report them 💀
  • -h, --help — print help (see a summary with -h). — help is always there for you 🫶

SUBCOMMAND</p> — test 💅

build and activate the new config, bestie — this is the whole main character moment ✨

Usage: test [OPTIONS] [INSTALLABLE] [-- <EXTRA_ARGS>...]

Like, it builds your new configuration and activates it. Both. Slay.

🎀 OPTIONS 🎀

  • -n, --dry — only print the actions, don't actually do them. window-shopping but for system rebuilds 🛍️
    • [default: false]
  • -a, --ask — ask for confirmation first. consent is iconic 🫶
    • [default: false]

🦋 Which installable to use 🦋

okay so Nix is lowkey flexible about what you hand it — it accepts various kinds of installables, and here's the whole menu:

  • [FLAKEREF[#ATTRPATH]] — a flake reference, with an optional attribute path tacked on. the classic.
    • [env: NH_FLAKE=]
    • [env: NH_OS_FLAKE=]
    • [env: NH_HOME_FLAKE=]
    • [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — path to a file, plus an optional attribute path.
    • [env: NH_FILE=]
    • [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — a Nix expression, plus an optional attribute path. raw expression energy ✍️
  • [PATH] — a path or symlink pointing to a /nix/store path 🗂️

🔥 THE REST OF THE FLAGS 🔥

  • --no-nom — don't use nix-output-monitor for the build process. no nom, no problem 😌
    • [default: false]
  • -o, --out-link — path to save the result link. defaults to using a temporary directory — very "I'll clean it up later, I promise" of it.
  • -d, --diff — whether to display a package diff 👀
    • [default: auto]
  • -j, --max-jobs — number of concurrent jobs Nix should run. go off, parallelism ✨
  • --cores — number of cores Nix should utilize 💪
  • --log-format — logging format used by Nix.
  • -k, --keep-going — keep building even when errors show up. unbothered, moisturized, in her lane 🌸
    • [default: false]
  • -K, --keep-failed — keep the build outputs from builds that failed. yes, we're keeping the receipts 🧾
    • [default: false]
  • --fallback — try to build locally if the substituters fail.
    • [default: false]
  • --repair — repair corrupted store paths 🩹
    • [default: false]
  • --builders — explicitly define remote builders. hi besties, build for me 🫶
  • -I, --include — paths to include.
  • -L, --print-build-logs — print build logs directly to stdout. no hiding 👀
    • [default: false]
  • -t, --show-trace — display tracebacks on errors. the full lore 😭
    • [default: false]
  • --accept-flake-config — accept configuration from flakes.
    • [default: false]
  • --refresh — refresh flakes to the latest revision. fresh out the oven 🍓
    • [default: false]
  • --impure — allow impure builds. living dangerously, ngl 💀
    • [default: false]
  • --offline — build without internet access.
    • [default: false]
  • --no-net — prohibit network usage entirely. airplane mode but make it Nix ✈️
    • [default: false]
  • --recreate-lock-file — recreate the flake.lock file entirely. scorched earth, periodt 🔥
    • [default: false]
  • --no-update-lock-file — do not update the flake.lock file.
    • [default: false]
  • --no-write-lock-file — do not write a lock file.
    • [default: false]
  • --no-use-registries — do not use registries.
    • [default: false]
  • --no-registries — do not use registries. ⚠️ deprecated — use --no-use-registries instead, bestie, she's old news.
    • [default: false]
  • --commit-lock-file — commit the lock file after updates. git commit but make it flake 📝
    • [default: false]
  • -Q, --no-build-output — suppress build output. quiet luxury 🤫
    • [default: false]
  • --use-substitutes — use substitutes when copying.
    • [default: false]
  • --json — output results in JSON format. for the machine besties 🖥️
    • [default: false]
  • --option — set a Nix configuration option. may be given multiple times! stack 'em up 🥞
  • --override-input — override a specific flake input. may be given multiple times! also stackable 🥞
  • -u, --update — update all flake inputs. everybody gets a glow-up 💖
    • [default: false]
  • -U, --update-input — update the specified flake input(s).
  • -H, --hostname — when using a flake installable, select this hostname from nixosConfigurations.
    • When it's unspecified, it defaults to the local hostname for local deployments, and to the hostname of the target machine for remote deployments (see --target-host). she picks for you, king 🫡
  • -s, --specialisation — explicitly select some specialisation.
  • -S, --no-specialisation — ignore specialisations.
    • [default: false]
  • --install-bootloader — install the bootloader for the switch and boot commands.
    • [default: false]

🌈 Extra args 🌈

Extra arguments passed to nix build.

You stick these after the -- in [-- <EXTRA_ARGS>...]. iykyk.

👑 Deployment & activation vibes 👑

  • -R, --bypass-root-check — don't panic if you're calling nh as root. no cap, she's just chill about it.
    • [env: NH_BYPASS_ROOT_CHECK]
    • [default: false]
  • --target-host — deploy the built configuration to a different host over SSH. long-distance relationship, but it works 🦋
  • --build-host — build the configuration on a different host over SSH. someone else does the heavy lifting 💅
  • --no-validate — skip the pre-activation system validation checks. bold. risky. valid tbh 🙈
    • [env: NH_NO_VALIDATE]
    • [default: false]
  • --show-activation-logs — show activation logs.
    • [env: NH_SHOW_ACTIVATION_LOGS]
    • [default: false]
  • -v, --verbose — increase logging verbosity. more words, more lore 🗣️
    • [default: 0]
  • -q, --quiet — decrease logging verbosity. less words, more peace 🤫
    • [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy, bestie. this is the important one ✨

It can be a path to an elevation program (e.g. /usr/bin/sudo), or one of these:

  • 'none' — no elevation at all
  • 'passwordless' — use elevation without a password prompt, for remote hosts with NOPASSWD configured
  • 'auto' — automatically detect available elevation programs, in this order: doas, sudo, run0, pkexec

Exactly in that order. no shuffling 🎯

  • [env: NH_ELEVATION_STRATEGY]
  • -h, --help — print help (see a summary with -h). our lord and saviour 🙏

🌸 SUBCOMMAND — build 🌸

bestie this is the one that actually builds your shiny new config 💅 it's giving main character energy fr fr

Usage:

build [OPTIONS] [INSTALLABLE] [-- <EXTRA_ARGS>...]
  • -n, --dry — just print the actions, don't do them. window shopping only 🛍️ [default: false]
  • -a, --ask — asks you for confirmation first, because consent is iconic 🫶 [default: false]

👑 which installable to use

Nix is lowkey flexible and accepts a whole bunch of installables, no cap:

  • [FLAKEREF[#ATTRPATH]] — a flake reference with an optional attribute path ✨
    • [env: NH_FLAKE=]
    • [env: NH_OS_FLAKE=]
    • [env: NH_HOME_FLAKE=]
    • [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — path to a file, with an optional attribute path
    • [env: NH_FILE=]
    • [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — a Nix expression, with an optional attribute path
  • [PATH] — a path or symlink to a /nix/store path 🗂️
  • --no-nom — don't use nix-output-monitor for the build process ngl [default: false]
  • -o, --out-link — path to save the result link — if you skip it, it defaults to using a temporary directory
  • -d, --diff — whether to display a package diff 👀 [default: auto]
  • -j, --max-jobs — how many concurrent jobs Nix should run
  • --cores — how many cores Nix should utilize
  • --log-format — the logging format used by Nix
  • -k, --keep-going — keep building even when errors show up, she's resilient 💪 [default: false]
  • -K, --keep-failed — keep the build outputs from failed builds [default: false]
  • --fallback — try to build locally if substituters fail [default: false]
  • --repair — repair corrupted store paths [default: false]
  • --builders — explicitly define remote builders
  • -I, --include — paths to include
  • -L, --print-build-logs — print build logs straight to stdout 📜 [default: false]
  • -t, --show-trace — display tracebacks on errors [default: false]
  • --accept-flake-config — accept configuration from flakes [default: false]
  • --refresh — refresh flakes to the latest revision 🌀 [default: false]
  • --impure — allow impure builds [default: false]
  • --offline — build without internet access 🚫🌐 [default: false]
  • --no-net — prohibit network usage [default: false]
  • --recreate-lock-file — recreate the flake.lock file entirely [default: false]
  • --no-update-lock-file — do not update the flake.lock file [default: false]
  • --no-write-lock-file — do not write a lock file [default: false]
  • --no-use-registries — do not use registries [default: false]
  • --no-registries — do not use registries — ⚠️ deprecated, use --no-use-registries instead [default: false]
  • --commit-lock-file — commit the lock file after updates [default: false]
  • -Q, --no-build-output — suppress build output 🤫 [default: false]
  • --use-substitutes — use substitutes when copying [default: false]
  • --json — output results in JSON format [default: false]
  • --option — set a Nix configuration option (may be given multiple times)
  • --override-input — override a specific flake input (may be given multiple times)
  • -u, --update — update all flake inputs 🔄 [default: false]
  • -U, --update-input — update the specified flake input(s)
  • -H, --hostname — when you're using a flake installable, select this hostname from nixosConfigurations

when unspecified, it defaults to the local hostname for local deployments, and to the hostname of the target machine for remote deployments (see --target-host) 🏠

  • -s, --specialisation — explicitly select some specialisation
  • -S, --no-specialisation — ignore specialisations [default: false]
  • --install-bootloader — install the bootloader for the switch and boot commands [default: false]

extra arguments passed to nix build — anything after the -- gets yeeted straight to nix build ✨

  • -R, --bypass-root-check — don't panic if you're calling nh as root 😱 [env: NH_BYPASS_ROOT_CHECK] [default: false]
  • --target-host — deploy the built configuration to a different host over SSH 🚀
  • --build-host — build the configuration on a different host over SSH
  • --no-validate — skip the pre-activation system validation checks [env: NH_NO_VALIDATE] [default: false]
  • -v, --verbose — increase logging verbosity [default: 0]
  • -q, --quiet — decrease logging verbosity [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy 👑

can be a path to an elevation program (e.g. /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without a password prompt, for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec) [env: NH_ELEVATION_STRATEGY]

  • -h, --help — print help (see a summary with -h)

🧚 SUBCOMMAND — repl 🧚

load the system in a repl, aka get your hands on it and poke around 🔍

Usage:

repl [OPTIONS] [INSTALLABLE]

🎀 which installable to use

Nix accepts various kinds of installables, iykyk:

  • [FLAKEREF[#ATTRPATH]] — a flake reference with an optional attribute path
    • [env: NH_FLAKE=]
    • [env: NH_OS_FLAKE=]
    • [env: NH_HOME_FLAKE=]
    • [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — path to a file, with an optional attribute path
    • [env: NH_FILE=]
    • [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — a Nix expression, with an optional attribute path
  • [PATH] — a path or symlink to a /nix/store path 🗂️
  • -H, --hostname — when using a flake installable, select this hostname from nixosConfigurations
  • -v, --verbose — increase logging verbosity [default: 0]
  • -q, --quiet — decrease logging verbosity [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy 👑

can be a path to an elevation program (e.g. /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without a password prompt, for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec) [env: NH_ELEVATION_STRATEGY]

  • -h, --help — print help (see a summary with -h)

🦋 SUBCOMMAND — info 🦋

lists the available generations from a profile path — it's literally the receipts of everything you've ever built 🧾✨

Usage:

info [OPTIONS]
  • -P, --profile — path to Nix' profiles directory [default: /nix/var/nix/profiles/system]
  • --fields — a comma-delimited list of field(s) to display 📋
  • -v, --verbose — increase logging verbosity [default: 0]
  • -q, --quiet — decrease logging verbosity [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy 👑

can be a path to an elevation program (e.g. /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without a password prompt, for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec) [env: NH_ELEVATION_STRATEGY]

  • -h, --help — print help (see a summary with -h)

💜 SUBCOMMAND — rollback 💜

rollback to a previous generation — the "oops bestie let's rewind" button ⏪😭

Usage:

rollback [OPTIONS]
  • -n, --dry — only print actions, without performing them [default: false]
  • -a, --ask — ask for confirmation [default: false]
  • -s, --specialisation — explicitly select some specialisation
  • -S, --no-specialisation — ignore specialisations [default: false]
  • -t, --to — rollback to a specific generation number (defaults to the previous generation) 🔢
  • -R, --bypass-root-check — don't panic if you're calling nh as root [env: NH_BYPASS_ROOT_CHECK] [default: false]
  • -d, --diff — whether to display a package diff [default: auto]
  • -v, --verbose — increase logging verbosity [default: 0]
  • -q, --quiet — decrease logging verbosity [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy 👑

can be a path to an elevation program (e.g. /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without a password prompt, for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec) [env: NH_ELEVATION_STRATEGY]

  • -h, --help — print help (see a summary with -h)

💅 SUBCOMMAND — build-vm: Build a NixOS VM image

okay bestie, this one's the vibe: you want a VM of your NixOS config, and nh is gonna build it for you ✨

Usage: build-vm [OPTIONS] [INSTALLABLE] [-- <EXTRA_ARGS>...]

🎀 the little options first

  • -n, --dry — only print the actions, don't actually do them. window shopping, basically. [default: false]
  • -a, --ask — ask for confirmation before doing stuff. consent era 🫶 [default: false]

🦋 Which installable to use.

Nix is lowkey flexible about what you hand it — it accepts various kinds of installables:

  • [FLAKEREF[#ATTRPATH]] — a flake reference with an optional attribute path. the classic. [env: NH_FLAKE=] [env: NH_OS_FLAKE=] [env: NH_HOME_FLAKE=] [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — path to file with an optional attribute path. [env: NH_FILE=] [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — a Nix expression with an optional attribute path.
  • [PATH] — path or symlink to a /nix/store path. straight to the source, iykyk 💀

🔥 the actual flags

  • --no-nom — don't use nix-output-monitor for the build process. [default: false]
  • -o, --out-link — path to save the result link, defaults to using a temporary directory.
  • -d, --diff — whether to display a package diff. [default: auto]
  • -j, --max-jobs — number of concurrent jobs Nix should run.
  • --cores — number of cores Nix should utilize.
  • --log-format — logging format used by Nix.
  • -k, --keep-going — continue building despite encountering errors. [default: false]
  • -K, --keep-failed — keep build outputs from failed builds. [default: false]
  • --fallback — attempt to build locally if substituters fail. [default: false]
  • --repair — repair corrupted store paths. [default: false]
  • --builders — explicitly define remote builders.
  • -I, --include — paths to include.
  • -L, --print-build-logs — print build logs directly to stdout. [default: false]
  • -t, --show-trace — display tracebacks on errors. [default: false]
  • --accept-flake-config — accept configuration from flakes. [default: false]
  • --refresh — refresh flakes to the latest revision. [default: false]
  • --impure — allow impure builds. [default: false]
  • --offline — build without internet access. [default: false]
  • --no-net — prohibit network usage. [default: false]
  • --recreate-lock-file — recreate the flake.lock file entirely. [default: false]
  • --no-update-lock-file — do not update the flake.lock file. [default: false]
  • --no-write-lock-file — do not write a lock file. [default: false]
  • --no-use-registries — do not use registries. [default: false]
  • --no-registries — do not use registries. ⚠️ deprecated, use --no-use-registries instead. [default: false]
  • --commit-lock-file — commit the lock file after updates. [default: false]
  • -Q, --no-build-output — suppress build output. [default: false]
  • --use-substitutes — use substitutes when copying. [default: false]
  • --json — output results in JSON format. [default: false]
  • --option — set a Nix configuration option (may be given multiple times).
  • --override-input — override a specific flake input (may be given multiple times).
  • -u, --update — update all flake inputs. [default: false]
  • -U, --update-input — update the specified flake input(s).
  • -H, --hostname — when using a flake installable, select this hostname from nixosConfigurations.

When unspecified, defaults to the local hostname for local deployments, and hostname of the target machine for remote deployments (see --target-host). 🫶

  • -s, --specialisation — explicitly select some specialisation.
  • -S, --no-specialisation — ignore specialisations. [default: false]
  • --install-bootloader — install bootloader for switch and boot commands. [default: false]

🌸 Extra arguments passed to nix build

that's the -- <EXTRA_ARGS>... part in the usage line — anything after -- gets yeeted straight at nix build. iconic.

  • -R, --bypass-root-check — don't panic if calling nh as root. [env: NH_BYPASS_ROOT_CHECK] [default: false]
  • --target-host — deploy the built configuration to a different host over SSH.
  • --build-host — build the configuration on a different host over SSH.
  • --no-validate — skip pre-activation system validation checks. [env: NH_NO_VALIDATE] [default: false]
  • -B, --with-bootloader — build with bootloader. bootloader is bypassed by default. [default: false]
  • -r, --run — run the VM immediately after building. [default: false] 🏃‍♀️💨
  • -v, --verbose — increase logging verbosity. [default: 0]
  • -q, --quiet — decrease logging verbosity. [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy. [env: NH_ELEVATION_STRATEGY]

can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without password prompt for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec). the main character of privilege escalation tbh 👑

  • -h, --help — print help (see a summary with '-h').

and yes, bestie, -e shows up twice in this list — once for --expr up in the installables, once for --elevation-strategy down here. that's just how the page is written, no cap 🫠

💅 SUBCOMMAND: build-image 💅

Bestie, this one builds you a NixOS disk-image variant. Like, an actual image. For a disk. Iconic behavior honestly ✨

Usage: build-image [OPTIONS] --image-variant <IMAGE_VARIANT>
[INSTALLABLE] [-- <EXTRA_ARGS>...]
  • -n, --dry — only prints what it would do, doesn't actually do it 🫶 (think of it as the vibe-check mode) [default: false]
  • -a, --ask — asks you for confirmation first, because consent is main character energy [default: false]

🌸 Which installable to use

Nix accepts various kinds of installables, and yes you should pick one:

  • [FLAKEREF[#ATTRPATH]] — a flake reference with an optional attribute path ✨
    • [env: NH_FLAKE=]
    • [env: NH_OS_FLAKE=]
    • [env: NH_HOME_FLAKE=]
    • [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — path to file with an optional attribute path 🎀
    • [env: NH_FILE=]
    • [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — a Nix expression with an optional attribute path 🦋
  • [PATH] — a path or symlink to a /nix/store path ⭐
💀 Heads up: -e shows up again way down the page for --elevation-strategy. Not me fixing it — I'm just the messenger, fr fr.
  • --no-nom — don't use nix-output-monitor for the build process [default: false]
  • -o, --out-link — path to save the result link; it defaults to using a temporary directory 🧚
  • -d, --diff — whether to display a package diff [default: auto]
  • -j, --max-jobs — number of concurrent jobs Nix should run 🔥
  • --cores — number of cores Nix should utilize
  • --log-format — logging format used by Nix
  • -k, --keep-going — keep building even when it hits errors, stubborn queen behavior [default: false]
  • -K, --keep-failed — keep the build outputs from failed builds [default: false]
  • --fallback — try building locally if substituters fail [default: false]
  • --repair — repair corrupted store paths [default: false]
  • --builders — explicitly define remote builders 👑
  • -I, --include — paths to include
  • -L, --print-build-logs — print build logs straight to stdout [default: false]
  • -t, --show-trace — display tracebacks on errors [default: false]
  • --accept-flake-config — accept configuration from flakes [default: false]
  • --refresh — refresh flakes to the latest revision [default: false]
  • --impure — allow impure builds (living dangerously, love that) [default: false]
  • --offline — build without internet access [default: false]
  • --no-net — prohibit network usage [default: false]
  • --recreate-lock-file — recreate the flake.lock file entirely [default: false]
  • --no-update-lock-file — do not update the flake.lock file [default: false]
  • --no-write-lock-file — do not write a lock file [default: false]
  • --no-use-registries — do not use registries [default: false]
  • --no-registries — do not use registries 🫠 deprecated, use --no-use-registries [default: false]
  • --commit-lock-file — commit the lock file after updates [default: false]
  • -Q, --no-build-output — suppress build output, shhh 🤫 [default: false]
  • --use-substitutes — use substitutes when copying [default: false]
  • --json — output results in JSON format [default: false]
  • --option — set a Nix configuration option (may be given multiple times) ✨
  • --override-input — override a specific flake input (may be given multiple times)
  • -u, --update — update all flake inputs [default: false]
  • -U, --update-input — update the specified flake input(s)
  • -H, --hostname — when using a flake installable, select this hostname from nixosConfigurations

When it's unspecified, it defaults to the local hostname for local deployments, and the hostname of the target machine for remote deployments (see --target-host). 🫶

  • -s, --specialisation — explicitly select some specialisation
  • -S, --no-specialisation — ignore specialisations [default: false]
  • --install-bootloader — install bootloader for switch and boot commands [default: false]
  • Extra arguments passed to nix build — you drop these after -- in the usage line 💜
  • -R, --bypass-root-check — don't panic if calling nh as root
    • [env: NH_BYPASS_ROOT_CHECK]
    • [default: false]
  • --target-host — deploy the built configuration to a different host over SSH 🌈
  • --build-host — build the configuration on a different host over SSH
  • --no-validate — skip pre-activation system validation checks 🙈
    • [env: NH_NO_VALIDATE]
    • [default: false]
  • --image-variant — image variant [required] ⚠️ yeah, this one is not optional, bestie
  • -v, --verbose — increase logging verbosity [default: 0]
  • -q, --quiet — decrease logging verbosity [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy 🎀

Can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without password prompt for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec)

  • [env: NH_ELEVATION_STRATEGY]
  • -h, --help — print help (see a summary with -h) ✨

🦋 SUBCOMMAND: home 🦋

Home-manager functionality. Yes, the whole home-manager situation lives here 💖

Usage: home [OPTIONS] <COMMAND>
  • -v, --verbose — increase logging verbosity [default: 0]
  • -q, --quiet — decrease logging verbosity [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy 👑

Can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without password prompt for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec)

  • [env: NH_ELEVATION_STRATEGY]
  • -h, --help — print help (see a summary with -h) 🫶

✨ SUBCOMMAND ✨

Okay bestie, this one is THE one. This is the subcommand that actually builds and activates your home-manager config. 💅 Literally the main character of the whole home-manager situation.

Usage: switch [OPTIONS] [INSTALLABLE] [-- <EXTRA_ARGS>...]
  • -n, --dry — only prints out what it would do, no actual doing 🫶 [default: false]
  • -a, --ask — asks you for confirmation before it goes off [default: false]

🌸 Which installable to use.

Nix is kinda flexible about what you hand it, ngl. It accepts various kinds of installables:

  • [FLAKEREF[#ATTRPATH]] — a flake reference with an optional attribute path 💖
    • [env: NH_FLAKE=]
    • [env: NH_OS_FLAKE=]
    • [env: NH_HOME_FLAKE=]
    • [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — path to a file, with an optional attribute path 📁
    • [env: NH_FILE=]
    • [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — a Nix expression, with an optional attribute path ✨
  • [PATH] — a path or a symlink pointing at a /nix/store path 🎀
  • --no-nom — don't use nix-output-monitor for the build process, like, at all [default: false]
  • -o, --out-link — the path where the result link gets saved; if you don't give one it defaults to using a temporary directory 🔗
  • -d, --diff — whether to display a package diff [default: auto]
  • -j, --max-jobs — how many concurrent jobs Nix should run 🏃‍♀️💨
  • --cores — how many cores Nix should utilize
  • --log-format — the logging format used by Nix
  • -k, --keep-going — keeps building even when it hits errors, stubborn queen behaviour [default: false]
  • -K, --keep-failed — keeps the build outputs from builds that failed [default: false]
  • --fallback — tries to build locally if the substituters fail [default: false]
  • --repair — repairs corrupted store paths 🩹 [default: false]
  • --builders — explicitly define your remote builders
  • -I, --include — paths to include
  • -L, --print-build-logs — prints build logs straight to stdout 📜 [default: false]
  • -t, --show-trace — displays tracebacks when errors happen [default: false]
  • --accept-flake-config — accepts configuration from flakes [default: false]
  • --refresh — refreshes flakes to the latest revision 🔄 [default: false]
  • --impure — allows impure builds [default: false]
  • --offline — builds with no internet access 🚫🌐 [default: false]
  • --no-net — prohibits network usage [default: false]
  • --recreate-lock-file — recreates the flake.lock file entirely, from scratch, no leftovers [default: false]
  • --no-update-lock-file — does not update the flake.lock file [default: false]
  • --no-write-lock-file — does not write a lock file at all [default: false]
  • --no-use-registries — does not use registries [default: false]
  • --no-registries — does not use registries (deprecated, use --no-use-registries) ⚠️ [default: false]
  • --commit-lock-file — commits the lock file after updates [default: false]
  • -Q, --no-build-output — suppresses build output 🤫 [default: false]
  • --use-substitutes — uses substitutes when copying [default: false]
  • --json — outputs results in JSON format [default: false]
  • --option — sets a Nix configuration option (may be given multiple times) 🔁
  • --override-input — overrides a specific flake input (may be given multiple times) 🔁
  • -u, --update — updates all flake inputs [default: false]
  • -U, --update-input — updates the specified flake input(s)
  • -c, --configuration — the name of the flake homeConfigurations attribute, like username@hostname

If you leave it unspecified, it'll try <username>@<hostname> and then <username> 💫

  • -s, --specialisation — explicitly selects some specialisation
  • -S, --no-specialisation — ignores specialisations [default: false]

🦋 Extra arguments passed to nix build

  • -b, --backup-extension — moves existing files out of the way by backing them up with this file extension 💾
  • --show-activation-logs — shows activation logs
    • [env: NH_SHOW_ACTIVATION_LOGS]
    • [default: false]
  • --build-host — builds the configuration on a different host over SSH 🌐
  • -v, --verbose — increases logging verbosity [default: 0]
  • -q, --quiet — decreases logging verbosity [default: 0]
  • -e, --elevation-strategy — chooses the privilege elevation strategy 👑

Can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without a password prompt, for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec)

  • [env: NH_ELEVATION_STRATEGY]
  • -h, --help — prints help (see a summary with '-h') 💖

✨ SUBCOMMAND ✨

And this one is the lowkey sibling — it just builds a home-manager configuration. Doesn't activate it. No cap. 🎀

Usage: build [OPTIONS] [INSTALLABLE] [-- <EXTRA_ARGS>...]
  • -n, --dry — only prints actions, without performing them [default: false]
  • -a, --ask — asks for confirmation [default: false]

🌸 Which installable to use.

Same deal as before — Nix accepts various kinds of installables:

  • [FLAKEREF[#ATTRPATH]] — a flake reference with an optional attribute path 💖
    • [env: NH_FLAKE=]
    • [env: NH_OS_FLAKE=]
    • [env: NH_HOME_FLAKE=]
    • [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — path to a file, with an optional attribute path 📁
    • [env: NH_FILE=]
    • [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — a Nix expression, with an optional attribute path ✨
  • [PATH] — a path or a symlink pointing at a /nix/store path 🎀
  • --no-nom — don't use nix-output-monitor for the build process [default: false]
  • -o, --out-link — the path where the result link gets saved; defaults to using a temporary directory 🔗
  • -d, --diff — whether to display a package diff [default: auto]
  • -j, --max-jobs — the number of concurrent jobs Nix should run 🏃‍♀️💨
  • --cores — the number of cores Nix should utilize
  • --log-format — the logging format used by Nix
  • -k, --keep-going — continues building despite encountering errors [default: false]
  • -K, --keep-failed — keeps build outputs from failed builds [default: false]
  • --fallback — attempts to build locally if substituters fail [default: false]
  • --repair — repairs corrupted store paths 🩹 [default: false]
  • --builders — explicitly define remote builders
  • -I, --include — paths to include
  • -L, --print-build-logs — prints build logs directly to stdout 📜 [default: false]
  • -t, --show-trace — displays tracebacks on errors [default: false]
  • --accept-flake-config — accepts configuration from flakes [default: false]
  • --refresh — refreshes flakes to the latest revision 🔄 [default: false]
  • --impure — allows impure builds [default: false]
  • --offline — builds without internet access 🚫🌐 [default: false]
  • --no-net — prohibits network usage [default: false]
  • --recreate-lock-file — recreates the flake.lock file entirely [default: false]
  • --no-update-lock-file — does not update the flake.lock file [default: false]
  • --no-write-lock-file — does not write a lock file [default: false]
  • --no-use-registries — does not use registries [default: false]
  • --no-registries — does not use registries (deprecated, use --no-use-registries) ⚠️ [default: false]
  • --commit-lock-file — commits the lock file after updates [default: false]
  • -Q, --no-build-output — suppresses build output 🤫 [default: false]
  • --use-substitutes — uses substitutes when copying [default: false]
  • --json — outputs results in JSON format [default: false]
  • --option — sets a Nix configuration option (may be given multiple times) 🔁
  • --override-input — overrides a specific flake input (may be given multiple times) 🔁
  • -u, --update — updates all flake inputs [default: false]
  • -U, --update-input — updates the specified flake input(s)
  • -c, --configuration — the name of the flake homeConfigurations attribute, like username@hostname

If it's unspecified, it'll try <username>@<hostname> and then <username> 💫

  • -s, --specialisation — explicitly selects some specialisation
  • -S, --no-specialisation — ignores specialisations [default: false]

🦋 Extra arguments passed to nix build

  • -b, --backup-extension — moves existing files by backing up with this file extension 💾
  • --show-activation-logs — shows activation logs
    • [env: NH_SHOW_ACTIVATION_LOGS]
    • [default: false]
  • --build-host — builds the configuration on a different host over SSH 🌐
  • -v, --verbose — increases logging verbosity [default: 0]
  • -q, --quiet — decreases logging verbosity [default: 0]
  • -e, --elevation-strategy — chooses the privilege elevation strategy 👑

Can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without a password prompt, for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec)

  • [env: NH_ELEVATION_STRATEGY]
  • -h, --help — prints help (see a summary with '-h') 💖

💅 SUBCOMMAND 💅

okay bestie, this one's the REPL one — you load a home-manager config into a Nix REPL and poke at it live. it's giving "science experiment but make it cute" 🧪✨

Load a home-manager configuration in a Nix REPL

Usage: repl [OPTIONS] [INSTALLABLE] [-- <EXTRA_ARGS>...]

🌸 Which installable to use 🌸

Nix is chill like that — it accepts a bunch of different kinds of installables:

  • [FLAKEREF[#ATTRPATH]] — a flake reference, with an optional attribute path tacked on. env vibes: [env: NH_FLAKE=], [env: NH_OS_FLAKE=], [env: NH_HOME_FLAKE=], [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — a path to a file, plus optional attribute path. env: [env: NH_FILE=], [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — a Nix expression, with an optional attribute path
  • [PATH] — a path (or symlink) to a /nix/store path

Then the actual flags, no cap:

  • -c, --configuration — the name of the flake homeConfigurations attribute, like username@hostname. If you don't specify it, it's gonna try <username>@<hostname> and then <username> 🫶

Extra arguments get passed straight to nix repl.

  • -v, --verbose — turn the logging up 📈 [default: 0]
  • -q, --quiet — turn the logging down 🤫 [default: 0]
  • -e, --elevation-strategy — pick your privilege elevation strategy. It can be a path to an elevation program (like /usr/bin/sudo), or one of: 'none' (no elevation at all), 'passwordless' (elevate without a password prompt — for remote hosts with NOPASSWD configured), or 'auto' (auto-detect whichever elevation programs are available, checking in this order: doas, sudo, run0, pkexec) 🔥 [env: NH_ELEVATION_STRATEGY]
  • -h, --help — print help (or use the summary version with -h) 💖

💜 SUBCOMMAND 💜

the mac girlies' section — Nix-darwin functionality. mostly darwin-rebuild stuff, but not exclusively, iykyk 🍎

Nix-darwin functionality

It implements functionality mostly around — but not exclusive to — darwin-rebuild.

Usage: darwin [OPTIONS] <COMMAND>
  • -v, --verbose — crank the logging verbosity up ⬆️ [default: 0]
  • -q, --quiet — dial the logging verbosity down ⬇️ [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy, bestie. Either a path to an elevation program (e.g. /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (elevation without a password prompt, for remote hosts with NOPASSWD set up), or 'auto' (automatically detect available elevation programs, in order: doas, sudo, run0, pkexec) 👑 [env: NH_ELEVATION_STRATEGY]
  • -h, --help — print help (see a summary with -h) ✨

🦋 SUBCOMMAND 🦋

THE main character move: build and activate a nix-darwin configuration. this is the one you came for 💅

Build and activate a nix-darwin configuration

Usage: switch [OPTIONS] [INSTALLABLE] [-- <EXTRA_ARGS>...]
  • -n, --dry — only print the actions, don't actually do them. look ma, no hands 🙈 [default: false]
  • -a, --ask — ask for confirmation first [default: false]

🎀 Which installable to use 🎀

Nix accepts various kinds of installables (yes, same menu as before, she's consistent):

  • [FLAKEREF[#ATTRPATH]] — flake reference with an optional attribute path. [env: NH_FLAKE=], [env: NH_OS_FLAKE=], [env: NH_HOME_FLAKE=], [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — path to a file with an optional attribute path. [env: NH_FILE=], [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — a Nix expression with an optional attribute path
  • [PATH] — path or symlink to a /nix/store path
  • --no-nom — don't use nix-output-monitor for the build process 🚫 [default: false]
  • -o, --out-link — path to save the result link; defaults to using a temporary directory
  • -d, --diff — whether to show a package diff [default: auto]
  • -j, --max-jobs — how many concurrent jobs Nix should run
  • --cores — how many cores Nix should use
  • --log-format — the logging format Nix uses
  • -k, --keep-going — keep building even when errors show up (iconic perseverance behavior) [default: false]
  • -K, --keep-failed — keep the build outputs from failed builds [default: false]
  • --fallback — try to build locally if the substituters fail [default: false]
  • --repair — repair corrupted store paths [default: false]
  • --builders — explicitly define remote builders
  • -I, --include — paths to include
  • -L, --print-build-logs — print build logs straight to stdout [default: false]
  • -t, --show-trace — display tracebacks on errors [default: false]
  • --accept-flake-config — accept configuration from flakes [default: false]
  • --refresh — refresh flakes to the latest revision [default: false]
  • --impure — allow impure builds (living dangerously, love that for you) [default: false]
  • --offline — build with no internet access [default: false]
  • --no-net — prohibit network usage entirely [default: false]
  • --recreate-lock-file — recreate the flake.lock file from scratch [default: false]
  • --no-update-lock-file — don't update the flake.lock file [default: false]
  • --no-write-lock-file — don't write a lock file at all [default: false]
  • --no-use-registries — don't use registries [default: false]
  • --no-registries — don't use registries (deprecated, use --no-use-registries instead, she's old news) [default: false]
  • --commit-lock-file — commit the lock file after updates [default: false]
  • -Q, --no-build-output — suppress build output [default: false]
  • --use-substitutes — use substitutes when copying [default: false]
  • --json — output results in JSON format [default: false]
  • --option — set a Nix configuration option (you can pass this multiple times)
  • --override-input — override a specific flake input (also repeatable)
  • -u, --update — update all flake inputs [default: false]
  • -U, --update-input — update the specified flake input(s)
  • -H, --hostname — when you're using a flake installable, pick this hostname out of darwinConfigurations 🏠

Extra arguments get passed along to nix build.

  • -R, --bypass-root-check — don't panic if nh is being called as root 🫶 [env: NH_BYPASS_ROOT_CHECK] [default: false]
  • --show-activation-logs — show the activation logs [env: NH_SHOW_ACTIVATION_LOGS] [default: false]
  • --build-host — build the configuration on a different host over SSH 🌐
  • -v, --verbose — increase logging verbosity [default: 0]
  • -q, --quiet — decrease logging verbosity [default: 0]
  • -e, --elevation-strategy — pick the privilege elevation strategy. Either a path to an elevation program (e.g. /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (elevate without a password prompt, for remote hosts with NOPASSWD configured), or 'auto' (auto-detect available elevation programs in order: doas, sudo, run0, pkexec) ⭐ [env: NH_ELEVATION_STRATEGY]
  • -h, --help — print help (see a summary with -h) 🌈

SUBCOMMAND

Build a nix-darwin configuration 🍎✨

Usage: build [OPTIONS] [INSTALLABLE] [-- <EXTRA_ARGS>...]
  • -n, --dry — only prints what it would do, doesn't actually do any of it. window shopping bestie 💅 [default: false]
  • -a, --ask — makes it ask you for confirmation first [default: false]

🎀 Which installable to use

Nix is, like, famously chill about what you hand it — it accepts various kinds of installables:

  • [FLAKEREF[#ATTRPATH]] — a flake reference with an optional attribute path.
    • [env: NH_FLAKE=]
    • [env: NH_OS_FLAKE=]
    • [env: NH_HOME_FLAKE=]
    • [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — path to a file, with an optional attribute path.
    • [env: NH_FILE=]
    • [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — a Nix expression, with an optional attribute path.
  • [PATH] — a path or symlink to a /nix/store path
  • --no-nom — please don't use nix-output-monitor for the build process, thanks [default: false]
  • -o, --out-link — path to save the result link; if you don't give one it defaults to using a temporary directory
  • -d, --diff — whether to display a package diff [default: auto]
  • -j, --max-jobs — number of concurrent jobs Nix should run
  • --cores — number of cores Nix should utilize
  • --log-format — logging format used by Nix
  • -k, --keep-going — keep building even when you hit errors, no thoughts just vibes [default: false]
  • -K, --keep-failed — keep the build outputs from failed builds [default: false]
  • --fallback — attempt to build locally if substituters fail [default: false]
  • --repair — repair corrupted store paths [default: false]
  • --builders — explicitly define remote builders
  • -I, --include — paths to include
  • -L, --print-build-logs — print build logs directly to stdout [default: false]
  • -t, --show-trace — display tracebacks on errors [default: false]
  • --accept-flake-config — accept configuration from flakes [default: false]
  • --refresh — refresh flakes to the latest revision [default: false]
  • --impure — allow impure builds 👀 [default: false]
  • --offline — build without internet access [default: false]
  • --no-net — prohibit network usage [default: false]
  • --recreate-lock-file — recreate the flake.lock file entirely [default: false]
  • --no-update-lock-file — do not update the flake.lock file [default: false]
  • --no-write-lock-file — do not write a lock file [default: false]
  • --no-use-registries — do not use registries [default: false]
  • --no-registries — do not use registries (deprecated, use --no-use-registries instead bestie) [default: false]
  • --commit-lock-file — commit the lock file after updates [default: false]
  • -Q, --no-build-output — suppress build output [default: false]
  • --use-substitutes — use substitutes when copying [default: false]
  • --json — output results in JSON format [default: false]
  • --option — set a Nix configuration option (may be given multiple times)
  • --override-input — override a specific flake input (may be given multiple times)
  • -u, --update — update all flake inputs [default: false]
  • -U, --update-input — update the specified flake input(s)
  • -H, --hostname — when using a flake installable, select this hostname from darwinConfigurations

Extra arguments passed to nix build — those go after the --, bestie 🫶

  • -R, --bypass-root-check — don't panic if calling nh as root
    • [env: NH_BYPASS_ROOT_CHECK]
    • [default: false]
  • --show-activation-logs — show activation logs
    • [env: NH_SHOW_ACTIVATION_LOGS]
    • [default: false]
  • --build-host — build the configuration on a different host over SSH 🌈
  • -v, --verbose — increase logging verbosity [default: 0]
  • -q, --quiet — decrease logging verbosity [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy.
    • Can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without password prompt for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec)
    • [env: NH_ELEVATION_STRATEGY]
  • -h, --help — print help (see a summary with -h)

SUBCOMMAND

Load a nix-darwin configuration in a Nix REPL 🧚‍♀️💜

Usage: repl [OPTIONS] [INSTALLABLE]

🌸 Which installable to use

Nix accepts various kinds of installables:

  • [FLAKEREF[#ATTRPATH]] — a flake reference with an optional attribute path.
    • [env: NH_FLAKE=]
    • [env: NH_OS_FLAKE=]
    • [env: NH_HOME_FLAKE=]
    • [env: NH_DARWIN_FLAKE=]
  • -f, --file <FILE> [ATTRPATH] — path to a file, with an optional attribute path.
    • [env: NH_FILE=]
    • [env: NH_ATTRP=]
  • -e, --expr <EXPR> [ATTRPATH] — a Nix expression, with an optional attribute path.
  • [PATH] — a path or symlink to a /nix/store path
  • -H, --hostname — when using a flake installable, select this hostname from darwinConfigurations
  • -v, --verbose — increase logging verbosity [default: 0]
  • -q, --quiet — decrease logging verbosity [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy.
    • Can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without password prompt for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec)
    • [env: NH_ELEVATION_STRATEGY]
  • -h, --help — print help (see a summary with -h)

SUBCOMMAND

Searches packages or NixOS/home-manager options via search.nixos.org, or a local SPAM database 🔎🦋

Usage: search [OPTIONS] [QUERY]... [COMMAND]
  • -l, --limit — number of search results to display [default: 30]
  • -c, --channel — name of the channel to query (e.g nixos-23.11, nixos-unstable, etc)
    • [env: NH_SEARCH_CHANNEL]
    • [default: nixos-unstable]
  • -P, --platforms — show supported platforms for each package
    • [env: NH_SEARCH_PLATFORM]
    • [default: false]
  • --backend-version — backend index version to query on search.nixos.org. Defaults to the version bundled with nh
    • [env: NH_SEARCH_BACKEND_VERSION]
  • --backend-version-fallbacks — number of newer index versions to try when the requested version is outdated (missing on the backend)
    • [env: NH_SEARCH_BACKEND_FALLBACKS]
    • [default: 1]
  • -j, --json — output results as JSON
    • [env: NH_SEARCH_JSON]
    • [default: false]
  • --default-search — default search mode used when no subcommand is given. Accepts packages or options (scope defaults to all)
    • [env: NH_DEFAULT_SEARCH]
    • [default: packages]

Query shorthand: equivalent to nh search packages <query> or nh search options <query> depending on --default-search — so you can literally just type your query and go ✨

  • -v, --verbose — increase logging verbosity [default: 0]
  • -q, --quiet — decrease logging verbosity [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy.
    • Can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without password prompt for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec)
    • [env: NH_ELEVATION_STRATEGY]
  • -h, --help — print help (see a summary with -h)

SUBCOMMAND

Search packages via search.nixos.org 📦💖

Usage: packages [OPTIONS] <QUERY>...
  • -l, --limit — number of search results to display [default: 30]
  • -c, --channel — name of the channel to query (e.g nixos-23.11, nixos-unstable, etc)
    • [env: NH_SEARCH_CHANNEL]
    • [default: nixos-unstable]
  • -P, --platforms — show supported platforms for each package
    • [env: NH_SEARCH_PLATFORM]
    • [default: false]
  • --backend-version — backend index version to query on search.nixos.org. Defaults to the version bundled with nh
    • [env: NH_SEARCH_BACKEND_VERSION]
  • --backend-version-fallbacks — number of newer index versions to try when the requested version is outdated (missing on the backend)
    • [env: NH_SEARCH_BACKEND_FALLBACKS]
    • [default: 1]

<QUERY>... — name of the package to search. [required] — yeah you actually have to tell it something bestie 😭

  • -j, --json — output results as JSON
    • [env: NH_SEARCH_JSON]
    • [default: false]
  • -v, --verbose — increase logging verbosity [default: 0]
  • -q, --quiet — decrease logging verbosity [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy.
    • Can be a path to an elevation program (e.g., /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation without password prompt for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs in order: doas, sudo, run0, pkexec)
    • [env: NH_ELEVATION_STRATEGY]
  • -h, --help — print help (see a summary with -h)

🌸 SUBCOMMAND 💅

✨ options — Search NixOS/home-manager options via search.nixos.org

Okay bestie, this is the one where you go "wait, what does that option even do" and nh just knows. It hits search.nixos.org for you. Iconic behavior honestly.

Usage: options [OPTIONS] <QUERY>...
  • -l, --limit — how many search results to show you. Default: 30. (Thirty is a lot, but we're nosy.)
  • -c, --channel — the name of the channel to query, like nixos-23.11, nixos-unstable, etc. Reads NH_SEARCH_CHANNEL from the env. Default: nixos-unstable.
  • --scope — which options scope you're searching: nixpkgs, home-manager, nix-darwin, or all (which is the default, because why choose).
  • --backend-version — the backend index version to query on search.nixos.org. Defaults to the version bundled with nh. Env: NH_SEARCH_BACKEND_VERSION.
  • --backend-version-fallbacks — how many newer index versions to try when the version you asked for is outdated (i.e. missing on the backend). Env: NH_SEARCH_BACKEND_FALLBACKS. Default: 1.
  • *QUERY*… (positional, required) — name of the option to search. Yeah, it's required, don't @ me.
  • -j, --json — output results as JSON. Env: NH_SEARCH_JSON. Default: false.
  • -v, --verbose — increase logging verbosity. Default: 0.
  • -q, --quiet — decrease logging verbosity. Default: 0.
  • -e, --elevation-strategy — choose the privilege elevation strategy. Env: NH_ELEVATION_STRATEGY.

It can be a path to an elevation program (e.g. /usr/bin/sudo), or one of: none (no elevation at all), passwordless (use elevation without a password prompt — for remote hosts with NOPASSWD configured), or auto (automatically detect available elevation programs in this order: doas, sudo, run0, pkexec).

  • -h, --help — print help (see a summary with -h).

🦋 SUBCOMMAND 💖

✨ offline — Search local SPAM database(s) without network access

Airplane mode queen energy ✈️ — this searches your local SPAM database(s), zero network required. No wifi, no problem.

Usage: offline [OPTIONS] --db <PATH> <QUERY>...
  • -l, --limit — number of search results to display. Default: 30.
  • -D, --db — path to a SPAM database file. Specify it multiple times to search across several databases. Env: NH_OFFLINE_DB. Required — no db, no search, sorry babe.
  • *QUERY*… (positional, required) — name of the package or option to search.
  • -j, --json — output results as JSON. Env: NH_SEARCH_JSON. Default: false.
  • -v, --verbose — increase logging verbosity. Default: 0.
  • -q, --quiet — decrease logging verbosity. Default: 0.
  • -e, --elevation-strategy — choose the privilege elevation strategy. Env: NH_ELEVATION_STRATEGY.

Can be a path to an elevation program (e.g. /usr/bin/sudo), or one of: none (no elevation), passwordless (use elevation without password prompt for remote hosts with NOPASSWD configured), or auto (automatically detect available elevation programs in order: doas, sudo, run0, pkexec).

  • -h, --help — print help (see a summary with -h).

🎀 SUBCOMMAND 🌈

✨ prs — Search Nixpkgs pull requests and branch reachability

Stalking PRs but make it cute 🕵️‍♀️ — this searches Nixpkgs pull requests and branch reachability.

Usage: prs [OPTIONS] <QUERY>...
  • -d, --days — search GitHub results updated in the last n days (default: 15).
  • *QUERY*… (positional, required) — pull request search query.
  • -j, --json — output results as JSON. Env: NH_SEARCH_JSON. Default: false.
  • -v, --verbose — increase logging verbosity. Default: 0.
  • -q, --quiet — decrease logging verbosity. Default: 0.
  • -e, --elevation-strategy — choose the privilege elevation strategy. Env: NH_ELEVATION_STRATEGY.

Can be a path to an elevation program (e.g. /usr/bin/sudo), or one of: none (no elevation), passwordless (use elevation without password prompt for remote hosts with NOPASSWD configured), or auto (automatically detect available elevation programs in order: doas, sudo, run0, pkexec).

  • -h, --help — print help (see a summary with -h).

🍓 SUBCOMMAND 💜

✨ issues — Search Nixpkgs issues, excluding pull requests

Same vibe as prs but for issues only — PRs are literally filtered out, we said not those.

Usage: issues [OPTIONS] <QUERY>...
  • -d, --days — search GitHub results updated in the last n days (default: 15).
  • *QUERY*… (positional, required) — issue search query.
  • -j, --json — output results as JSON. Env: NH_SEARCH_JSON. Default: false.
  • -v, --verbose — increase logging verbosity. Default: 0.
  • -q, --quiet — decrease logging verbosity. Default: 0.
  • -e, --elevation-strategy — choose the privilege elevation strategy. Env: NH_ELEVATION_STRATEGY.

Can be a path to an elevation program (e.g. /usr/bin/sudo), or one of: none (no elevation), passwordless (use elevation without password prompt for remote hosts with NOPASSWD configured), or auto (automatically detect available elevation programs in order: doas, sudo, run0, pkexec).

  • -h, --help — print help (see a summary with -h).

🧚 SUBCOMMAND ⭐

✨ clean — Enhanced nix cleanup

The glow-up version of nix cleanup ✨ It's a command with subcommands, so it needs its own <COMMAND> — you can't just yell clean into the void.

Usage: clean [OPTIONS] <COMMAND>
  • -v, --verbose — increase logging verbosity. Default: 0.
  • -q, --quiet — decrease logging verbosity. Default: 0.
  • -e, --elevation-strategy — choose the privilege elevation strategy. Env: NH_ELEVATION_STRATEGY.

Can be a path to an elevation program (e.g. /usr/bin/sudo), or one of: none (no elevation), passwordless (use elevation without password prompt for remote hosts with NOPASSWD configured), or auto (automatically detect available elevation programs in order: doas, sudo, run0, pkexec).

  • -h, --help — print help (see a summary with -h).

❄️ SUBCOMMAND 💀

✨ all — Clean all profiles

Everything. All of it. All the profiles 🔥 Same option list as user below, so don't be confused when it looks familiar.

Usage: all [OPTIONS]
  • -k, --keep — at least keep this number of generations. Default: 1.
  • -K, --keep-since — at least keep gcroots and generations in this time range since now. Default: 0h.

See the documentation of humantime for possible formats: <https://docs.rs/humantime/latest/humantime/fn.parse_duration.html>

  • -n, --dry — only print actions, without performing them. Default: false.
  • -a, --ask — ask for confirmation. Default: false.
  • --no-gc — don't run nix store --gc. Default: false.
  • --no-gcroots — don't clean gcroots. Default: false.
  • --no-direnv — don't clean direnv gcroots. Default: false.
  • --optimise — run nix-store --optimise after gc. Default: false.
  • --max — pass --max to nix store gc.
  • --keep-one — keep at least one gcroot per direnv project. Default: false.
  • -x, --cross-filesystems — cross filesystem boundaries when scanning gcroots. Default: false.
  • -v, --verbose — increase logging verbosity. Default: 0.
  • -q, --quiet — decrease logging verbosity. Default: 0.
  • -e, --elevation-strategy — choose the privilege elevation strategy. Env: NH_ELEVATION_STRATEGY.

Can be a path to an elevation program (e.g. /usr/bin/sudo), or one of: none (no elevation), passwordless (use elevation without password prompt for remote hosts with NOPASSWD configured), or auto (automatically detect available elevation programs in order: doas, sudo, run0, pkexec).

  • -h, --help — print help (see a summary with -h).

🌸 SUBCOMMAND 🫶

✨ user — Clean the current user's profiles

Just your profiles, main character that you are 👑 Not root's, not anybody else's — yours.

Usage: user [OPTIONS]
  • -k, --keep — at least keep this number of generations. Default: 1.
  • -K, --keep-since — at least keep gcroots and generations in this time range since now. Default: 0h.

See the documentation of humantime for possible formats: <https://docs.rs/humantime/latest/humantime/fn.parse_duration.html>

  • -n, --dry — only print actions, without performing them. Default: false.
  • -a, --ask — ask for confirmation. Default: false.
  • --no-gc — don't run nix store --gc. Default: false.
  • --no-gcroots — don't clean gcroots. Default: false.
  • --no-direnv — don't clean direnv gcroots. Default: false.
  • --optimise — run nix-store --optimise after gc. Default: false.
  • --max — pass --max to nix store gc.
  • --keep-one — keep at least one gcroot per direnv project. Default: false.
  • -x, --cross-filesystems — cross filesystem boundaries when scanning gcroots. Default: false.
  • -v, --verbose — increase logging verbosity. Default: 0.
  • -q, --quiet — decrease logging verbosity. Default: 0.
  • -e, --elevation-strategy — choose the privilege elevation strategy. Env: NH_ELEVATION_STRATEGY.

Can be a path to an elevation program (e.g. /usr/bin/sudo), or one of: none (no elevation), passwordless (use elevation without password prompt for remote hosts with NOPASSWD configured), or auto (automatically detect available elevation programs in order: doas, sudo, run0, pkexec).

  • -h, --help — print help (see a summary with -h).

🧹 Clean a specific profile

profile [OPTIONS] <PROFILE>

Alright bestie, this one cleans exactly one profile and nothing else — you point at it and it goes to work ✨

  • -k, --keep — at least keep this number of generations 💖 [default: 1]
  • -K, --keep-since — at least keep gcroots and generations in this time range since now. Check the humantime docs for the possible formats: <https://docs.rs/humantime/latest/humantime/fn.parse_duration.html> ⏳ [default: 0h]
  • -n, --dry — only print the actions, don't actually perform them (a little look-but-don't-touch moment 👀) [default: false]
  • -a, --ask — ask you for confirmation first, very considerate of it 🫶 [default: false]
  • --no-gc — don't run nix store --gc [default: false]
  • --no-gcroots — don't clean gcroots [default: false]
  • --no-direnv — don't clean direnv gcroots [default: false]
  • --optimise — run nix-store --optimise after gc, slay 💅 [default: false]
  • --max — pass --max through to nix store gc
  • --keep-one — keep at least one gcroot per direnv project [default: false]
  • -x, --cross-filesystems — cross filesystem boundaries when scanning gcroots [default: false]
  • <PROFILE> — which profile to clean — this one is required, no skipping it 🎀
  • -v, --verbose — increase logging verbosity [default: 0]
  • -q, --quiet — decrease logging verbosity [default: 0]
  • -e, --elevation-strategy — choose the privilege elevation strategy. It can be a path to an elevation program (like /usr/bin/sudo), or one of: 'none' (no elevation), 'passwordless' (use elevation with no password prompt, for remote hosts with NOPASSWD configured), or 'auto' (automatically detect available elevation programs, in this order: doas, sudo, run0, pkexec) 👑 [env: NH_ELEVATION_STRATEGY]
  • -h, --help — print help (see a summary with -h) 🙈

🚦 EXIT STATUS

  • 0 — successful program execution, we love a happy ending 💖
  • 1 — unsuccessful program execution 😭
  • 101 — the program panicked 💀

🌱 ENVIRONMENT

  • NH_NO_CHECKS — when set (any non-empty value), it skips startup checks like Nix version and experimental feature validation. Super useful for generating completions or running in constrained build environments ✨
  • NH_FLAKE — your preferred path/reference to a directory containing your flake.nix, used by NH when running flake-based commands. Historically it was called FLAKE; NH will migrate FLAKE into NH_FLAKE if it's present 🦋
  • NH_OS_FLAKE — command-specific flake reference for nh os commands. It takes precedence over NH_FLAKE 👑
  • NH_HOME_FLAKE — command-specific flake reference for nh home commands. Takes precedence over NH_FLAKE too 💅
  • NH_DARWIN_FLAKE — command-specific flake reference for nh darwin commands. Also takes precedence over NH_FLAKE 🍓
  • NH_FILE — preferred path to a directory/file containing a Nix expression. It gets chosen after the os/home/darwin-specific env vars, but before NH_FLAKE 🎀
  • NH_ATTRP — Nix attribute path for an expression specified with NH_FILE. For example, nixosConfigurations.<hostname> 🔥
  • NH_SUDO_ASKPASS — path to a program used as SUDO_ASKPASS when NH self-elevates with sudo 🧚
  • NH_PRESERVE_ENV — controls whether environment variables marked for preservation get passed to elevated commands. Set it to "0" to disable, "1" to force. If it's unset, it defaults to enabled 🌸
  • NH_SHOW_ACTIVATION_LOGS — controls whether activation output is displayed. By default activation output is hidden 👀 — set it to "1" and you get the full logs
  • NH_LOG — sets the tracing/log filter for NH, using tracing_subscriber format (e.g., nh=trace) ⭐
  • NH_NOM — control whether nix-output-monitor (nom) is enabled for build processes. Equivalent of --no-nom 🌈
  • NH_REMOTE_CLEANUP — whether to clean up remote processes on interrupt via pkill. It's opt-in because the behavior is fragile ⚠️
  • NH_SSHOPTS — SSH options for remote operations. Takes precedence over NIX_SSHOPTS, and accepts the same format as NIX_SSHOPTS 🔐
  • NH_SUDOOPTS — extra arguments inserted into the sudo invocation when NH elevates privileges. Takes precedence over NIX_SUDOOPTS ⚡
  • NIXOS_INSTALL_BOOTLOADER — forwarded to switch-to-configuration. If true, it forces bootloader installation. Also available via --install-bootloader 👟
  • NIXOS_NO_CHECK — forwarded to switch-to-configuration during activation. It inhibits certain NixOS service checks 🚧
  • NIX_SSHOPTS — SSH options passed to Nix commands for remote builds. NH_SSHOPTS takes precedence when both are set 🌐
  • NIX_SUDOOPTS — extra arguments inserted into the sudo invocation. Supported for nixos-rebuild compatibility; NH_SUDOOPTS takes precedence 💜
  • NIX_CONFIG — Nix configuration options passed to all Nix commands 🛠️
  • NIX_REMOTE — remote store configuration for Nix operations 📦
  • NIX_SSL_CERT_FILE — SSL certificate file for Nix HTTPS operations 🔒
  • NIX_USER_CONF_FILES — user configuration files for Nix 📂

🗂️ FILES

  • /nix/var/nix/profiles/system — system profile directory containing system generations 🏠
  • /run/current-system — symlink to the currently active system profile ⭐
  • /etc/specialisation — NixOS specialisation detection. It contains the active specialisation name 🎀

💫 EXAMPLES

Switch to a new NixOS configuration:

$ nh os switch --hostname myhost --specialisation dev

Rollback to a previous NixOS generation:

$ nh os rollback --to 42

Switch to a home-manager configuration:

$ nh home switch --configuration alice@work

Build a home-manager configuration with backup:

$ nh home build --backup-extension .bak

Switch to a darwin configuration:

$ nh darwin switch --hostname mymac

Search for ripgrep:

$ nh search ripgrep

Show supported platforms for a package:

$ nh search --platforms ripgrep

Clean all but keep 5 generations:

$ nh clean all --keep 5

Clean a specific profile:

$ nh clean profile /nix/var/nix/profiles/system

And that's the whole page, bestie — you made it to the end 🎉 You're officially an nh scholar now, no cap. This little masterpiece is the nh manual for nh 4.4.2, so if you ever need to flex your knowledge again, you know exactly where to look 💖✨👑

okay bye, go clean some generations, ily 🫶

📦 where this page comes from