nix-darwin

https://nix-darwin.github.io/nix-darwin/manual/
Admin
nix-darwin is a declarative configuration system for macOS that uses the Nix package manager to...
Tokens:27,085
Snippets:540
Trust Score:8.3
Update:1 month ago
Show doc for...
Tokens:
Raw
### AeroSpace Startup Command Example

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example of setting the default layout via startup commands.

```nix
[
  "layout tiles"
]
```

--------------------------------

### Default and example values for environment.defaultPackages

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

The default and example values for the environment.defaultPackages option.

```nix
[  ]
```

```nix
[ ]
```

--------------------------------

### System Path Configuration Example

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example of defining additional paths for the system documentation.

```nix
[
  "/share/doc"
]
```

--------------------------------

### Homebrew Casks Configuration Example

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example demonstrating how to define a list of casks with various configurations including custom arguments, greedy upgrades, and post-install commands.

```nix
# Adapted from https://docs.brew.sh/Brew-Bundle-and-Brewfile
[
  # `brew install --cask`
  "google-chrome"

  # `brew install --cask --appdir=~/my-apps/Applications`
  {
    name = "firefox";
    args = { appdir = "~/my-apps/Applications"; };
  }

  # always upgrade auto-updated or unversioned cask to latest version even if already installed
  {
    name = "opera";
    greedy = true;
  }

  # `brew install --cask`, run a post-install command on install or upgrade
  {
    name = "google-cloud-sdk";
    postinstall = "${HOMEBREW_PREFIX}/bin/gcloud components update";
  }
]
```

--------------------------------

### Fonts Packages Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default empty list and an example of installing fonts.

```nix
[ ]
```

```nix
[ pkgs.dejavu_fonts ]
```

--------------------------------

### nix.buildMachines hostName example

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example value for a build machine hostname.

```nix
"nixbuilder.example.org"
```

--------------------------------

### Universal Access Cursor Size Example

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example setting for the mouse cursor size.

```nix
1.5
```

--------------------------------

### Homebrew Tap Name Example

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example of specifying a tap name.

```nix
"apple/apple"
```

--------------------------------

### networking.domain Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example setting for the network domain.

```nix
null
```

```nix
"home.arpa"
```

--------------------------------

### launchd.user.agents inetdCompatibility Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example configuration for inetdCompatibility.

```nix
null
```

```nix
{
  Wait = true;
}
```

--------------------------------

### Set nixpkgs.system

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example of specifying the Nix platform type.

```nix
"x86_64-darwin"
```

--------------------------------

### AeroSpace Window Detection Example

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example configuration for window detection rules.

```nix
[
  {
    check-further-callbacks = false;
    "if" = {
      app-id = "Another.Cool.App";
      app-name-regex-substring = "CoolApp";
      during-aerospace-startup = false;
      window-title-regex-substring = "Title";
      workspace = "cool-workspace";
    };
    run = [
      "move-node-to-workspace m"
      "resize-node"
    ];
  }
]
```

--------------------------------

### Configure MachServices

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example configuration for registering Mach services.

```nix
{
  "org.nixos.service" = {
    ResetAtClose = true;
  };
}
```

--------------------------------

### networking.dns Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example list of DNS servers.

```nix
[ ]
```

```nix
[
  "8.8.8.8"
  "8.8.4.4"
  "2001:4860:4860::8888"
  "2001:4860:4860::8844"
]
```

--------------------------------

### Configure environment.extraOutputsToInstall

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default empty list and example configuration for extra package outputs.

```nix
[ ]
```

```nix
[
  "dev"
  "info"
]
```

--------------------------------

### Configure homebrew.goPackages

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Define a list of Go packages to install.

```nix
[ ]
```

```nix
[
  "github.com/charmbracelet/crush"
]
```

--------------------------------

### launchd.user.envVariables Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example setting for environment variables in launchd.

```nix
{ }
```

```nix
{
  LANG = "nl_NL.UTF-8";
}
```

--------------------------------

### AeroSpace Configuration Example

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example configuration for gaps and key bindings in AeroSpace.

```nix
{
  gaps = {
    outer.left = 8;
    outer.bottom = 8;
    outer.top = 8;
    outer.right = 8;
  };
  mode.main.binding = {
    alt-h = "focus left";
    alt-j = "focus down";
    alt-k = "focus up";
    alt-l = "focus right";
  };
}
```

--------------------------------

### Configure IOKit matching for launchd

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example configuration for matching IOKit devices.

