nix.dev/source/concepts/flakes.md

(flakes)=

Flakes

What is usually referred to as "flakes" is:

• A policy for managing dependencies between {term}Nix expressions<Nix expression>.
• An experimental feature in Nix, implementing that policy and supporting functionality.

Technically, a flake is a file system tree that contains a file named flake.nix in its root directory.

Flakes add the following behavior to Nix:

1. A flake.nix file offers a uniform schema, where:

   • Other flakes can be referenced as dependencies providing {term}Nix language code or other files.
   • The values produced by the {term}Nix expressions in flake.nix are structured according to pre-defined use cases.

2. References to other flakes can be specified using a dedicated URL-like syntax. A flake registry allows using symbolic identifiers for further brevity. References can be automatically locked to their current specific version and later updated programmatically.

3. A new command line interface, implemented as a separate experimental feature, leverages flakes by accepting flake references in order to build, run, or deploy software defined as a flake.

Nix handles flakes differently than regular {term}Nix files in the following ways:

• The flake.nix file is checked for schema validity.

  In particular, the metadata fields cannot be arbitrary Nix expressions. This is to prevent complex, possibly non-terminating computations while querying the metadata.

• The entire flake directory is copied to Nix store before evaluation.

  This allows for effective evaluation caching, which is relevant for large expressions such as Nixpkgs, but also requires copying the entire flake directory again on each change.

• No external variables, parameters, or impure language values are allowed.

  It means full reproducibility of a Nix expression, and, by extension, the resulting build instructions by default, but also prohibits parameterisation of results by consumers.

Why are flakes controversial?

{ref}Flakes <flakes> were originally proposed in RFC 49, and have been in development since 2019. Nix introduced the implementation as its first experimental feature in 2021.

The subject is considered controversial among Nix users and developers in terms of design, development processes, and community governance. In particular:

• The RFC was closed without conclusion, and some design and implementation issues are not yet resolved. Examples include the notion of a global flake registry, the impossibility of parameterising flakes, and the new command line interface and flakes being closely tied to each other.
• The original implementation introduced regressions in the Nix 2.4 release, breaking some stable functionality without a major version increment.
• New Nix users were and still are encouraged by various individuals to adopt flakes despite there being no concrete plan or timeline for stabilisation.

This led to a situation where the stable interface was only sparsely maintained for multiple years, and repeatedly suffered breakages due to ongoing development. Meanwhile, the new interface was adopted widely enough for evolving its design without negatively affecting users to become very challenging.

As of the 2022 community survey, more than half of the user base, a third of which were relative beginners, relied on experimental features. {term}Nixpkgs as a contrasting example, while featuring a flake.nix for compatibility, does not depend on Nix experimental features in its code base.

Should I enable flakes?

You have to judge for yourself based on your needs.

Flakes and the nix command suite bring multiple improvements that are relevant for both software users and package authors:

• The new command-line interface, together with flakes, makes dealing with existing packages significantly more convenient.
• The constraints imposed on flakes strengthen reproducibility by default, and enable various performance improvements when interacting with a large Nix package repository like {term}Nixpkgs.
• Flake references allow for easier handling of version upgrades for existing packages or project dependencies.
• The flake schema helps with composing Nix projects from multiple sources in an orderly fashion.

Other than that, and below the surface of the flake schema, Nix and the Nix language work exactly the same in both cases. In principle, the same level of reproducibility can be achieved with or without flakes. In particular, the process of adding software to {term}Nixpkgs or maintaining {term}NixOS modules and configurations is not affected by flakes at all.

Both paradigms have their own set of unique concepts and support tooling that have to be learned, with varying ease of use, implementation quality, and support status. At the moment, neither the stable nor the experimental interface is clearly superior to the other in all aspects. While flakes reduce complexity in some regards, they also introduce additional mechanisms and you will have to learn more about the system to fully understand how it works.

There are downsides to relying on experimental features in general:

• Interfaces and behaviour of experimental features could still be changed by Nix developers. This may require you to adapt your code at some point in the future, which will be more effort when it has grown in complexity. Currently there is no agreed-upon plan or timeline for stabilising flakes.
• The Nix maintainer team focuses on fixing bugs and regressions in stable interfaces, supporting well-understood use cases, as well as improving the internal design and overall contributor experience in order to ease future development. Improvements to experimental features have a low priority.
• The Nix documentation team focuses on improving documentation and learning materials for stable features and common principles. When using flakes, you will have to rely more heavily on user-to-user support, third-party documentation, and the source code.