Export Pcb Pdf
export_pcb_pdfExport PCB layouts to PDF via kicad-cli, with customizable layers, mirroring, color themes, and output modes. Supports single, separate, or multipage PDFs for documentation and manufacturing.
Instructions
Plot the PCB layout to PDF via kicad-cli, exposing the full layer-plot option set (layer + common-layer lists, mirror, refdes/value exclusion, border+title, soldermask subtraction, DNP fab-layer modes, negative, black-and-white, theme, drill shape, and single/separate/multipage output modes). Rich CLI sibling of export_pdf. Reads the last SAVED state of the .kicad_pcb.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| theme | No | Color theme to use (default: PCB editor settings) | |
| layers | No | Layers to plot, untranslated names e.g. ['F.Cu','B.Cu','Edge.Cuts'] | |
| mirror | No | Mirror the board (to show bottom layers) | |
| negative | No | Plot as negative | |
| boardPath | No | Path to the .kicad_pcb (default: current board) | |
| defineVar | No | Project variable overrides as 'KEY=VALUE' strings | |
| modeSingle | No | Single file; output path is full path; LAYER_LIST controls all layers | |
| outputPath | Yes | Output PDF file path (or directory in separate mode) | |
| commonLayers | No | Layers to include on every plot (e.g. ['Edge.Cuts']) | |
| drawingSheet | No | Path to a drawing sheet override | |
| excludeValue | No | Exclude value text | |
| modeSeparate | No | Plot the layers to individual PDF files | |
| blackAndWhite | No | Black and white only | |
| drillShapeOpt | No | Pad/via drill shape option (0 none, 1 small, 2 actual; default 2) | |
| excludeRefdes | No | Exclude reference designator text | |
| modeMultipage | No | Plot the layers to a single multi-page PDF | |
| includeBorderTitle | No | Include the border and title block | |
| subtractSoldermask | No | Subtract soldermask from silkscreen | |
| sketchPadsOnFabLayers | No | Draw pad outlines and numbers on fab layers | |
| hideDnpFootprintsOnFabLayers | No | Don't plot DNP footprint text/graphics on fab layers | |
| sketchDnpFootprintsOnFabLayers | No | Plot DNP footprints in sketch mode on fab layers | |
| crossoutDnpFootprintsOnFabLayers | No | Plot an 'X' over DNP footprint courtyards and strike out their refdes |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |