https://github.com/applicative-systems/nixos-test-driver-manual
Inofficial NixOS Test Driver Manual that gets you up to speed with the NixOS Test driver, interactive mode, VMs, containers, GPU tests, and more.
https://github.com/applicative-systems/nixos-test-driver-manual
manual nixos test test-automation testing
Last synced: 14 days ago
JSON representation
Inofficial NixOS Test Driver Manual that gets you up to speed with the NixOS Test driver, interactive mode, VMs, containers, GPU tests, and more.
- Host: GitHub
- URL: https://github.com/applicative-systems/nixos-test-driver-manual
- Owner: applicative-systems
- Created: 2026-04-06T16:56:26.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2026-05-24T10:45:03.000Z (22 days ago)
- Last Synced: 2026-05-24T12:25:30.822Z (22 days ago)
- Topics: manual, nixos, test, test-automation, testing
- Language: Shell
- Homepage: https://applicative.systems/nixos-test-driver-manual/
- Size: 6.28 MB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# NixOS Test Driver Manual
Opinionated, hands-on documentation for the NixOS integration test driver.
This repository contains the source for the manual published at:
-
The goal of this manual is to complement the [official NixOS manual](https://nixos.org/manual/nixos/stable/#sec-nixos-tests) with practical tutorials, feature guides, best practices, and runnable examples.
## What is in this repository?
- `docs/`: the MkDocs source for the published manual
- `examples/`: runnable example tests used throughout the documentation
- `flake.nix`: development, formatting, documentation, and example test outputs
- `mkdocs.yml`: site structure and theme configuration
## Read the manual
Good starting points:
- [Setup](./docs/setup.md)
- [Tutorials](./docs/tutorials/index.md)
- [Features](./docs/features/index.md)
- [Best Practices](./docs/best-practices/index.md)
## Build the documentation
Build the static site with Nix:
```console
nix build .#documentation
```
The generated site will be available through the `result/` symlink.
## Run the example tests
This repository exposes several example tests as flake packages:
```console
nix build .#test-minimal
nix build .#test-ping
nix build .#test-browser
```
For interactive debugging examples:
```console
nix build .#test-browser.driverInteractive
./result/bin/run-nixos-test
```
## Development
Enter the development shell:
```console
nix develop
```
Format the repository:
```console
nix fmt
```
## Maintainers
This manual is maintained by [Applicative Systems](https://applicative.systems).