snix/web/content/docs/guides/building.md at 02b084ec0bb950e3b75cd2eb3722acf1950e5722

Florian Klink 8b04f098da docs(web): replace console with bash

This gives us a cute "Terminal Window Look" for these code blocks.

Change-Id: I87fbb739917cef692c692585e7ff569d3da66435
Reviewed-on: https://cl.snix.dev/c/snix/+/30449
Reviewed-by: Vova Kryachko <v.kryachko@gmail.com>
Tested-by: besadii
Autosubmit: Florian Klink <flokli@flokli.de>

2025-05-04 17:26:22 +00:00

2.4 KiB

Raw Blame History

title	slug	description	summary	date	lastmod	draft	weight	toc
Building Snix	building			2025-03-14T14:14:35+01:00	2025-03-14T14:14:35+01:00	false	11	true

This document describes how to build the project locally, both for interactive development as well as referring to it from Nix code (for example, to run one of its binaries on your machine).

{{}} Please check the [Contribution Guide]({{< relref "contributing" >}}) on how to contribute after following this guide. {{}}

Requirements

Ensure you have Direnv installed and hooked into your shell.
Ensure you have Nix installed.

Getting the sources

Snix is hosted in its own Forgejo instance, hosted on git.snix.dev, and a (read-only) mirror on GitHub.

Check out the source code as follows:

git clone https://git.snix.dev/snix/snix.git

Interactive development

direnv allow

This provides all the necessary tools and dependencies to interactively build the source code, using cargo build etc.

Building only

It is also possible to build the different Snix crates with Nix, in which you don't need to enter the shell. From the root of the repository, you can build as follows:

$ nix-build -A snix.cli

Alternatively, you can use the mg wrapper from anywhere in the repository (requires the direnv setup from above):

mg build //snix:cli

This uses crate2nix to build each crate dependency individually.

Binary cache for Development

If you want to fetch store paths built by CI, you can configure our Harmonia deployment as a Nix substituter:

{
  nix.settings.trusted-public-keys = [
    "cache.snix.dev-1:miTqzIzmCbX/DyK2tLNXDROk77CbbvcRdWA4y2F8pno="
  ];
  nix.settings.substituters = [
    "https://cache.snix.dev"
  ];
}

Keep in mind there's no guarantees on paths being available, they get GC'ed eventually.

2.4 KiB Raw Blame History