rsigma config init🔗
Write a commented YAML config template to disk.
Synopsis🔗
Description🔗
Scaffolds a rsigma.yaml populated with every supported section, sensible defaults, and inline comments documenting each key. The first line is a # yaml-language-server: $schema= header that lets editors with the yaml-language-server extension auto-complete and validate the file against the JSON Schema generated from the same source as the config loader.
By default the template is written to ./rsigma.yaml. Running init against an existing file is refused unless --force is passed; this is deliberate so an accidental re-run never clobbers operator edits.
Flags🔗
| Flag | Default | Description |
|---|---|---|
-o, --output <PATH> | ./rsigma.yaml | Where to write the template. |
--force | off | Overwrite an existing file. |
Examples🔗
Scaffold the default location:
Scaffold a system-wide config and check it loads cleanly:
sudo mkdir -p /etc/rsigma
sudo rsigma config init -o /etc/rsigma/config.yaml
rsigma config validate -c /etc/rsigma/config.yaml
Regenerate the template after a version bump:
Exit codes🔗
| Code | Meaning |
|---|---|
0 | Template written. |
3 | File exists and --force was not passed, or the write failed. |
See also🔗
config validateto check the resulting file.- Configuration Reference for the schema, discovery, and precedence rules.