divnix/digga
1
1
Fork 0
mirror of https://github.com/divnix/digga.git synced 2024-12-22 23:51:39 +03:00
Code Issues Projects Releases Wiki Activity
A flake utility library to craft shell-, home-, and hosts- environments.
1,165 Commits 12 Branches 7 Tags 5.4 MiB
Nix 98.7%
Shell 1.3%
7e9b1c57ac
Go to file
David Arnold 7e9b1c57ac fix: bootstrap image naming 
transparency.
2022-02-23 15:23:14 -08:00
.github add: cachix action 2022-02-23 15:23:14 -08:00
checks fix: boostrap iso module 2022-02-23 15:23:14 -08:00
doc imp: add per host tests 2022-02-23 15:23:14 -08:00
examples bump: dowstream test 2022-02-23 15:23:14 -08:00
jobs docs: fix gotcha about default channel 2022-02-23 15:23:14 -08:00
modules fix: bootstrap image naming 2022-02-23 15:23:14 -08:00
overlays ref: reorganise exported confenience modules & overlays 2022-02-23 15:23:14 -08:00
src imp: add per host tests 2022-02-23 15:23:14 -08:00
ufr-polyfills fmt 2022-02-23 15:23:14 -08:00
.editorconfig copy over .editorconfig from devos 2022-02-23 15:22:07 -08:00
.gitignore add gitignore and remove nix build result 2022-02-23 15:22:07 -08:00
.gitmodules satisfy pre-commit hook (editorconfig / format) 2022-02-23 15:23:14 -08:00
bors.toml add github actions and bors configuration 2022-02-23 15:22:07 -08:00
CHANGELOG.md Update Changelog for tag 2022-02-23 15:23:14 -08:00
COPYING add README and COPYING 2022-02-23 15:22:07 -08:00
deprecated.nix ref: adapt to fup upstream refactoring 2022-02-23 15:23:14 -08:00
flake.lock fix: bump flake-utils-plus with a regression w.r.t exportModules reverted 2022-02-23 15:23:14 -08:00
flake.nix fix: mkFlake options & functor 2022-02-23 15:23:14 -08:00
README.md docs: add general docs (w/o library reference) 2022-02-23 15:23:14 -08:00
shell.nix fix: check wrapper 2022-02-23 15:23:14 -08:00

README.md

Bors enabled MIT License NixOS Chat

⚠ Advisory ⚠

Digga requires the flakes feature available via an experimental branch of nix. Until nix 3.0 is released, this project should be considered unstable, though quite usable as flakes have been maturing well for a while.

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.

Usage

The best way to make use of library is with the Official template.

You can also have a look at the different examples.

Philosophy

In it's lib.mkFlake function, digga implements a well-secified 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 form 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.

License

Digga is licensed under the MIT License.