Skip to main content
Version: Next

Command-Line Interface

CLI Options​

Below is a list of all available CLI (Command-Line Interface) options for the project, with a brief explanation of each.

-t, --tools <className[:key=value...]>​

  • Description: Specifies a tool to enable with optional configuration. This option can be used multiple times.
  • Example: -t "DumpCfg:format=dot"

--output-path <PATH>​

  • Description: Specifies the directory to save warnings or output generated by tools. If <PATH> is -, then the output is sent to stdout.
  • Default: -

--list-tools​

  • Description: Lists available tools and their configuration options.
  • Default: false

-o, --output-format <json|plain>​

  • Description: Sets the output format for all tools and warnings (either JSON or plain text).
  • Default: plain

-C, --no-colors​

  • Description: Disables ANSI colors in the output.
  • Default: false

--souffle-binary <PATH>​

  • Description: Specifies the path to the Soufflé binary.
  • Default: "souffle"

--souffle-path <PATH>​

  • Description: Specifies the directory to save generated Soufflé files.
  • Default: "/tmp/misti/souffle"

--souffle-verbose​

  • Description: Generates human-readable, more verbose Soufflé files.
  • Default: false

--tact-stdlib-path <PATH>​

  • Description: Specifies the path to the Tact standard library.

-v, --verbose​

  • Description: Enables verbose output.
  • Default: false

-q, --quiet​

  • Description: Suppresses all output.
  • Default: false

-m, --min-severity <info|low|medium|high|critical>​

  • Description: Sets the minimum level of severity to report.
  • Default: info

-de, --enabled-detectors <name|path:name>​

  • Description: A comma-separated list of detectors to enable.
  • Argument Validation: Requires a non-empty list of detector names.

-dd, --disabled-detectors <names>​

  • Description: A comma-separated list of detector names to disable.
  • Argument Validation: Requires a non-empty list of detector names.

-A, --all-detectors​

  • Description: Enables all available built-in detectors.
  • Default: false

-c, --config <PATH>​

  • Description: Specifies the path to the Misti configuration file.

--new-detector <PATH>​

  • Description: Creates a new custom detector at the specified path.
  • Default: undefined

Exit Codes​

Misti returns different exit codes depending on the execution result:

  • 0: Successful execution with no warnings or errors.
  • 1: Warnings were reported.
  • 2: Execution failed due to an internal or execution error.