```nix
{
  "com.apple.iokit.matching" = {
    "com.apple.usb.device" = {
      IOMatchLaunchStream = true;
      IOProviderClass = "IOUSBDevice";
      idProduct = "*";
      idVendor = "*";
    };
  };
}
```

--------------------------------

### AeroSpace Workspace Change Command Example

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example command to trigger sketchybar on workspace change.

```nix
[
  "/bin/bash"
  "-c"
  "sketchybar --trigger aerospace_workspace_change FOCUSED=$AEROSPACE_FOCUSED_WORKSPACE"
]
```

--------------------------------

### Newsyslog Files Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example configuration for newsyslog files.

```nix
{
  myapp = [
    {
      logfilename = "/var/log/myapp.log";
      owner = "myuser";
      group = "wheel";
      mode = "644";
      count = 7;
      size = "10M";
      flags = [ "Z" "C" ];
      pidFile = "/var/run/myapp.pid";
      signal = "USR1";
    }
  ];
  system = [
    {
      logfilename = "/var/log/system.log";
      mode = "644";
      count = 5;
      when = "@T00";
      flags = [ "Z" ];
    }
  ];
}
```

--------------------------------

### networking.computerName Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example setting for the system computer name.

```nix
null
```

```nix
"John’s MacBook Pro"
```

--------------------------------

### Configure ProcessType

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example setting for the ProcessType configuration key.

```nix
"Background"
```

--------------------------------

### System Packages Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default empty list and an example of adding packages to the system environment.

```nix
[ ]
```

```nix
[ pkgs.firefox pkgs.thunderbird ]
```

--------------------------------

### Configure inetdCompatibility for launchd agents

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example configuration for the inetdCompatibility submodule.

```nix
{
  Wait = true;
}
```

--------------------------------

### Configure nixpkgs.pkgs

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default value and example usage for the nixpkgs.pkgs option.

```nix
{ }
```

```nix
import <nixpkgs> {}
```

--------------------------------

### Configure launchd serviceConfig

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example of setting basic service configuration keys for a launchd agent.

```nix
{
  KeepAlive = true;
  Program = "/run/current-system/sw/bin/nix-daemon";
}
```

--------------------------------

### Configure networking.hostName

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default value and example for system hostname.

```nix
null
```

```nix
"Johns-MacBook-Pro"
```

--------------------------------

### Configure HardResourceLimits

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example of setting hard resource limits for a launchd agent.

```nix
{
  NumberOfFiles = 4096;
}
```

--------------------------------

### Configure networking.knownNetworkServices

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default value and example for configured network services.

```nix
[ ]
```

```nix
[
  "Wi-Fi"
  "Ethernet Adaptor"
  "Thunderbolt Ethernet"
]
```

--------------------------------

### networking.applicationFirewall Settings

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Configuration examples for enabling various application firewall features.

```nix
null
```

```nix
true
```

--------------------------------

### synergy service configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default values and example settings for the synergy client and server.

```nix
"pkgs.synergy"
```

```nix
false
```

```nix
true
```

```nix
""
```

```nix
"~/.synergy/SSL/Synergy.pem"
```

```nix
"/etc/synergy-server.conf"
```

--------------------------------

### Configure homebrew.masApps

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Define Mac App Store applications to install.

```nix
{ }
```

```nix
{
  "1Password for Safari" = 1569813296;
  Xcode = 497799835;
}
```

--------------------------------

### spotifyd service configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default values and example settings for the spotifyd service.

```nix
false
```

```nix
"pkgs.spotifyd"
```

```nix
null
```

```nix
{
  bitrate = 160;
  volume_normalisation = true;
}
```

--------------------------------

### Configure Homebrew Prefix

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the installation path for Homebrew, defaulting based on system architecture.

```nix
if pkgs.stdenv.hostPlatform.isAarch64 then "/opt/homebrew"
else "/usr/local"
```

--------------------------------

### Launchd Agent Environment Variables

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example of setting environment variables for a launchd agent.

```nix
{
  LANG = "nl_NL.UTF-8";
  PATH = "/foo/bar/bin";
}
```

--------------------------------

### Configure SSH knownHosts

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example configuration for system-wide known SSH hosts.

```nix
{
  myhost = {
    extraHostNames = [ "myhost.mydomain.com" "10.10.1.4" ];
    publicKeyFile = ./pubkeys/myhost_ssh_host_dsa_key.pub;
  };
  "myhost2.net".publicKey = "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAILIRuJ8p1Fi+m6WkHV0KWnRfpM1WxoW8XAS+XvsSKsTK";
  "myhost2.net/dsa" = {
    hostNames = [ "myhost2.net" ];
    publicKeyFile = ./pubkeys/myhost2_ssh_host_dsa_key.pub;
  };
}
```

