nix3-registry-add - Man Page
add/replace flake in user flake registry
Warning
This program is experimental and its interface is subject to change.
Synopsis
nix registry add [option…] from-url to-url
Examples
- Set the
nixpkgsflake identifier to a specific branch of Nixpkgs:
# nix registry add nixpkgs github:NixOS/nixpkgs/nixos-20.03
- Pin
nixpkgsto a specific revision:
# nix registry add nixpkgs github:NixOS/nixpkgs/925b70cd964ceaedee26fde9b19cc4c4f081196a
- Add an entry that redirects a specific branch of
nixpkgsto another fork:
# nix registry add nixpkgs/nixos-20.03 ~/Dev/nixpkgs
- Add
nixpkgspointing togithub:nixos/nixpkgsto your custom flake registry:
nix registry add --registry ./custom-flake-registry.json nixpkgs github:nixos/nixpkgs
Description
This command adds an entry to the user registry that maps flake reference from-url to flake reference to-url. If an entry for from-url already exists, it is overwritten.
Entries can be removed using nix registry remove .
Options
--registryregistryThe registry to operate on.
Common evaluation options
--argname exprPass the value expr as the argument name to Nix functions.
--arg-from-filename pathPass the contents of file path as the argument name to Nix functions.
--arg-from-stdinnamePass the contents of stdin as the argument name to Nix functions.
--argstrname stringPass the string string as the argument name to Nix functions.
--eval-storestore-urlThe URL of the Nix store to use for evaluation, i.e. to store derivations (
.drvfiles) and inputs referenced by them.--impureAllow access to mutable paths and repositories.
--include/-IpathAdd path to search path entries used to resolve lookup paths
This option may be given multiple times.
Paths added through
-Itake precedence over thenix-pathconfiguration setting and theNIX_PATHenvironment variable .--override-flakeoriginal-ref resolved-refOverride the flake registries, redirecting original-ref to resolved-ref.
Miscellaneous global options
--helpShow usage information.
--offlineDisable substituters and consider all previously downloaded files up-to-date.
--optionname valueSet the Nix configuration setting name to value (overriding
nix.conf).--refreshConsider all previously downloaded files out-of-date.
--repairDuring evaluation, rewrite missing or corrupted files in the Nix store. During building, rebuild missing or corrupted store paths.
--versionShow version information.
Note
See
man nix.conffor overriding configuration settings with command line flags.