https://github.com/raphiz/options-search
Nix Modules Option Search
https://github.com/raphiz/options-search
Last synced: 5 months ago
JSON representation
Nix Modules Option Search
- Host: GitHub
- URL: https://github.com/raphiz/options-search
- Owner: raphiz
- License: mit
- Created: 2023-09-27T05:26:51.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2025-03-04T22:23:56.000Z (over 1 year ago)
- Last Synced: 2025-04-09T19:03:29.823Z (about 1 year ago)
- Language: Nix
- Size: 21.5 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nix Modules option search
Want to try it out? Run the devshell:
```bash
nix develop github:raphiz/options-search
# you will be greeted with further instructions
```
## Example usage
First, add this flake as an input to your flake:
```nix
inputs = {
options-search.url = "github:raphiz/options-search";
}
```
then import the module
```nix
nixpkgs.lib.modules.evalModules { # or your module-system function of choice, eg. nixpkgs.lib.nixosSystem
modules = [
inputs.options-search.nixosModules.default
];
};
```
Thats it. You can now run the `options-search` in the evaluated module context.
For more examples, checkout the [devshell.nix file](./devshell.nix).
## Credits
* Based upon the ideas and code of [home-manager-option-search](https://mipmip.github.io/home-manager-option-search/).
* Based on parts of [nixos-render-docs](https://github.com/NixOS/nixpkgs/blob/master/pkgs/tools/nix/nixos-render-docs/src/nixos_render_docs)
* Idea inspired by [Alain Lehmanns nix-option-search](https://github.com/ciderale/nix-option-search)