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

    notice

    Prints Topaz and bundled third-party notices.

    Invocation, options and results

    Link

    topaz notice

    Synopsis
    1. topaz notice

    Input

    Accept no operands or options. Reject source paths, language selectors, and --format json.

    Options and conflicts

    OptionDefaultContractConflicts

    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 this command to inspect the notices included in the installed product.

    Example contract

    Link
    Ruletools-commands-notice.rule.invocation

    Example contract

    The invocation topaz notice 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 notice session.

    Why

    The command prints notices bundled with the installed toolchain. Rejecting a source operand prevents an unused file argument from appearing to change those notices.

    Source evidence

    Behavior contract

    Link
    Ruletools-commands-notice.rule.behavior

    Command behavior

    Arguments and rejection

    Accept no operands or options. Reject source paths, language selectors, and --format json.

    Output

    Print the bundled component notices to standard output. Errors use standard error. There is no selectable JSON format.

    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

    Bundled notices identify the components of this installation. A project filename or registry response must not silently change that subject.

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