```nix
{ }
```

--------------------------------

### Permissible Shells Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default empty list and an example of specifying allowed login shells.

```nix
[ ]
```

```nix
[ pkgs.bashInteractive pkgs.zsh ]
```

--------------------------------

### networking.dhcpClientId Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example setting for the DHCP client identifier.

```nix
null
```

```nix
"my-client-id"
```

--------------------------------

### AeroSpace Monitor Change Command Example

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default command for monitor focus changes.

```nix
[
  "move-mouse monitor-lazy-center"
]
```

--------------------------------

### Configure SSH publicKey

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example and default value for programs.ssh.knownHosts.<name>.publicKey.

```nix
"ecdsa-sha2-nistp521 AAAAE2VjZHN...UEPg=="
```

```nix
null
```

--------------------------------

### Buildkite Agent Extra Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example of adding extra configuration lines to the Buildkite agent.

```nix
"debug=true"
```

--------------------------------

### Homebrew User Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default user for Homebrew installation.

```nix
config.system.primaryUser
```

--------------------------------

### AutoSSH Session Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example of defining an AutoSSH session as a launchd daemon.

```nix
[
  {
    extraArguments = "-N -D4343 billremote@socks.host.net";
    monitoringPort = 20000;
    name = "socks-peer";
    user = "bill";
  }
]
```

--------------------------------

### Example environment hook configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Use this hook to export environment variables or secrets before build commands run. Note that contents are copied to the world-readable Nix store.

```nix
''
  export SECRET_VAR=`head -1 /run/keys/secret`
''
```

--------------------------------

### AutoSSH Session Metadata

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Examples for defining the session name and user.

```nix
"socks-peer"
```

```nix
"bill"
```

--------------------------------

### Configure Homebrew Formulae List

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Define a list of Homebrew formulae to install, supporting simple strings or complex attribute sets for advanced configuration.

```nix
[ ]
```

```nix
# Adapted from https://docs.brew.sh/Brew-Bundle-and-Brewfile
[
  # `brew install`
  "imagemagick"

  # `brew install --with-rmtp`, `brew services restart` on version changes
  {
    name = "denji/nginx/nginx-full";
    args = [ "with-rmtp" ];
    restart_service = "changed";
  }

  # `brew install`, always `brew services restart`, `brew link`, `brew unlink mysql` (if it is installed)
  {
    name = "mysql@5.6";
    restart_service = true;
    link = true;
    conflicts_with = [ "mysql" ];
  }

  # `brew install`, run a post-install command on version changes
  {
    name = "postgresql@16";
    postinstall = "${HOMEBREW_PREFIX}/opt/postgresql@16/bin/postgres -D ${HOMEBREW_PREFIX}/var/postgresql@16";
  }
]
```

--------------------------------

### Environment Variables Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default empty attribute set and an example of setting environment variables.

```nix
{ }
```

```nix
{
  EDITOR = "vim";
  LANG = "nl_NL.UTF-8";
}
```

--------------------------------

### AeroSpace Window Detection Commands

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example of defining commands to execute when window conditions are met in AeroSpace.

```nix
[
  "move-node-to-workspace m"
  "resize-node"
]
```

--------------------------------

### VSCode Extensions Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

List of VSCode extensions to install via Homebrew Bundle.

```nix
[ ]
```

```nix
[
  "golang.go"
]
```

--------------------------------

### Set default launchd environment variables

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example of setting environment variables for processes launched by launchd.

```nix
{
  LANG = "nl_NL.UTF-8";
}
```

--------------------------------

### GitLab Runner Registration Flags

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example configuration for passing custom command-line flags to the GitLab Runner registration process.

```nix
[
  "--docker-helper-image my/gitlab-runner-helper"
]
```

--------------------------------

### synapse-bt service configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default values and example settings for the Synapse BitTorrent daemon.

```nix
false
```

```nix
"pkgs.synapse-bt"
```

```nix
"/var/lib/synapse-bt"
```

```nix
"/var/lib/synapse-bt/downloads"
```

```nix
{ }
```

```nix
16384
```

--------------------------------

### Shell Aliases Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default empty attribute set and an example of mapping aliases to command strings.

```nix
{ }
```

```nix
{
  ll = "ls -l";
}
```

--------------------------------

### Configure Mac App Store management

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Settings for enabling mas and defining applications to install.

```nix
false
```

```nix
true
```

```nix
pkgs.mas
```

