nix3-registry-add(1)        General Commands Manual       nix3-registry-add(1)


              Warning
              This program is experimental
              <@docroot@/development/experimental-features.md#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
       o  Set the nixpkgs flake identifier to a specific branch of Nixpkgs:

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

       o  Pin nixpkgs to a specific revision:

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

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

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

       o  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
       o  --registry <#opt-registry> registry

          The registry to operate on.

   Common evaluation options
       o  --arg <#opt-arg> name expr

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

       o  --arg-from-file <#opt-arg-from-file> name path

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

       o  --arg-from-stdin <#opt-arg-from-stdin> name

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

       o  --argstr <#opt-argstr> name string

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

       o  --eval-store <#opt-eval-store> store-url

          The URL of the Nix store
          <@docroot@/store/types/index.md#store-url-format> to use for
          evaluation, i.e. to store derivations (.drv files) and inputs
          referenced by them.

       o  --impure <#opt-impure>

          Allow access to mutable paths and repositories.

       o  --include <#opt-include> / -I path

          Add path to search path entries used to resolve lookup paths
          <@docroot@/language/constructs/lookup-path.md>

          This option may be given multiple times.

          Paths added through -I take precedence over the nix-path
          configuration setting
          <@docroot@/command-ref/conf-file.md#conf-nix-path> and the NIX_PATH
          environment variable
          <@docroot@/command-ref/env-common.md#env-NIX_PATH>.

       o  --override-flake <#opt-override-flake> original-ref resolved-ref

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

   Logging-related options
       o  --debug <#opt-debug>

          Set the logging verbosity level to `debug'.

       o  --log-format <#opt-log-format> format

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

       o  --print-build-logs <#opt-print-build-logs> / -L

          Print full build logs on standard error.

       o  --quiet <#opt-quiet>

          Decrease the logging verbosity level.

       o  --verbose <#opt-verbose> / -v

          Increase the logging verbosity level.

   Miscellaneous global options
       o  --help <#opt-help>

          Show usage information.

       o  --offline <#opt-offline>

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

       o  --option <#opt-option> name value

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

       o  --refresh <#opt-refresh>

          Consider all previously downloaded files out-of-date.

       o  --repair <#opt-repair>

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

       o  --version <#opt-version>

          Show version information.

          Note

          See man nix.conf
          <@docroot@/command-ref/conf-file.md#command-line-flags> for
          overriding configuration settings with command line flags.

                                                          nix3-registry-add(1)