Export Ipc2581
export_ipc2581Exports the PCB to IPC-2581 for CAD/MES interchange, including placement, nets, and BOM data. Map schematic fields to BOM columns for assembly imports.
Instructions
Export the PCB in IPC-2581 format via kicad-cli. Single-file MES/CAD interchange carrying placement, nets and BOM part data inline. The bomCol* params map schematic fields to the embedded BOM columns (e.g. internal P/N, manufacturer P/N) — useful for assembly/MES imports. Reads the last SAVED state of the .kicad_pcb.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| units | No | Units (default mm) | |
| version | No | IPC-2581 standard version (default 'C') | |
| compress | No | Compress the output | |
| boardPath | No | Path to the .kicad_pcb (default: current board) | |
| bomColMfg | No | Schematic field to use for the BOM Manufacturer column | |
| defineVar | No | Project variable overrides as 'KEY=VALUE' strings | |
| precision | No | Coordinate precision (default 6) | |
| bomColDist | No | Value to insert into the BOM Distributor column | |
| outputPath | Yes | Output .xml file path | |
| bomColIntId | No | Schematic field to use for the BOM Internal Id column | |
| bomColMfgPn | No | Schematic field to use for the BOM Manufacturer Part Number column | |
| bomColDistPn | No | Schematic field to use for the BOM Distributor Part Number column | |
| drawingSheet | No | Path to a drawing sheet override |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| result | Yes |