https://github.com/NuschtOS/search
Simple and fast static-page NixOS option search
https://github.com/NuschtOS/search
nix nixos
Last synced: 11 months ago
JSON representation
Simple and fast static-page NixOS option search
- Host: GitHub
- URL: https://github.com/NuschtOS/search
- Owner: NuschtOS
- License: mit
- Created: 2024-06-23T20:04:47.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-10-23T22:30:35.000Z (over 1 year ago)
- Last Synced: 2024-10-24T08:08:00.978Z (over 1 year ago)
- Topics: nix, nixos
- Language: TypeScript
- Homepage: https://search.nüschtos.de
- Size: 431 KB
- Stars: 15
- Watchers: 3
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
- best-of-nix - GitHub - 36% open · ⏱️ 29.10.2025) (Discovery)
- awesome-nix - NüschtOS Search - Simple and fast static-page NixOS option search. (Resources / Discovery)
README
# NüschtOS Search
Simple and fast static-page NixOS option search
## Deployments
- General collection of community projects
- All flakes used at C3D2
- NixVim
- Nixidy
## Usage
There are two functions exposeed to build the directory containing the static search:
| Name | Description | Available Options |
|---|---|---|
| `mkMultiSearch` | to build a search with multiple scopes (modules). | `baseHref`, `title` and `scopes` |
| `mkSearch` | is a thin wrapper around `mkMultiSearch` to only use one scope (module). | `modules`, `optionsJSON`, `optionsPrefix`, `urlPrefix`, `baseHref` and `title` |
### Explanation of options
| Name | Description |
|---|---|
| `baseHref` | The directory to where the search is going to be deployed relative to the domain. Defaults to `/`. |
| `title` | The title on the top left. Defaults to `NüschtOS Search`. |
| `modules` | A list of NixOS modules as an attrset or file similar to the `nixosSystem` function. Exclusive with `optionsJSON`. |
| `optionsJSON` | Path to a pre-generated `options.json` file. Exclusive with `modules`. |
| `optionsPrefix` | A static prefix to append to all options. An extra `dot` is always appended. Defaults to being empty. |
| `overrideEvalModulesArgs` | Allows overriding the arguments given to `lib.evalModules`. It can be used to eg. set the class of the module evaluation. |
| `specialArgs` | works exactly like `specialArgs` in the module system. It allows adding extra arguments like `modulesPath`, `pkgs` or other variables. |
| `urlPrefix` | The prefix which is prepended to the declaration link. This is usually a link to a git. |
| `scopes` | is a list of attributes which each takes `name`, `modules`, `optionsJSON`, `optionsPrefix` or `urlPrefix` option. |
### Examples
```nix
mkMultiSearch {
baseHref = "/search/";
title = "Custom Search";
scopes = [ {
name = "NixOS Modules";
modules = [ self.inputs.nixos-modules.nixosModule ];
urlPrefix = "https://github.com/NuschtOS/nixos-modules/blob/main/";
} {
name = "Example Module";
optionsJSON = ./path/to/options.json;
optionsPrefix = "programs.example";
urlPrefix = "https://git.example.com/blob/main/";
specialArgs = {
custom = "foo";
};
overrideEvalModulesArgs = {
class = "nixos";
};
} ];
};
```
```nix
mkSearch {
modules = [ self.inputs.nixos-modules.nixosModule ];
urlPrefix = "https://github.com/NuschtOS/nixos-modules/blob/main/";
}
```
```nix
mkSearch {
optionsJSON = ./path/to/options.json;
optionsPrefix = "programs.example";
urlPrefix = "https://git.example.com/blob/main/";
}
```
```nix
mkSearch {
optionsJSON = ./path/to/options.json;
urlPrefix = "https://git.example.com/blob/main/";
baseHref = "/search/";
title = "Custom Search";
}
```
- Static page with GitHub Actions and Cloudflare/GitHub Pages
- Deployed with NixOS
## Motivation
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.
## FAQ
### Missing declaration
This is most often caused by using nix' `import` keyword to load a module in the flake instead of referencing it via the path type.
This causes the module system to no longer be aware of the origin of the module and the missing declaration.
- If no arguments are being hand over, this can be easily fixed by removing the `import` keyword. (e.g. [change in sops-nix](https://github.com/Mic92/sops-nix/pull/645))
- If arguments are being hand over, the module needs to be slightly refactored.
- It is often the easiest to move everything depending on the arguments into the `flake.nix` and loading the module via the module systems `imports` variable. (e.g. [change in ifstate.nix](https://codeberg.org/m4rc3l/ifstate.nix/pulls/9))
### default/example is a string/has extra surrounding quotes
This is caused by a missing `lib.literalExpression` in default/example. Please open a pull request against the source of that option to fix this.
### Eval Errors
Sometimes default values are computed. As the required input data is typically not available, `defaultText` should be used. (e.g. [change in nixos-hardware](https://github.com/NixOS/nixos-hardware/pull/1343))
## Debugging `options.json`
Generating a `options.json` in a `nix repl` can be done with the following snippet:
```nix
:b (pkgs.nixosOptionsDoc { inherit ((lib.evalModules { modules = [ { config._module.check = false; } outputs.nixosModules.default ]; })) options; warningsAreErrors = false; }).optionsJSON
```
It is assumed that the flake was loaded before with `:lf` and the module(s) is/are under `nixosModules.default`. For some flakes this may need to be adapted.
## Contact
For bugs and issues please open an issue in this repository.
If you want to chat about things or have ideas, feel free to join the [Matrix chat](https://matrix.to/#/#nuschtos:c3d2.de).
## License
Licensed under MIT license ([LICENSE](LICENSE) or ).