Use the 'commented' field tag option to generate an example configuration

[michaelvanstraten]

What would you like sesh to do?

I've noticed that there isn't any documentation on the config options for the sesh.toml file. Fortunately, go-toml supports 'commented' field tags, which allow you to annotate config structs with comments explaining their purpose.

We could add a new CLI option that generates an example config and then outputs that config to a file or to standard output. This would enable tools like home-manager to parse the example and generate a documented home-manager module.

[joshmedeski]

This is a great idea, thanks for sharing the resources.

If you're willing to submit a PR I can take it from there. Otherwise I'll put it on my list of things to do.

[michaelvanstraten]

If you're willing to submit a PR I can take it from there. Otherwise I'll put it on my list of things to do.

I’m prepared to implement the new sub-command to generate the example config, but it would be incredibly helpful if you could provide the doc strings for the comments. I’m not deeply familiar with the sesh codebase, and your expertise would be invaluable in ensuring accuracy.

[michaelvanstraten]

I've taken the liberty to add a home-manager module for sesh nix-community/home-manager#5789, maybe we can add it to the README when it's been merged.