https://github.com/luochen1990/flake-fhs
Nix Flake Hierarchy Standard
https://github.com/luochen1990/flake-fhs
fhs nix nix-flake nix-flake-template nix-flakes
Last synced: 3 days ago
JSON representation
Nix Flake Hierarchy Standard
- Host: GitHub
- URL: https://github.com/luochen1990/flake-fhs
- Owner: luochen1990
- License: mit
- Created: 2025-12-11T04:57:29.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2026-03-20T06:05:22.000Z (3 months ago)
- Last Synced: 2026-03-20T18:32:38.639Z (3 months ago)
- Topics: fhs, nix, nix-flake, nix-flake-template, nix-flakes
- Language: Nix
- Homepage: https://flake-fhs.lambda.lc/
- Size: 400 KB
- Stars: 7
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Agents: AGENTS.md
Awesome Lists containing this project
README
# Flake FHS
**Flake FHS** (Flake Filesystem Hierarchy Standard) is a Nix Flake framework that automatically generates flake outputs based on a standardized directory structure.
## A Directory Tree is a Flake
Just drop your files into the designated directories, and the corresponding Flake outputs are automatically generated:
* `pkgs/` -> `packages`
* `hosts/` -> `nixosConfigurations`
* `modules/` -> `nixosModules`
* `apps/` -> `apps`
* `shells/` -> `devShells`
* `checks/` -> `checks`
* `lib/` -> `lib`
## Why Flake FHS?
* **Zero Boilerplate**: No more manually maintaining complex and repetitive `flake.nix` code.
* **Predictable Structure**: Standardized directory hierarchy makes any project architecture instantly understandable.
* **Unified Paradigm**: All outputs share the same consistent dependency injection mechanism.
* **Progressive Adoption**: Can be used alongside your existing Flake configuration for a smooth transition.
## Quick Start
```bash
# Initialize a new project with the short-name template
nix flake init --template github:luochen1990/flake-fhs
```
## Documentation
- Visit the official documentation site: [**flake-fhs.lambda.lc**](https://flake-fhs.lambda.lc)
- Or GitHub Docs Repo：[**flake-fhs-docs**](https://github.com/luochen1990/flake-fhs-docs/tree/master/src/content/docs) when the website is down
---
MIT License | Copyright © 2025 Luochen