Home / Docs / Command line

una build

Release v0.4.0

Compile main of the [run] entry module into a native executable.

text
una build [OPTIONS] [PATH]

Examples

sh
una build .

Check the package, then write a native executable under target/una/.

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
--out <FILE> Write the executable to this file instead of target/una/<name>
--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
--debuggable Let a debugger or profiler attach to the executable (macOS: the get-task-allow entitlement)
--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 build [path] (v0.2, ADR 0055) Compile main of [run] entry into a native executable; --out <file> (spec/16 §2); (v0.4, ADR 0124 rule 27) --debuggable (spec/16 §2 rule 9)

Help text

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

text
Compile `main` of the `[run] entry` module into a native executable

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

      --out <FILE>
          Write the executable to this file instead of `target/una/<name>`

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

      --debuggable
          Let a debugger or profiler attach to the executable (macOS: the get-task-allow entitlement)

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