nix3-formatter-build(1)

📦 version 2.35.3, in fedora 44

💖 nix3-formatter-build(1) 💖

okay bestie, welcome to the General Commands Manual page for nix formatter build. sit down, hydrate, let's go ✨

⚠️ Warning, babes — this program is experimental and its interface is subject to change. no cap. it might glow up and change its whole personality on you.

🎀 Name 🎀

nix formatter build — build the current flake's formatter 🌸

🦋 Synopsis 🦋

nix formatter build [option…]

✨ Description ✨

nix formatter build builds the formatter specified in the flake. that's it, that's the whole vibe 💅

it's similar to nix build, except — unless you pass --no-link — after a successful build it creates a symlink to the store path of the formatter. that symlink is named ./result by default, lowkey iconic, and you can override that with the --out-link option.

and it always prints the command to standard output. always. every time. periodt. 🫶

🔥 Examples 🔥

  • Build the formatter:
# nix formatter build
/nix/store/cb9w44vkhk2x4adfxwgdkkf5gjmm856j-treefmt/bin/treefmt

👑 Options 👑

  • --no-link — do not create symlinks to the build results. no result link for you, sorry bestie 🙈
  • --out-link / -o path — use path as the prefix for the symlinks to the build results. it defaults to result.

🌈 Common evaluation options 🌈

  • --arg name expr — pass the value expr as the argument name to Nix functions.
  • --arg-from-file name path — pass the contents of file path as the argument name to Nix functions.
  • --arg-from-stdin name — pass the contents of stdin as the argument name to Nix functions.
  • --argstr name string — pass the string string as the argument name to Nix functions.
  • --debugger — start an interactive environment if evaluation fails. it's giving "we can fix this together" energy 🥺
  • --eval-store store-url — the URL of the Nix store to use for evaluation, i.e. to store derivations (.drv files) and inputs referenced by them.
  • --impure — allow access to mutable paths and repositories. living dangerously, we love that for you 💀
  • --include / -I path — add path to search path entries used to resolve lookup paths.

This option may be given multiple times.

Paths added through -I take precedence over the nix-path configuration setting and the NIX_PATH environment variable. so like, -I is the main character here 👑

  • --override-flake original-ref resolved-ref — override the flake registries, redirecting original-ref to resolved-ref. gaslight gatekeep girlboss 🎀
  • --commit-lock-file — commit changes to the flake's lock file. yes queen, save your work 💾
  • --inputs-from flake-url — use the inputs of the specified flake as registry entries.
  • --no-registries — don't allow lookups in the flake registries.
DEPRECATED 🚫 — use --no-use-registries instead. it's old news, we've moved on.
  • --no-update-lock-file — do not allow any updates to the flake's lock file.
  • --no-write-lock-file — do not write the flake's newly generated lock file.
  • --output-lock-file flake-lock-path — write the given lock file instead of flake.lock within the top-level flake.
  • --override-input input-path flake-url — override a specific flake input (e.g. dwarffs/nixpkgs). the input path must not be empty. this implies --no-write-lock-file. sneaky little implication, ngl 🙈
  • --recreate-lock-file — recreate the flake's lock file from scratch.
DEPRECATED 🚫 — use nix flake update instead.
  • --reference-lock-file flake-lock-path — read the given lock file instead of flake.lock within the top-level flake.
  • --update-input input-path — update a specific flake input (ignoring its previous entry in the lock file).
DEPRECATED 🚫 — use nix flake update instead.
  • --debug — set the logging verbosity level to debug. loud and proud 🗣️
  • --log-format format — set the format of log output; one of raw, internal-json, bar or bar-with-logs.
  • --print-build-logs / -L — print full build logs on standard error.
  • --quiet — decrease the logging verbosity level. shhh 🤫
  • --verbose / -v — increase the logging verbosity level. tell me EVERYTHING 💜

🌟 Miscellaneous global options 🌟

  • --help — show usage information.
  • --offline — disable substituters and consider all previously downloaded files up-to-date.
  • --option name value — set the Nix configuration setting name to value (overriding nix.conf).
  • --refresh — consider all previously downloaded files out-of-date.
  • --repair — during evaluation, rewrite missing or corrupted files in the Nix store. during building, rebuild missing or corrupted store paths.
  • --version — show version information.

🍓 Options that change the interpretation of installables 🍓

  • --expr expr — interpret installables as attribute paths relative to the Nix expression expr.
  • --file / -f file — interpret installables as attribute paths relative to the Nix expression stored in file. if file is the character -, then a Nix expression is read from standard input. implies --impure.
📝 Note — see man nix.conf for overriding configuration settings with command line flags.

okay that's the whole page bestie, you ate that 📚✨

💅 sign-off, fr fr: that was nix3-formatter-build(1) straight out of the General Commands Manual. go build something cute. bye bestie, ily 🫶🎀
📦 where this page comes from