NIXTAMAL-GC(1)

📦 version 2.4.0, in nixpkgs unstable

🎀 NAME 🎀

okay so this is NIXTAMAL-GC(1), the nixtamal-gc page from the Nixtamal manual — and bestie, it's giving “garbage collect old generations” with a big EXPERIMENTAL sticker on it. 💅

nixtamal-gc garbage collects old generations. It is experimental. It requires NIXTAMAL_EXPERIMENTAL_GC to be set, and it is probably still broken. What it does is keep 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. ✨

✨ SYNOPSIS ✨

nixtamal gc [OPTION]…

📜 LICENSE 📜

GNU General Public License, version 3.0 later (GPL-3.0-or-later). 🫶

🧑‍🍳 MAKER 🧑‍🍳

toastal <https://toast.al/contact/> — no cap, that's the maker. 💖

💸 FUNDING 💸

See: https://toast.al/funding/ — support the vibes if you can. 🌸

🌸 OPTIONS 🌸

  • --color=WHEN (absent=auto or NIXTAMAL_OUTPUT_COLOR env) — colorize the output. WHEN must be one of auto, always or never.
  • --directory=PATH (absent NIXTAMAL_DIRECTORY env) — working directory for Nixtamal-related files (default: $PWD/nix/tamal).
  • --generations=INT (absent=2 or NIXTAMAL_GC_GENERATIONS env) — number of generations to keep (default: 2). Set to 0 to keep all, 1 to keep only current. Can also be set via NIXTAMAL_GC_GENERATIONS.
  • -j INT, --jobs=INT (absent=80 or NIXTAMAL_JOBS env) — Nixtamal’s executor pool domain size.
  • -q, --quiet — be quiet. Takes over -v and --verbosity.
  • -v, --verbose — increase verbosity. Repeatable, but more than twice does not bring more.
  • --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 🌈

  • --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.

🔥 EXIT STATUS 🔥

nixtamal gc exits with:

  • 0 — on success.
  • 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).

🌿 ENVIRONMENT 🌿

These environment variables affect the execution of nixtamal gc:

  • NIXTAMAL_DIRECTORY — Directory for Nixtamal
  • NIXTAMAL_GC_GENERATIONS — See option --generations.
  • 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>. 🙈

👀 SEE ALSO 👀

k bai bestie, that's the whole page — Nixtamal 2.4.0 signing off 💖✨

📦 where this page comes from