NixOS Wiki

Flakes/zh: Difference between revisions

← Older edit
VisualWikitext
Weijia (talk | contribs)
trusted
1,066 edits
Created page with "=== 为多架构定义 Flake ==="
Weijia (talk | contribs)
trusted
1,066 edits
No edit summary
 
(57 intermediate revisions by the same user not shown)
Line 3: Line 3:
{{Cleanup}}
{{Cleanup}}


'''Nix Flakes''' 是 [[Nix]] 2.4 版本中首次引入的一项[[Experimental Nix features|实验性功能]]{{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)}}，旨在解决 Nix 生态系统许多领域的改进问题：它们为 Nix 项目提供了一个统一结构、允许固定每个依赖项的特定版本并通过锁文件共享这些依赖项，同时总体上使编写可复现的 Nix 表达式变得更加方便。
'''Nix flakes''' 是 [[Nix]] 2.4 版本中首次引入的一项[[Experimental Nix features|实验性功能]]{{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)}}，旨在解决 Nix 生态系统许多领域的改进问题：它们为 Nix 项目提供了一个统一结构、允许固定每个依赖项的特定版本并通过锁文件共享这些依赖项，同时总体上使编写可复现的 Nix 表达式变得更加方便。


Flake 是一个直接包含 <code>flake.nix</code> 文件的目录，该文件内容遵循一种特定结构。Flakes 引入了一种类似 URL 的语法{{Cite manual|nix|command-ref/new-cli/nix3-flake|number=8.5.17|title=nix flake|subsection=url-like-syntax|subtitle=URL-like syntax}} 来指定远程资源。为了简化这种 URL 语法，Flakes 使用符号标识符注册表{{Cite manual|nix|command-ref/new-cli/nix3-registry|number=8.5.62|title=nix registry}}，这允许通过类似 <code>github:NixOS/nixpkgs</code> 的语法直接指定资源。
Flake 是一个直接包含 <code>flake.nix</code> 文件的目录，该文件内容遵循一种特定结构。Flakes 引入了一种类似 URL 的语法{{Cite manual|nix|command-ref/new-cli/nix3-flake|number=8.5.17|title=nix flake|subsection=url-like-syntax|subtitle=URL-like syntax}} 来指定远程资源。为了简化这种 URL 语法，Flakes 使用符号标识符注册表{{Cite manual|nix|command-ref/new-cli/nix3-registry|number=8.5.62|title=nix registry}}，这允许通过类似 <code>github:NixOS/nixpkgs</code> 的语法直接指定资源。
Line 74: Line 74:
====Nix 独立程序====
====Nix 独立程序====


