https://github.com/gaelreyrol/udev-nix

A small utility library to create udev rules with Nix!
https://github.com/gaelreyrol/udev-nix

nix udev udev-rules

Last synced: 3 days ago
JSON representation

A small utility library to create udev rules with Nix!

• Host: GitHub
• URL: https://github.com/gaelreyrol/udev-nix
• Owner: gaelreyrol
• License: lgpl-3.0
• Created: 2023-06-14T16:07:35.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-04-07T15:02:13.000Z (10 months ago)
• Last Synced: 2024-04-07T16:24:07.509Z (10 months ago)
• Topics: nix, udev, udev-rules
• Language: Nix
• Homepage:
• Size: 85 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: ReadMe.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# udev-nix

[![CI](https://github.com/gaelreyrol/udev-nix/actions/workflows/ci.yml/badge.svg)](https://github.com/gaelreyrol/udev-nix/actions/workflows/ci.yml)

> A small utility library to create udev rules with Nix!

For now this is a pet project to improve my Nix knowledge, the API might change in the future.

Don't hesitate to submit changes that will help me to improve the code 🤗.

> **DO NOT USE IN PRODUCTION**

## ToDo

- [x] Make test derivations to compare output files

- [ ] Assertions on rule keys according to the implementation

- [ ] Improve API through composition

  - [ ] Explain API functions

- [ ] Find a way to test rules on devices (in a VM)

- [ ] Create and expose a NixOS Module

- [ ] Inspire from [Disko](https://github.com/nix-community/disko) & [notnft](https://github.com/chayleaf/notnft)

- [ ] Publish library on [Links](https://discourse.nixos.org/c/links/12) category of NixOS Discourse

## Usage

### Flakes

Import the flake:

```nix

{

  inputs = {

    udev-nix.url = "github:gaelreyrol/udev-nix";

  };

}

```

Create an udev file:

```nix

{

  outputs = inputs@{ nixpkgs, udev-nix, ... }:

  let

    udevLib = udev-nix.lib."x86_64-linux";

  in

  {

    packages.x86_64-linux.myUdevFile = udevLib.mkUdevFile "20-test.rules" {

      rules = with udevLib; {

        "Description on my udev file" = {

          Subsystems = operators.match "usb";

          Tag = operators.add "uaccess";

        };

      };

    };

  };

}

```

It will produce this result:

```bash

$ cat /nix/store/pn8abdgzvafkywdpwzcn09hi0vw8np27-20-test.rules

# Description on my udev file

TAG+="uaccess", SUBSYSTEMS=="usb"

```