aboutsummaryrefslogtreecommitdiff
path: root/src/nix/registry-add.md
blob: 90b54a596c903430843b064f44af0b148350a516 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
R""(

# Examples

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

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

* Pin `nixpkgs` to a specific revision:

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

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

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

* Add `nixpkgs` pointing to `github:nixos/nixpkgs` to your custom flake
  registry:

  ```console
  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`](./nix3-registry-remove.md).

)""