nix3-profile-install(1)

📦
version 2.26.3 · 6 versions
, in debian trixie, ubuntu questing

💖 nix3-profile-install(1) 💖

okay so this lil page lives in the General Commands Manual, and it's literally all about nix profile install. sit with me bestie, we're gonna get you fluent 💅

⚠️ Warning — this program is experimental and its interface is subject to change. (translating: it works, it slays, but the API might glow up on you without warning 🙈)

✨ Name ✨

nix profile install — install a package into a profile. that's it, that's the whole job, and it eats every time 🫶

🌈 Synopsis 🌈

nix profile install [option…] installables…

🎀 Examples 🎀

here's the vibe, in four iconic flavours:

  • Install a package from Nixpkgs:
# nix profile install nixpkgs#hello
  • Install a package from a specific branch of Nixpkgs:
# nix profile install nixpkgs/release-20.09#hello
  • Install a package from a specific revision of Nixpkgs:
# nix profile install nixpkgs/d73407e8e6002646acfdef0e39ace088bacc83da#hello
  • Install a specific output of a package:
# nix profile install nixpkgs#bash^man

see how the flake ref just keeps getting more specific? it's giving glow up, not me doing too much 💅

🌸 Description 🌸

This command adds installables to a Nix profile. that's the whole main character moment — you point at stuff, it goes in your profile, no cap ✨

💜 Options 💜

  • --priority priority — the priority of the package to install.
  • --profile path — the profile to operate on.
  • --stdin — read installables from the standard input. No default installable applied. (so like, it won't just assume one for you, you gotta feed it 😌)

🔥 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. (safety net era 🧚)
  • --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. (letting the chaos in fr fr)
  • --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. (old news bestie, move on 🫶)
  • --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). 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'. (maximum yapping, we love to see it)
  • --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.
  • --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 will be 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, you're officially fluent in nix profile install 🎀✨

this iconic lil page signs off as nix3-profile-install(1) — that's the source/version tag and the whole footer vibe, so go forth and install things, iykyk 💖🦋👑

📦 where this page comes from