cafkafk/nix-weather
cafkafk/nix-weather
1
1
Fork 0
Code Issues 5 Pull requests Projects Releases 3 Packages Activity Actions
A fast rust tool to check availability of your entire system in caches. It so to speak "checks the weather" before going to update. Heavily inspired by guix weather.
46 commits 1 branch 3 tags 940 KiB
Nix 50.9%
Rust 48.3%
Just 0.8%
Find a file
Christina Sørensen c7f6b2c256
build: change rust tabwidth 
Signed-off-by: Christina Sørensen <christina@cafkafk.com>
2024-09-06 11:24:30 +02:00
.config build: add basic changelog gen 2024-09-06 05:08:33 +02:00
.forgejo ci(audit): fix multiple audit.yml flows spawning on same commit 2024-09-06 05:26:14 +02:00
.github ci: removed unused cheks, add funding for github 2024-09-05 21:02:09 +02:00
crates refactor: deduplicate nix-weather cargo manifest 2024-09-06 05:11:57 +02:00
LICENSES docs: readme headers, code of conduct 2024-09-05 08:50:47 +02:00
.envrc feat: flake + lix 2024-09-05 07:32:31 +02:00
.gitignore feat: flake + lix 2024-09-05 07:32:31 +02:00
.rustfmt.toml build: change rust tabwidth 2024-09-06 11:24:30 +02:00
.versionrc build: add convco config with merge type 2024-09-05 10:26:56 +02:00
Cargo.lock chore(release): create v0.0.2 2024-09-06 06:39:45 +02:00
Cargo.toml chore(release): create v0.0.2 2024-09-06 06:39:45 +02:00
CODE_OF_CONDUCT.md docs: readme headers, code of conduct 2024-09-05 08:50:47 +02:00
CONTRIBUTING.md docs: add CONTRIBUTING.md 2024-09-05 10:07:11 +02:00
deny.toml ci: fix license allowance 2024-09-05 19:06:54 +02:00
flake.lock build(deps): bump flake.lock 2024-09-06 05:10:38 +02:00
flake.nix feat: flake + lix 2024-09-05 07:32:31 +02:00
justfile build: add basic changelog gen 2024-09-06 05:08:33 +02:00
LICENSE.txt feat: flake + lix 2024-09-05 07:32:31 +02:00
README.md docs: correct readme h1 2024-09-05 10:11:53 +02:00
REUSE.toml build: add convco config with merge type 2024-09-05 10:26:56 +02:00

README.md

Nix Weather - Check Cache Availablility of NixOS Configurations

A fast rust tool to check availability of your entire system in caches. It so to speak "checks the weather" before going to update. Heavily inspired by guix weather.

Built with Nix Contributor Covenant REUSE status License: EUPL-1.2

Usage

Note

Currently, nix-weather only has first-class support for flakes.

General usage would be like this:

nix-weather --name myhost --config ~/git/my-nixos-config

Here, we specify the name of the host, as specified at the flake output nixosConfiguration, and a path to the NixOS configuration flake.

How It Works

The basic idea is that we construct a set of all requisites to build the top-level of a NixOS configuration, and then query Nix cache(s) for the narinfo. By doing this in a high concurrency, parallel task runner (i.e. tokio async runtime), and only querying the headers for status codes, we can reach impressive speeds, typically around 45~ network time.

One of the biggest limiting factors regarding speed is building the config.system.toplevel, and finding the necessary requisites with nix-store. Caching the requisites is a future goal, so that we only have to build the toplevel, and then match against its derivation in cache, which should cut down the nix part of the runtime by ~80%.

Contributing

For information on contributing, please see CONTRIBUTING.md.