Module

These are the available NixOS module options for nixos-cli. This is the preferred way to configure things like settings, and to add the CLI itself to the $PATH.

services.nixos-cli.enable

unified NixOS tooling replacement for nixos-* utilities

Type: boolean

Default: false

Example: true

services.nixos-cli.package

Package to use for nixos-cli

Type: types.package

Default:

if useFlakePkg
then self.packages.${pkgs.system}.nixos
else self.packages.${pkgs.system}.nixosLegacy

services.nixos-cli.config

Configuration for nixos-cli, in TOML format

Type: tomlFormat.type

Default: {}

services.nixos-cli.useActivationInterface

Use the nixos activate interface to switch configurations, instead of the switch-to-configuration-ng program that is currently used in nixpkgs.

The behavior is mostly the same, but changes can be made that may potentially break behavior from the original on a per-case basis.

If this is disabled, users will still be able to use nixos activate on their own, but it will serve solely as a shim to run the switch script on a switchable. system.

This activation interface is experimental and subject to change.

Type: types.bool

Default: false

Example: true

services.nixos-cli.generationTag

A description for this generation

Type: types.nullOr types.str

Default: lib.maybeEnv "NIXOS_GENERATION_TAG" null

Example: "Sign Git GPG commits by default"

services.nixos-cli.prebuildOptionCache

Prebuild JSON cache for nixos option command

Type: types.bool

Default: config.documentation.nixos.enable

Generated with nix-options-doc