Skip to content

disambiguate from nix flake check #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
maxheld83 wants to merge 2 commits into
base: main
Choose a base branch
from
+6 −0
Open

disambiguate from nix flake check #220

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a6d3a6e
disambiguate Flake Checker from `nix flake check`
maxheld83 Mar 25, 2026
cd85353
fix order
maxheld83 Mar 25, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -150,6 +155,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
[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
Expand Down