Flakes/es: Difference between revisions

(2 intermediate revisions by the same user not shown)

Line 1:

~~<div class="mw-translate-fuzzy">~~

'''Nix flakes''' es una [https://nixos.org/manual/nix/stable/contributing/experimental-Features.html característica experimental] que fue introducida en Nix 2.4 ([https://nixos.org/manual/nix/unstable/release-notes/rl-2.4.html ver notas]).

~~</div>~~

'''Nix flakes''' are an [~~[Experimental Nix~~ features|experimental feature]] first introduced in the 2.4 [[Nix]] release,{{Cite manual|nix|development/experimental-features|number=13.8|title=Experimental Features|subsection=xp-feature-flakes|subtitle=flakes}}{{Cite manual|nix|release-notes/rl-2.4|number=14.27|title=Release 2.4 (2021-11-01)}} aiming to address a number of areas of improvement for the Nix ecosystem: they provide a uniform structure for Nix projects, allow for pinning specific versions of each dependencies, and sharing these dependencies via lock files, and overall make it more convenient to write reproducible Nix expressions.

'''Nix flakes''' are an [https://nix.dev/manual/nix/stable/contributing/experimental-features experimental feature] first introduced in the 2.4 [[Nix]] release,{{Cite manual|nix|development/experimental-features|number=13.8|title=Experimental Features|subsection=xp-feature-flakes|subtitle=flakes}}{{Cite manual|nix|release-notes/rl-2.4|number=14.27|title=Release 2.4 (2021-11-01)}} aiming to address a number of areas of improvement for the Nix ecosystem: they provide a uniform structure for Nix projects, allow for pinning specific versions of each dependencies, and sharing these dependencies via lock files, and overall make it more convenient to write reproducible Nix expressions.

</div>

Line 19:

Line 17:

== Flake file structure ==

</div>

Minimally, a flake file contains a description of the flake, a set of input dependencies and an output. You can generate a very basic flake file at any time using nix flake init. This will populate the current directory with a file called flake.nix that will contain something akin to:

</div>

{{File|3=<nowiki>{

description = "A very basic flake";

~~</div>~~

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

inputs = {

nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";

};

~~</div>~~

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

outputs = { self, nixpkgs }: {

packages.x86_64-linux = {

</~~div~~>

default = self.packages.x86_64-linux.hello;

hello = nixpkgs.legacyPackages.x86_64-linux.hello;

};

}</nowiki>|name=flake.nix|lang=nix}}

~~packages~~.x86_64~~-linux.~~hello ~~= nixpkgs~~.~~legacyPackages~~.~~x86_64-linux.hello;~~

In the example above, you can see the description, the input specified as a GitHub repository with a specific branch (here <code>nixos/nixpkgs</code> on the <code>nixos-unstable</code> branch), and an output that makes use of the input. The output simply specifies that the flake contains one package for the x86_64 architecture called <code>hello</code>. Even if your flake's output wouldn't use its input (however, in practice, that is highly unlikely), the output still needs to be a Nix function.

</div>

~~packages~~.~~x86_64-linux.default = self.packages.x86_64-linux~~.~~hello;~~

{{Note|Flakes require you to specify its outputs for each architecture separately. For more information, read the related section below.}}

</div>

};

=== Nix configuration ===

~~}</nowiki>|name~~=~~flake.nix|lang~~=~~nix}}~~

In the example above, you can see the description, the input specified as a GitHub repository with a specific branch (here <code>nixos/nixpkgs</code> on the <code>nixos-unstable</code> branch), and an output that makes use of the input. The output simply specifies that the flake contains one package for the x86_64 architecture called <code>hello</code>. Even if your flake's output wouldn't use its input (however, in practice, that is highly unlikely), the output still needs to be a Nix ~~function.~~

~~{{Note|Flakes require you to specify its outputs for each architecture separately. For more information, read the related section below.}}~~

</div>

~~=== Nix configuration ===~~

It is possible to override the global Nix configuration set in your <code>nix.conf</code> file for the purposes of evaluating a flake. This can be useful, for example, for setting up binary caches specific to certain projects, while keeping the global configuration untouched. The flake file can contain a nixConfig attribute with any relevant configuration settings supplied. For example, enabling the nix-community binary cache would be achieved by:

</div>

{{File|3=<nowiki>{

...

Line 62:

Line 64:

];

}

}</nowiki>|name=flake.nix|lang=nix}}{{Note|If you are used to configuring your Nix settings via the NixOS configuration, these options are under <code>nix.settings</code> and not <code>nix</code>. For example, you cannot specify the automatic storage optimisation under <code>nix.optimisation.enable</code>.}}

}</nowiki>|name=flake.nix|lang=nix}}

