Home / Docs / Command line

una core

Release v0.4.0

Print the package's Core IR; with --json, as una.core/1.

text
una core [OPTIONS] [PATH]

Examples

sh
una core .

Print the package's Core IR.

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
--with-rejected With --json, also export the declarations rejected for information flow, under rejected, apart from Core
--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

Specification

The normative rules, from spec/13 §5:

Command Meaning
una core [path] (v0.3, ADR 0083) Check at tier 0 and print the package's Core IR: with --json, one una.core/1 document (§8); otherwise the text syntax of spec/09, every module in turn. --with-rejected (ADR 0091), with --json only, adds the declarations rejected for information flow, apart from Core (§8); without --json it is a usage error

Help text

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

text
Print the package's Core IR; with --json, as `una.core/1` (ADR 0083)

Usage: una core [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

      --with-rejected
          With --json, also export the declarations rejected for information flow, under `rejected`, apart from Core (ADR 0091)

      --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]

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