CLI reference / product / surface

stado product surface

Invocation

stado product surface [OPTIONS]

Purpose

Refuse a Swift package revision whose version tag disagrees with what it did to the library's public API, as swift api-digester reads it against the released tag

Required inputs and options

Input or optionContract
--catalog <catalog>Independent authoritative catalog path
--package-path <package-path>Package directory; defaults to the current directory
--module <module>The library module to read; defaults to the manifest's single library product
--workspace <workspace>The workspace of canonical checkouts this operation reads and builds from; default WISENT_WORKSPACE, else ~/Documents/CodingProjects/Wisent
--jsonPrint the dumps, the digester's diagnosis and the verdict

Output and state effect

It performs the operation described above and emits its operator result on standard output or standard error. Any state change is limited to the resources and records named by the purpose and options on this page.

Refusals

  • Before dispatch, Stado refuses a missing required token shown in the invocation, an unknown option, or a value outside a listed value set; argument-usage failures exit with code 2.