···

       
62
       
 
       
$ sudo launchctl kickstart -k system/org.nixos.nix-daemon

     

       
63
       
 
       
```

     

       
64
       
 
       


     

       
65
       
-
       
## Example flake usage

     

       
66
       
 
       


     

       
67
       
 
       
```

     

       
68
       
 
       
{

     
···

       
120
       
 
       
}

     

       
121
       
 
       
```

     

       
122
       
 
       


     

       
123
       
-
       
## Reconfiguring the builder

     

       
124
       
 
       


     

       
125
       
 
       
Initially you should not change the builder configuration else you will not be

     

       
126
       
 
       
able to use the binary cache. However, after you have the builder running locally

     

···

       
62
       
 
       
$ sudo launchctl kickstart -k system/org.nixos.nix-daemon

     

       
63
       
 
       
```

     

       
64
       
 
       


     

       
65
       
+
       
## Example flake usage {#sec-darwin-builder-example-flake}

     

       
66
       
 
       


     

       
67
       
 
       
```

     

       
68
       
 
       
{

     
···

       
120
       
 
       
}

     

       
121
       
 
       
```

     

       
122
       
 
       


     

       
123
       
+
       
## Reconfiguring the builder {#sec-darwin-builder-reconfiguring}

     

       
124
       
 
       


     

       
125
       
 
       
Initially you should not change the builder configuration else you will not be

     

       
126
       
 
       
able to use the binary cache. However, after you have the builder running locally

     

···

       
6
       
 
       


     

       
7
       
 
       
A bash script fragment that produces a disk image at `destination`.

     

       
8
       
 
       


     

       
9
       
-
       
### Attributes

     

       
10
       
 
       


     

       
11
       
 
       
* `size`. The disk size, in MiB.

     

       
12
       
 
       
* `fullName`. Name that will be written to `${destination}/nix-support/full-name`.

     
···

       
20
       
 
       


     

       
21
       
 
       
If the build fails and Nix is run with the `-K/--keep-failed` option, a script `run-vm` will be left behind in the temporary build directory that allows you to boot into the VM and debug it interactively.

     

       
22
       
 
       


     

       
23
       
-
       
### Attributes

     

       
24
       
 
       


     

       
25
       
 
       
* `preVM` (optional). Shell command to be evaluated *before* the VM is started (i.e., on the host).

     

       
26
       
 
       
* `memSize` (optional, default `512`). The memory size of the VM in MiB.

     

       
27
       
 
       
* `diskImage` (optional). A file system image to be attached to `/dev/sda`.

     

       
28
       
 
       
  Note that currently we expect the image to contain a filesystem, not a full disk image with a partition table etc.

     

       
29
       
 
       


     

       
30
       
-
       
### Examples

     

       
31
       
 
       


     

       
32
       
 
       
Build the derivation hello inside a VM:

     

       
33
       
 
       
```nix

     
···

       
56
       
 
       


     

       
57
       
 
       
Takes a file, such as an ISO, and extracts its contents into the store.

     

       
58
       
 
       


     

       
59
       
-
       
### Attributes

     

       
60
       
 
       


     

       
61
       
 
       
* `file`. Path to the file to be extracted.

     

       
62
       
 
       
  Note that currently we expect the image to contain a filesystem, not a full disk image with a partition table etc.

     

       
63
       
 
       
* `fs` (optional). Filesystem of the contents of the file.

     

       
64
       
 
       


     

       
65
       
-
       
### Examples

     

       
66
       
 
       


     

       
67
       
 
       
Extract the contents of an ISO file:

     

       
68
       
 
       
```nix

     
···

       
82
       
 
       


     

       
83
       
 
       
Generate a script that can be used to run an interactive session in the given image.

     

       
84
       
 
       


     

       
85
       
-
       
### Examples

     

       
86
       
 
       


     

       
87
       
 
       
Create a script for running a Fedora 27 VM:

     

       
88
       
 
       