```nix
{ }
```

```nix
{
  Xcode = 497799835;
  "1Password for Safari" = 1569813296;
}
```

--------------------------------

### Configure Homebrew Cargo Packages

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies a list of Rust packages to install via cargo. The rust formula is installed automatically if missing.

```nix
[ ]
```

```nix
[
  "ripgrep"
]
```

--------------------------------

### Example agent tags configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Define agent tags as an attribute set to control job routing.

```nix
{
  docker = "true";
  queue = "default";
  ruby2 = "true";
}
```

--------------------------------

### Configure Homebrew Extra Flags

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Passes additional command-line flags to the brew bundle install process.

```nix
[ ]
```

```nix
[
  "--verbose"
]
```

--------------------------------

### Configure Homebrew Formula Arguments

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Set argument flags for brew install, excluding the leading double dashes.

```nix
null
```

--------------------------------

### AeroSpace Workspace Monitor Assignment

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example mapping workspaces to specific monitor patterns using various types.

```nix
{
  "1" = 1;
  "2" = "main";
  "3" = "secondary";
  "4" = "built-in";
  "5" = "^built-in retina display$";
  "6" = [
    "secondary"
    "dell"
  ];
}
```

--------------------------------

### Configure PostgreSQL initdb arguments

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Defines additional arguments passed to initdb during data directory initialization.

```nix
[
  "--data-checksums"
  "--allow-group-access"
]
```

--------------------------------

### Importing modules using modulesPath

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Demonstrates how to use the modulesPath argument to import additional modules from the nixpkgs tree.

```nix
{ modulesPath, ... }: {
  imports = [
    (modulesPath + "/profiles/minimal.nix")
  ];
}
```

--------------------------------

### Configure vim options

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Settings for enabling vim, sensible defaults, plugin management, and custom configuration files.

```nix
false
```

```nix
true
```

```nix
{ }
```

```nix
{
  vim-jsx = pkgs.vimUtils.buildVimPluginFrom2Nix {
    name = "vim-javascript-2016-07-29";
    src = pkgs.fetchgit {
      url = "git://github.com/mxw/vim-jsx";
      rev = "261114c925ea81eeb4db1651cc1edced66d6b5d6";
      sha256 = "17pffzwnvsimnnr4ql1qifdh4a0sqqsmcwfiqqzgglvsnzw5vpls";
    };
    dependencies = [];

  };
}
```

```nix
[ ]
```

```nix
[
  {
    names = [
      "surround"
      "vim-nix"
    ];
  }
]
```

```nix
""
```

```nix
"‹name›"
```

--------------------------------

### Configure extra PostgreSQL plugins

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Lists additional PostgreSQL plugins to include.

```nix
with pkgs.postgresql_11.pkgs; [ postgis pg_repack ]
```

--------------------------------

### system.startup.chime Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Controls the startup chime setting.

```nix
null
```

```nix
false
```

--------------------------------

### AutoSSH Monitoring Port

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example integer value for the peer monitoring port.

```nix
20000
```

--------------------------------

### Enable Homebrew Management

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Toggle the management of Homebrew packages and services.

```nix
false
```

```nix
true
```

--------------------------------

### chunkwm Tiling Plugin Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Optional configuration string for the tiling plugin.

```nix
"chunkc set global_desktop_mode   bsp"
```

--------------------------------

### Configure Zsh Prompt Initialization

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default command string for initializing the zsh prompt.

```nix
"autoload -U promptinit && promptinit && prompt suse && setopt prompt_sp"
```

--------------------------------

### Configure nixpkgs.config

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets global configuration for Nixpkgs. Ignored if nixpkgs.pkgs is set.

```nix
{ }
```

```nix
{ allowBroken = true; allowUnfree = true; }
```

--------------------------------

### Configure nixpkgs.buildPlatform

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the platform on which nix-darwin is built. Ignored if nixpkgs.pkgs is set.

```nix
config.nixpkgs.hostPlatform
```

```nix
{
  system = "x86_64-darwin";
}
```

--------------------------------

### AutoSSH Extra Arguments

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example string for passing arguments to AutoSSH and the underlying SSH process.

```nix
"-N -D4343 bill@socks.example.net"
```

--------------------------------

### Configure user description

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets a short description for the user account.

```nix
null
```

```nix
"Alice Q. User"
```

--------------------------------

### Configure nix.gc.options

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets options passed to nix-collect-garbage during automatic runs.

```nix
""
```

```nix
"--max-freed $((64 * 1024**3))"
```

--------------------------------

