vyges-extract — CLI reference

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

vyges-extract — foundry-correlated RC parasitic extraction (DEF -> SPEF)

usage:
  vyges-extract run    JOB [-o OUT] [--json] [--pdk NAME | --tech-lef PATH] [--refresh]
                           [--captable PATH | --allow-incomplete-rc]
                           [--cell-lef CL --lib LIB]   # std-cell *CONN hookup
  vyges-extract gen-rc (--pdk NAME | --tech-lef PATH) [--refresh]
  vyges-extract check  JOB
  vyges-extract demo   [-o OUT] [--json]
  vyges-extract klayout2spef --gds F --layermap M [--top CELL] [-o OUT] [--geom-out G]
                             [--def D --cell-lef CL --lib LIB]
                             [--runner podman [--image REF] [--mount DIR] | --python CMD]
                             [--routing-only] [--from-dump F] [--self-test]

klayout2spef drives a headless KLayout (LayoutToNetlist) over a GDS to write SPEF +
an EM geometry sidecar (per-segment layer/width/length) for current-density sign-off.
--runner podman wraps the driver in the vyges-klayout container; --self-test and
--from-dump run the parse→SPEF pipeline offline (no KLayout).

RC rules come from a job's `rules:`, or are DERIVED from the PDK tech LEF via
--pdk / --tech-lef (the metal stack is discovered, not hand-listed) and cached
as vyges-additions/<pdk>/vyges-extract-rc.rules (regenerate with --refresh). When
a tech LEF is geometry-only (no R/C), an OpenRCX captable supplies the numbers;
`run` refuses zero-R/C rules rather than report parasitics that are all zero.

flags:
  --pdk NAME       derive RC rules from the PDK tech LEF (resolved via pdk-store)
  --tech-lef PATH  derive RC rules from this tech LEF directly
  --captable PATH  OpenRCX rules file for R/C the LEF lacks (else pdk-store captable)
  --refresh        re-derive the cached RC rules
  --allow-incomplete-rc  extract even when a layer has no R/C (understates parasitics)
  -o FILE          write output to FILE (default: stdout)
  --json           per-net parasitics summary as JSON instead of SPEF
  -q, --quiet      suppress non-essential output
  -v, --verbose    extra detail on stderr
  -j, --threads N  parallel worker threads (default: all cores; 1 = serial)
  --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-extract --describe.

extract

foundry-correlated RC parasitic extraction (DEF -> SPEF)

Maturity: workflow-validated

run {job}

Consumes: def, gds

Artifacts: spef (out)

Assertion: parasitic-extract — none; this operation establishes no engineering claim

Provenance limitations

• The job names the DEF/LEF and the rules or captable; input_hash covers the job path and arguments, not their contents.