nix::flake::LockFlags Struct Reference

Public Attributes
bool	recreateLockFile = false
bool	updateLockFile = true
bool	writeLockFile = true
std::optional< bool >	useRegistries = std::nullopt
bool	applyNixConfig = false
bool	allowUnlocked = true
bool	commitLockFile = false
std::optional< std::string >	referenceLockFilePath
std::optional< Path >	outputLockFilePath
std::map< InputPath, FlakeRef >	inputOverrides
std::set< InputPath >	inputUpdates

Member Data Documentation

allowUnlocked

bool nix::flake::LockFlags::allowUnlocked = true

Whether unlocked flake references (i.e. those without a Git revision or similar) without a corresponding lock are allowed. Unlocked flake references with a lock are always allowed.

applyNixConfig

bool nix::flake::LockFlags::applyNixConfig = false

Whether to apply flake's nixConfig attribute to the configuration

commitLockFile

bool nix::flake::LockFlags::commitLockFile = false

Whether to commit changes to flake.lock.

inputOverrides

std::map<InputPath, FlakeRef> nix::flake::LockFlags::inputOverrides

Flake inputs to be overridden.

inputUpdates

std::set<InputPath> nix::flake::LockFlags::inputUpdates

Flake inputs to be updated. This means that any existing lock for those inputs will be ignored.

outputLockFilePath

std::optional<Path> nix::flake::LockFlags::outputLockFilePath

The path to a lock file to write to instead of the flake.lock file in the top-level flake

recreateLockFile

bool nix::flake::LockFlags::recreateLockFile = false

Whether to ignore the existing lock file, creating a new one from scratch.

referenceLockFilePath

std::optional<std::string> nix::flake::LockFlags::referenceLockFilePath

The path to a lock file to read instead of the flake.lock file in the top-level flake

updateLockFile

bool nix::flake::LockFlags::updateLockFile = true

Whether to update the lock file at all. If set to false, if any change to the lock file is needed (e.g. when an input has been added to flake.nix), you get a fatal error.

useRegistries

std::optional<bool> nix::flake::LockFlags::useRegistries = std::nullopt

Whether to use the registries to lookup indirect flake references like 'nixpkgs'.

writeLockFile

bool nix::flake::LockFlags::writeLockFile = true

Whether to write the lock file to disk. If set to true, if the any changes to the lock file are needed and the flake is not writable (i.e. is not a local Git working tree or similar), you get a fatal error. If set to false, Nix will use the modified lock file in memory only, without writing it to disk.

---

The documentation for this struct was generated from the following file:

• lix/libexpr/flake/flake.hh