The config Subcommand

Sigma Documentation
Version
latest

Syntax

sigma config SUBCOMMAND

Description

The config command manages configuration. Subcommands allow you to create a default configuration, get command help, or validate a configuration.

Subcommand Description

create-default [-f, --force] [file]
Create a default configuration for Sigma analysis.

  • Use -f flag to overwrite the existing file.

  • Use the file parameter to specify the name of the configuration file.

dump [-f, --force] [file]

Dump the aggregated configuration loaded from all sources.

  • Use the -f flag to overwrite the existing file.

  • Use the file parameter to specify the name of the dump file.

Note: If you don't specify a file name, .sigma-config.yml will be used.

help

Display help for the sigma config command.

validate

 Validate all the configuration settings from the command line and configuration files.