NIXTAMAL-SET-UP(1)
NAME
nixtamal-set-up - Set up working directory for Nixtamal. By default, also adds Nixpkgs from upstream to the project's inputs.
SYNOPSIS
nixtamal set-up [OPTION]…
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/
OPTIONS
- -b BLUEPRINT, --blueprint=BLUEPRINT
- Make a complete project structure based on a blueprint to give a starting off point to build on.
- --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)
- --fetch-time=FETCH_TIME
- The default fetch time to be used for inputs.
- --hash-algorithm=HASH_ALGORITHM
- The default algorithm to be used for inputs & patches.
- -j INT, --jobs=INT (absent=32 or NIXTAMAL_JOBS env)
- Nixtamal’s executor pool domain size.
- --nixpkgs-channel=CHANNEL_NAME (absent NIXTAMAL_NIXPKGS_CHANNEL env)
- Nixpkgs Git channel for Nixtamal setup (such as “nixpkgs-unstable”). Both --nixpkgs-channel & --nixpkgs-ref cannot be used at the same time.
- --nixpkgs-ref=REF (absent NIXTAMAL_NIXPKGS_REF env)
- Nixpkgs Git ref for Nixtamal setup (such as “refs/heads/nixos-25.11”; default: refs/heads/nixos-unstable). Both --nixpkgs-channel & --nixpkgs-ref cannot be used at the same time.
- --nixpkgs-revision=REVISION (absent NIXTAMAL_NIXPKGS_REVISION env)
- Nixpkgs Git revision for Nixtamal setup. The value will be used as the latest revision/change.
- --no-nixpkgs (absent NIXTAMAL_NO_NIXPKGS env)
- Do not add Nixpkgs to the pinned inputs list by default.
- -q, --quiet
- Be quiet. Takes over -v and --verbosity.
- --use-channels (absent NIXTAMAL_USE_NIXPKGS_CHANNELS env)
- Channels are more efficient being compressed with LZMA instead of gzip, doesn’t rely on US megacorpations, & would be recommend — however, the syntax for this setup is less intuitive/portable to users while also not providing a clear template for Git archives to be remixed for other inputs making it not the default for newcomers.
- --use-nixpkgs-git-mirrors (absent NIXTAMAL_USE_NIXPKGS_GIT_MIRRORS env)
- For resilience, add known Nixpkgs Git mirrors to fallback on when the Nixpkgs’s Microsoft GitHub host inevitably goes down again. Off by default as the Git updating is slightly slower & some users might object to TUNA’s hosting origin state.
- -v, --verbose
- Increase verbosity. Repeatable, but more than twice does not bring more.
- --vcs=VCS (absent=auto)
- VCS for ignore file setup.
- --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 set-up 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).
ENVIRONMENT
These environment variables affect the execution of nixtamal set-up:
- NIXTAMAL_DIRECTORY
- Directory for Nixtamal
- NIXTAMAL_JOBS
- See option --jobs.
- NIXTAMAL_LOG_LEVEL
- See option --verbosity.
- NIXTAMAL_NIXPKGS_CHANNEL
- See option --nixpkgs-channel.
- NIXTAMAL_NIXPKGS_REF
- See option --nixpkgs-ref.
- NIXTAMAL_NIXPKGS_REVISION
- See option --nixpkgs-revision.
- NIXTAMAL_NO_NIXPKGS
- See option --no-nixpkgs.
- NIXTAMAL_OUTPUT_COLOR
- See option --color.
- NIXTAMAL_USE_NIXPKGS_CHANNELS
- See option --use-channels.
- NIXTAMAL_USE_NIXPKGS_GIT_MIRRORS
- See option --use-nixpkgs-git-mirrors.
BUGS
No tracker is set up; contact the maker directly or join the XMPP chatroom @ <xmpp:nixtamal@chat.toastal.in.th?join>.
SEE ALSO
- nixtamal(1)
- fulfilling input pinning for Nix
- nixtamal-manifest(5)
- manifest.kdl format
nixtamal(1)
| Nixtamal 1.9.2 |