Nix 实战：来几个 use case

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

{ # 只列举最常用的字段
  description = "这个项目的文字描述";
  inputs = rec {
    # 所有外部输入。除了这些外部输入外，接下来的所有构建都会被切断网络通信。
    # 由此可以保证最大限度的可复现性（aka 函数式）
    # 外部输入可以是 git repo 或网络文件。
    nixpkgs-master.url = "github:nixos/nixpkgs/master";
    nixpkgs-unstable.url = "github:nixos/nixpkgs/nixpkgs-unstable";
    # rec 关键字让你可以在同一个结构体内 ref 自己的字段。
    # 我喜欢用这种方式快速切软件源版本
    nixpkgs = nixpkgs-unstable;
  };
  outputs = {nixpkgs, ...} @ args: {
    # 这里是这个 nix 项目的构建定义。照着这里的流程做就能 build 出成果。
    # 注意 outputs 是一个函数，输入是所有 input 组成的 struct，被解构
    # 赋值了，所以这里能拿到 nixpkgs 字段作为传入变量。没被匹配的字段
    # 就放在 args 变量里了。比如 args.nixpkgs-master.xxxxxx

    # nix fmt 命令会使用这个字段指定的 formatter 来 format Nix 代码。
    # 如下是一个常见的例子：
    formatter = { "x86_64-linux" = nixpkgs.legacyPackages.x86_64-linux.nixpkgs-fmt; };
    # 所有 overlay 。Overlay 是现场修改 input 内容物的方式，最常见的是
    # 修改或者新增某个软件包的定义（而不用 fork 一份 nixpkgs），接下来
    # 使用 input 的部分可以完全无感地继续该怎么用怎么用。
    overlays = { ... };

    # 对于软件项目，下面的字段比较常用：

    # 所有软件包的定义。 nix build 和 nix shell 命令会用这里的定义来build 软件包。
    # 关于如何编写你的软件的 derivation，请翻阅文档或随便在 nixpkgs 里
    # 找一个软件包定义。
    # 下面这个软件可以用 nix build .#software-name 构建。成果会放在
    # ./result 里。
    packages = { x86_64-linux.software-name = myDerivation; };
    # 如果 nix build 命令没有附加包名参数，则此 derivation 会被构建：
    defaultPackage = { x86_64-linux = myDerivation; };
    # nix flake check 命令会执行下面 derivation 定义里的测试流程。
    checks = {  x86_64-linux.software-name = myDerivation; };

    # 开发环境。比如下面一个很简单的例子。
    # 在此项目根目录使用 nix shell 命令可以把你带入这个预装好环境的 shell 中。
    # 你自己项目外的个性化设置（shell、配色、alias、缩写等）不会被覆盖。
    # 不难注意到，你可以定义很多套 shell
    devShells = {
      x86_64-linux.default = nixpkgs.legacyPackages.x86_64-linux.mkShell {
        name = "my-software-dev";
        packages = with nixpkgs.legacyPackages.x86_64-linux; [ nodejs yarn nodePackages.prettier just ];
      };
    };

    # 对于 NixOS 系统构建，下面的字段比较常用：

    # nixos-rebuild 会看这个定义
    # home-manager 的设置会作为它的 module 而被注入
    # my-computer 是电脑的 hostname
    # nixos-rebuild switch 命令若不指定这个名字，则以本机的 hostname 作为 key 在这里查找
    nixosConfigurations = { my-computer = systemDerivation; };
    # nix-darwin 会看这个定义
    # home-manager 也可以注入它
    # 字段名同样是 hostname
    darwinConfigurations = { my-mac = darwinSystemDerivation; };

    # 还有其它的第三方工具会在这里找自己感兴趣的字段
    # 比如 deploy-rs 会要求这么定义：
    deploy = {
      nodes.my-computer = { ... };
    };
  }; # outputs
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

{ nixpkgs, ... }: {
  someConfig =
    let
      # 提前把自己系统的 packages 列表做个别名
      pkgs = nixpkgs.legacyPackages."x86_64-linux";
    in
    {
      environment.systemPackages = with pkgs; [ btop ]; # 这样就不用写一大堆了
    }
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

# /etc/nixos/modules/my_user.nix
{ lib, pkgs, config, ... }:
let
  # 省得下面打字了
  # 和上面 pkgs 一样，这个 cfg 也是一种约定俗成
  cfg = config.nyk.user;
in
{
  options.nyk.user = {
    # 对于非 bool 的字段，详见 lib.mkOption 的函数定义
    enable = lib.mkEnableOption "Whether to enable user:nyk definition";
  };
  config = lib.mkIf cfg.enable { # 只有当 config.nyk.user.enable = true 时整段定义才会出现
    users.users.nyk = { # 常规的 nixos 配置
      isNormalUser = true;
      shell = pkgs.fish;
    };
  };
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13

# /etc/nixos/configuration.nix
{
  imports = [
    # 先把模块定义文件给注入进我们的环境
    ./modules/my_user.nix
  ];

  config = {
    nyk = {
      user.enable = true; # 这样上面的 config 注入就能生效了
    };
  };
}

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22

# 用 environment.systemPackages 装，
# 或者在 devShell 里使用也是一样的效果。
# 新建一个有 glances 的临时环境
$ nix shell nixpkgs#glances
$ which glances
/nix/store/xxxxxxx-glances-4.2.0/bin/glances
$ which python3
which: no python3 in (........)
$ exit # 退出那个临时环境
$ which glances
which: no glances in (........)
$ which python3
which: no python3 in (........)

# 以下是在 nix 里试用一个软件最快的方法：
$ nix run nixpkgs#glances
# 退出软件后
$
# 到这里就完全没有这个软件存在过的痕迹了
# 它可能还会在 /nix/store 里留存一段时间，但最终会被 GC 掉
$ which glances
which: no glances in (........)

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

# 进入 flake.nix 所在的目录
$ pwd
/etc/nixos
# 让你能进入当前系统 config 求值完之后的树内
$ nix --extra-experimental-features repl-flake repl ".#nixosConfigurations.$(hostname)"
nix-repl> config.networking.enableIPv6 # options 当然也能看到
true
nix-repl> config.nix.settings.substituters
[
  "https://mirrors.ustc.edu.cn/nix-channels/store"
  "https://cache.nixos.org/"
]
nix-repl> pkgs.cloudflared.version
"2024.11.0"