From bbe5a72aa65fddcffa756d6c1d642b0d13fd0f24 Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Fri, 4 Apr 2025 16:27:40 +0100 Subject: [PATCH] docs(architecture/overview): describe CLI a bit more Change-Id: Icab9cc26119fb7114794edf1f56494e41e5d63b2 Reviewed-on: https://cl.snix.dev/c/snix/+/30299 Tested-by: besadii Reviewed-by: Ilan Joselevich Autosubmit: Florian Klink --- web/content/docs/components/overview.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/web/content/docs/components/overview.md b/web/content/docs/components/overview.md index 617553d72..972e71ada 100644 --- a/web/content/docs/components/overview.md +++ b/web/content/docs/components/overview.md @@ -79,8 +79,12 @@ It allows keeping `snix-eval` relatively simple. ## CLI `snix-cli` is a REPL interface, constructing an Evaluator and populating it with -most builtins present in Nix. It is our main vehicle to evaluate Nixpkgs and -check for differences. +most builtins present in Nix. Upon receiving an expression, it'll invoke the +evaluator, and depending on the configuration, this might dispatch builds, cause +substitutions etc. + +It currently is our vehicle to evaluate Nixpkgs and check for differences - it's +not a replacement for `nix-build` or similar. Its CLI is subject to change. ## Serde `snix-serde` is a crate allowing (de)-serialisation of Rust data structures