nix3-bundle(1)

📦
version 2.35.3 · 13 versions
, in fedora 44

💅 nix3-bundle(1) — General Commands Manual, bestie edition

okay so real talk: this page lives in the Nix 3 section of the General Commands Manual, and it's all about nix bundle. Buckle up, she's cute but she's experimental 🧪

⚠️ Warning: this program is experimental and its interface is subject to change. No cap. She might switch up on you.

✨ Name ✨

nix bundle — bundle an application so that it works outside of the Nix store 🎀

🌸 Synopsis 🌸

nix bundle [option…] installable

🦋 Examples 🦋

  1. Bundle Hello 💖
# nix bundle nixpkgs#hello
# ./hello
Hello, world!
  1. Bundle a specific version of Nix 👑
# nix bundle github:NixOS/nix/e3ddffb27e5fc37a209cfd843c6f7f6a9460a8ec
# ./nix --version
nix (Nix) 2.4pre20201215_e3ddffb
  1. Bundle a Hello using a specific bundler 🎁
# nix bundle --bundler github:NixOS/bundlers#toDockerImage nixpkgs#hello
# docker load < hello-2.10.tar.gz
# docker run hello-2.10:latest hello
Hello, world!

💜 Description 💜

nix bundle, by default, packs the closure of the installable into a single self-extracting executable. See the bundlers homepage for more details. it's giving "one file, all the vibes" ✨

📝 Note: This command only works on Linux. sorry to the mac girlies 😭

🌈 Flake output attributes 🌈

If no flake output attribute is given, nix bundle tries the following flake output attributes:

  • bundlers.<system>.default

If an attribute name is given, nix bundle tries the following flake output attributes:

  • bundlers.<system>.<name>

🎀 Bundlers 🎀

A bundler is specified by a flake output attribute named bundlers.<system>.<name>. It looks like this:

bundlers.x86_64-linux = rec {
  identity = drv: drv;

  blender_2_79 = drv: self.packages.x86_64-linux.blender_2_79;

  default = identity;
};

A bundler must be a function that accepts an arbitrary value (typically a derivation or app definition) and returns a derivation. that's the whole vibe check ✅

✨ OPTIONS ✨

  • --bundler, -B flake-url — use a custom bundler instead of the default (github:NixOS/bundlers).
  • --out-link, -o path — override the name of the symlink to the build result. it defaults to the base name of the app. 💅

🧚 Common evaluation options 🧚

  • --arg name expr — pass the value expr as the argument name to Nix functions.
  • --arg-from-file name path — pass the contents of file path as the argument name to Nix functions.
  • --arg-from-stdin name — pass the contents of stdin as the argument name to Nix functions.
  • --argstr name string — pass the string string as the argument name to Nix functions.
  • --debugger — start an interactive environment if evaluation fails. slay, debug mode 🐛
  • --eval-store store-url — the URL of the Nix store to use for evaluation, i.e. to store derivations (.drv files) and inputs referenced by them.
  • --impure — allow access to mutable paths and repositories. living dangerously, love that for you 🙈
  • --include, -I path — add path to search path entries used to resolve lookup paths.

This option may be given multiple times.

Paths added through -I take precedence over the nix-path configuration setting and the NIX_PATH environment variable.

  • --override-flake original-ref resolved-ref — override the flake registries, redirecting original-ref to resolved-ref.
  • --commit-lock-file — commit changes to the flake's lock file.
  • --inputs-from flake-url — use the inputs of the specified flake as registry entries.
  • --no-registries — don't allow lookups in the flake registries.
💀 DEPRECATED — use --no-use-registries instead.
  • --no-update-lock-file — do not allow any updates to the flake's lock file.
  • --no-write-lock-file — do not write the flake's newly generated lock file.
  • --output-lock-file flake-lock-path — write the given lock file instead of flake.lock within the top-level flake.
  • --override-input input-path flake-url — override a specific flake input (e.g. dwarffs/nixpkgs). The input path must not be empty. This implies --no-write-lock-file.
  • --recreate-lock-file — recreate the flake's lock file from scratch.
💀 DEPRECATED — use nix flake update instead.
  • --reference-lock-file flake-lock-path — read the given lock file instead of flake.lock within the top-level flake.
  • --update-input input-path — update a specific flake input (ignoring its previous entry in the lock file).
💀 DEPRECATED — use nix flake update instead.
  • --debug — set the logging verbosity level to 'debug'.
  • --log-format format — set the format of log output; one of raw, internal-json, bar or bar-with-logs.
  • --print-build-logs, -L — print full build logs on standard error.
  • --quiet — decrease the logging verbosity level. shhh 🤫
  • --verbose, -v — increase the logging verbosity level.

⭐ Miscellaneous global options ⭐

  • --help — show usage information.
  • --offline — disable substituters and consider all previously downloaded files up-to-date.
  • --option name value — set the Nix configuration setting name to value (overriding nix.conf).
  • --refresh — consider all previously downloaded files out-of-date.
  • --repair — during evaluation, rewrite missing or corrupted files in the Nix store. During building, rebuild missing or corrupted store paths.
  • --version — show version information.

🍓 Options that change the interpretation of installables 🍓

  • --expr expr — interpret installables as attribute paths relative to the Nix expression expr.
  • --file, -f file — interpret installables as attribute paths relative to the Nix expression stored in file. If file is the character -, then a Nix expression is read from standard input. Implies --impure.
📝 Note: see man nix.conf for overriding configuration settings with command line flags.

and that's the whole page, bestie — no crumbs left behind 💖✨

signing off from nix3-bundle(1) in the General Commands Manual 🦋 periodt. 👑

📦 where this page comes from