From a6d3a6ea58349f930bf1ef4fdf9c55358b04df97 Mon Sep 17 00:00:00 2001 From: Max Held Date: Wed, 25 Mar 2026 21:45:52 +0100 Subject: [PATCH 1/2] disambiguate Flake Checker from `nix flake check` Perhaps others can be as confused as I am sometimes ... --- README.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/README.md b/README.md index 36e028c..5153714 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,11 @@ **Nix Flake Checker** is a tool from [Determinate Systems][detsys] that performs "health" checks on the [`flake.lock`][lockfile] files in your [flake][flakes]-powered Nix projects. Its goal is to help your Nix projects stay on recent and supported versions of [Nixpkgs]. +> [!NOTE] +> Nix Flake Checker is not [`nix flake check`][flake-check]. +> `nix flake check` checks whether a flake can be evaluated, *given* some [`flake.lock`][lockfile]. +> Nix Flake Checker (this tool) looks only at your [`flake.lock`][lockfile]. + To run the checker in the root of a Nix project: ```shell @@ -149,6 +154,7 @@ If you'd like to help make the parser more exhaustive, [pull requests][prs] are [action]: https://github.com/DeterminateSystems/flake-checker-action [cel]: https://cel.dev +[flake-check]: https://nix.dev/manual/nix/2.28/command-ref/new-cli/nix3-flake-check.html [detsys]: https://determinate.systems [flakes]: https://zero-to-nix.com/concepts/flakes [install]: https://zero-to-nix.com/start/install From cd85353d6241736bb840a1bd22e1dafdde1b33a6 Mon Sep 17 00:00:00 2001 From: Max Held Date: Wed, 25 Mar 2026 21:47:35 +0100 Subject: [PATCH 2/2] fix order --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 5153714..ede789c 100644 --- a/README.md +++ b/README.md @@ -154,8 +154,8 @@ If you'd like to help make the parser more exhaustive, [pull requests][prs] are [action]: https://github.com/DeterminateSystems/flake-checker-action [cel]: https://cel.dev -[flake-check]: https://nix.dev/manual/nix/2.28/command-ref/new-cli/nix3-flake-check.html [detsys]: https://determinate.systems +[flake-check]: https://nix.dev/manual/nix/2.28/command-ref/new-cli/nix3-flake-check.html [flakes]: https://zero-to-nix.com/concepts/flakes [install]: https://zero-to-nix.com/start/install [installer]: https://github.com/DeterminateSystems/nix-installer