Spis/Docs

CLI command

spis collect-example-images

Collect and retain qualifying cover images for catalog examples.

Invocation#

bash
spis collect-example-images [--replace] [<catalog> ...]

Collect and retain, for each catalog example, the image on its page that shows the product's interface.

Inputs and options#

  • --replace permits replacing an existing retained image. Zero or more interface family names select scope; the families are the ones the reference contract declares.
  • Which image shows the interface is Brama's choice, asked through MODEL_ROUTER_URL, the router alias MODEL_ROUTER_MODEL and the bearer the vault role MODEL_ROUTER_TOKEN_ROLE names. Every readable image on the page is listed with its address, the page's description of it and its dimensions; no size, aspect or word weight decides it.

Output and state effects#

Processes every declared interface family or the selected names, reads every image on each example page, asks Brama which shows the interface, retains that image with its bytes, dimensions and provenance, updates sources.json, and writes/removes image-collection-failures.json. A page with no readable image, or where Brama finds none showing the interface, is an unresolved entry naming that answer. Existing images are preserved unless --replace. It prints per-catalog counts and exits 1 when unresolved failures remain.

Refusals#

These messages are emitted by the current Rust implementation:

  • Unknown flags are refused with unknown argument: FLAG plus usage.
  • Unknown catalogs are refused as a usage error unknown catalog(s): NAME, ... followed by the usage line.
  • Unresolved entries print image collection left N unresolved entries and exit 1.