vyges-lvs — CLI reference

Generated from vyges-lvs --help. Do not edit by hand — run scripts/gen-cli-reference.sh.

vyges-lvs — layout-vs-schematic netlist comparison with clear divergence diagnostics

usage:
  vyges-lvs run     JOB [-o OUT] [--json] [--fail-on-mismatch]
  vyges-lvs extract GDS (--rules RULES | --pdk NAME) [--top CELL] [-o out.spice]
  vyges-lvs check   JOB
  vyges-lvs demo         [-o OUT] [--json]

A JOB is a small declarative `.lvs` file: the layout side as a SPICE netlist
(`layout:`) OR a GDS to extract natively (`layout_gds:` + `rules:`/`pdk:`), plus
the `schematic:` and an optional `top:`. The compare is name-independent (graph
colour-refinement); a mismatch reports the unmatched device/net classes.
`extract` runs native device extraction (GDS/OASIS -> SPICE) on its own.

Extraction rules come from `--rules`/`rules:` directly, or are resolved from a
PDK by `--pdk`/`pdk:` NAME via the installed pdk-store (its `lvs_device_rules`).

flags:
  --pdk NAME           resolve extraction rules from pdk-store (vs --rules)
  -o FILE              write the report to FILE (default: stdout)
  --json               machine-readable JSON instead of the text report
  --fail-on-mismatch   exit 3 if the netlists are not equivalent (CI gate)
  -q, --quiet          suppress non-essential output
  -v, --verbose        extra detail on stderr
  --describe           print a machine-readable JSON description of the command
  -h, --help           show this help
  -V, --version        show version
  --bug-report         file a bug (central: vyges/community)
  --feature-request    request a feature (central)
  --sponsor            sponsor Vyges (github.com/sponsors/vyges-ip)
  --star               star this tool on GitHub ⭐

Contract

Generated from vyges-lvs --describe.

lvs

layout-vs-schematic comparison (job → report)

Maturity: workflow-validated

run {job}

Consumes: gds, schematic

Artifacts: lvs_report (report_path)

Assertion: lvs-match — passes when lvs_met is true (summary from note)

Provenance limitations

• The job names the layout, schematic and extraction rules; input_hash covers the job path and arguments, not their contents, and SPICE .include chains are not followed.