metrical [OPTIONS] <COMMAND>
Purpose
- Global options and errors that apply to all MetriCal commands.
Usage
metrical [OPTIONS] <COMMAND>
Description
Most commands in MetriCal have their own options and settings. However, there are a few common options that are applicable to all modes. These should be placed before the command name (as seen in the Usage section above).
Options
--license <LICENSE>
The license file passed to MetriCal.
There are three ways to pass in a license key:
- Set it via the command line argument
--license
- Set the
TANGRAM_PLATFORM_LICENSE
environment variable - Locate it in the Tangram config TOML, typically located at
$HOME/.config/tangram-vision/config.toml
License keys are checked and validated in this order.
- Set it via the command line argument
--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
Exit Codes
Exit Code | Description |
---|---|
0 | Success |
1 | Bad arguments |
2 | Incomplete or early exit from the main process of the command |
3 | Process was unable to write the requested output to disk |
4 | License validation error |