Flakes/ru: Difference between revisions

<div lang="en" dir="ltr" class="mw-content-ltr">

====Introduction====

</div>

<div lang="en" dir="ltr" class="mw-content-ltr">

<div lang="en" dir="ltr" class="mw-content-ltr">

* A [https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-flake.html#description flake] refers to a file-system tree whose root directory contains the Nix file specification called <code>flake.nix</code>.

<div lang="en" dir="ltr" class="mw-content-ltr">

* The contents of <code>flake.nix</code> file follow a uniform naming schema for declaring packages and their dependencies in the Nix language.

<div lang="en" dir="ltr" class="mw-content-ltr">

*  Flakes introduce a [https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-flake.html#flake-references URL-like syntax] for specifying remote sources.

<div lang="en" dir="ltr" class="mw-content-ltr">

* To simplify the long URL syntax with shorter names, [https://nixos.org/manual/nix/stable/command-ref/new-cli/nix3-registry.html flakes uses a registry] of symbolic identifiers.

<div lang="en" dir="ltr" class="mw-content-ltr">

* Flakes also allow for locking references and versions that can then be queried and updated programmatically.

<div lang="en" dir="ltr" class="mw-content-ltr">

====Enable flakes temporarily====

<div lang="en" dir="ltr" class="mw-content-ltr">

When using any <code>nix</code> command, add the following command-line options:

====Enable flakes permanently in NixOS====

<div lang="en" dir="ltr" class="mw-content-ltr">

Add the following to the [[Overview_of_the_NixOS_Linux_distribution#Declarative_Configuration system configuration |NixOS configuration]]:

<div lang="en" dir="ltr" class="mw-content-ltr">

=====Other Distros, with Home-Manager=====

<div lang="en" dir="ltr" class="mw-content-ltr">

Add the following to your home-manager config:

=====Other Distros, without Home-Manager=====

{{Note | The  [https://github.com/DeterminateSystems/nix-installer Determinate Nix Installer] enables flakes by default.}}

Add the following to <code>~/.config/nix/nix.conf</code> or <code>/etc/nix/nix.conf</code>:

<syntaxHighlight lang=text>

experimental-features = nix-command flakes

</syntaxHighlight>

===Basic Usage of Flake===

Before running any nix commands at this point, please note the two warnings below: one for encryption and the other for git.

====Encryption WARNING====

{{Warning | Since contents of flake files are copied to the world-readable Nix store folder, do not put any unencrypted secrets in flake files. You should instead use a [[Comparison of secret managing schemes|secret managing scheme]].}}

====Git WARNING====

For flakes in git repos, only files in the working tree will be copied to the store.

Therefore, if you use <code>git</code> for your flake, ensure to <code>git add</code> any project files after you first create them.

See also https://www.tweag.io/blog/2020-05-25-flakes/

====Generate flake.nix file====

To start the basic usage of flake, run the flake command in the project directory:

* <code>description</code> is a string describing the flake.

* <code>nixConfig</code> is an attribute set of values which reflect the [https://nixos.org/manual/nix/stable/command-ref/conf-file.html values given to nix.conf]. This can extend the normal behavior of a user's nix experience by adding flake-specific configuration, such as a binary cache.

<div lang="en" dir="ltr" class="mw-content-ltr">

=== Input schema ===

Nixpkgs can be defined using the following code:

Where:

==== nix run ====

 

 

 

 

 

 

== Accessing flakes from Nix expressions ==

If you want to access a flake from within a regular Nix expression on a system that has flakes enabled, you can use something like <code>(builtins.getFlake "/path/to/directory").packages.x86_64-linux.default</code>, where 'directory' is the directory that contains your <code>flake.nix</code>.

Nix flakes run in pure evaluation mode, which is underdocumented. Some tips for now:

* fetchurl and fetchtar [https://github.com/NixOS/nix/blob/36c4d6f59247826dde32ad2e6b5a9471a9a1c911/src/libexpr/primops/fetchTree.cc#L201 require] a sha256 argument to be considered pure.

* builtins.currentSystem is non-hermetic and impure. This can usually be avoided by passing the system (i.e., x86_64-linux) explicitly to derivations requiring it.

   inputs.nixpkgs.url = github:NixOS/nixpkgs/nixos-unstable;

 

<div lang="en" dir="ltr" class="mw-content-ltr">

<syntaxhighlight lang="nix">

{

  inputs.nixpkgs.url = github:NixOS/nixpkgs/nixos-unstable;

 

    };

<div lang="en" dir="ltr" class="mw-content-ltr">

== Pinning the registry on NixOS ==

 

<syntaxhighlight lang="nix">

{ inputs, ... }:

{

nix.registry = {

     nixpkgs.flake = inputs.nixpkgs;

This has the unfortunate side-effect of requiring import-from-derivation and slowing down build times, however it may greatly speed up almost every eval. Full-time flakes users may be able to just use <code>narHash = pkgs.narHash</code>.

== Super fast nix-shell ==

</div>

A feature of the nix Flake edition is that Nix evaluations are cached.

<div lang="en" dir="ltr" class="mw-content-ltr">

Running nix-shell can be a bit slow and take 1-3 seconds.

   inputs.nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";

 

   outputs =

    { nixpkgs, ... }:

     {

       /*

        This example assumes your system is x86_64-linux

       devShells.x86_64-linux =

          pkgs = nixpkgs.legacyPackages.x86_64-linux;

        in

        {

          default = pkgs.mkShell {

            packages = [ pkgs.hello ];

And finally, run <code>nix develop</code>. This is what replaces the old nix-shell invocation.

Exit and run again, this command should now be super fast.

<div lang="en" dir="ltr" class="mw-content-ltr">

</div>

<div lang="en" dir="ltr" class="mw-content-ltr">

=== Automatically switch nix shells with nix-direnv ===

You can easily switch nix shells when you cd into different projects with [https://github.com/nix-community/nix-direnv nix-direnv].

== Pushing Flakes to Cachix ==

== Build specific attributes in a flake repository ==

When in the repository top-level, run <code>nix build .#<attr></code>. It will look in the <code>legacyPackages</code> and <code>packages</code> output attributes for the corresponding derivation.

 

<syntaxHighlight lang=console>

 

<div lang="en" dir="ltr" class="mw-content-ltr">

=== Building flakes from a Git repo url with submodules ===

As per nix 2.9.1, git submodules in package <code>src</code>'s won't get copied to the nix store, this may cause the build to fail. To workaround this, use:

When a git folder exists, flake will only copy files added in git to maximize reproducibility (this way if you forgot to add a local file in your repo, you will directly get an error when you try to compile it). However, for development purpose you may want to create an alternative flake file, for instance containing configuration for your preferred editors as described [https://discourse.nixos.org/t/local-personal-development-tools-with-flakes/22714/8 here]… of course without committing this file since it contains only your own preferred tools. You can do so by doing something like that (say for a file called <code>extra/flake.nix</code>):

* [https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-flake.html Nix flake command reference manual] - Many additional details about flakes, and their parts.

* [https://www.youtube.com/watch?v=QXUlhnhuRX4&list=PLgknCdxP89RcGPTjngfNR9WmBgvD_xW0l Nix flakes 101: Introduction to nix flakes] (Jörg Thalheim, 2020)

* [https://github.com/NixOS/nix/blob/master/src/nix/flake.md spec describing flake inputs in more detail]

* [https://github.com/numtide/flake-utils flake-utils: Library to avoid some boiler-code when writing flakes]

* [https://zimbatm.com/NixFlakes/#direnv-integration zimbat's direnv article]