divnix/digga
1
1
Fork 0
mirror of https://github.com/divnix/digga.git synced 2024-11-21 15:17:49 +03:00
Code Issues Projects Releases Wiki Activity
A flake utility library to craft shell-, home-, and hosts- environments.
1,358 Commits 12 Branches 7 Tags 5.4 MiB
Nix 98.7%
Shell 1.3%
main
Go to file
David 117be8023d
chore: update wiki links
2024-05-17 12:19:41 +02:00
.github meta: rework/cleanup/clarify bug issue template 2022-07-31 10:52:21 -04:00
checks 💎 style Format files 2022-11-12 06:02:28 -05:00
doc chore: update wiki links 2024-05-17 12:19:41 +02:00
examples 📝 devos: clarify how to use /lib/ 2023-01-25 00:03:07 -06:00
jobs 💎 style Format files 2022-11-12 06:02:28 -05:00
modules 💎 style Format files 2022-11-12 06:02:28 -05:00
overlays 💎 style Format files 2022-11-12 06:02:28 -05:00
shell ♻️ env Add flake update commands 2023-01-06 08:41:20 -05:00
src Update home-manager to 22.11 2023-01-06 13:47:48 -05:00
.editorconfig editorconfig: fixup 2020-12-30 01:00:12 -07:00
.envrc devshell: add .envrc for digga development 2022-08-04 10:11:46 -04:00
.git-blame-ignore-revs ♻️ env Ignore format commit 2022-11-12 06:02:28 -05:00
.gitignore ♻️ env Add rm-locks to pre-commit 2023-01-05 22:29:35 -05:00
CHANGELOG.md 💎 style Format files 2022-11-12 06:02:28 -05:00
COPYING init 2019-12-02 22:18:30 -07:00
default.nix 💎 style Format files 2022-11-12 06:02:28 -05:00
deprecated.nix 💎 style Format files 2022-11-12 06:02:28 -05:00
flake.lock Update home-manager to 22.11 2023-01-06 13:47:48 -05:00
flake.nix Update home-manager to 22.11 2023-01-06 13:47:48 -05:00
README.md chore: update wiki links 2024-05-17 12:19:41 +02:00
shell.nix 💎 style Format files 2022-11-12 06:02:28 -05:00
treefmt.toml ♻️ env Add other formatters 2022-11-12 06:02:28 -05:00

README.md

MIT License NixOS Chat

DEPRECATION NOTICE

This project is no longer maintained and not recommended for any sort of use case. Please see https://github.com/divnix/digga/issues/503 for better alternatives and the reasons behind this decision.

Digga — slangy German for "good friend" — is a flake utility library that helps you declaratively craft and manage all three layers of your system environment within a single nix flakes repository:

This library is based on flake-utils-plus.

Status: Beta

Although this project has already matured quite a bit, a fair amount of api polishing is still expected. There are unstable versions (0.x.x) to help users keep track of changes and progress.

Usage

The best way to make use of library is with the Official template. Check out the guide to get up and running. Also have a look at devos's flake.nix. If anything is not immediately discoverable via our mkFlake, please file a bug report.

Examples

Make sure to check out all the examples to see the different ways to make use of the digga api.

In the Wild

You can also see digga being actually used:

Philosophy

In it's lib.mkFlake function, Digga implements a well-specified API interface comprising four API containers that allow you to:

  1. configure nixpkgs channels including internal and external overlays,

  2. define NixOS hosts including internal and external NixOS modules as well as host defaults that apply to all hosts in the environment,

  3. specify user home environments including internal and external home-manager modules, and

  4. setup & combine a series of devshells that you like to have available in your projects.

Modules, Profiles & Suites

For NixOS- & home-manager-modules, Digga allows you to distinguish between modules, profiles and suites.

  • Modules are abstract configurations that, while holding the implementation, do not set any system state.

  • Profiles are concrete configurations that set system state within the profile domain.

  • Suites are a composable, clean and discoverable mechanism for profile aggregation.

Internal Art vs External Art

Overlays and modules can be defined internally coming from your repo or externally coming from an upstream flake. This distinction serves the library to only export your own work as the public flake output.

Downstream consumers of your flake can now more easily tell your art apart from other upstream art.

Contributing

We encourage contributions of any kind. The simplest way to get involved is to join the chat or report problems and ideas on the issue thread.

To craft well thought out APIs we need all the thoughts regarding new ideas.

Pull Requests are just as amazing.

Why flakes?

Flakes are a part of an explicit push to improve Nix's UX, and have become an integral part of that effort.

They also make Nix expressions easier to distribute and reuse with convient flake references for building or using packages, modules, and whole systems.

Shoulders

This work does not reinvent the wheel. It stands on the shoulders of the following giants:

🧅 — like the layers of an onion

👪 — like family

❤️

Inspiration & Art

Divnix

The divnix org is an open space that spontaneously formed out of "the Nix". It is really just a place where otherwise unrelated people work together and get stuff done.

It's a place to stop "geeking out in isolation" (or within company boundaries). A place to experiment, learn together, and iterate quickly on best practices. That's what it is.

It might eventually become a non-profit if that's not too complicated or, if those goals are sufficiently upstreamed into "the Nix", dissolved.

License

Digga is licensed under the MIT License.