actions-for-kicad/KiCad actions
A GitHub action that can generate and check KiCad schematics and PCBs.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Activelast commit Jun 22, 2026
- License
- MIT
Pinned Snippet
uses: actions-for-kicad/kicad-actions@301c658e8e54b2f530d512b04c4f112b3952e72e # v2.4-k10.0tags can be moved; commit SHAs can't. why a SHA?
Inputs
| name | description | required | default |
|---|---|---|---|
| project_file_name | The project file, used for running a jobset. Not required if there is a single `.kicad_pro` file in the working directory. | — | — |
| schematic_file_name | Location of the '.kicad_sch' file. | — | — |
| symbol_libraries | Comma-separated list of symbol libraries in the format name=path. | — | — |
| run_erc | Run the ERC on the schematic. | — | false |
| erc_output_file_name | Output file name of ERC report. | — | erc.rpt |
| schematic_output_pdf | Run the PDF export of the schematic. | — | false |
| schematic_output_pdf_file_name | Output file name of PDF schematic. | — | schematic.pdf |
| schematic_output_black_white | Run the PDF, SVG, DXF and PS schematic export in black and white. | — | false |
| schematic_output_pages | Comma-separated list of schematic pages to include in exports. | — | — |
| schematic_output_svg | Run the SVG export of the schematic. | — | false |
| schematic_output_svg_folder_name | Output folder name of SVG schematic. | — | schematics |
| schematic_output_dxf | Run the DXF export of the schematic. | — | false |
| schematic_output_dxf_folder_name | Output folder name of DXF schematic. | — | schematics |
| schematic_output_ps | Run the PS export of the schematic. | — | false |
| schematic_output_ps_folder_name | Output folder name of PS schematic. | — | schematics |
| schematic_output_bom | Run the BOM export of the schematic. | — | false |
| schematic_output_bom_file_name | Output file name of the BOM. | — | bom.csv |
| schematic_output_bom_fields | Output fields in the BOM file. `*` includes all fields. | — | Reference,Value,Footprint,${QUANTITY},${DNP} |
| schematic_output_bom_labels | Output labels in the BOM file. | — | Refs,Value,Footprint,Qty,DNP |
| schematic_output_netlist | Run the netlist export of the schematic. | — | false |
| schematic_output_netlist_file_name | Output file name of the netlist. | — | netlist.net |
| schematic_output_xml_netlist | Run the XML netlist export of the schematic. | — | false |
| schematic_output_xml_netlist_file_name | Output file name of the XML netlist. | — | netlist.xml |
| pcb_file_name | Location of the '.kicad_pcb' file. | — | — |
| footprint_libraries | Comma-separated list of footprint libraries in the format name=path. | — | — |
| run_drc | Run the DRC on the PCB. | — | false |
| drc_output_file_name | Output file name of DRC report. | — | drc.rpt |
| pcb_output_drill | Run the drill export of the PCB. | — | false |
| pcb_output_drill_folder_name | Output folder name of drill file. | — | drill |
| pcb_output_drill_format | Format of the drill file. Options: 'excellon', 'gerber'. | — | excellon |
| pcb_output_drill_split | Split drill file into plated and non-plated counterparts. | — | false |
| pcb_output_gerbers | Run the gerber export of the PCB. | — | false |
| pcb_output_gerbers_folder_name | Output folder name of gerber files. | — | gerbers |
| pcb_output_layers | Output layers of the PCB. | — | — |
| pcb_output_gerbers_and_drill | Run the gerber and drill export of the PCB. | — | false |
| pcb_output_gerbers_and_drill_folder_name | Output folder name of gerber and drill files. | — | gerbers |
| pcb_output_dxf | Run the DXF export of the PCB. | — | false |
| pcb_output_dxf_folder_name | Output folder name of DXF PCB. | — | dxf |
| pcb_output_pdf | Run the PDF export of the PCB. | — | false |
| pcb_output_pdf_file_name | Output file name of PDF PCB. | — | pcb.pdf |
| pcb_output_black_white | Run the PDF and SVG PCB export in black and whit. | — | false |
| pcb_output_svg | Run the SVG export of the PCB. | — | false |
| pcb_output_svg_file_name | Output file name of SVG PCB. | — | pcb.svg |
| pcb_output_pos | Run the POS export of the PCB. | — | false |
| pcb_output_pos_file_name | Output file name of POS PCB. | — | pcb.pos |
| pcb_output_pos_format | Format of the pos file. Options: 'ascii', 'csv', 'gerber'. | — | ascii |
| pcb_output_pos_side | Side of the post file. Options: 'front', 'back', 'both'. Both is not supported by gerber. | — | both |
| pcb_output_ipc2581 | Run the IPC-2581 export of the PCB. | — | false |
| pcb_output_ipc2581_file_name | Output file name of IPC-2581 PCB. | — | pcb.xml |
| pcb_output_step | Run the STEP export of the PCB. | — | false |
| pcb_output_step_file_name | Output file name of STEP PCB. | — | pcb.step |
| pcb_output_image | Run the image export of the PCB. | — | false |
| pcb_output_image_file_name | Output file name of image PCB. Must end in '.png', '.jpg', '.jpeg'. | — | pcb.png |
| pcb_output_image_side | Side of the image PCB. Options: 'top', 'bottom', 'left', 'right', 'front', 'back'. | — | top |
| pcb_output_image_background | Background of the image PCB. Options: 'default', 'transparent', 'opaque'. For PNG files, default is transparent. For JPG files, default is opaque. | — | default |
| pcb_output_image_width | Width of the image PCB in pixels. | — | 1600 |
| pcb_output_image_height | Height of the image PCB in pixels. | — | 900 |
| pcb_output_image_floor | Enables floor, shadows and post-processing. | — | false |
| pcb_output_image_perspective | Enables perspective view. | — | false |
| pcb_output_image_quality | Quality of the image PCB. Options: 'basic', 'high', 'user'. | — | basic |
| pcb_output_image_zoom | Zoom factor of the image PCB. | — | 1.0 |
| pcb_output_image_rotate | Rotation of the image PCB. Format: 'x,y,z'. | — | 0,0,0 |
| jobset_file_name | Run a predefined KiCad jobset file. | — | — |
Outputs
no outputs