All Extensions

This section describes all official Denix extensions.

Args

Name	args
Description	More convenient way to configure _module.args via myconfig
Maintainers	yunfachi (GitHub, Telegram)

Settings

Name	Default Value	Description
path	"args"	Path in myconfig where options will be created

Base

Name	base
Description	Creates feature-rich and fine-tunable modules for hosts and rices with minimal effort
Maintainers	yunfachi (GitHub, Telegram)

Settings

Name	Default Value	Description
enableAll	true	Default value for hosts.enable and rices.enable

args

Name	Default Value	Description
enable	false	Default value for hosts.args.enable and rices.args.enable
path	"args"	Default value for hosts.args.path and rices.args.path

assertions

Name	Default Value	Description
enable	true	Default value for hosts.assertions.enable and rices.assertions.enable
moduleSystem	"home-manager"	Default value for hosts.assertions.moduleSystem and rices.assertions.moduleSystem

hosts

Name	Default Value	Description
enable	enableAll	Whether to create the hosts module
extraSubmodules	[]	Additional submodules used to define custom options within the host type. Example value: [ ({ config, ... }: { options.coolName = "cool " + config.name; }) ]

hosts.args

Name	Default Value	Description
enable	args.enable	Whether to create host and hosts arguments with the args extension
path	args.path	Path to options of the args extension

hosts.system

Name	Default Value	Description
enable	true	Whether to create a string option system in the host submodule, which sets the values for the homeManagerSystem, nixos.nixpkgs.hostPlatform, and darwin.nixpkgs.hostPlatform options

hosts.assertions

Name	Default Value	Description
enable	assertions.enable	Whether to add delib.hostNamesAssertions to the assertions option of the specified module system
moduleSystem	assertions.moduleSystem	Module system to which assertions will be added. Any value is allowed, even "myconfig" if you have a dedicated module for that. Values "home-manager" and "nix-darwin" will be automatically converted to "home" and "darwin" respectively

hosts.type

Name	Default Value	Description
enable	true	Whether to create an enum option type in the host submodule
generateIsType	true	Whether to generate a boolean option for each value in hosts.type.types, formatted as "is{Type}". Also creates "isPC", with a value of isDesktop || isLaptop
types	["desktop" "laptop" "server"]	All allowed values for the type option in the host submodule. Note: to append to the list rather than overwrite it, use: types = prev.types ++ ["newType"];

hosts.features

Name	Default Value	Description
enable	true	Whether to create the features option with an enum-list type in the host submodule
generateIsFeatured	true	Whether to generate a boolean option for each value in hosts.features.features, formatted as "{feature}Featured"
features	[]	All allowed values for the features option in the host submodule
default	[]	Default value for the features option in the host submodule
defaultByHostType	{}	Attrset where keys are one of the hosts.type.types values and values are lists similar to hosts.features.default. Merged with hosts.features.default and the list whose key matches the value of the type option in the host submodule

hosts.displays

Name	Default Value	Description
enable	true	Whether to create the displays option in the host submodule. Its type is a list of submodules with the following options: enable (bool; default true), name (str; no default), primary (bool; default true, but only if the displays options in the host submodule contains one item), touchscreen (bool; default false), refreshRate (int; default 60), width (int; default 1920), height (int; default 1080), x (int; default 0), y (int; default 0)

rices

Name	Default Value	Description
enable	enableAll	Whether to create the rices module
extraSubmodules	[]	Additional submodules used to define custom options within the rice type. Example value: [ ({ config, ... }: { options.coolName = "cool " + config.name; }) ]

rices.args

Name	Default Value	Description
enable	args.enable	Whether to create rice and rices arguments using the args extension
path	args.path	Path to options of the args extension

rices.assertions

Name	Default Value	Description
enable	assertions.enable	Whether to add delib.riceNamesAssertions to the assertions option of the specified module system
moduleSystem	assertions.moduleSystem	Module system to which assertions will be added. Any value is allowed, even "myconfig" if you have a dedicated module for that. "home-manager" and "nix-darwin" will be automatically converted to "home" and "darwin" respectively

User

WIP

Overlays

Name	overlays
Description	Simplified overlay configuration module
Maintainers	Zonni (GitHub)

Settings

Name	Default Value	Description
defaultTargets	["nixos" "home"]	Default targets to apply overlays
moduleNamePrefix	"overlays"	Prefix added to module names when withPrefix is true

Library

overlayModule

Creates a module that applies overlays for specified targets. If withPrefix is true, it creates the option ${moduleNamePrefix}.${name}.enable with the value delib.overlayModule :: enabled; otherwise, it does the same but in ${name}.enable.

Arguments:

Name	Type	Default Value	Description
name	string	required	Name of the overlay module
overlay	overlay function	null	Single overlay function to apply
overlays	list of overlay functions	[]	List of overlay functions to apply
targets	list of strings	defaultTargets	Target systems to apply overlays to. Valid values: "nixos", "home", "darwin"
withPrefix	boolean	true	Whether to add moduleNamePrefix to the module name
enabled	boolean	true	Whether overlay should be enabled by default