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

    lispex embed info

    Reports the embedded Lispex component identity.

    Invocation, options and results

    Link

    topaz lispex embed info

    Synopsis
    1. topaz lispex embed info --format json

    Input

    The complete form is topaz lispex embed info --format json. Require the format option exactly once with a separate json value.

    Reject the omitted format, --format human, --json, equals forms, repeated options, positional operands and every unlisted option. No compiler or language version selector is accepted.

    Options and conflicts

    OptionDefaultContractConflicts
    --format jsonNot specified

    Required output format. Use json to read the embedded component report.

    None listed

    Output channels

    stdout

    stderr

    Exit status

    0

    The complete embedded component report is written.

    2

    Command arguments are invalid.

    4

    Embedded component verification or runtime inspection fails.

    Effects

    Read the embedded component and installed runtime identity. Do not create an output directory, save source or modify caller files.

    Do not scan user directories for alternate evaluator components.

    Perform no network access, registry lookup or component download.

    The same executable bytes, admitted component, runtime policy and target produce the same JSON bytes. Identity fields describe the installed product and contain no invocation timestamp or randomly allocated path.

    Do not load the current directory as a Topaz package. Ignore no package option silently because package options are rejected. No manifest, lock or vendor directory is read or changed.

    Operation

    Link

    Use the JSON report to identify the embedded evaluator before preparing a request.

    Example contract

    Link
    Ruletools-commands-lispex-embed-info.rule.invocation

    Example contract

    The invocation topaz lispex embed info main.tpz --language-version 5.21 --format json is expected to exit with 2.

    The component report requires info --format json. The extra fixture operand and language selector cause this invocation to be rejected.

    Why

    The component report describes the embedded evaluator in the installed executable. Rejecting source operands and language selectors avoids implying that they select a different component.

    Source evidence

    Behavior contract

    Link
    Ruletools-commands-lispex-embed-info.rule.behavior

    Command behavior

    Arguments and rejection

    The complete form is topaz lispex embed info --format json. Require the format option exactly once with a separate json value.

    Reject the omitted format, --format human, --json, equals forms, repeated options, positional operands and every unlisted option. No compiler or language version selector is accepted.

    Output

    Write one UTF-8 JSON object followed by a newline to standard output. The schema is topaz.lispex-embed-info/v4.

    The object contains schema, admission, component, contract, runtime, semantic, discovery, fallback, portableProviderReceipt and selectors. The last four fields are booleans and are false.

    component contains the component id, artifactSha256 and manifestSha256. contract contains id and manifestSha256. semantic contains abiId, costModelId, profileId and valueCodecId. runtime contains id, policyId, policySha256, integer safetyFuel and target. Admission identities and releaseAuthority describe the installed release.

    There is no human output mode. Usage or inspection failures write a human explanation to standard error and no successful JSON report.

    Exit status

    Exit 0 after writing the complete component report.

    Exit 2 for invalid command arguments. Exit 4 when embedded component verification or runtime inspection fails. Report inspection does not use exit 3 because it evaluates no caller request.

    Filesystem effects

    Read the embedded component and installed runtime identity. Do not create an output directory, save source or modify caller files.

    Do not scan user directories for alternate evaluator components.

    Network access

    Perform no network access, registry lookup or component download.

    Reproducibility

    The same executable bytes, admitted component, runtime policy and target produce the same JSON bytes. Identity fields describe the installed product and contain no invocation timestamp or randomly allocated path.

    Packages and locks

    Do not load the current directory as a Topaz package. Ignore no package option silently because package options are rejected. No manifest, lock or vendor directory is read or changed.

    Why

    The component report describes the evaluator that is already installed. Allowing source or selection arguments would imply a different component could be inspected. Its mandatory structured representation gives callers one explicit way to request that report.

    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 reviewed recipe adds a forbidden fixture operand and language selector. A successful exact component report is outside that recipe and has not been executed in this sandbox.

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

    The component report requires info --format json. The extra fixture operand and language selector cause this invocation to be rejected.

    Source evidence

    Verification scope

    Link

    Observed with Topaz 5.21.3 on 2026-11-06T08:36:29.642Z. This invocation passed; exit 2. 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