Ubuntu Manpages

nix flake prefetch

download the source tree denoted by a flake reference into the Nix store

Warning
This program is experimental and its interface is subject to change.

nix flake prefetch [option…] flake-url

  • Download a tarball and unpack it:

# nix flake prefetch https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.10.5.tar.xz --out-link ./result
Downloaded 'https://cdn.kernel.org/pub/linux/kernel/v5.x/linux-5.10.5.tar.xz?narHash=sha256-3XYHZANT6AFBV0BqegkAZHbba6oeDkIUCDwbATLMhAY='
to '/nix/store/sl5vvk8mb4ma1sjyy03kwpvkz50hd22d-source' (hash
'sha256-3XYHZANT6AFBV0BqegkAZHbba6oeDkIUCDwbATLMhAY=').
# cat ./result/README
Linux kernel
…
  • Download the dwarffs flake (looked up in the flake registry):

# nix flake prefetch dwarffs --json
{"hash":"sha256-VHg3MYVgQ12LeRSU2PSoDeKlSPD8PYYEFxxwkVVDRd0="
,"storePath":"/nix/store/l06r23gw4psl1f547il2hbnwnxaplbaz-source"}

This command downloads the source tree denoted by flake reference flake-url. Note that this does not need to be a flake (i.e. it does not have to contain a flake.nix file).

Produce output in JSON format, suitable for consumption by another program.
Print compact JSON output on a single line, even when the output is a terminal. Some commands may print multiple JSON objects on separate lines.

            See `--pretty`.
Create symlink named path to the resulting store path.
Print multi-line, indented JSON output for readability.

            Default: indent if output is to a terminal.
            This option is only effective when `--json` is also specified.

Pass the value expr as the argument name to Nix functions.
Pass the contents of file path as the argument name to Nix functions.
Pass the contents of stdin as the argument name to Nix functions.
Pass the string string as the argument name to Nix functions.
Start an interactive environment if evaluation fails.
The URL of the Nix store to use for evaluation, i.e. to store derivations (.drv files) and inputs referenced by them.
Allow access to mutable paths and repositories.
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 the flake registries, redirecting original-ref to resolved-ref.
Commit changes to the flake’s lock file.
Use the inputs of the specified flake as registry entries.
Don’t allow lookups in the flake registries.
DEPRECATED
Use --no-use-registries instead.
Do not allow any updates to the flake’s lock file.
Do not write the flake’s newly generated lock file.
Write the given lock file instead of flake.lock within the top-level flake.
Override a specific flake input (e.g. dwarffs/nixpkgs). The input path must not be empty. This implies --no-write-lock-file.
Recreate the flake’s lock file from scratch.
DEPRECATED
Use nix flake update instead.
Read the given lock file instead of flake.lock within the top-level flake.
Update a specific flake input (ignoring its previous entry in the lock file).
DEPRECATED
Use nix flake update instead.
Set the logging verbosity level to ‘debug’.
Set the format of log output; one of raw, internal-json, bar or bar-with-logs.
Print full build logs on standard error.
Decrease the logging verbosity level.
Increase the logging verbosity level.

Show usage information.
Disable substituters and consider all previously downloaded files up-to-date.
Set the Nix configuration setting name to value (overriding nix.conf).
Consider all previously downloaded files out-of-date.
During evaluation, rewrite missing or corrupted files in the Nix store. During building, rebuild missing or corrupted store paths.
Show version information.

Note

See man nix.conf for overriding configuration settings with command line flags.