lix/src/nix/registry-add.md
Delan Azabani b2944d93a6 Reject fully-qualified URLs in 'from' argument of nix registry add
We previously allowed you to map any flake URL to any other flake URL,
including shorthand flakerefs, indirect flake URLs like `flake:nixpkgs`,
direct flake URLs like `github:NixOS/nixpkgs`, or local paths.

But flake registry entries mapping from direct flake URLs often come
from swapping the 'from' and 'to' arguments by accident, and even when
created intentionally, they may not actually work correctly.

This patch rejects those URLs (and fully-qualified flake: URLs), making
it harder to swap the arguments by accident.

Fixes #181.

Change-Id: I24713643a534166c052719b8770a4edfcfdb8cf3
2024-06-29 05:11:31 +00:00

1 KiB

R""(

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, where from-url must be a shorthand like 'nixpkgs' or 'nixpkgs/nixos-20.03'. If an entry for from-url already exists, it is overwritten.

Entries can be removed using nix registry remove.

)""