{{Note|If you are used to configuring your Nix settings via the NixOS configuration, these options are under <code>nix.settings</code> and not <code>nix</code>. For example, you cannot specify the automatic storage optimisation under <code>nix.optimisation.enable</code>.}}

</div>

Line 76:

Line 81:

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

</div>

--experimental-features 'nix-command flakes'

</syntaxhighlight>

=== Enabling flakes permanently ===

Line 112:

Line 119:

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

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

</div>

Line 122:

Line 129:

experimental-features = nix-command flakes

</syntaxHighlight>

== Usage ==

Line 140:

Line 148:

=== The nix flakes command ===

</div>

~~</div>~~

Line 151:

Line 160:

</div>

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

$ nix flake show

Line 159:

Line 167:

└───hello: package 'hello-2.12.2'

</syntaxhighlight>

~~</div>~~

Line 169:

Line 176:

</div>

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

{

description = "Example flake with a devShell";

~~</div>~~

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

inputs.nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";

~~</div>~~

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

outputs = { self, nixpkgs }:

outputs = { self, nixpkgs}:

let

system = "x86_64-linux";

Line 196:

Line 198:

}

</syntaxhighlight>

~~</div>~~

Line 202:

Line 203:

</div>

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

$ nix develop

</syntaxhighlight>

~~</div>~~

Line 218:

Line 217:

Running <code>nix build</code> will look in the <code>legacyPackages</code> and <code>packages</code> output attributes for the corresponding [[derivation]] and then your system architecture and build the default output. If you want to specify a build attribute in a flake repository, you can run <code>nix build .#<attr></code>. In the example above, if you wanted to build the <code>packages.x86_64-linux.hello</code> attribute, run:

Running <code>nix build</code> will look in the <code>legacyPackages</code> and <code>packages</code> output attributes for the corresponding [[derivations|derivation]] and then your system architecture and build the default output. If you want to specify a build attribute in a flake repository, you can run <code>nix build .#<attr></code>. In the example above, if you wanted to build the <code>packages.x86_64-linux.hello</code> attribute, run:

</div>

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

$ nix build .#hello

</syntaxHighlight>

~~</div>~~

Line 281:

Line 278:

<code>inputs.nixpkgs.url = "github:NixOS/nixpkgs/<branch name>";</code>

Nixpkgs can alternatively also point to an url cached by the NixOS organization:

</div>

<code>inputs.nixpkgs.url = "<nowiki>https://nixos.org/channels/nixpkgs-unstable/nixexprs.tar.xz</nowiki>";</code>

In this example the input would point to the `nixpkgs-unstable` channel.

</div>

Line 322:

</div>

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

inputs.self.submodules = true;

</syntaxhighlight>

~~</div>~~

Line 333:

Line 331:

