KiCad Tools

Create or update a net class with design rules and assign nets. Edits the KiCad project file (.kicad_pro) alongside the board to define the net class and assign nets. Does NOT require pcbnew. Args: name: Net class name (e.g. "Power", "HighSpeed") nets: List of net names to assign to this class track_width: Track width in mm (None = use default) clearance: Clearance in mm (None = use default) via_size: Via diameter in mm (None = use default) via_drill: Via drill in mm (None = use default) pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Set the schematic page/sheet size. Args: size: Standard name (A5, A4, A3, A2, A1, A0, A, B, C, D, E) or 'User' for custom width: Custom width in mm (required when size='User') height: Custom height in mm (required when size='User') portrait: If True, swap width/height for portrait orientation schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.

Change the width of existing traces matching the given filters. At least one filter (net_name, layer, or bounding box) is required. Args: width: New trace width in mm net_name: Filter by net name layer: Filter by layer name (e.g. "F.Cu", "B.Cu") x_min: Left edge of bounding box filter (mm) y_min: Top edge of bounding box filter (mm) x_max: Right edge of bounding box filter (mm) y_max: Bottom edge of bounding box filter (mm) pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Trace a net across the hierarchy, following hierarchical pins and labels. Args: net_name: Net/label name to trace schematic_path: Path to root .kicad_sch file. Optional; omit to use the configured default.

Update the PCB from the schematic (headless Tools -> Update PCB from Schematic). Exports the schematic's netlist, loads the assigned footprints from libraries, and binds every pad to its net. Creates the .kicad_pcb if it does not exist; new footprints land in a grid cluster. Existing footprints are matched by reference and keep their position; a changed footprint assignment swaps the footprint in place. Stale board footprints are reported, and removed only with delete_stale (locked ones are never removed). Zones are NOT refilled: run fill_zones afterward. Net names arrive exactly as KiCad's F8 produces them (local labels sheet-prefixed, e.g. "/SIG"); read them with list_pcb_nets. Requires kicad-cli. It no longer needs KiCad's pcbnew Python bindings. Every byte this writes goes through the server's byte-preserving write, so a board's format stamp does not move and the parts of it this tool did not touch arrive unchanged. Args: schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default. pcb_path: Path to .kicad_pcb file (created if missing). Optional; omit to use the configured default. delete_stale: Remove unlocked board footprints absent from the schematic project_path: Path to .kicad_pro for explicit root resolution (sub-sheets)

Upgrade a footprint library to current KiCad format. Rewrites every footprint in the library, so this takes the library directory. kicad-cli has no per-footprint option here, and a single .kicad_mod path is rejected. KiCad performs the migration, as it should, but it performs it on a copy and each result lands through the server's atomic write, so no footprint file can be left truncated. Only files whose content actually changed are written, so an upgrade that touches three footprints leaves the rest of the library alone. The whole library is still copied to ``<name>.pretty.bak`` first and the result names it, because that is the undo for an upgrade that SUCCEEDED. There is exactly one, and every run overwrites it. Each file is atomic; the library as a whole is not a transaction. An upgrade interrupted midway leaves some footprints migrated and some not, and no file damaged. Version control is still the better answer for a library you care about. Args: footprint_path: Path to a .pretty library directory. Optional; omit to use the configured default.

Upgrade a symbol library to current KiCad format. KiCad performs the migration, as it should, but it performs it on a copy: the result lands through the server's atomic write, so your library is replaced whole or not at all and can never be left truncated. A backup is still taken beside it at ``<name>.kicad_sym.bak``, and the result names it, because that is the undo for an upgrade that SUCCEEDED and is not something an atomic write can offer. There is exactly one, and every run overwrites it. Args: symbol_lib_path: Path to .kicad_sym file. Optional; omit to use the configured default.

Validate all footprint placements against keep-out zones and board edge. Args: pcb_path: Path to .kicad_pcb file. Optional; omit to use the configured default.

Validate hierarchical schematic for common issues. Checks for orphaned labels/pins, direction mismatches, duplicate reference designators, unannotated components, and missing files. Args: schematic_path: Path to root .kicad_sch file. Optional; omit to use the configured default.

Wire multiple component pins to the same net label. Wires each pin with a short stub and a shared net label, one file write. Args: pins: List of {"reference": "R1", "pin": "1"} dicts label_text: Net label text (e.g. "GND", "VCC") direction: Wire direction: "auto", "left", "right", "up", "down" stub_length: Wire stub length in mm (default 2.54) auto_pwr_flag: Auto-place PWR_FLAG when net has power_in but no power_out (default True) schematic_path: Path to .kicad_sch file. Optional; omit to use the configured default.