Nix Home Manager Option Search

#1

Post by mipselaer » Sat, Jan 20, 2024, 1:24 PM UTC

Nix Home Manager Option Search
mipmip.github.io

Re: Nix Home Manager Option Search

#2

Post by mipselaer » Sat, Jan 20, 2024, 1:24 PM UTC

When you like Home Manager but don't like reading long manuals.

Re: Nix Home Manager Option Search

#3

Post by __MatrixMan__ » Sat, Jan 20, 2024, 10:45 PM UTC

Is there a good way of getting this sort of thing for nix projects in general? I often find myself cloning the repo for it just so I can grep for `mkOption` and I often wonder if there's a smarter way.

Re: Nix Home Manager Option Search

#4

Post by asheko » Sun, Jan 21, 2024, 5:21 PM UTC

Hi

Re: Nix Home Manager Option Search

#5

Post by presto8 » Mon, Jan 22, 2024, 6:44 AM UTC

__MatrixMan__ wrote: post #3

Is there a good way of getting this sort of thing for nix projects in general? I often find myself cloning the repo for it just so I can grep for `mkOption` and I often wonder if there's a smarter way.

man configuration.nix

Then use the search function of the pager.

Re: Nix Home Manager Option Search

#6

Post by HappyAndHarmles » Mon, Jan 22, 2024, 6:55 AM UTC

On a related note, if anybody would like to get started with home-manager, we have a flake template for it:

https://github.com/juspay/nix-dev-home

Re: Nix Home Manager Option Search

#7

Post by pimeys » Mon, Jan 22, 2024, 7:39 AM UTC

presto8 wrote: post #5

__MatrixMan__ wrote: post #3

Is there a good way of getting this sort of thing for nix projects in general? I often find myself cloning the repo for it just so I can grep for `mkOption` and I often wonder if there's a smarter way.

man configuration.nix Then use the search function of the pager.

man home-configuration.nix

works for home-manager

Re: Nix Home Manager Option Search

#8

Post by jmnicolas » Mon, Jan 22, 2024, 7:42 AM UTC

I "love" these projects that won't even describe what they do on their front page or even in their manual.

Of course everybody has 30 minutes to spare to try to understand what it is.

Re: Nix Home Manager Option Search

#9

Post by hiimshort » Mon, Jan 22, 2024, 7:53 AM UTC

__MatrixMan__ wrote: post #3

Is there a good way of getting this sort of thing for nix projects in general? I often find myself cloning the repo for it just so I can grep for `mkOption` and I often wonder if there's a smarter way.

I only got it to the proof of concept stage, but I was hacking on something that would generate docs for everything found on a Nix Flake (including modules): https://github.com/snowfallorg/frost

Here's an example output that I generated for my config repo: https://jakehamilton.github.io/config/

Re: Nix Home Manager Option Search

#10

Post by drakerossman » Mon, Jan 22, 2024, 7:54 AM UTC

jmnicolas wrote: post #8

I "love" these projects that won't even describe what they do on their front page or even in their manual. Of course everybody has 30 minutes to spare to try to understand what it is.

Fear not, these are configuration options for a project called Home Manager, which manages your user configuration and dotfiles with the help of Nix the package manager:

https://drakerossman.com/blog/how-to-add-home-manager-to-nix...