### Set multiple build machine system types

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Lists multiple system types the build machine can execute.

```nix
[
  "x86_64-linux"
  "aarch64-linux"
]
```

--------------------------------

### Configure Homebrew Cask Language Preference

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the preferred language codes for cask installations.

```nix
null
```

```nix
"zh-TW"
```

--------------------------------

### Configure PostgreSQL log line prefix

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets a printf-style string for log line prefixes.

```nix
"%m [%p] "
```

--------------------------------

### Set sleep idle time

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Example for disabling sleep using the "never" value.

```nix
"never"
```

--------------------------------

### chunkwm Plugins List

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

List of enabled chunkwm plugins.

```nix
[
  "border"
  "ffm"
  "tiling"
]
```

```nix
[
  "tiling"
]
```

--------------------------------

### Configure kwm package and settings

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default package and configuration settings for the kwm service.

```nix
"pkgs.kwm"
```

```nix
""
```

```nix
"kwmc rule owner=\"iTerm2\" properties={role=\"AXDialog\"}"
```

--------------------------------

### Configure nixpkgs.hostPlatform

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies the platform where the nix-darwin configuration will run.

```nix
{
  system = "aarch64-darwin";
}
```

--------------------------------

### Configure program packages

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default package definitions for various programs.

```nix
pkgs._1password-cli
```

```nix
pkgs._1password-gui
```

```nix
pkgs.arq
```

--------------------------------

### Ensure PostgreSQL databases exist

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Lists databases that should be ensured to exist.

```nix
[
  "gitea"
  "nextcloud"
]
```

--------------------------------

### Configure nix.linux-builder.workingDirectory

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the working directory for the Linux builder daemon process.

```nix
"/var/lib/linux-builder"
```

--------------------------------

### nix.package default

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default Nix package instance.

```nix
pkgs.nix
```

--------------------------------

### chunkwm Border Plugin Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Optional configuration string for the border plugin.

```nix
"chunkc set focused_border_color   0xffc0b18b"
```

--------------------------------

### Configure sandbox paths

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies additional host filesystem directories to include within the build sandbox.

```nix
[ ]
```

```nix
[
  "/dev"
  "/proc"
]
```

--------------------------------

### Configure nix-daemon service

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Settings for nix-daemon socket activation, logging, and temporary directory configuration.

```nix
false
```

```nix
null
```

```nix
"/var/log/nix-daemon.log"
```

--------------------------------

### Configure tmux options

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Settings for enabling sensible defaults, vim-style keybindings, iTerm2 integration, and custom configuration strings.

```nix
false
```

```nix
true
```

```nix
""
```

```nix
config.system.stateVersion <= 6 && config.programs.tmux.enableSensible
```

```nix
"‹name›"
```

--------------------------------

### Configure Dock Behavior

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Settings for Dock appearance, autohide behavior, and animation speeds.

```nix
null
```

```nix
0.24
```

```nix
1.0
```

--------------------------------

### Configure nix.linux-builder.systems

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies the system types the build machine can execute derivations on.

```nix
''
  The `nixpkgs.hostPlatform.system` of the build machine's final NixOS configuration.
''
```

```nix
[
  "x86_64-linux"
  "aarch64-linux"
]
```

--------------------------------

### Configure user shell

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the shell for the user account.

```nix
null
```

```nix
pkgs.bashInteractive
```

--------------------------------

### Configure environment.etc text

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default empty text value for environment.etc files.

```nix
""
```

--------------------------------

### Configure Mopidy service

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Options for enabling Mopidy, specifying the package, and configuring media keys support.

```nix
false
```

```nix
"pkgs.mopidy"
```

```nix
"pkgs.pythonPackages.osxmpdkeys"
```

--------------------------------

### Configure nix.linux-builder.package

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies the package to use for the Linux builder.

```nix
"pkgs.darwin.linux-builder"
```

--------------------------------

### Configure trusted root certificate files

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specify paths to PEM-formatted certificate files to be included in the system trust store.

```nix
[ ]
```

```nix
[ "${pkgs.cacert}/etc/ssl/certs/ca-bundle.crt" ]
```

--------------------------------

### Configure environment.pathsToLink

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default empty list of directories to symlink.

```nix
[ ]
```

--------------------------------

### Configure nix.extraOptions

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Appends additional text to the nix.conf file.

```nix
""
```

```nix
''
  keep-outputs = true
  keep-derivations = true
''
```

--------------------------------

### Configure khd package

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the package used for the khd service.

```nix
"pkgs.khd"
```