<div lang="en" dir="ltr" class="mw-content-ltr">
{{Note |[https://github.com/DeterminateSystems/nix-installer Determinate Nix 安装程序] 默认启用 Flakes 功能。}}
{{Note | The  [https://github.com/DeterminateSystems/nix-installer Determinate Nix Installer] enables flakes by default.}}
</div>


添加如下内容至 <code>~/.config/nix/nix.conf</code> 或 <code>/etc/nix/nix.conf</code>:
添加如下内容至 <code>~/.config/nix/nix.conf</code> 或 <code>/etc/nix/nix.conf</code>:
Line 221: Line 219:
=== 输出规范 ===
=== 输出规范 ===


<div lang="en" dir="ltr" class="mw-content-ltr">
Nix 包管理器仓库的 [https://github.com/NixOS/nix/blob/master/src/nix/flake-check.md src/nix/flake-check.md] 中对此进行了描述。
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].
</div>


一旦 Inputs 被解析，它们就会与 <code>self</code> 一起传递给函数 <code>outputs</code>，<code>self</code> 是此 flake 在 Store 中的目录。<code>outputs</code> 根据以下规范返回 flake 的输出。
一旦 Inputs 被解析，它们就会与 <code>self</code> 一起传递给函数 <code>outputs</code>，<code>self</code> 是此 flake 在 Store 中的目录。<code>outputs</code> 根据以下规范返回 flake 的输出。
Line 304: Line 300:
=== 为多架构定义 Flake ===
=== 为多架构定义 Flake ===


<div lang="en" dir="ltr" class="mw-content-ltr">
Flakes 强制要求您为每种支持的架构指定一个程序。以下示例展示了如何编写一个针对多种架构的 flake。
Flakes force you to specify a program for each supported architecture. An example below shows how to write a flake that targets multiple architectures.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
{
{
   description = "A flake targeting multiple architectures";
   description = "针对多种架构的 flake";
</div>


   <div lang="en" dir="ltr" class="mw-content-ltr">
   inputs = {
inputs = {
     nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
     nixpkgs.url = "github:nixos/nixpkgs?ref=nixos-unstable";
   };
   };
</div>


   <div lang="en" dir="ltr" class="mw-content-ltr">
   outputs = { self, nixpkgs }: let
outputs = { self, nixpkgs }: let
     systems = [ "x86_64-linux" "aarch64-linux" ];
     systems = [ "x86_64-linux" "aarch64-linux" ];
     forAllSystems = f: builtins.listToAttrs (map (system: {
     forAllSystems = f: builtins.listToAttrs (map (system: {
Line 337: Line 326:
}
}
</syntaxhighlight>
</syntaxhighlight>
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
您还可以使用如 [[Flake Utils|flake-utils]] 或 [[Flake Parts|flake-parts]] 的第三方项目来编写，它们会提供代码来避免此类样板代码。为了避免多次重新定义程序，请参阅 [[Flake Utils#Defining a flake for multiple architectures]]
You can also use third-parties projects like [[Flake Utils|flake-utils]] or [[Flake Parts|flake-parts]] that automatically provide code to avoid this boilerplate. To avoid re-defining the program multiple times, refer to [[Flake Utils#Defining a flake for multiple architectures]]
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Using_overlays"></span>
=== Using overlays ===
=== 使用 overlays ===  
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
要将 [[Overlays]] 与 Flakes 一起使用，请参阅 [[Overlays#In a Nix flake]] 页面。
To use [[Overlays]] with flakes, refer to [[Overlays#In a Nix flake]] page.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Enable_unfree_software"></span>
=== Enable unfree software ===
=== 启用非自由软件 ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
为了在 flake 项目中允许使用 [[Unfree software|非自由软件]]，您需要在导入 Nixpkgs 时通过设置 <code>config.allowUnfree = true;</code> 来明确允许它。
To allow for [[Unfree software|unfree software]] in a flake project, you need to explicitly allow it by setting <code>config.allowUnree = true;</code> when importing Nixpkgs.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<syntaxhighlight lang="nix">
<syntaxhighlight lang="nix">
{
{
Line 371: Line 350:
     };
     };
}
}
</syntaxhighlight>
</syntaxhighlight>  
</div>  


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="NixOS_configuration_with_flakes"></span>
== NixOS configuration with flakes ==
== 启用 Flake 的 NixOS 配置 ==
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
可使用 Flakes 管理 [[NixOS]] 系统配置，以获得可复现、声明式输入和简化更新的优点。
It is possible to manage a [[NixOS]] system configuration using flakes, gaining the benefits of reproducible, declarative inputs and streamlined updates.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
关于详情与示例，请参阅 [[NixOS system configuration#Defining NixOS as a flake]]。
For details and examples, see [[NixOS system configuration#Defining NixOS as a flake]].
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Development_tricks"></span>
== Development tricks ==
== 开发技巧 ==
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Automatically_switch_nix_shells_with_direnv"></span>
=== Automatically switch nix shells with direnv ===
=== 使用 direnv 自动切换 Nix shell ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
在项目目录之间导航时，使用 [[Direnv]] 可以自动激活不同的 Nix shell。Nix 与 Direnv 的额外集成参阅 [https://github.com/nix-community/nix-direnv nix-direnv]。
It is possible to automatically activate different Nix shells when navigating between project directories by using [[Direnv]]. Additional Nix integration with Direnv can be achieved with [https://github.com/nix-community/nix-direnv nix-direnv].
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Pushing_Flakes_to_Cachix"></span>
=== Pushing Flakes to Cachix ===
=== 推送 Flakes 至 Cachix ===
</div>


https://docs.cachix.org/pushing#flakes
https://docs.cachix.org/pushing#flakes


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Flake_support_in_projects_without_flakes"></span>
=== Flake support in projects without flakes ===
=== 非 Flake 项目中的 Flake 支持 ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
[https://github.com/edolstra/flake-compat flake-compat] 库提供了一个兼容层，允许使用传统 <code>default.nix</code> 和 <code>shell.nix</code> 文件的项目与 Flakes 兼容。更多详情和使用示例，请参阅 [[Flake Compat]] 页面。
The [https://github.com/edolstra/flake-compat flake-compat] library provides a compatibility layer that allows projects using traditional <code>default.nix</code> and <code>shell.nix</code> files to operate with flakes. For more details and usage examples, see the [[Flake Compat]] page.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
另一个允许在非 flake 项目中使用 Flakes 的项目是 [https://github.com/fricklerhandwerk/flake-inputs flake-inputs]。
Another project that allows consuming flakes from non-flake projects is [https://github.com/fricklerhandwerk/flake-inputs flake-inputs].
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Accessing_flakes_from_Nix_expressions"></span>
=== Accessing flakes from Nix expressions ===
=== 从 Nix 表达式访问 Flakes ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
如果您想在启用了 Flakes 功能的系统上从常规 Nix 表达式中访问 flake，可以使用类似 <code>(builtins.getFlake "/path/to/directory").packages.x86_64-linux.default</code> 的代码，其中“directory”是包含 <code>flake.nix</code> 的目录。
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>.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Efficiently_build_multiple_flake_outputs"></span>
=== Efficiently build multiple flake outputs ===
=== 高效构建多个 Flake 输出 ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
要自动推送''所有'' flake 输出，请查看 [https://github.com/srid/devour-flake#usage devour-flake]。
To push ''all'' flake outputs automatically, checkout [https://github.com/srid/devour-flake#usage devour-flake].
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Build_a_package_added_in_a_PR"></span>
=== Build a package added in a PR ===
=== 构建一个添加至 PR 中的包 ===
</div>


<syntaxHighlight>
<syntaxHighlight>
Line 440: Line 396:
</syntaxHighlight>
</syntaxHighlight>


<div lang="en" dir="ltr" class="mw-content-ltr">
这允许构建尚未添加到 nixpkgs 的包。
this allows building a package that has not yet been added to nixpkgs.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
请注意，这将下载 nixpkgs 的完整 tarball 压缩档。如果您已有本地克隆，由于增量压缩机制，使用它可能会更快：
note that this will download a full source tarball of nixpkgs.  if you already have a local clone, using that may be faster due to delta compression:
</div>


<syntaxHighlight>
<syntaxHighlight>
Line 452: Line 404:
</syntaxHighlight>
</syntaxHighlight>


<div lang="en" dir="ltr" class="mw-content-ltr">
这允许构建尚未添加到 nixpkgs 的包。
this allows building a package that has not yet been added to nixpkgs.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="How_to_add_a_file_locally_in_git_but_not_include_it_in_commits"></span>
=== How to add a file locally in git but not include it in commits ===
=== 如何在 git 中添加一个本地文件但不将其包含在提交中 ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
当 [[git]] 文件夹存在时，flake 将仅复制在 git 中添加的文件，以最大限度地提高可复现性（因此，如果您忘记在代码库中添加本地文件，则在尝试编译时会直接出错）。但是，有时出于开发目的您可能需要创建一个备用的 flake 文件，例如包含您首选编辑器的配置，如[https://discourse.nixos.org/t/local-personal-development-tools-with-flakes/22714/8 此处所述]，这种情况下当然无需提交此文件，因为它只包含您自己首选的工具。在上述情况下，您可以执行以下操作（例如，创建了一个名为  <code>extra/flake.nix</code> 的文件）：
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>):
</div>


<syntaxHighlight>
<syntaxHighlight>
Line 469: Line 416:
</syntaxHighlight>
</syntaxHighlight>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Rapid_iteration_of_a_direct_dependency"></span>
=== Rapid iteration of a direct dependency ===
=== 直接依赖项的快速迭代 ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
使用 Nix 作为开发环境的一个常见痛点是，每次更新依赖项时都需要完全重构并重新进入开发 shell。<code>nix develop --redirect <flake> <directory></code> 命令允许您向 shell 提供可变的依赖项，就像它是由 Nix 构建的一样。
One common pain point with using Nix as a development environment is the need to completely rebuild dependencies and re-enter the dev shell every time they are updated. The <code>nix develop --redirect <flake> <directory></code> command allows you to provide a mutable dependency to your shell as if it were built by Nix.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
考虑这样一个场景：您的可执行程序 <code>consumexe</code> 依赖于一个库 <code>libdep</code>。你希望同时开发这两个项目，并且对 <code>libdep</code> 的修改能够实时反映到 <code>consumexe</code> 中。这种工作流程可以通过以下方式实现：
Consider a situation where your executable, <code>consumexe</code>, depends on a library, <code>libdep</code>. You're trying to work on both at the same time, where changes to <code>libdep</code> are reflected in real time for <code>consumexe</code>. This workflow can be achieved like so:
</div>


<syntaxHighlight lang=bash>
<syntaxHighlight lang=bash>
Line 489: Line 431:
</syntaxHighlight>
</syntaxHighlight>


<div lang="en" dir="ltr" class="mw-content-ltr">
现在您已经构建了依赖项，<code>consumexe</code> 可以将其作为输入。'''在另一个终端中'''：
Now that you've built the dependency, <code>consumexe</code> can take it as an input. '''In another terminal''':
</div>


<syntaxHighlight lang=bash>
<syntaxHighlight lang=bash>
Line 500: Line 440:
</syntaxHighlight>
</syntaxHighlight>


<div lang="en" dir="ltr" class="mw-content-ltr">
如果 Nix 警告您重定向的 flake 实际上并未用作已推导 flake 的输入，请尝试使用 <code>--inputs-from .</code> 标志。如果一切顺利，您应该能够在依赖项更改时执行 <code>buildPhase && installPhase</code> 操作，并使用新版本依赖重建您的程序，而''无需''退出开发 shell。
If Nix warns you that your redirected flake isn't actually used as an input to the evaluated flake, try using the <code>--inputs-from .</code> flag. If all worked well you should be able to <code>buildPhase && installPhase</code> when the dependency changes and rebuild your consumer with the new version ''without'' exiting the development shell.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="See_also"></span>
== See also ==
=== 另见 ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Official_sources"></span>
=== Official sources ===
=== 官方来源 ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://nix.dev/concepts/flakes Flakes] - nix.dev
* [https://nix.dev/concepts/flakes Flakes] - nix.dev
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://nixos.org/manual/nix/unstable/command-ref/new-cli/nix3-flake.html Nix flake 命令参考手册] - 关于 Flakes 及其各部分的更多附加细节。
* [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.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://github.com/NixOS/nix/blob/master/src/nix/flake.md 更详细地描述 Flakes Inputs 的规范]
* [https://github.com/NixOS/nix/blob/master/src/nix/flake.md spec describing flake inputs in more detail]
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://github.com/NixOS/rfcs/pull/49 RFC 49] (2019) - 原始 Flakes 规范
* [https://github.com/NixOS/rfcs/pull/49 RFC 49] (2019) - Original flakes specification
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Guides"></span>
=== Guides ===
=== 指南 ===
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://jade.fyi/blog/flakes-arent-real/ Flakes 幻象，亦非洪水猛兽] (Jade Lovelace, 2024)
* [https://jade.fyi/blog/flakes-arent-real/ Flakes aren't real and can't hurt you] (Jade Lovelace, 2024)
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://github.com/ryan4yin/nixos-and-flakes-book NixOS & Flakes Book](Ryan4yin, 2023) - 🛠️ ❤️ 一本非官方的 NixOS & Flakes 新手入门书籍。
* [https://github.com/ryan4yin/nixos-and-flakes-book NixOS & Flakes Book](Ryan4yin, 2023) - 🛠️ ❤️ An unofficial NixOS & Flakes book for beginners.
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://xeiaso.net/blog/nix-flakes-1-2022-02-21 Nix Flakes：一个简要介绍] (Xe Iaso, 2022)
* [https://xeiaso.net/blog/nix-flakes-1-2022-02-21 Nix Flakes: an Introduction] (Xe Iaso, 2022)
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://serokell.io/blog/practical-nix-flakes Practical Nix Flakes] (Alexander Bantyev, 2021) - 关于使用 Nix 和 Flakes 的介绍文章。
* [https://serokell.io/blog/practical-nix-flakes Practical Nix Flakes] (Alexander Bantyev, 2021) - Intro article on working with Nix and Flakes
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://www.tweag.io/blog/2020-05-25-flakes/ Nix Flakes, 第一节：介绍和教程] (Eelco Dolstra, 2020)
* [https://www.tweag.io/blog/2020-05-25-flakes/ Nix Flakes, Part 1: An introduction and tutorial] (Eelco Dolstra, 2020)
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://www.tweag.io/blog/2020-06-25-eval-cache/ Nix Flakes, 第二节：推导缓存] (Eelco Dolstra, 2020)
* [https://www.tweag.io/blog/2020-06-25-eval-cache/ Nix Flakes, Part 2: Evaluation caching] (Eelco Dolstra, 2020)
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://www.tweag.io/blog/2020-07-31-nixos-flakes/ Nix Flakes, 第三节：管理 NixOS 系统] (Eelco Dolstra, 2020)
* [https://www.tweag.io/blog/2020-07-31-nixos-flakes/ Nix Flakes, Part 3: Managing NixOS systems] (Eelco Dolstra, 2020)
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://www.youtube.com/watch?v=QXUlhnhuRX4&list=PLgknCdxP89RcGPTjngfNR9WmBgvD_xW0l Nix flakes 101: Introduction to nix flakes] (Jörg Thalheim, 2020) YouTube 视频
* [https://www.youtube.com/watch?v=QXUlhnhuRX4&list=PLgknCdxP89RcGPTjngfNR9WmBgvD_xW0l Nix flakes 101: Introduction to nix flakes] (Jörg Thalheim, 2020) YouTube video
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
<span id="Useful_flake_modules"></span>
=== Useful flake modules ===
=== Flake 实用模块 ===  
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [[Flake Utils|flake-utils]]：一个用于简化 Flakes 编写、避免样板代码的库
* [[Flake Utils|flake-utils]]: Library to avoid some boiler-code when writing flakes
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [[Flake Parts|flake-parts]]：帮助编写模块化、结构化 Flakes 的库
* [[Flake Parts|flake-parts]]: Library to help write modular and organized flakes
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [[Flake Compat|flake-compat]]：Flakes 兼容层
* [[Flake Compat|flake-compat]]: A compatibility layer for flakes
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
* [https://github.com/nix-community/todomvc-nix 构建 Rust 和 Haskell 的 flakes]
* [https://github.com/nix-community/todomvc-nix building Rust and Haskell flakes]
</div>


<div lang="en" dir="ltr" class="mw-content-ltr">
{{references}}
{{references}}
</div>


[[Category:Software]]
[[Category:Software]]
Retrieved from "https://wiki.nixos.org/wiki/Flakes/zh"