Skip to main content
Version: 15.0

Global Arguments

Most commands in MetriCal have their own options and settings. However, there are a few common arguments that are applicable to all commands.

--license [LICENSE]​

The license key for MetriCal.

There are three ways to pass in a license key:

  • Set it via the command line argument --license
  • Set the TANGRAM_VISION_LICENSE environment variable
  • Set it in the Tangram config TOML, typically located at $HOME/.config/tangram-vision/config.toml

License keys are checked and validated in this order. Read more about licensing in the licensing usage guide.

--license-timeout [LICENSE_TIMEOUT]​

Default: 10

The timeout (in seconds) for the calls to the Tangram licensing server. Used when making licensing http requests.

--report-path [REPORT_PATH]​

MetriCal can actually write the TUI output of any command to an HTML file. The path to save the TUI output to. you can also just redirect stderr, though this will subsume the interactive output.

-vv, -v, -q, -qq, -qqq​

The logging verbosity for MetriCal.

MetriCal uses the log crate to produce logs at various levels of priority. Users can set the log level by passing verbosity flags to any MetriCal command:

  • -vv: Trace
  • -v: Debug
  • default: Info
  • -q: Warn
  • -qq: Error
  • -qqq: Off

Some outputs will change slightly depending on the verbosity level to avoid spamming your console.

--color [WHEN]​

Possible values: enabled, disabled, auto

Default: auto

Whether or not to use ANSI color codes in the terminal output. If set to auto MetriCal will attempt to detect if the output is a TTY and enable colors accordingly. Does not affect the colors output to the report.html file if one is generated

--progress-indicators [WHEN]​

Possible values: enabled, disabled, auto

Default: auto

Whether or not to enable progress bars and other animated displays in the terminal output. If set to auto, MetriCal will attempt to detect if the output is a TTY and enable progress bars accordingly

-V, --version​

Print the current version of MetriCal

-h, --help​

Print the help message for this command or function. -h prints a summary of the documentation presented by --help.