1
0
Fork 0
mirror of https://github.com/LnL7/nix-darwin.git synced 2025-03-31 04:04:45 +00:00

docs: clarify how to use inputs with flakes

This commit clarifies that in order to access `inputs` in a host configuration, the `inputs` argument must be used. This commit also documents how `specialArgs` can be used to access the inputs as arguments directly.
This commit is contained in:
Lauren Yim 2023-06-12 16:08:03 +10:00 committed by GitHub
parent 7c16d31383
commit 1fc5d125fb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -94,15 +94,30 @@ A minimal example of using an existing configuration.nix:
}
```
Inputs from the flake can also be passed to `darwinSystem`, these inputs are then
accessible as an argument, similar to pkgs and lib inside the configuration.
Inputs from the flake can also be passed to `darwinSystem`. These inputs are then
accessible as an argument `inputs`, similar to `pkgs` and `lib`, inside the configuration.
```nix
darwin.lib.darwinSystem {
system = "x86_64-darwin";
modules = [ ... ];
modules = [ ./configuration.nix ];
inputs = { inherit darwin dotfiles nixpkgs; };
}
# in configuration.nix:
{ pkgs, lib, inputs }:
# inputs.darwin, inputs.dotfiles, and inputs.nixpkgs can be accessed here
```
Alternatively, `specialArgs` could be used:
```nix
darwin.lib.darwinSystem {
system = "x86_64-darwin";
modules = [ ./configuration.nix ];
specialArgs = { inherit darwin dotfiles nixpkgs; };
}
# in configuration.nix:
{ pkgs, lib, darwin, dotfiles, nixpkgs }:
```
Since the installer doesn't work with flakes out of the box yet, nix-darwin will need to