nix3-registry-add(1)

    Warning
    This program is experimental (https://nix.dev/manual/nix/2.34/development/experimental-features.html#xp-feature-nix-command) and its interface is subject to change.

Name

nix registry add - add/replace flake in user flake registry

Synopsis

nix registry add [option…] from-url to-url

Examples

•   Set the nixpkgs flake identifier to a specific branch of Nixpkgs:

    # nix registry add nixpkgs github:NixOS/nixpkgs/nixos-20.03

•   Pin nixpkgs to a specific revision:

    # nix registry add nixpkgs github:NixOS/nixpkgs/925b70cd964ceaedee26fde9b19cc4c4f081196a

•   Add an entry that redirects a specific branch of nixpkgs to another fork:

    # nix registry add nixpkgs/nixos-20.03 ~/Dev/nixpkgs

•   Add nixpkgs pointing to github:nixos/nixpkgs to 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 (./nix3-registry-remove.md) .

Options

•   --registry (#opt-registry) registry

    The registry to operate on.

  Common evaluation options

•   --arg (#opt-arg) name expr

    Pass the value expr as the argument name to Nix functions.

•   --arg-from-file (#opt-arg-from-file) name path

    Pass the contents of file path as the argument name to Nix functions.

•   --arg-from-stdin (#opt-arg-from-stdin) name

    Pass the contents of stdin as the argument name to Nix functions.

•   --argstr (#opt-argstr) name string

    Pass the string string as the argument name to Nix functions.

•   --eval-store (#opt-eval-store) store-url

    The URL of the Nix store (https://nix.dev/manual/nix/2.34/store/types/index.html#store-url-format) to use for evaluation, i.e. to store derivations (.drv files) and inputs referenced by them.

•   --impure (#opt-impure)

    Allow access to mutable paths and repositories.

•   --include (#opt-include) / -I path

    Add path to search path entries used to resolve lookup paths (https://nix.dev/manual/nix/2.34/language/constructs/lookup-path.html)

    This option may be given multiple times.

    Paths added through -I take precedence over the nix-path configuration setting (https://nix.dev/manual/nix/2.34/command-ref/conf-file.html#conf-nix-path) and the NIX_PATH environment variable (https://nix.dev/manual/nix/2.34/command-ref/env-common.html#env-NIX_PATH) .

•   --override-flake (#opt-override-flake) original-ref resolved-ref

    Override the flake registries, redirecting original-ref to resolved-ref.

  Logging-related options

•   --debug (#opt-debug)

    Set the logging verbosity level to ‘debug’.

•   --log-format (#opt-log-format) format

    Set the format of log output; one of raw, internal-json, bar or bar-with-logs.

•   --print-build-logs (#opt-print-build-logs) / -L

    Print full build logs on standard error.

•   --quiet (#opt-quiet)

    Decrease the logging verbosity level.

•   --verbose (#opt-verbose) / -v

    Increase the logging verbosity level.

  Miscellaneous global options

•   --help (#opt-help)

    Show usage information.

•   --offline (#opt-offline)

    Disable substituters and consider all previously downloaded files up-to-date.

•   --option (#opt-option) name value

    Set the Nix configuration setting name to value (overriding nix.conf).

•   --refresh (#opt-refresh)

    Consider all previously downloaded files out-of-date.

•   --repair (#opt-repair)

    During evaluation, rewrite missing or corrupted files in the Nix store. During building, rebuild missing or corrupted store paths.

•   --version (#opt-version)

    Show version information.

    Note

    See man nix.conf (https://nix.dev/manual/nix/2.34/command-ref/conf-file.html#command-line-flags) for overriding configuration settings with command line flags.