Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Job-file formats

Every engine is driven by a small declarative job file — you describe the job, not the script. Each format is documented with worked examples in its engine’s repository (the examples/ directory, linked from each engine’s chapter).

Sign-off · analyze — describe the job, get a standard sign-off artifact:

FormatEngineDeclares
.char / .charlibvyges-charcorner(s), cells, SPICE collateral
.extvyges-extractdesign, PDK parasitic rules, settings
.pwrvyges-powernetlist, libraries, activity source, budget
.stavyges-sta-silibraries, parasitics, constraints
.emirvyges-em-irdesign, PDN, IR/EM budget
.thermalvyges-thermaldie + grid + material params, floorplan, limit
.lvsvyges-lvslayout (GDS) + schematic netlist

Optimizers · act — netlist in, better netlist out (each move scored by sta-si):

FormatEngineDeclares
.resizevyges-resizenetlist, libraries, (SPEF), timing / area goal
.vtswapvyges-vt-swapnetlist, libraries, (SPEF), leakage / timing goal
.bufinsvyges-buffer-insertnetlist, libraries, (SPEF), transition limit

Shared CLI conventions

Every engine shares the same surface (<engine> = vyges loom <name>, e.g. vyges loom sta-si):

vyges loom <engine> run   JOB [-o OUT] [--json]   run the job → standard artifact (or JSON)
vyges loom <engine> check JOB                      parse + validate the job
vyges loom <engine> demo                           built-in example, no inputs

Common flags: --json, -q/--quiet, -v/--verbose, -h/--help, -V/--version, plus the central --bug-report / --feature-request / --sponsor. The engines that gate on a budget/limit add a fail flag — sta-si, em-ir, thermal use --fail-on-violation; power uses --fail-on-budget — returning a distinct non-zero exit code so a violation fails CI automatically.

-V/--version prints the exact build commit (e.g. vyges-char 0.0.1 (abc1234)) so a bug report traces back to a precise build.