blob: eae659cd34238f69c8e702340712348300e445b0 (
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
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
|
# nix-exprs
## how to use
### library
> **Note**
> coming soon
### flake configuration
```nix
{
inputs = {
getchoo = {
url = "github:getchoo/overlay";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = {
nixpkgs,
getchoo,
...
}: {
nixosConfigurations.hostname = nixpkgs.lib.nixosSystem {
modules = [
{
nixpkgs.overlays = [getchoo.overlays.default];
environment.systemPackages = with pkgs; [
treefetch
];
}
];
};
};
}
```
### home-manager
```nix
{
home-manager.users.<name> = let
# you can use a flake input here instead as shown in the last example
getchoo = builtins.fetchTarball "https://github.com/getchoo/overlay/archive/refs/heads/main.tar.gz";
in {nixpkgs.overlays = [getchoo.overlays.default];};
}
```
### `configuration.nix`
```nix
_: let
getchoo = builtins.fetchTarball "https://github.com/getchoo/overlay/archive/refs/heads/main.tar.gz";
in {
nixpkgs.overlays = [getchoo.overlays.default];
}
```
### cli support
`nixpkgs.overlays` does not configure overlays for tools
such as `nix(-)run`, `nix(-)shell`, etc.
the best way to make this overlay available to them is to
add it to your flake registry or `~/.config/nixpkgs/overlays.nix`.
#### flake registry
```shell
nix registry add getchoo github:getchoo/overlay
nix run getchoo#treefetch
```
#### overlays.nix
in `~/.config/nixpkgs/overlays.nix` (or a nix file in `~/.config/nixpkgs/overlays/`):
```nix
let
getchoo = import (builtins.fetchTarball "https://github.com/getchoo/overlay/archive/refs/heads/main.tar.gz");
in [getchoo.overlays.default]
```
|
