mulixは、NixOS、Home Manager、およびNix-Darwinの設定を、Nix module systemの上に薄く組み立てるためのフレームワークです。
設定を module と host に分けて収集し、各 module の option、target configuration、module 間のデータ受け渡しを一つのグラフとして扱います。
mulix自体がNix module systemの代替になることは目指していません。通常のNix moduleのmerge / override / typeの仕組みをできるだけそのまま利用し、mulix固有のDSLは「何を収集するか」「どのconfigNameを受け渡すか」「どのhostで有効にするか」に絞っています。
paths にディレクトリを渡すと、その配下の .nix ファイルから mulib.module=、=mulib.host=、=mulib.overlay を再帰的に収集します。その他の値を返すファイルは参加しません。
同じ name を持つ host は複数ファイルに分割できます。=system= と type は同じ値なら重複して書けますが、異なる値を書くと競合としてエラーになります。
module間の受け渡しだけでなく、hostからmoduleへ値を渡す場合も send を使います。
通常の contribution は send.<configName>=、強制 contribution は =send.force.<configName> です。
mulib.host {
name = "laptop";
system = "x86_64-linux";
send.force.myconfig = {
desktop.enable = true;
};
}専用の shared namespace はありません。
moduleの関数引数に登録済みconfigNameを書くと、それがreceiverになります。
# configNames.nix
{ lib, ... }: {
machineInfo = {
type = lib.types.attrs;
merge = "single";
default = {};
};
}# producer
{ mulib, ... }:
mulib.module {
name = "machine-info";
send.machineInfo = {
cpu = "amd";
};
}# consumer
{ machineInfo, mulib, ... }:
mulib.module {
name = "consumer";
os = { ... }: {
# machineInfo is available here through the normal mulix receiver.
};
}send の経路は依存グラフに参加し、未登録のconfigNameや競合したmergeをmulix側で診断します。
mulib.configurations では、NixOS / nix-darwin のOS buildにHome Managerを同時に組み込めます。
homeManager = {
embed = true;
user = "alice";
useGlobalPkgs = true;
};統合モードではHome ManagerのNixOS / nix-darwin moduleをmulixが追加し、各hostの home targetをそのuserのHome Manager modulesとして渡します。(旧 homeManager.enable はv5で embed に改名されました。)
.
├── flake.nix
├── conditionNames.nix
├── configNames.nix
├── hosts/
│ └── your_hostname/
│ └── default.nix
├── modules/
│ ├── system.nix
│ └── tools.nix
└── overlays/
└── packages.nix
このリポジトリには、そのままコピーして使えるテンプレートも置いてあります。
nix flake init -t github:fyukmdaa/mulix#minimal- Getting Started
- 最初のhost / module / flakeを作る
- Concepts
- module、host、condition、configName、sendの考え方
- Reference
- 公開APIと各フィールドのリファレンス
- denixから見たmulix
- 影響元であるdenixとの設計上の違い
- mulixについて
- プロジェクトの思想の概要
mulixの os / home / darwin / always.* fragmentは、最終的にはNix module systemへ渡されるmodule definitionです。
そのため、例えば以下のような通常のNix moduleの機構を使えます。
lib.mkIflib.mkMergelib.mkDefaultlib.mkForcelib.mkOverridelib.mkBefore/lib.mkAfter
mulix固有の便利な構文で表現できない場合は、通常のNix moduleとして記述してください。
実装のテストは tests/ 以下にあります。
for test in tests/*/run-tests.sh; do
bash "$test" || exit 1
done- denix
- module / hostを中心とした構成整理の考え方に大きな影響を受けました。