suricata-check (CLI)¶
suricata-check¶
The suricata-check command processes all rules inside a rules file and outputs a list of detected issues.
Check the CLI usage documentation for a full overview of how to use the CLI: https://suricata-check.teuwen.net/cli_usage.html
suricata-check [OPTIONS]
Options
- -h, --help¶
Show this message and exit.
- --ini <ini>¶
Path to suricata-check.ini file to read configuration from.
- -r, --rules <rules>¶
Path to Suricata rules to provide check on.
- Default:
'.'
- -s, --single-rule <single_rule>¶
A single Suricata rule to be checked
- -o, --out <out>¶
Path to suricata-check output folder.
- Default:
'.'
- --log-level <log_level>¶
Verbosity level for logging. Can be one of (‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’)
- Default:
'INFO'
- --gitlab¶
Flag to create CodeClimate output report for GitLab CI/CD.
- Default:
False
- --github¶
Flag to write workflow commands to stdout for GitHub CI/CD.
- Default:
False
- --evaluate-disabled¶
Flag to evaluate disabled rules.
- Default:
False
- --issue-severity <issue_severity>¶
Verbosity level for detected issues. Can be one of (‘DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’)
- Default:
'INFO'
- -a, --include-all¶
Flag to indicate all checker codes should be enabled.
- Default:
False
- -i, --include <include>¶
List of all checker codes to enable. Regexes can be provided.
- Default:
- -e, --exclude <exclude>¶
List of all checker codes to disable. Regexes can be provided.
- Default: