Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/viperml/nh
Yet another nix cli helper
https://github.com/viperml/nh
cli nix nix-flake nixos rust
Last synced: 1 day ago
JSON representation
Yet another nix cli helper
- Host: GitHub
- URL: https://github.com/viperml/nh
- Owner: viperML
- License: eupl-1.2
- Created: 2022-02-08T19:42:42.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-02T11:11:01.000Z (9 days ago)
- Last Synced: 2025-01-08T19:11:49.818Z (2 days ago)
- Topics: cli, nix, nix-flake, nixos, rust
- Language: Rust
- Homepage:
- Size: 674 KB
- Stars: 1,151
- Watchers: 8
- Forks: 37
- Open Issues: 23
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
nh
Because the name "yet-another-nix-helper" was too long to type...
## What does it do?
Nh is my own take at reimplementing some commands from the NixOS ecosystem. I aim
to provide more feature and better ergonomics than the existing commands.
Nh has serveral subcommands, such as:
- `os`, which reimplements `nixos-rebuild`, with a tree of builds, diff and
confirmation.
- `home`, which reimplements `home-manager`.
- `search`, a super-fast package searching tool (powered by a ElasticSearch
client).
- `clean`, my own take at cleaning GC roots from a NixOS system.
This wouldn't be possible with the programs that nh runs under the hood:
- Tree of builds with [nix-output-monitor](https://github.com/maralorn/nix-output-monitor).
- Visualization of the upgrade diff with [nvd](https://khumba.net/projects/nvd).
- And of course, all the [crates](./Cargo.toml) we depend on.
## Installation
The latest stable version is available in Nixpkgs. This repository provides the
latest development version of nh.
```
nix shell nixpkgs#nh # stable
nix shell github:viperML/nh # dev
```
### NixOS
We provide a NixOS module that integrates `nh clean` as a service. To enable it,
set the following configuration:
```nix
{ config, pkgs, ... }:
{
programs.nh = {
enable = true;
clean.enable = true;
clean.extraArgs = "--keep-since 4d --keep 3";
flake = "/home/user/my-nixos-config";
};
}
```
Nh supports both Flakes and classical NixOS configurations:
- For flakes, the command is `nh os switch /path/to/flake`
- For a classical configuration:
- `nh os switch -f ''`, or
- `nh os switch -f '' -- -I
nixos-config=/path/to/configuration.nix` if using a different location than
the default.
You might want to check `nh os --help` for other values and the defaults from
environment variables.
#### Specialisations support
Nh is capable of detecting which specialisation you are running, so it runs the proper activation script.
To do so, you need to give nh some information of the spec that is currently running by writing its name to `/etc/specialisation`. The config would look like this:
```nix
{config, pkgs, ...}: {
specialisation."foo".configuration = {
environment.etc."specialisation".text = "foo";
# ..rest of config
};
specialisation."bar".configuration = {
environment.etc."specialisation".text = "bar";
# ..rest of config
};
}
```
# Status
[](https://deps.rs/repo/github/viperML/nh)
[](https://repology.org/project/unit/versions)
## Hacking
Just clone and `nix develop`. We also provide a `.envrc` for Direnv.