--------------------------------

### Configure nix.linux-builder.protocol

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the communication protocol for the build machine.

```nix
"ssh-ng"
```

```nix
"ssh"
```

--------------------------------

### Configure nix.linux-builder.supportedFeatures

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Defines a list of features supported by the Linux builder.

```nix
[ "kvm" "benchmark" "big-parallel" ]
```

```nix
[ "kvm" "big-parallel" ]
```

--------------------------------

### Default value for documentation.enable

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

The default value for the documentation.enable option.

```nix
true
```

--------------------------------

### Configure nixpkgs.overlays

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Defines a list of overlays to modify the Nixpkgs package set.

```nix
[ ]
```

```nix
[
  (self: super: {
    openssh = super.openssh.override {
      hpnSupport = true;
      kerberos = self.libkrb5;
    };
  })
]
```

--------------------------------

### Configure Dock Folder Show Effect

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the animation effect used when clicking a folder in the Dock.

```nix
"automatic"
```

--------------------------------

### Configure Karabiner-Elements package

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the package used for Karabiner-Elements.

```nix
pkgs.karabiner-elements
```

--------------------------------

### Configure Dock Folder Display

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Determines whether the folder appears as a stack of previews or a standard folder icon.

```nix
"stack"
```

--------------------------------

### Configure Netdata service

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Settings for enabling Netdata, defining directories, and custom configuration.

```nix
false
```

```nix
true
```

```nix
pkgs.netdata
```

```nix
"/var/cache/netdata"
```

```nix
""
```

```nix
"/var/log/netdata"
```

```nix
"/var/lib/netdata"
```

--------------------------------

### Define supported build machine features

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Lists features supported by the builder; derivations requiring other features will ignore this machine.

```nix
[
  "kvm"
  "big-parallel"
]
```

--------------------------------

### Configure homebrew.extraConfig

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Add extra lines to the generated Brewfile.

```nix
""
```

```nix
''
  # 'brew cask install' only if '/usr/libexec/java_home --failfast' fails
  cask "java" unless system "/usr/libexec/java_home --failfast"
''
```

--------------------------------

### Configure ofborg service

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Settings for the ofborg builder service.

```nix
false
```

```nix
pkgs.ofborg
```

```nix
"/var/log/ofborg.log"
```

--------------------------------

### Default runtime packages

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

The default set of packages available in the agent environment.

```nix
[ pkgs.bash pkgs.gnutar pkgs.gzip pkgs.git pkgs.nix ]
```

--------------------------------

### Configure GitHub Runners

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Configuration for multiple GitHub Runners.

```nix
{ }
```

```nix
{
  runner1 = {
    enable = true;
    name = "runner1";
    tokenFile = "/secrets/token1";
    url = "https://github.com/owner/repo";
  };
  runner2 = {
    enable = true;
    name = "runner2";
    tokenFile = "/secrets/token2";
    url = "https://github.com/owner/repo";
  };
}
```

--------------------------------

### Configure NSGlobalDomain Spring Loading Delay

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the spring loading delay for directories.

```nix
null
```

```nix
1.0
```

--------------------------------

### wg-quick logDir default

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default directory for wg-quick logs.

```nix
"/var/log"
```

--------------------------------

### Configure Homebrew Taps

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Define formula repositories to tap, including support for custom Git clone targets.

```nix
[
  # `brew tap`
  "apple/apple"

  # `brew tap` with custom Git URL and arguments
  {
    name = "user/tap-repo";
    clone_target = "https://user@bitbucket.org/user/homebrew-tap-repo.git";
    force_auto_update = true;
  }
]
```

--------------------------------

### Yabai Window Manager Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Options for enabling Yabai, scripting additions, and setting configuration parameters.

```nix
<derivation yabai-7.1.25>
```

```nix
{
  focus_follows_mouse = "autoraise";
  mouse_follows_focus = "off";
  window_placement    = "second_child";
  window_opacity      = "off";
  top_padding         = 36;
  bottom_padding      = 10;
  left_padding        = 10;
  right_padding       = 10;
  window_gap          = 10;
}
```

```nix
yabai -m rule --add app='System Preferences' manage=off
```

--------------------------------

### Configure StartCalendarInterval

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Defines a calendar-based schedule for job execution using a list of attrsets.

```nix
[
  {
    Hour = 2;
    Minute = 30;
  }
]
```

--------------------------------

### User Launch Agents Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default values for user launch agent settings including enable, target, and text.

```nix
{ }
```

```nix
true
```

```nix
"‹name›"
```

