readme: add nix repl entry (#134)

* readme: add nix repl entry * Update README.md Co-authored-by: Sandro <[email protected]> --------- Co-authored-by: Sandro <[email protected]>
NuschtOS · Oct 23, 2024 · 5faf014 · 5faf014
1 parent 15515ca
commit 5faf014
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -18,3 +18,11 @@ Until we have written proper instructions please take a look at the following ex
 
 We wanted something similar to https://search.nixos.org to easily search through all the flakes options across many projects we accumulated in projects
 but without the need to deploy an Elasticsearch. Ideally it should be just a static site with json blob that can be deployed on GitHub pages.
+
+## Debugging
+
+Generating a `options.json` in a `nix repl` can be done with the following snippet:
+
+```
+:b (pkgs.nixosOptionsDoc { inherit ((lib.evalModules { modules = [ { config._module.check = false; } outputs.nixosModules.default ]; })) options; warningsAreErrors = false; }).optionsJSON
+```