~~This~~ is described in the ~~nix package manager~~ [https://~~github~~.~~com~~/~~NixOS~~/nix/~~blob~~/~~master~~/~~src/nix~~/flake-check.~~md src/~~nix/flake-check~~.md~~].

The output schema is described the [https://nix.dev/manual/nix/2.33/command-ref/new-cli/nix3-flake-check.html#evaluation-checks nix flake check manual page].

</div>

Line 430:

Line 428:

* <code>builtins.currentSystem</code> is non-hermetic and impure as it reflects the host system performing the ~~evauluation~~. This can usually be avoided by passing the system (i.e., x86_64-linux) explicitly to derivations requiring it.

* <code>builtins.currentSystem</code> is non-hermetic and impure as it reflects the host system performing the evaluation. This can usually be avoided by passing the system (i.e., x86_64-linux) explicitly to derivations requiring it.

</div>

Line 445:

Line 443:

</div>

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

{

description = "A flake targeting multiple architectures";

~~</div>~~

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

inputs = {

nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";

};

~~</div>~~

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

outputs = { self, nixpkgs }: let

systems = [ "x86_64-linux" "aarch64-linux" ];

Line 474:

Line 467:

}

</syntaxhighlight>

~~</div>~~

Line 496:

Line 488:

</div>

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

{

Line 508:

Line 499:

};

}

</syntaxhighlight>

~~</div~~>

Line 636:

Line 626:

# Output should show ~/libdep-src-checkout/ so you know it worked

</syntaxHighlight>

Line 720:

Line 711:

* [https://github.com/nix-community/todomvc-nix building Rust and Haskell flakes]

</div>

~~{{references}}~~

[[Category:Software|Software]]

[[Category:Nix|Nix]]

[[Category:Nix Language|Nix Language]]

[[Category:Flakes|Flakes]]

</div>

~~[[Category:Software]]~~

~~[[Category:Nix]]~~

~~[[Category:Nix Language]]~~

~~[[Category:Flakes]]~~

@@ Line 1: / Line 1: @@
 <languages />
-<div class="mw-translate-fuzzy">
+{{Cleanup}}
-'''Nix flakes''' es una [https://nixos.org/manual/nix/stable/contributing/experimental-Features.html característica experimental] que fue introducida en Nix 2.4 ([https://nixos.org/manual/nix/unstable/release-notes/rl-2.4.html ver notas]).
-</div>
 <div lang="en" dir="ltr" class="mw-content-ltr">
-'''Nix flakes''' are an [[Experimental Nix features|experimental feature]] first introduced in the 2.4 [[Nix]] release,{{Cite manual|nix|development/experimental-features|number=13.8|title=Experimental Features|subsection=xp-feature-flakes|subtitle=flakes}}{{Cite manual|nix|release-notes/rl-2.4|number=14.27|title=Release 2.4 (2021-11-01)}} aiming to address a number of areas of improvement for the Nix ecosystem: they provide a uniform structure for Nix projects, allow for pinning specific versions of each dependencies, and sharing these dependencies via lock files, and overall make it more convenient to write reproducible Nix expressions.
+'''Nix flakes''' are an [https://nix.dev/manual/nix/stable/contributing/experimental-features experimental feature] first introduced in the 2.4 [[Nix]] release,{{Cite manual|nix|development/experimental-features|number=13.8|title=Experimental Features|subsection=xp-feature-flakes|subtitle=flakes}}{{Cite manual|nix|release-notes/rl-2.4|number=14.27|title=Release 2.4 (2021-11-01)}} aiming to address a number of areas of improvement for the Nix ecosystem: they provide a uniform structure for Nix projects, allow for pinning specific versions of each dependencies, and sharing these dependencies via lock files, and overall make it more convenient to write reproducible Nix expressions.
 </div>
@@ Line 19: / Line 17: @@
 <div lang="en" dir="ltr" class="mw-content-ltr">
 == Flake file structure ==
+</div>
+<div lang="en" dir="ltr" class="mw-content-ltr">
 Minimally, a flake file contains a description of the flake, a set of input dependencies and an output. You can generate a very basic flake file at any time using nix flake init. This will populate the current directory with a file called flake.nix that will contain something akin to:
+</div>
 {{File|3=<nowiki>{
    description = "A very basic flake";
-</div>
-   <div lang="en" dir="ltr" class="mw-content-ltr">
+   inputs = {
-inputs = {
      nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
    };
-</div>
-   <div lang="en" dir="ltr" class="mw-content-ltr">
+   outputs = { self, nixpkgs }: {
-outputs = { self, nixpkgs }: {
+    packages.x86_64-linux = {
-</div>
+      default = self.packages.x86_64-linux.hello;
+      hello = nixpkgs.legacyPackages.x86_64-linux.hello;
+    };
+  };
+}</nowiki>|name=flake.nix|lang=nix}}
-    <div lang="en" dir="ltr" class="mw-content-ltr">
+<div lang="en" dir="ltr" class="mw-content-ltr">
-packages.x86_64-linux.hello = nixpkgs.legacyPackages.x86_64-linux.hello;
+In the example above, you can see the description, the input specified as a GitHub repository with a specific branch (here <code>nixos/nixpkgs</code> on the <code>nixos-unstable</code> branch), and an output that makes use of the input. The output simply specifies that the flake contains one package for the x86_64 architecture called <code>hello</code>. Even if your flake's output wouldn't use its input (however, in practice, that is highly unlikely), the output still needs to be a Nix function.
 </div>
-    <div lang="en" dir="ltr" class="mw-content-ltr">
+<div lang="en" dir="ltr" class="mw-content-ltr">
-packages.x86_64-linux.default = self.packages.x86_64-linux.hello;
+{{Note|Flakes require you to specify its outputs for each architecture separately. For more information, read the related section below.}}
 </div>
-  <div lang="en" dir="ltr" class="mw-content-ltr">
+<div lang="en" dir="ltr" class="mw-content-ltr">
-};
+=== Nix configuration ===
-}</nowiki>|name=flake.nix|lang=nix}}
-In the example above, you can see the description, the input specified as a GitHub repository with a specific branch (here <code>nixos/nixpkgs</code> on the <code>nixos-unstable</code> branch), and an output that makes use of the input. The output simply specifies that the flake contains one package for the x86_64 architecture called <code>hello</code>. Even if your flake's output wouldn't use its input (however, in practice, that is highly unlikely), the output still needs to be a Nix function.
-{{Note|Flakes require you to specify its outputs for each architecture separately. For more information, read the related section below.}}
 </div>
 <div lang="en" dir="ltr" class="mw-content-ltr">
-=== Nix configuration ===
 It is possible to override the global Nix configuration set in your <code>nix.conf</code> file for the purposes of evaluating a flake. This can be useful, for example, for setting up binary caches specific to certain projects, while keeping the global configuration untouched. The flake file can contain a nixConfig attribute with any relevant configuration settings supplied. For example, enabling the nix-community binary cache would be achieved by:
+</div>
 {{File|3=<nowiki>{
    ...
@@ Line 62: / Line 64: @@
      ];
    }
-}</nowiki>|name=flake.nix|lang=nix}}{{Note|If you are used to configuring your Nix settings via the NixOS configuration, these options are under <code>nix.settings</code> and not <code>nix</code>. For example, you cannot specify the automatic storage optimisation under <code>nix.optimisation.enable</code>.}}
+}</nowiki>|name=flake.nix|lang=nix}}
+<div lang="en" dir="ltr" class="mw-content-ltr">
+{{Note|If you are used to configuring your Nix settings via the NixOS configuration, these options are under <code>nix.settings</code> and not <code>nix</code>. For example, you cannot specify the automatic storage optimisation under <code>nix.optimisation.enable</code>.}}
 </div>
