NIXTAMAL-CHECK-SOUNDNESS(1)

📦 version 2.4.0, in nixpkgs unstable

🌸 NIXTAMAL-CHECK-SOUNDNESS 🌸

okay so bestie, welcome to the Nixtamal Manual — this page is nixtamal-check-soundness, and it's basically the vibe-checker for your manifest × lockfile 🫶

✨ NAME ✨

nixtamal-check-soundness — Checks that the manifest × lockfile is sound.

🎀 SYNOPSIS 🎀

nixtamal check-soundness [OPTION]…

💖 LICENSE 💖

GNU General Public License, version 3.0 later (GPL-3.0-or-later) — free as in slay, periodt.

👑 MAKER 👑

toastal <https://toast.al/contact/> — the main character who built all this 💅

🍓 FUNDING 🍓

See: https://toast.al/funding/ — ngl, tossing a coin their way is iconic behaviour.

🌈 OPTIONS 🌈

okay so these are all the little dials and knobs you can turn:

  • --color=WHEN (absent=auto or NIXTAMAL_OUTPUT_COLOR env) — colorizes the output, because plain text is lowkey giving sad beige. WHEN must be one of auto, always or never.
  • --directory=PATH (absent NIXTAMAL_DIRECTORY env) — the working directory for Nixtamal-related files (default: $PWD/nix/tamal).
  • -j INT, --jobs=INT (absent=80 or NIXTAMAL_JOBS env) — Nixtamal's executor pool domain size. eighty threads by default, she's ambitious fr fr.
  • -q, --quiet — Be quiet. Takes over -v and --verbosity. like, shush 💀
  • -v, --verbose — Increase verbosity. Repeatable, but more than twice does not bring more. so don't spam it, bestie, it peaks at two.
  • --verbosity=LEVEL (absent=warning or NIXTAMAL_LOG_LEVEL env) — Be more or less verbose. LEVEL must be one of quiet, error, warning, info or debug. Takes over -v.

⭐ COMMON OPTIONS ⭐

the universal besties, every manpage has 'em:

  • --help[=FMT] (default=auto) — Show this help in format FMT. The value FMT must be one of auto, pager, groff or plain. With auto, the format is pager or plain whenever the TERM env var is dumb or undefined. (petition for a cute format, but alas 🙈)
  • --version — Show version information. drop the number, queen.

💀 EXIT STATUS 💀

nixtamal check-soundness exits with:

  • 0 — on success. we love a clean run ✨
  • 65 — Nixtamal working directory or manifest not set up. Run nixtamal set-up.
  • 66 — Version mismatch between manifest and lockfile. Run nixtamal lock, but might require removing the lockfile first until nixtaml fast-forward is made.
  • 67 — Manifest ∨ lockfile is not using the latest schema version. Run nixtamal upgrade to upgrade.
  • 68 — Failed to parse the manifest file.
  • 69 — Failed to parse the lockfile.
  • 70 — Failed to serialize lockfile.
  • 71 — Fresh command execution threw an exception.
  • 72 — Fresh command output nothing.
  • 73 — Prefetch command threw an exception.
  • 74 — Prefetch command output was unusable.
  • 75 — Prefetch command flopped on JSON output.
  • 76 — Darcs context file is missing or invalid. Try running nixtamal lock on the input.
  • 77 — Vendored patch file is missing. Try running nixtamal lock to fetch it.
  • 78 — Silo error (such as bad hex in generation number).
  • 79 — Version not found or invalid in manifest file.
  • 80 — Upgrading Nixtamal failed.
  • 81 — BLAKE3 hash algorithm is requested but this Nix doesn't support it.
  • 82 — Input kind mismatch between manifest & lockfile which prevents values to be melded.
  • 83 — Blueprint scaffolding failed to write files.
  • 84 — A patch failed to apply. 😭
  • 85 — An input references patches that are not defined in the manifest.
  • 123 — on indiscriminate errors reported on standard error.
  • 124 — on command line parsing errors.
  • 125 — on unexpected internal errors (bugs). yes bestie, bugs happen, we don't gatekeep.
fr fr, if you're staring at a number in the sixties or seventies, that's a "run nixtamal lock" kind of situation. the manpage literally tells you which one, so read it, iykyk 💅

🦋 ENVIRONMENT 🦋

these environment variables affect the execution of nixtamal check-soundness:

  • NIXTAMAL_DIRECTORY — Directory for Nixtamal.
  • NIXTAMAL_JOBS — See option --jobs.
  • NIXTAMAL_LOG_LEVEL — See option --verbosity.
  • NIXTAMAL_OUTPUT_COLOR — See option --color.

🧚 BUGS 🧚

No tracker is set up; contact the maker directly or join the XMPP chatroom @ <xmpp:nixtamal@chat.toastal.in.th?join>. it's giving cozy group chat energy, come hang out 💜

🔥 SEE ALSO 🔥

okay that's the whole page, no cap. this was Nixtamal 2.4.0 — go forth, run your soundness checks, and remember: if it exits 0 you ate and left no crumbs 🌈💖✨

📦 where this page comes from