Home / Docs / Command line

una check

Release v0.4.0

Check a package: tiers 0 and 1.

text
una check [OPTIONS] [PATH]

Examples

sh
una check .

Check the package in the current directory. It prints nothing when every check passes.

sh
una check --tier 0 .

Every check except the proofs, for a quick pass while editing.

sh
una --json check .

The diagnostics as one JSON document, for an agent.

Arguments

Argument What it does Default
[PATH] The package directory, or a single file .

Options

Option What it does Default
--json Print machine output as JSON on stdout, and nothing else on stdout
--tier <TIER> The tier to check: 0 skips the solver, 1 also proves every obligation. Values: 0: Tier 0: every check except proof obligations; 1: Tier 1: tier 0 and every proof obligation. 1
--color <WHEN> When to use colors in human output. Values: never: Never use colors; auto: Use colors when the output is a terminal; always: Always use colors. auto
--dump-core <MODULE> Print the Core IR of this module on stdout
--solver-wallclock <SECONDS> Stop a solver query after this many seconds; the obligation is then unknown 60
--solver-memory <MIB> The memory limit of each solver query in MiB, from 256 to 1048576 4096

Specification

The normative rules, from spec/13 §5:

Command Meaning
una check [path] Tiers 0 and 1; --tier 0 skips the solver; --dump-core <module> prints Core IR

Help text

As una check --help prints it at v0.4.0:

text
Check a package: tiers 0 and 1

Usage: una check [OPTIONS] [PATH]

Arguments:
  [PATH]
          The package directory, or a single file

          [default: .]

Options:
      --json
          Print machine output as JSON on stdout, and nothing else on stdout

      --tier <TIER>
          The tier to check: 0 skips the solver, 1 also proves every obligation

          Possible values:
          - 0: Tier 0: every check except proof obligations
          - 1: Tier 1: tier 0 and every proof obligation

          [default: 1]

      --color <WHEN>
          When to use colors in human output

          Possible values:
          - never:  Never use colors
          - auto:   Use colors when the output is a terminal
          - always: Always use colors

          [default: auto]

      --dump-core <MODULE>
          Print the Core IR of this module on stdout

      --solver-wallclock <SECONDS>
          Stop a solver query after this many seconds; the obligation is then unknown

          [default: 60]

      --solver-memory <MIB>
          The memory limit of each solver query in MiB, from 256 to 1048576 (ADR 0124)

          [default: 4096]

  -h, --help
          Print help (see a summary with '-h')
View the Markdown