@@ Line 76: / Line 81: @@
 When using any [[Nix command|<code>nix</code> command]], add the following command-line options:
 </div>
 <syntaxhighlight lang="shell">
   --experimental-features 'nix-command flakes'
 </syntaxhighlight>
 <div lang="en" dir="ltr" class="mw-content-ltr">
 === Enabling flakes permanently ===
@@ Line 112: / Line 119: @@
 <div lang="en" dir="ltr" class="mw-content-ltr">
-{{Note | The  [https://github.com/DeterminateSystems/nix-installer Determinate Nix Installer] enables flakes by default.}}
+{{Note | The  [https://github.com/DeterminateSystems/nix-installer Determinate Nix Installer] enables flakes by default, but installs the proprietary Determinate Nix.}}
 </div>
@@ Line 122: / Line 129: @@
 experimental-features = nix-command flakes
 </syntaxHighlight>
 <div lang="en" dir="ltr" class="mw-content-ltr">
 == Usage ==
@@ Line 140: / Line 148: @@
 <div lang="en" dir="ltr" class="mw-content-ltr">
 === The nix flakes command ===
+</div>
 {{Main|Nix (command)}}
-</div>
 <div lang="en" dir="ltr" class="mw-content-ltr">
@@ Line 151: / Line 160: @@
 </div>
-<div lang="en" dir="ltr" class="mw-content-ltr">
 <syntaxhighlight lang="console">
 $ nix flake show
@@ Line 159: / Line 167: @@
          └───hello: package 'hello-2.12.2'
 </syntaxhighlight>
-</div>
 <div lang="en" dir="ltr" class="mw-content-ltr">
@@ Line 169: / Line 176: @@
 </div>
-<div lang="en" dir="ltr" class="mw-content-ltr">
 <syntaxhighlight lang="nix">
 {
    description = "Example flake with a devShell";
-</div>
-   <div lang="en" dir="ltr" class="mw-content-ltr">
+   inputs.nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
-inputs.nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
-</div>
-   <div lang="en" dir="ltr" class="mw-content-ltr">
+   outputs = { self, nixpkgs }:
-outputs = { self, nixpkgs}:
      let
        system = "x86_64-linux";
@@ Line 196: / Line 198: @@
 }
 </syntaxhighlight>
-</div>
 <div lang="en" dir="ltr" class="mw-content-ltr">
@@ Line 202: / Line 203: @@
 </div>
-<div lang="en" dir="ltr" class="mw-content-ltr">
 <syntaxhighlight lang="console">
 $ nix develop
 </syntaxhighlight>
-</div>
 <div lang="en" dir="ltr" class="mw-content-ltr">
@@ Line 218: / Line 217: @@
 <div lang="en" dir="ltr" class="mw-content-ltr">
-Running <code>nix build</code> will look in the <code>legacyPackages</code> and <code>packages</code> output attributes for the corresponding [[derivation]] and then your system architecture and build the default output. If you want to specify a build attribute in a flake repository, you can run <code>nix build .#<attr></code>. In the example above, if you wanted to build the <code>packages.x86_64-linux.hello</code> attribute, run:
+Running <code>nix build</code> will look in the <code>legacyPackages</code> and <code>packages</code> output attributes for the corresponding [[derivations|derivation]] and then your system architecture and build the default output. If you want to specify a build attribute in a flake repository, you can run <code>nix build .#<attr></code>. In the example above, if you wanted to build the <code>packages.x86_64-linux.hello</code> attribute, run:
 </div>
-<div lang="en" dir="ltr" class="mw-content-ltr">
 <syntaxHighlight lang=console>
 $ nix build .#hello
 </syntaxHighlight>
-</div>
 <div lang="en" dir="ltr" class="mw-content-ltr">
@@ Line 281: / Line 278: @@
 <code>inputs.nixpkgs.url = "github:NixOS/nixpkgs/<branch name>";</code>
+<div lang="en" dir="ltr" class="mw-content-ltr">
 Nixpkgs can alternatively also point to an url cached by the NixOS organization:
+</div>
 <code>inputs.nixpkgs.url = "<nowiki>https://nixos.org/channels/nixpkgs-unstable/nixexprs.tar.xz</nowiki>";</code>
+<div lang="en" dir="ltr" class="mw-content-ltr">
 In this example the input would point to the `nixpkgs-unstable` channel.
+</div>
 <div lang="en" dir="ltr" class="mw-content-ltr">
@@ Line 322: / Line 322: @@
 </div>
-<div lang="en" dir="ltr" class="mw-content-ltr">
 <syntaxhighlight lang="nix">
    inputs.self.submodules = true;
 </syntaxhighlight>
-</div>
 <div lang="en" dir="ltr" class="mw-content-ltr">
@@ Line 333: / Line 331: @@
 <div lang="en" dir="ltr" class="mw-content-ltr">
-This is described in the nix package manager [https://github.com/NixOS/nix/blob/master/src/nix/flake-check.md src/nix/flake-check.md].
+The output schema is described the [https://nix.dev/manual/nix/2.33/command-ref/new-cli/nix3-flake-check.html#evaluation-checks nix flake check manual page].
 </div>
@@ Line 430: / Line 428: @@
 <div lang="en" dir="ltr" class="mw-content-ltr">
-* <code>builtins.currentSystem</code> is non-hermetic and impure as it reflects the host system performing the evauluation. This can usually be avoided by passing the system (i.e., x86_64-linux) explicitly to derivations requiring it.
+* <code>builtins.currentSystem</code> is non-hermetic and impure as it reflects the host system performing the evaluation. This can usually be avoided by passing the system (i.e., x86_64-linux) explicitly to derivations requiring it.
 </div>
@@ Line 445: / Line 443: @@
 </div>
-<div lang="en" dir="ltr" class="mw-content-ltr">
 <syntaxhighlight lang="nix">
 {
    description = "A flake targeting multiple architectures";
-</div>
-  <div lang="en" dir="ltr" class="mw-content-ltr">
 inputs = {
      nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
    };
-</div>
-  <div lang="en" dir="ltr" class="mw-content-ltr">
 outputs = { self, nixpkgs }: let
      systems = [ "x86_64-linux" "aarch64-linux" ];
@@ Line 474: / Line 467: @@
 }
 </syntaxhighlight>
-</div>
 <div lang="en" dir="ltr" class="mw-content-ltr">
@@ Line 496: / Line 488: @@
 </div>
-<div lang="en" dir="ltr" class="mw-content-ltr">
 <syntaxhighlight lang="nix">
 {
@@ Line 508: / Line 499: @@
      };
 }
 </syntaxhighlight>
-</div>
 <div lang="en" dir="ltr" class="mw-content-ltr">
@@ Line 636: / Line 626: @@
 # Output should show ~/libdep-src-checkout/ so you know it worked
 </syntaxHighlight>
 <div lang="en" dir="ltr" class="mw-content-ltr">
@@ Line 720: / Line 711: @@
 * [https://github.com/nix-community/todomvc-nix building Rust and Haskell flakes]
 </div>
+{{references}}
 <div lang="en" dir="ltr" class="mw-content-ltr">
-{{references}}
+[[Category:Software|Software]]
+[[Category:Nix|Nix]]
+[[Category:Nix Language|Nix Language]]
+[[Category:Flakes|Flakes]]
 </div>
-[[Category:Software]]
-[[Category:Nix]]
-[[Category:Nix Language]]
-[[Category:Flakes]]