```nix

     
···

       
100
       
 
       


     

       
101
       
 
       
A set of functions that build a predefined set of minimal Linux distributions images.

     

       
102
       
 
       


     

       
103
       
-
       
### Images

     

       
104
       
 
       


     

       
105
       
 
       
* Fedora

     

       
106
       
 
       
  * `fedora26x86_64`

     
···

       
126
       
 
       
  * `debian11i386`

     

       
127
       
 
       
  * `debian11x86_64`

     

       
128
       
 
       


     

       
129
       
-
       
### Attributes

     

       
130
       
 
       


     

       
131
       
 
       
* `size` (optional, defaults to `4096`). The size of the image, in MiB.

     

       
132
       
 
       
* `extraPackages` (optional). A list names of additional packages from the distribution that should be included in the image.

     

       
133
       
 
       


     

       
134
       
-
       
### Examples

     

       
135
       
 
       


     

       
136
       
 
       
8GiB image containing Firefox in addition to the default packages:

     

       
137
       
 
       
```nix

     

···

       
6
       
 
       


     

       
7
       
 
       
A bash script fragment that produces a disk image at `destination`.

     

       
8
       
 
       


     

       
9
       
+
       
### Attributes {#vm-tools-createEmptyImage-attributes}

     

       
10
       
 
       


     

       
11
       
 
       
* `size`. The disk size, in MiB.

     

       
12
       
 
       
* `fullName`. Name that will be written to `${destination}/nix-support/full-name`.

     
···

       
20
       
 
       


     

       
21
       
 
       
If the build fails and Nix is run with the `-K/--keep-failed` option, a script `run-vm` will be left behind in the temporary build directory that allows you to boot into the VM and debug it interactively.

     

       
22
       
 
       


     

       
23
       
+
       
### Attributes {#vm-tools-runInLinuxVM-attributes}

     

       
24
       
 
       


     

       
25
       
 
       
* `preVM` (optional). Shell command to be evaluated *before* the VM is started (i.e., on the host).

     

       
26
       
 
       
* `memSize` (optional, default `512`). The memory size of the VM in MiB.

     

       
27
       
 
       
* `diskImage` (optional). A file system image to be attached to `/dev/sda`.

     

       
28
       
 
       
  Note that currently we expect the image to contain a filesystem, not a full disk image with a partition table etc.

     

       
29
       
 
       


     

       
30
       
+
       
### Examples {#vm-tools-runInLinuxVM-examples}

     

       
31
       
 
       


     

       
32
       
 
       
Build the derivation hello inside a VM:

     

       
33
       
 
       
```nix

     
···

       
56
       
 
       


     

       
57
       
 
       
Takes a file, such as an ISO, and extracts its contents into the store.

     

       
58
       
 
       


     

       
59
       
+
       
### Attributes {#vm-tools-extractFs-attributes}

     

       
60
       
 
       


     

       
61
       
 
       
* `file`. Path to the file to be extracted.

     

       
62
       
 
       
  Note that currently we expect the image to contain a filesystem, not a full disk image with a partition table etc.

     

       
63
       
 
       
* `fs` (optional). Filesystem of the contents of the file.

     

       
64
       
 
       


     

       
65
       
+
       
### Examples {#vm-tools-extractFs-examples}

     

       
66
       
 
       


     

       
67
       
 
       
Extract the contents of an ISO file:

     

       
68
       
 
       
```nix

     
···

       
82
       
 
       


     

       
83
       
 
       
Generate a script that can be used to run an interactive session in the given image.

     

       
84
       
 
       


     

       
85
       
+
       
### Examples {#vm-tools-makeImageTestScript-examples}

     

       
86
       
 
       


     

       
87
       
 
       
Create a script for running a Fedora 27 VM:

     

       
88
       
 
       
```nix

     
···

       
100
       
 
       


     

       
101
       
 
       
A set of functions that build a predefined set of minimal Linux distributions images.

     

       
102
       
 
       


     

       
103
       
+
       
### Images {#vm-tools-diskImageFuns-images}

     

       
104
       
 
       


     

       
105
       
 
       
* Fedora

     

       
106
       
 
       
  * `fedora26x86_64`

     
···

       
126
       
 
       
  * `debian11i386`

     

       
127
       
 
       
  * `debian11x86_64`

     

       
128
       
 
       


     

       
129
       
+
       
### Attributes {#vm-tools-diskImageFuns-attributes}

     

       
130
       
 
       


     

       
131
       
 
       
* `size` (optional, defaults to `4096`). The size of the image, in MiB.

     

       
132
       
 
       
* `extraPackages` (optional). A list names of additional packages from the distribution that should be included in the image.

     

       
133
       
 
       


     

       
134
       
+
       
### Examples {#vm-tools-diskImageFuns-examples}

     

       
135
       
 
       


     

       
136
       
 
       
8GiB image containing Firefox in addition to the default packages:

     

       
137
       
 
       
```nix