Open workbench
Menu

SIS CLI

Migration & Compatibility Guide

Use the command grammar and schema identity of the installed binary. sis --version, sis doctor --json, and each command’s --help are the local entry points.

Current operator grammar

  • Bundled guidance is sis docs <topic>; list it with sis docs index.
  • Queries with two positionals put the query first: sis query findings sample.html --format json. A sole file positional still defaults to findings.
  • Interactive PDF inspection is sis query repl <pdf>.
  • Transformations use sis sanitize plan|apply|release|verify; scoped planning is plan --asset, release profiles use release --profile, and verification takes the report positionally.
  • Workflow bundles use sis workflow bundle lint <bundle-dir>.
  • Corpus investigation uses sis corpus cluster|correlate|diff. Correlation input is --input reports.jsonl.
  • Streaming analysis uses sis scan <file> --stream.
  • Prefer scan --format for stdout and repeatable --emit KIND=PATH for side artefacts.

Superseded root spellings were removed during CLI consolidation rather than retained as general compatibility aliases. Do not infer that an old script works from an older guide. Some output/explanation spellings remain hidden compatibility forms; current examples use the canonical forms above.

Saved artefacts and comparisons

Keep input identity, binary/build identity, posture, policy provenance and schema versions with every capture. Report, report JSONL, workspace and semantic snapshot are distinct artefact shapes. A deserialisable saved report does not imply a new analysis under a different build has equivalent semantics. A report written before the embedded semantic_snapshot section existed is refused by sis query --from-report (PERSISTED_ANALYSIS_REFUSED, missing_section); it is not read as having no analysis.

Use sis docs query for supported saved-result projections and sis docs batch for comparing captures. A failed or unavailable projection is not an empty observation. Consumers should tolerate additive fields while rejecting a schema/artefact shape they cannot interpret.

  • sis docs compatibility — identifier windows and format-scoped query contracts
  • sis docs scan — stdout, side artefacts and exits
  • sis docs verdict — result semantics