NIXTAMAL(1)
NAME
nixtamal - fulfilling input pinning for Nix
SYNOPSIS
nixtamal COMMAND …
LICENSE
GNU General Public License, version 3.0 later (GPL-3.0-or-later)
MAKER
toastal <https://toast.al/contact/>
FUNDING
See: https://toast.al/funding/
COMMANDS
- check-soundness [OPTION]…
- Checks that the manifest × lockfile is sound.
- gc [OPTION]…
- Garbage collect old generations (experimental). Requires NIXTAMAL_EXPERIMENTAL_GC to be set & is probably still broken. Keeping the freshest (configurable) number of generations. We suggest at least 2 if favoring rebase-style workflows so swapping back & forth is less trouble.
- list-stale [OPTION]…
- List stale inputs with fresh-cmd, without refreshing
- lock [OPTION]… [INPUT_NAME]…
- Lock all not-yet-locked inputs.
- 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.
- 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.
- tweak [OPTION]…
- Tweak the manifest file with $VISUAL, $EDITOR, or vi
- upgrade [OPTION]…
- Upgrade lockfile & manifest to current schema version.
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 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
- Silo error (such as bad hex in generation number).
- 78
- Version not found or invalid in manifest file.
- 79
- Upgrading Nixtamal failed.
- 80
- BLAKE3 hash algorithm is requested but this Nix doesn’t support it.
- 81
- Input kind mismatch between manifest & lockfile which prevents values to be melded.
- 82
- Blueprint scaffolding failed to write files.
- 123
- on indiscriminate errors reported on standard error.
- 124
- on command line parsing errors.
- 125
- on unexpected internal errors (bugs).
SEE ALSO
- nixtamal-set-up(1)
- Set up working directory for Nixtamal
- nixtamal-check-soundness(1)
- Check manifest × lockfile soundness
- nixtamal-tweak(1)
- Tweak manifest with $EDITOR
- nixtamal-show(1)
- Show current inputs
- nixtamal-lock(1)
- Lock not-yet-locked inputs
- nixtamal-list-stale(1)
- List stale inputs
- nixtamal-refresh(1)
- Refresh non-frozen inputs
- nixtamal-gc(1)
- Garbage collect old generations
- nixtamal-upgrade(1)
- Upgrade lockfile & manifest schema
- nixtamal-manifest(5)
- manifest.kdl format
BUGS
No tracker is set up; contact the maker directly or join the XMPP chatroom @ <xmpp:nixtamal@chat.toastal.in.th?join>.
| Nixtamal 1.9.3 |