NIXTAMAL-UPGRADE(1)

📦 version 2.4.0, in nixpkgs unstable

🎀 nixtamal-upgrade(1) — the Nixtamal Manual, bestie edition 🎀

okay so real talk: this is the nixtamal-upgrade page from the Nixtamal Manual, and it's literally the glow-up page. it takes your lockfile & manifest and upgrades them to the current schema version. that's the whole vibe. 💅

✨ NAME ✨

nixtamal-upgrade — upgrade lockfile & manifest to current schema version. periodt.

🌸 SYNOPSIS 🌸

nixtamal upgrade [OPTION]…

that's it. that's the whole invocation. options go after, and there are a lot of them, so buckle up 🫶

👑 LICENSE 👑

GNU General Public License, version 3.0 later (GPL-3.0-or-later). slay and free, as in freedom 🦋

🧚 MAKER 🧚

toastal <https://toast.al/contact/> — the main character who made this 💜

💖 FUNDING 💖

See: https://toast.al/funding/ — yes this is your sign to check it out, no cap 🌈

⭐ OPTIONS ⭐

  • --color=WHEN (absent=auto or NIXTAMAL_OUTPUT_COLOR env) — colorize the output, aesthetic matters. 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). that's where the magic lives 🏠
  • --dry-run — show what would be upgraded without making changes (basic). like a vibe check before the real thing, iykyk.
  • --from=VERSION — upgrade from a specific version. must match the lockfile version, fr fr — no gaslighting the lockfile.
  • -j INT, --jobs=INT (absent=80 or NIXTAMAL_JOBS env) — Nixtamal's executor pool domain size. yes, 80 is the default, she's ambitious 🔥
  • -q, --quiet — be quiet. takes over -v and --verbosity. not me silencing the whole group chat 💀
  • --to=VERSION — upgrade to a specific version. must be newer than --from, lowkey obvious but we said it anyway.
  • -v, --verbose — increase verbosity. repeatable, but more than twice does not bring more. so -vv and then like... chill 😭
  • --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 faves, here for every invocation 🫶

  • --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.
  • --version — show version information. the classic. iconic. 🎀

🌈 EXIT STATUS 🌈

nixtamal upgrade exits with:

  • 0 — on success. we love a happy ending 💖
  • 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. (yes, that's literally this command, go off 👑)
  • 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. silent treatment, rude 😭
  • 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). if you see this one, it's not you, it's them 🙈

💜 ENVIRONMENT 💜

these environment variables affect the execution of nixtamal upgrade:

  • 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>. yes that's a real link, go say hi, the group chat is open 🫶

🍓 SEE ALSO 🍓

that's the whole page bestie, go upgrade something and slay ✨

💌 cute sign-off: this was Nixtamal 2.4.0, page NIXTAMAL-UPGRADE(1) — see you in the next manpage, mwah 🎀
📦 where this page comes from