design

Usage

altium-cruncher design project.PrjPcb -o output/design_review
altium-cruncher design-review project.PrjPcb
altium-cruncher dr schematic.SchDoc

Arguments

file accepts .SchDoc or .PrjPcb. When omitted, the command attempts project auto-detection in the current directory. -o selects the output directory. --no-indexes omits optional lookup indexes from the design JSON. design-review and dr are aliases for the same command and output contract.

Output

The command defaults to output/design_review and writes design_review_manifest.json with schema altium_cruncher.design_review_manifest.a0, README.md, design/<input>_design.json from AltiumDesign.to_json(), notes/<input>_notes.jsonc, serialized SchDoc/PcbDoc JSON under json/schdoc/ and json/pcbdoc/, schematic SVGs under sch/, and PCB copper-layer review SVGs under pcb/layers/ for project inputs with boards. The design JSON is the primary semantic model for components, nets, hierarchy, PnP, variants, SVG ids, and lookup indexes; its component rows are also the BOM-like part of the netlist. The generated README explains how schematic SVG metadata, PCB SVG metadata, design JSON indexes, and json-dump document snapshots relate, and includes power-tree review hints for following selected two-pin series parts. Each PCB review SVG follows the default pcb-svg layer-output contract but limits physical layers to copper layers, including inner copper layers when present; board outline, board cutouts, drills, and slots are included. Composed PCB views and assembly/HLR virtual layers are intentionally omitted from dr; use pcb-svg when those heavier views are needed. The command logs each generated SVG and JSON artifact as it is written. The notes artifact uses the default review filter and suppresses title-block/sheet-template owned text.

Tests

L0 verifies help and aliases. Unit workflow tests synthesize SchDoc and PcbDoc inputs, then verify the dr alias writes design JSON, notes JSONC, document JSON, schematic SVG, copper-only PCB review SVGs, manifest, and README artifacts while omitting composed assembly views. L3 continues to verify Hydroscope design JSON contents through the same command.