Invocation, options and results
Ссылкаtopaz help
topaz help
Ввод
Require the explicit help command and no extra operands or options. Reject an empty invocation and requests that append a source file or language selector.
Help describes the current command names and the options admitted by each command. It does not execute an example or start a service.
Параметры и конфликты
| Параметр | Значение по умолчанию | Контракт | Конфликты |
|---|
Каналы вывода
stdout
stderr
Статус завершения
0
The requested bundled text is printed.
1
Argument validation or output fails.
Эффекты
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
СсылкаUse help to inspect the invocation syntax shipped with the installed CLI.
Example contract
СсылкаExample contract
The invocation topaz help main. 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 help session.
Причина
help prints the installed command reference. Rejecting a source operand prevents unused command arguments from silently passing validation.
Behavior contract
СсылкаCommand behavior
Arguments and rejection
Require the explicit help command and no extra operands or options. Reject an empty invocation and requests that append a source file or language selector.
Help describes the current command names and the options admitted by each command. It does not execute an example or start a service.
Output
Print the installed usage and command reference to standard output. Command-validation failures use standard error. - is rejected.
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.
Причина
Explicit help requests documentation. An omitted command can be an incomplete automation request, so it must fail instead of appearing to complete an operation.
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
СсылкаArgument-rejection example
Ссылкаfunction identity<T>(value: T) -> T {value}
Ожидаемый результат
Ожидаемый результат
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 help session.
Verification scope
Ссылка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.