OPTNIX(1)

✨ NAME ✨

bestie, welcome to the OPTNIX(1) page from the General Commands Manual. The name says it all: optnix — a fast options searcher for NixOS module systems 💅

🌸 SYNOPSIS 🌸

optnix [options] [OPTION-NAME]

💅 DESCRIPTION 💅

okay so there are a bunch of module systems that Nix users use on a daily basis:

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

These systems can have documentation that's genuinely hard to navigate, especially for options in external modules 😭

optnix solves that problem, and lets users inspect option values if possible; just like nix repl in most cases, but prettier. periodt 👑

🎀 EXAMPLES 🎀

Search for options interactively using the nixos scope:

optnix -s nixos

Search for the option programs.zsh.enable in interactive mode using the default scope:

optnix programs.zsh.enable

Search for the option programs.zsh.enable in non-interactive mode in the default scope:

optnix -n programs.zsh.enable

Display the value of programs.zsh.enable in the home-manager scope:

optnix -v -s home-manager programs.zsh.enable

Display the value of flake.nixosConfigurations in the flake-parts scope using a custom configuration file:

optnix -c ./contrib/optnix.toml -v -s flake-parts flake.apps

🦋 ARGUMENTS 🦋

OPTION-NAME

Specify the name of an option to search for.

• In non-interactive mode, this argument is required, and it MUST evaluate to a valid option.
• In interactive mode, it serves as an initial input for the search bar, and is not required.

🔥 OPTIONS 🔥

• -c, --config <FILES> — path to extra configuration file(s) to load. To specify multiple extra configuration files to load, pass this option multiple times.
• -j, --json — output information in JSON format. Implies non-interactive mode.
• -l, --list-scopes — list available scopes and their origins (aka what configuration file they most recently were modified in) and exit.
• -m, --min-score <SCORE> — minimum score threshold for deeming a potential candidate a match. This option is ignored in regex mode. The lower the number is, the more search results will show up, but they may be less relevant.
• -n, --non-interactive — do not show search TUI for options. If specified, OPTION-NAME will become a mandatory parameter.
• -s, --scope <NAME> — scope name to use. If a default scope is not defined in the configuration, this parameter is required.
• -v, --value-only — only show the value of the passed option; useful for scripting. Implies non-interactive mode.
• --version — display version information.
• -h, --help — show the help message for this command.

💜 AUTHORS 💜

Maintained by Varun Narravula <varun@snare.dev>. Up-to-date sources can be found at https://sr.ht/~watersucks/optnix, and bugs reports or patches can be submitted by email to the sr.ht mailing lists/issue tracker, or to the GitHub mirror as a pull request/issue. Prefer the former if possible.

---

okay that's the whole OPTNIX(1) page — dated 1980-01-01, sourced from the General Commands Manual. mwah, go search some options bestie 💖✨