```nix
""
```

--------------------------------

### Configure nix.registry.<name>.to

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies the flake reference that the 'from' reference is rewritten to.

```nix
{ }
```

```nix
{
  owner = "my-org";
  repo = "my-nixpkgs";
  type = "github";
}
```

--------------------------------

### Configure nixpkgs.flake.source

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies the path to the nixpkgs sources used to build the system.

```nix
"if (using nix-darwin.lib.darwinSystem) then nixpkgs.source else null"
```

```nix
"builtins.fetchTarball { name = \"source\"; sha256 = \"sha256-AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=\"; url = \"https://github.com/nixos/nixpkgs/archive/somecommit.tar.gz\"; }"
```

--------------------------------

### Configure fish shell options

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default values for fish shell configuration settings.

```nix
false
```

```nix
pkgs.fish
```

```nix
<derivation babelfish-1.2.1>
```

```nix
""
```

```nix
{ }
```

```nix
{
  gco = "git checkout";
  npu = "nix-prefetch-url";
}
```

```nix
true
```

--------------------------------

### Configure nix.nixPath

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Defines the default Nix expression search path.

```nix
lib.optionals cfg.channel.enable [
  # Include default path <darwin-config>.
  { darwin-config = "${config.environment.darwinConfig}"; }
  "/nix/var/nix/profiles/per-user/root/channels"
]
```

--------------------------------

### Configure StartCalendarInterval

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Defines calendar-based job scheduling intervals.

```nix
null
```

```nix
[
  {
    Hour = 2;
    Minute = 30;
  }
]
```

--------------------------------

### Configure Bash Settings

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default settings for bash configuration options.

```nix
true
```

```nix
false
```

```nix
pkgs.bash-completion
```

```nix
""
```

--------------------------------

### Configure PostgreSQL settings

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets PostgreSQL configuration parameters. String values are automatically quoted and escaped.

```nix
{
  log_connections = true;
  log_statement = "all";
  logging_collector = true
  log_disconnections = true
  log_destination = lib.mkForce "syslog";
}
```

--------------------------------

### Default value for _module.args

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

The default value for the _module.args option.

```nix
{ }
```

--------------------------------

### Configure user permissions

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets specific database permissions for a user.

```nix
{
  "DATABASE \"nextcloud\"" = "ALL PRIVILEGES";
  "ALL TABLES IN SCHEMA public" = "ALL PRIVILEGES";
}
```

--------------------------------

### chunkwm Package

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies the chunkwm package to use.

```nix
pkgs.chunkwm
```

--------------------------------

### Configure nix.linux-builder.mandatoryFeatures

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets a list of features mandatory for the Linux builder.

```nix
[]
```

```nix
[ "big-parallel" ]
```

--------------------------------

### Configure GnuPG options

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default values for GnuPG package and agent settings.

```nix
pkgs.gnupg
```

```nix
false
```

--------------------------------

### Configure nix.linux-builder.config

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies extra NixOS configuration for the Linux builder.

```nix
{ }
```

```nix
({ pkgs, ... }:

{
  environment.systemPackages = [ pkgs.neovim ];
})
```

--------------------------------

### Spacebar Service Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Configuration options for the spacebar service.

```nix
false
```

```nix
<derivation spacebar-1.4.0>
```

```nix
{ }
```

```nix
{
  clock_format     = "%R";
  background_color = "0xff202020";
  foreground_color = "0xffa8a8a8";
}
```

```nix
""
```

```nix
echo "spacebar config loaded..."
```

--------------------------------

### Configure Zsh Global CompInit

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default value for executing compinit in interactive shells.

```nix
config.programs.zsh.enableCompletion
```

--------------------------------

### Configure eternal-terminal service

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Settings for the Eternal Terminal server.

```nix
false
```

```nix
true
```

```nix
"pkgs.eternal-terminal"
```

```nix
20971520
```

```nix
2022
```

```nix
false
```

```nix
0
```

--------------------------------

### Configure networking.fqdnOrHostName

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default logic for determining FQDN or hostname.

```nix
if cfg.domain == null then cfg.hostName else cfg.fqdn
```

--------------------------------

### Configure Homebrew Cask Arguments

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets global arguments for all casks listed in homebrew.casks.

```nix
{ }
```

```nix
{
  appdir = "~/Applications";
  require_sha = true;
}
```

--------------------------------

### Configure Privoxy settings

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Defines the configuration string for the Privoxy service.

```nix
"forward / upstream.proxy:8080"
```

--------------------------------

### time.timeZone Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the system time zone.

