Skip to content
Topaz6.0 · Before release
Download

Search documentation

Specification 6.0 · Not released · Tested product 5.21.3

Use arrow keys to choose a result. Press Enter to open.

Type an API name, diagnostic number, rule, or project topic.

    Tools

    version

    Prints the installed Topaz version.

    Invocation, options and results

    Link

    topaz version

    Synopsis
    1. topaz version

    Input

    Accept no positional operands. Accept --verbose and the listed language selector. Reject version aliases, source operands, --format json, compiler selection, and unrelated options.

    Options and conflicts

    OptionDefaultContractConflicts
    --verbosefalse

    Reports the selected compiler and whether it was explicit or the default. For version, prints the detailed release report.

    None listed
    --language-version <5.21>5.21

    language version selector

    None listed

    Output channels

    stdout

    stderr

    Exit status

    0

    The requested bundled text is printed.

    1

    Argument validation or output fails.

    Effects

    Read the installed executable's bundled metadata without opening or modifying project files. No output file or workspace is created.

    The command performs no network access.

    The same installed executable, admitted options, and presentation settings produce the same text. Release changes can change the bundled content.

    No manifest, dependency, vendor tree, or lock is loaded or changed.

    Operation

    Link

    Use verbose output to inspect the compiler version, language mode, runtime version, and backend label. Compiler status reports the default compiler and command support.

    Example contract

    Link
    Ruletools-commands-version.rule.invocation

    Example contract

    The invocation topaz version main.tpz --language-version 5.21 is expected to exit with 1.

    The command has no positional source operand. The adapter-supplied fixture operand is deliberately rejected before its operation; this is an arity example, not a successful version session.

    Why

    The version report describes the installed toolchain. Rejecting a source operand prevents it from appearing to report the language version of that file.

    Source evidence

    Behavior contract

    Link
    Ruletools-commands-version.rule.behavior

    Command behavior

    Arguments and rejection

    Accept no positional operands. Accept --verbose and the listed language selector. Reject version aliases, source operands, --format json, compiler selection, and unrelated options.

    Output

    Standard output reports the installed product version. Verbose output also reports the selected language mode and bundled component and compiler identity. Command failures use standard error.

    The command has no selectable JSON report. Product release identity is independent of the selected language mode.

    Exit status

    Exit 0 means the requested installed text was printed. Exit 1 covers invalid arguments and output failure.

    Filesystem effects

    Read the installed executable's bundled metadata without opening or modifying project files. No output file or workspace is created.

    Network access

    The command performs no network access.

    Reproducibility

    The same installed executable, admitted options, and presentation settings produce the same text. Release changes can change the bundled content.

    Packages and locks

    No manifest, dependency, vendor tree, or lock is loaded or changed.

    Why

    Version inspection requests the installed toolchain identity. A language selector describes its selected mode and does not change the reported product release.

    Source evidence

    The linked public CLI recipe checks the exact displayed argument rejection before the requested operation. It does not execute the successful operation or verify its effects.

    The safe recipe checks rejection of its extra fixture operand and language selector. The successful no-operand form is outside the reviewed vector and remains not-run in this runner.

    Example

    Link

    Argument-rejection example

    Link
    main.tpzArgument-rejection exampleOpen in Playground
    1. function identity<T>(value: T) -> T {
    2. value
    3. }
    target product 5.21.3
    Expected result

    Expected result

    Textual rejection details remain Pending in the reference model. The independent Tools example gate expects exit 1.

    The command has no positional source operand. The adapter-supplied fixture operand is deliberately rejected before its operation; this is an arity example, not a successful version session.

    Source evidence

    Verification scope

    Link

    Observed with Topaz 5.21.3 on 2026-11-06T08:36:29.642Z. This invocation passed; exit 1. 3 assertions were evaluated against the independent expected result. Execution record. This result covers the displayed invocation.

    Related references

    Link

    Compiler selection

    Packages, locks and targets

    Menu

    Download