optnix

README

optnix

An options searcher for Nix module systems.

Introduction

optnix is a fast, terminal-based options searcher for Nix module systems.

There are multiple module systems that Nix users use on a daily basis:

• NixOS (the most well-known one)
• Home Manager
• nix-darwin
• flake-parts

And their documentation can be hard to look for. Not to mention, any external options from imported modules can be impossible to find without reading source code. optnix can solve that problem for you, and allows you to inspect their values if possible; just like nix repl in most cases, but better.

There is a website for high-level documentation available at https://optnix.snare.dev.

This repository is hosted on sr.ht, with an official mirror on GitHub.

Install

optnix is available in nixpkgs.

More installation instructions can be found on the documentation website.

Integrations

optnix can be used as a Go library, and is used as such in the following applications.

nixos-cli

optnix is used as a library in the nixos option subcommand of nixos-cli.

nixos option requires zero configuration for discovery of NixOS options.

Contributing

Prefer emailing patch sets to the official development mailing list.

While the official repository is located on sr.ht, contributions are also accepted through GitHub using the official mirror, if desired.

Additionally, filing GitHub issues is fine, but consider using the official issue tracker on sr.ht. All issues from GitHub will be mirrored there by me anyway.