Command Reference

Sigma Documentation

Version
latest

This section describes the syntax of the sigma command and of its subcommands.

Using the Sigma CLI

Use the sigma command and its subcommands to do the following:

  • Configure Sigma (optional).

    sigma config

  • Scan your code and return results.

    sigma analyze

  • Provide help and information.

    sigma help

    sigma checkers

    sigma explain

The following sections describe the syntax of the sigma command and its subcommands.

Note: The output of Sigma commands contains unicode. Some terminals disable unicode support by default, requiring support to be enabled manually. If using a terminal that does not support unicode, the output can be redirected to a file and read in a viewer that supports unicode.