check.md

mops check

Generated from mops check --help by ./gradlew :cli:updateReference. Do not edit this page. Global options are listed in the index.

Run MPS checks.

Usage: mops check [-h] [COMMAND]
Run MPS checks.
Commands:
  model    Run MPS's full model check over one model.
  module   Run MPS's full check over one or more project modules.
  project  Run MPS's full check over every project module and its models.
  help     Display help information about the specified command.
Options:
  -h, --help                Show this help message and exit.

mops check model

Run MPS's full model check over one model.

Usage: mops check model [-h] [--format=FORMAT] [--limit=N] MODEL_TARGET
Run MPS's full model check over one model and report the findings. Exits 1 when
any finding is an error.
Parameters:
      MODEL_TARGET          Model name or serialized model reference.
Options:
      --format=FORMAT       How to print findings: human (a readable list
                              sorted by severity, then # metadata lines;
                              default) or jsonl (one finding object per line,
                              then a summary record).
  -h, --help                Show this help message and exit.
      --limit=N             Maximum findings to report, most severe first.
                              Defaults to 20 so a broken model does not flood
                              the output; 0 means unlimited.

The check covers typesystem, model, module, and checking rules. Findings print
most severe first. Text output is one tab-separated row per finding (severity,
message, and for a node-level finding the node's name, concept, and reference),
followed by `#` metadata lines: `# <errors>, <warnings>, <infos>` (or `# no
findings`) and, when --limit cut the list, `# truncated: showing <shown> of
<total> findings; pass --limit 0 for all`. See `mops explain output`.

--format jsonl prints one finding object per line and ends with a summary
record, {"type":"summary",...}, carrying shown, total, errors, warnings, infos,
limit, truncated, and, when truncated, a hint naming --limit 0. Findings have
no type field. The totals and the exit code cover every finding, not only the
shown ones, in both formats.

mops check module

Run MPS's full check over one or more project modules.

Usage: mops check module [-h] [--format=FORMAT] [--limit=N] MODULE...
Run MPS's full check over one or more project modules and their models. Exits 1
when any finding is an error.
Parameters:
      MODULE...             Project module name or serialized reference.
Options:
      --format=FORMAT       How to print findings: human (a readable list
                              sorted by severity, then # metadata lines;
                              default) or jsonl (one finding object per line,
                              then a summary record).
  -h, --help                Show this help message and exit.
      --limit=N             Maximum findings to report, most severe first.
                              Defaults to 20 so a broken model does not flood
                              the output; 0 means unlimited.

The check covers typesystem, model, module, and checking rules. Findings print
most severe first. Text output is one tab-separated row per finding (severity,
message, and for a node-level finding the node's name, concept, and reference),
followed by `#` metadata lines: `# <errors>, <warnings>, <infos>` (or `# no
findings`) and, when --limit cut the list, `# truncated: showing <shown> of
<total> findings; pass --limit 0 for all`. See `mops explain output`.

--format jsonl prints one finding object per line and ends with a summary
record, {"type":"summary",...}, carrying shown, total, errors, warnings, infos,
limit, truncated, and, when truncated, a hint naming --limit 0. Findings have
no type field. The totals and the exit code cover every finding, not only the
shown ones, in both formats.

mops check project

Run MPS's full check over every project module and its models.

Usage: mops check project [-h] [--format=FORMAT] [--limit=N]
Run MPS's full check over every project module and its models. Exits 1 when any
finding is an error.
Options:
      --format=FORMAT       How to print findings: human (a readable list
                              sorted by severity, then # metadata lines;
                              default) or jsonl (one finding object per line,
                              then a summary record).
  -h, --help                Show this help message and exit.
      --limit=N             Maximum findings to report, most severe first.
                              Defaults to 20 so a broken model does not flood
                              the output; 0 means unlimited.

The check covers typesystem, model, module, and checking rules. Findings print
most severe first. Text output is one tab-separated row per finding (severity,
message, and for a node-level finding the node's name, concept, and reference),
followed by `#` metadata lines: `# <errors>, <warnings>, <infos>` (or `# no
findings`) and, when --limit cut the list, `# truncated: showing <shown> of
<total> findings; pass --limit 0 for all`. See `mops explain output`.

--format jsonl prints one finding object per line and ends with a summary
record, {"type":"summary",...}, carrying shown, total, errors, warnings, infos,
limit, truncated, and, when truncated, a hint naming --limit 0. Findings have
no type field. The totals and the exit code cover every finding, not only the
shown ones, in both formats.