From 11b35f0a108fd1197b60637cf8b181a26460c846 Mon Sep 17 00:00:00 2001 From: Nathan Henrie Date: Mon, 23 Jun 2025 09:13:58 -0600 Subject: [PATCH] doc: clarify lack of support when using nondefault implementations Also format codeblock RFC style, use `lib.getExe` --- doc/overriding-age-binary.md | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/doc/overriding-age-binary.md b/doc/overriding-age-binary.md index 34ae232..2d3a5c7 100644 --- a/doc/overriding-age-binary.md +++ b/doc/overriding-age-binary.md @@ -4,9 +4,17 @@ The agenix CLI uses `age` by default as its age implemenation, you can use the `rage` implementation with Flakes like this: ```nix -{pkgs,agenix,...}:{ +{ + pkgs, + lib, + agenix, + ... +}: +{ environment.systemPackages = [ - (agenix.packages.x86_64-linux.default.override { ageBin = "${pkgs.rage}/bin/rage"; }) + (agenix.packages.x86_64-linux.default.override { ageBin = lib.getExe pkgs.rage; }) ]; } ``` + +Please note that the behavior of alternative implementations may not match that required for agenix to function, and the agenix team does not plan to provide support for bugs encountered when using agenix with nondefault implementations.