NIXTAMAL(1)

📦
version 2.4.0 · 2 versions
, in nixpkgs unstable

💅 NIXTAMAL(1) 💅

okay bestie, welcome to the Nixtamal Manual — section 1 of the manual, the command-line girlies. this is your girl's whole personality in one page, so grab a boba and let's go 🧋✨

🌸 NAME 🌸

nixtamal — fulfilling input pinning for Nix. that's it, that's the whole vibe. it pins your inputs. it fulfills them. iconic behavior fr fr 💅

✨ SYNOPSIS ✨

nixtamal COMMAND …

literally just pick a command and go, no cap 🫶

📜 LICENSE 📜

GNU General Public License, version 3.0 later (GPL-3.0-or-later). free software, the legal kind, slay 💖

🎀 MAKER 🎀

toastal <https://toast.al/contact/> — the main character who built all this, we stan 👑

💸 FUNDING 💸

See: https://toast.al/funding/ — if this tool ate and left no crumbs for you, the link is right there 🌈

🦋 COMMANDS 🦋

  • check-soundness [OPTION]… — Checks that the manifest × lockfile is sound. it's giving "sanity check but make it fashion" ✨
  • gc [OPTION]… — Garbage collect old generations (experimental). heads up bestie: this one requires NIXTAMAL_EXPERIMENTAL_GC to be set & is probably still broken 😭 it keeps the freshest (configurable) number of generations. we suggest at least 2 if you're favoring rebase-style workflows, so swapping back & forth is less trouble. bestie protection, you know? 🫶
  • list-stale [OPTION]… — List stale inputs with fresh-cmd, without refreshing. look at them, don't touch them 💀
  • lock [OPTION]… [INPUT_NAME]… — Lock all not-yet-locked inputs. lock in, literally 🔒
  • refresh [OPTION]… [INPUT_NAME]… — Refreshes all non-frozen inputs using the fresh-cmd — or the default fresh-cmd for certain kinds with a reasonable default (Git, some files/archives) — & then locks stale inputs. glow-up for your inputs, periodt ✨
  • set-up [OPTION]… — Set up working directory for Nixtamal. by default, also adds Nixpkgs from upstream to the project's inputs 🎀
  • show [OPTION]… — Shows current inputs as understood by Nixtamal for earthlings. yes bestie, that means you, a human 💖
  • tweak [OPTION]… — Tweak the manifest file with $VISUAL, $EDITOR, or vi. your editor, your rules 💅
  • upgrade [OPTION]… — Upgrade lockfile & manifest to current schema version. out with the old, in with the new 🦋

🌟 COMMON OPTIONS 🌟

  • --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. iykyk 🙈
  • --version — Show version information. who am i? you're that girl 🎀

💀 EXIT STATUS 💀

nixtamal exits with:

  1. 0 — on success. ate. 💅
  2. 65 — Nixtamal working directory or manifest not set up. Run nixtamal set-up. you forgot to get ready first 😭
  3. 66 — Version mismatch between manifest and lockfile. Run nixtamal lock, but might require removing the lockfile first until nixtaml fast-forward is made. yes, removing — no thoughts head empty, just delete 🔥
  4. 67 — Manifest ∨ lockfile is not using the latest schema version. Run nixtamal upgrade to upgrade. respectfully, upgrade ✨
  5. 68 — Failed to parse the manifest file. she's not reading 💀
  6. 69 — Failed to parse the lockfile. her either 💀
  7. 70 — Failed to serialize lockfile.
  8. 71 — Fresh command execution threw an exception. the vibes were off 😭
  9. 72 — Fresh command output nothing. silence. awkward silence. 🙈
  10. 73 — Prefetch command threw an exception.
  11. 74 — Prefetch command output was unusable. gave us nothing usable ngl
  12. 75 — Prefetch command flopped on JSON output. flopped fr fr 💀
  13. 76 — Darcs context file is missing or invalid. Try running nixtamal lock on the input.
  14. 77 — Vendored patch file is missing. Try running nixtamal lock to fetch it.
  15. 78 — Silo error (such as bad hex in generation number). bad hex, bad vibes 🎀
  16. 79 — Version not found or invalid in manifest file.
  17. 80 — Upgrading Nixtamal failed. the glow-up did not go as planned 😭
  18. 81 — BLAKE3 hash algorithm is requested but this Nix doesn't support it. your Nix said "not today" 🙅
  19. 82 — Input kind mismatch between manifest & lockfile which prevents values to be melded. they're not compatible bestie, we don't force it 💔
  20. 83 — Blueprint scaffolding failed to write files.
  21. 84 — A patch failed to apply. the patch said no 💀
  22. 85 — An input references patches that are not defined in the manifest. ghost patches. not the cute kind 👻
  23. 123 — on indiscriminate errors reported on standard error.
  24. 124 — on command line parsing errors.
  25. 125 — on unexpected internal errors (bugs). a bug! not the cute kind either 🐛

🐚 SEE ALSO 🐚

the whole friend group honestly 🫶✨

🫶 BUGS 🫶

No tracker is set up; contact the maker directly or join the XMPP chatroom @ <xmpp:nixtamal@chat.toastal.in.th?join>. no cap, just pull up and say hi 💜

ngl if something's cursed, go straight to the source — the maker is right there and the chatroom is open.

okay that's the whole page bestie, you're officially caught up 💖 this was Nixtamal 2.4.0 — the version and the date live down here in the footer like the little signature it is. go pin some inputs, you're gonna slay 🌸💅✨

📦 where this page comes from