stackpanel config generate-example
Generate annotated config.example.nix with option descriptions
stackpanel config generate-example
Generate an annotated config.example.nix file with inline documentation from option descriptions.
This command reads the stackpanel options JSON (from nixosOptionsDoc) and generates a comprehensive example configuration file with inline comments explaining each option.
Examples: stackpanel config generate-example --options-json options.json --output config.example.nix stackpanel config generate-example --options-json options.json --output config.example.nix --no-comments stackpanel config generate-example --options-json options.json --current-config config.nix --output example.nix
Usage
stackpanel config generate-exampleFlags
| Flag | Type | Default | Description |
|---|---|---|---|
--current-config | string | none | Path to current config.nix (optional, used as reference) |
--no-comments | bool | false | Skip inline documentation comments |
--options-json | string | none | Path to options.json from nixosOptionsDoc |
--output | string | none | Output path for generated config.example.nix |
Global Flags
These flags are inherited from parent commands.
| Flag | Type | Default | Description |
|---|---|---|---|
--daemon, -d | bool | false | Run in daemon mode (no TUI, for background processes) |
--no-color | bool | false | Disable color output |
--no-tui | bool | false | Disable interactive TUI mode |
--verbose, -v | bool | false | Enable verbose output |