```nix
null
```

```nix
"America/New_York"
```

--------------------------------

### Configure nix.linux-builder.maxJobs

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the number of concurrent jobs the Linux builder supports.

```nix
''
  The `virtualisation.cores` of the build machine's final NixOS configuration.
''
```

```nix
2
```

--------------------------------

### Set nix-index package

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default value for programs.nix-index.package.

```nix
"pkgs.nix-index"
```

--------------------------------

### Configure Privoxy package

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies the package to use for the Privoxy service.

```nix
pkgs.privoxy
```

--------------------------------

### Configure emacs daemon

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Settings for enabling and configuring the Emacs daemon.

```nix
false
```

```nix
<derivation emacs-30.2>
```

```nix
[ ]
```

```nix
[
  "/Users/my_user_name"
]
```

```nix
"emacs"
```

--------------------------------

### Set custom system preferences

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Allows defining arbitrary system preferences using a nested attribute set structure.

```nix
{
  NSGlobalDomain = {
    TISRomanSwitchState = 1;
  };
  "com.apple.Safari" = {
    "com.apple.Safari.ContentPageGroupIdentifier.WebKit2DeveloperExtrasEnabled" = true;
  };
}
```

--------------------------------

### Configure trusted binary cache substituters

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Lists additional binary cache URLs accessible by non-root users.

```nix
[ ]
```

```nix
[
  "https://hydra.nixos.org/"
]
```

--------------------------------

### Configure environment.etc target

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default value for the target symlink name in environment.etc.

```nix
"‹name›"
```

--------------------------------

### Configure Node.js Runtimes

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies the supported Node.js versions for the runner.

```nix
[
  "node24"
]
```

--------------------------------

### Configure GitLab Runner Docker volumes

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Bind-mount volumes into the container.

```nix
[
  "/var/run/docker.sock:/var/run/docker.sock"
]
```

--------------------------------

### Configure Dock Folder Arrangement

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Sets the sort order for files within a folder added to the Dock.

```nix
"name"
```

--------------------------------

### Configure NextDNS service

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Options for enabling NextDNS and providing additional command-line arguments.

```nix
false
```

```nix
[ ]
```

```nix
[
  "-config"
  "10.0.3.0/24=abcdef"
]
```

--------------------------------

### Apply system patches

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Applies a list of patches to the system root.

```nix
[ ]
```

```nix
[
  (pkgs.writeText "bashrc.patch" '''
    --- a/etc/bashrc
    +++ b/etc/bashrc
    @@ -8,3 +8,5 @@
     shopt -s checkwinsize

     [ -r "/etc/bashrc_$TERM_PROGRAM" ] && . "/etc/bashrc_$TERM_PROGRAM"
    +
    +if test -e /etc/static/bashrc; then . /etc/static/bashrc; fi
  ''')
]
```

--------------------------------

### Configure build machine SSH key

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies the path to the SSH private key for authentication on the build machine.

```nix
"/root/.ssh/id_buildhost_builduser"
```

--------------------------------

### Configure nix.registry.<name>.from

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Specifies the flake reference to be rewritten.

```nix
{ }
```

```nix
{
  id = "nixpkgs";
  type = "indirect";
}
```

--------------------------------

### Homebrew Tap Default Values

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default settings for tap configuration options.

```nix
null
```

```nix
false
```

```nix
true
```

--------------------------------

### Launchd Agents Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default configuration for launchd agents.

```nix
{ }
```

```nix
""
```

```nix
[]
```

--------------------------------

### Sketchybar Service Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Configuration options for the Sketchybar service.

```nix
false
```

```nix
true
```

```nix
pkgs.sketchybar
```

```nix
""
```

```nix
''
  sketchybar --bar height=24
  sketchybar --update
  echo "sketchybar configuration loaded.."
''
```

```nix
[ ]
```

```nix
[ pkgs.jq ]
```

--------------------------------

### chunkwm Extra Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Additional commands to be included in the chunkwmrc file.

```nix
""
```

```nix
"chunkc tiling::rule --owner Emacs --state tile"
```

--------------------------------

### Tailscale Service Configuration

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Options for enabling the Tailscale daemon, selecting the package, and overriding local DNS settings.

```nix
true
```

```nix
pkgs.tailscale
```

```nix
false
```

--------------------------------

### Configure networking.fqdn

Source: https://nix-darwin.github.io/nix-darwin/manual/index.html

Default value for the fully qualified domain name.

```nix
"${networking.hostName}.${networking.domain}"
```
Tokens:
Raw