🧰 typeCAD/pcb reference
Instead of using the KiCAD schematic editor, you write TypeScript code and build it into a KiCAD project — placing components and making connections happens in code, not by clicking and dragging.
The smallest board
import { PCB } from '@typecad/pcb';
let typecad = new PCB('typecad');
typecad.create();That creates a KiCAD board file, schematic file, netlist, and BOM in ./build/ — typecad.kicad_pcb, typecad.kicad_sch, typecad.net, and typecad.csv. Run typecad-pcb build from your project's hw/ directory to build; a typecad.conf.ts file there configures it.
The flow
typeCAD
- Create a typeCAD project
- Edit the code to add components and make connections
- Build it
- Open the board in the VS Code board viewer
Board viewer
- View Board renders the built board — no KiCAD needed
- Search a designator, click copper to highlight a net
- Switch to Layout and drag parts, draw traces
- Apply writes the session back to your TypeScript
Design rules (minimum clearances, track/via dimensions) default to the JLCPCB no-surcharge standard and are written to the project file for DRC — see Board Layout. The whole flow stays in VS Code — the board viewer is part of the typeCAD extension, and KiCAD works for the visual pass too if you'd rather use it.
Areas
Start here
Core language
Board & layout
Checks & output
Packages
Reference
Something wrong or missing? Open an issue — we'd rather hear about it.