Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hercules-ci/flake-parts
❄️ Simplify Nix Flakes with the module system
https://github.com/hercules-ci/flake-parts
flake-parts flakes nix nix-modules nixos
Last synced: about 2 months ago
JSON representation
❄️ Simplify Nix Flakes with the module system
- Host: GitHub
- URL: https://github.com/hercules-ci/flake-parts
- Owner: hercules-ci
- License: mit
- Created: 2021-10-27T09:03:42.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2024-07-01T23:44:14.000Z (3 months ago)
- Last Synced: 2024-07-02T07:07:18.241Z (3 months ago)
- Topics: flake-parts, flakes, nix, nix-modules, nixos
- Language: Nix
- Homepage: https://flake.parts
- Size: 252 KB
- Stars: 670
- Watchers: 18
- Forks: 36
- Open Issues: 50
-
Metadata Files:
- Readme: README.md
- Changelog: ChangeLog.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome-github-repos - hercules-ci/flake-parts - ❄️ Simplify Nix Flakes with the module system (Nix)
- awesome-nix - flake.parts - Minimal Nix modules framework for Flakes: split your flakes into modules and get things done with community modules. (Development / Discovery)
README
# Flake Parts
_Core of a distributed framework for writing Nix Flakes._
`flake-parts` provides the options that represent standard flake attributes
and establishes a way of working with `system`.
Opinionated features are provided by an ecosystem of modules that you can import.
`flake-parts` _itself_ has the goal to be a minimal mirror of the Nix flake schema.
Used by itself, it is very lightweight.
---
**Documentation**: [flake.parts](https://flake.parts)
---
# Why Modules?
Flakes are configuration. The module system lets you refactor configuration
into modules that can be shared.
It reduces the proliferation of custom Nix glue code, similar to what the
module system has done for NixOS configurations.
Unlike NixOS, but following Flakes' spirit, `flake-parts` is not a
monorepo with the implied goal of absorbing all of open source, but rather
a single module that other repositories can build upon, while ensuring a
baseline level of compatibility: the core attributes that constitute a flake.
# Features
- Split your `flake.nix` into focused units, each in their own file.
- Take care of [system](https://flake.parts/system.html).
- Allow users of your library flake to easily integrate your generated flake outputs
into their flake.
- Reuse project logic written by others
# Getting Started
If your project does not have a flake yet:
```console
nix flake init -t github:hercules-ci/flake-parts
```
# Migrate
Otherwise, add the input,
```nix
flake-parts.url = "github:hercules-ci/flake-parts";
```
then slide `mkFlake` between your outputs function head and body,
```nix
outputs = inputs@{ flake-parts, ... }:
flake-parts.lib.mkFlake { inherit inputs; } {
flake = {
# Put your original flake attributes here.
};
systems = [
# systems for which you want to build the `perSystem` attributes
"x86_64-linux"
# ...
];
};
```
Now you can add the remaining module attributes like in the [the template](./template/default/flake.nix).
# Templates
See [the template](./template/default/flake.nix).
# Examples
See the [examples/](./examples) directory.
# Projects using flake-parts
- [nixd](https://github.com/nix-community/nixd/blob/main/flake.nix) (c++)
- [hyperswitch](https://github.com/juspay/hyperswitch/blob/main/flake.nix) (rust)
- [argo-workflows](https://github.com/argoproj/argo-workflows/blob/master/dev/nix/flake.nix) (go)
- [nlp-service](https://github.com/recap-utr/nlp-service/blob/main/flake.nix) (python)
- [emanote](https://github.com/srid/emanote/blob/master/flake.nix) (haskell)
# Options Reference
See [flake.parts options](https://flake.parts/options/flake-parts.html)