KiCad Nightly Referenzhandbuch
Copyright
Dieses Dokument unterliegt dem Copyright © 2023-2025 der unten aufgeführten Mitwirkenden. Sie dürfen es unter den Bedingungen der GNU General Public License (http://www.gnu.org/licenses/gpl.html), Version 3 oder höher, oder der Creative Commons Attribution License (http://creativecommons.org/licenses/by/3.0/), Version 3.0 oder höher, verbreiten und/oder verändern.
Alle Markenzeichen in diesem Leitfaden gehören ihren rechtmäßigen Eigentümern.
Mitwirkende
Graham Keeth
Feedback
Das KiCad-Projekt freut sich über Rückmeldungen, Fehlerberichte und Vorschläge in Bezug auf die Software oder ihre Dokumentation. Weitere Informationen zum Einreichen von Feedback oder zum Melden eines Problems finden Sie in den Anweisungen unter https://www.kicad.org/help/report-an-issue/
Version der Software und Dokumentation
Dieses Benutzerhandbuch basiert auf KiCad 9.99. Funktionalität und Aussehen können sich in anderen Versionen von KiCad unterscheiden.
Revision der Dokumentation: 7cf88bb6.
Einführung in die KiCad Befehlszeilenschnittstelle
KiCad bietet eine Befehlszeilenschnittstelle, die durch Ausführen der Binärdatei kicad-cli verfügbar ist. Mit der Befehlszeilenschnittstelle können Sie eine Reihe von Aktionen für Schaltpläne, Leiterplatten, Symbole und Footprints automatisiert ausführen, z. B. das Plotten von Gerber-Dateien aus einem Leiterplattenentwurf oder das Aktualisieren einer Symbolbibliothek von einem älteren Dateiformat auf ein modernes Format.
Unter macOS befindet sich die Anwendung kicad-cli unter
/Applications/KiCad/KiCad.app/Contents/MacOS/kicad-cli.
|
kicad-cli verfügt über 6 Unterbefehle: fp, jobset, pcb, sch, sym und version. Jeder Unterbefehl kann eigene Unterbefehle und Argumente haben. Um beispielsweise Gerber-Dateien aus einer Leiterplatte zu exportieren, könnten Sie kicad-cli pcb export gerbers example.kicad_pcb ausführen.
Sie können das Flag --help oder -h hinzufügen, um Informationen zu den einzelnen Unterbefehlen anzuzeigen. Wenn Sie beispielsweise kicad-cli pcb -h ausführen, werden Informationen zur Verwendung des Unterbefehls pcb angezeigt, und wenn Sie kicad-cli pcb export gerbers -h ausführen, werden Informationen zur Verwendung speziell für den Unterbefehl pcb export gerbers angezeigt.
Footprint-Befehle
Der Unterbefehl fp exportiert Footprints in ein anderes Format oder aktualisiert die Footprint-Bibliotheken auf die aktuelle Version des KiCad-Footprint-Dateiformats.
Footprint-Export
Der Befehl fp export svg exportiert einen oder mehrere Footprints aus der angegebenen Bibliothek in SVG-Dateien.
Usage: kicad-cli fp export svg [--help] [--output OUTPUT_DIR] [--layers LAYER_LIST] [--define-var KEY=VALUE]… [--theme VAR] [--footprint FOOTPRINT_NAME] [--sketch-pads-on-fab-layers] [--hide-DNP-footprints-on-fab-layers] [--sketch-DNP-footprints-on-fab-layers] [--crossout-DNP-footprints-on-fab-layers] [--black-and-white] INPUT_FILE_OR_DIR
Positionsargumente:
|
Footprint ( |
Optionale Argumente:
|
Hilfe zum Befehl zum Exportieren von Footprint-SVG-Dateien anzeigen. |
|
Das Ausgabeverzeichnis für die exportierten Dateien. Für jede
Ebene jedes Footprints in der Bibliothek wird eine Datei ausgegeben. Wenn |
|
Eine durch Kommas getrennte Liste der Ebenennamen, die aus dem Footprint exportiert werden sollen, z. B. |
|
Projektvariablendefinitionen hinzufügen oder überschreiben. Kann mehrfach verwendet werden, um mehrere Variablen zu definieren. |
|
Der Name des Themas, das für den Export verwendet werden soll. Wenn kein Thema angegeben ist, wird das derzeit im Footprinteditor ausgewählte Thema verwendet. |
|
Der Name des spezifischen Footprints, der aus der Bibliothek exportiert werden soll. Wenn dieses Argument nicht verwendet wird, werden alle Footprints in der Bibliothek exportiert. |
|
Pad-Umrisse und deren Nummern auf den vorderen und hinteren Fab-Layern zeichnen. |
|
Text und Grafiken von DNP-Footprints nicht auf Fab-Layern plotten. |
|
Grafiken von DNP-Footprints im Skizzenmodus auf Fab-Layern zeichnen. |
|
Ein „X” über den Hof von DNP-Footprints auf Fab-Layern zeichnen und deren Referenzbezeichnungen durchstreichen. |
|
Footprints in Schwarz-Weiß exportieren. |
Footprint-Upgrade
Der Befehl fp upgrade konvertiert die angegebene Footprintbibliothek aus einem älteren KiCad-Footprint-Format oder einem Nicht-KiCad-Footprint-Format in das native Format der aktuellen KiCad-Version. Befindet sich die Eingabebibliothek bereits im aktuellen Dateiformat, wird keine Aktion durchgeführt.
Unterstützte Footprint-Eingabeformate sind:
-
KiCad-Footprintbibliothek (Ordner
.prettymit.kicad_mod-Dateien) -
KiCad (vor 5.0) Footprintbibliothek (
.mod,.emp) -
Altium-Footprintbibliothek (
.PcbLib) -
Altium integrierte Bibliothek (
.IntLib) -
CADSTAR PCB-Archiv (
.cpa) -
EAGLE XML-Bibliothek (
.lbr) -
EasyEDA (JLCEDA) Std-Datei (
.json) -
EasyEDA (JLCEDA) Pro-Datei (
.elibz,.epro,.zip) -
GEDA/PCB-Bibliothek (Ordner mit
.fp-Dateien)
Usage: kicad-cli fp upgrade [--help] [--output OUTPUT_DIR] [--force] INPUT_FILE_OR_DIR
Positionsargumente:
|
Footprint or footprint library directory to upgrade. For KiCad format footprint
libraries, this can be a footprint ( |
Optionale Argumente:
|
Hilfe zum Upgrade-Befehl anzeigen. |
|
Das Ausgabeverzeichnis für die aktualisierten Footprints. Wenn |
|
Die Eingabebibliothek erneut speichern, auch wenn sie bereits im aktuellen Dateiformat vorliegt. |
Jobset-Befehle
Der Befehl jobset run führt einen vordefinierten Jobset aus.
Verwendung: kicad-cli jobset run [--help] [--stop-on-error] [--file JOB_FILE] [--output OUTPUT] INPUT_FILE
Positionsargumente:
|
Projektdatei, die mit dem Jobset verwendet werden soll. |
Optionale Argumente:
|
Hilfe für den Befehl „jobset“ anzeigen. |
|
Da die Jobs nacheinander ausgeführt werden, wird die Ausführung nach dem Fehlschlagen eines Jobs beendet. Wenn diese Option nicht angegeben wird, werden die Jobs nach dem Fehlschlagen eines Jobs weiter ausgeführt. |
|
Die auszuführende Jobset-Datei ( |
|
Das zu generierende Jobset-Ziel. Wenn kein Ziel angegeben ist, werden alle Ziele generiert. Das Ziel wird durch seine Beschreibung oder seine eindeutige ID angegeben. Die angegebene Beschreibung muss eindeutig sein. Wenn der Jobset mehr als ein Ziel mit der angegebenen Beschreibung enthält, wird keines davon ausgeführt. IDs sind von Natur aus eindeutig und können verwendet werden, um auf ein Ziel zu
verweisen, auch wenn die Beschreibung des Ziels nicht eindeutig ist. Die ID für jedes
Ziel wird vom Befehl |
Platinenkommandos
Der Befehl „pcb“ führt eine Designregelprüfung durch oder exportiert eine Platine in verschiedene andere Dateiformate, darunter Fertigungs- und 3D-Dateien.
PCB DRC
Der Befehl „pcb drc“ führt eine Designregelprüfung auf einer Platine durch und erstellt einen Bericht.
Usage: kicad-cli pcb drc [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--format FORMAT] [--all-track-errors] [--schematic-parity] [--units UNITS] [--severity-all] [--severity-error] [--severity-warning] [--severity-exclusions] [--exit-code-violations] [--refill-zones] [--save-board] INPUT_FILE
Positionsargumente:
|
Platinendatei, auf der DRC ausgeführt werden soll. |
Optionale Argumente:
|
Show help for the DRC command. |
|
Output filename for the generated DRC report. When |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Report file format. Options are |
|
Report all errors for each track. |
|
Test for parity between PCB and schematic. |
|
Units to use in the report. Options are |
|
Report all DRC violations. This is equivalent to using all of the other DRC severity options. |
|
Report all error-level DRC violations. This can be combined with the other DRC severity options. |
|
Report all warning-level DRC violations. This can be combined with the other DRC severity options. |
|
Report all excluded DRC violations. This can be combined with the other DRC severity options. |
|
Return an exit code depending on whether or not DRC violations exist. The exit code is 0 if no violations are found, and 5 if any violations are found. |
|
Refill all zones before running DRC.
The board will not be saved after refilling zones unless |
|
Save the board after running DRC.
The board will not be saved unless |
PCB 3D PDF-Export
Der Befehl „pcb export 3dpdf“ exportiert ein Leiterplattendesign in eine PDF-Datei, die ein eingebettetes 3D-Modell der Leiterplatte enthält.
Usage: kicad-cli pcb export 3dpdf [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--force] [--no-unspecified] [--no-dnp] [--grid-origin] [--drill-origin] [--subst-models] [--board-only] [--cut-vias-in-body] [--no-board-body] [--no-components] [--component-filter VAR] [--include-tracks] [--include-pads] [--include-zones] [--include-inner-copper] [--include-silkscreen] [--include-soldermask] [--fuse-shapes] [--fill-all-vias] [--no-extra-pad-thickness] [--min-distance MIN_DIST] [--net-filter VAR] [--user-origin VAR] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the 3D PDF export command. |
|
The output filename. When |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Overwrite output file. |
|
Exclude 3D models of components with "unspecified" footprint type. |
|
Exclude 3D models of components with "Do not populate" attribute. |
|
Use grid origin as origin of output file. |
|
Use drill origin as origin of output file. |
|
Replace VRML models in footprints with STEP or IGS models of the same name, if they exist. |
|
Only include the board itself in the generated model; exclude all component models. |
|
Cut via holes in board body even if conductor layers are not exported. |
|
Exclude board body. |
|
Exclude 3D models for components. |
|
Only include component 3D models matching this list of reference designators (comma-separated, wildcards supported) |
|
Include tracks and vias on outer conductor layers in export (time consuming). |
|
Include pads in export (time consuming). |
|
Include zones in export (time consuming). |
|
Include elements on inner conductor layers in export. |
|
Include silkscreen graphics in export as a set of flat faces. |
|
Include solder mask layers in export as a set of flat faces. |
|
Fuse overlapping geometry together in export (time consuming). |
|
Don’t cut via holes in conductor layers. |
|
Disable adding additional metal thickness to pads. When not used, pads have 0.005mm added to their metal thickness, which causes pads to be separate faces in the exported model, distinct from the surrounding metal. |
|
Tolerance for considering two points to be in the same location. Default:
|
|
Only include copper items belonging to nets matching this wildcard. |
|
Specify a custom origin for the output file, with X and Y coordinates. For
example, |
PCB BREP (OCCT) export
Der Befehl „pcb export brep“ exportiert ein Leiterplattendesign in eine BREP-3D-Modelldatei (OCCT-native Boundary Representation).
Usage: kicad-cli pcb export brep [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--force] [--no-unspecified] [--no-dnp] [--grid-origin] [--drill-origin] [--subst-models] [--board-only] [--cut-vias-in-body] [--no-board-body] [--no-components] [--component-filter VAR] [--include-tracks] [--include-pads] [--include-zones] [--include-inner-copper] [--include-silkscreen] [--include-soldermask] [--fuse-shapes] [--fill-all-vias] [--no-extra-pad-thickness] [--min-distance MIN_DIST] [--net-filter VAR] [--user-origin VAR] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the BREP export command. |
|
The output filename. When |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Overwrite output file. |
|
Exclude 3D models of components with "unspecified" footprint type. |
|
Exclude 3D models of components with "Do not populate" attribute. |
|
Use grid origin as origin of output file. |
|
Use drill origin as origin of output file. |
|
Replace VRML models in footprints with STEP or IGS models of the same name, if they exist. |
|
Only include the board itself in the generated model; exclude all component models. |
|
Cut via holes in board body even if conductor layers are not exported. |
|
Exclude board body. |
|
Exclude 3D models for components. |
|
Only include component 3D models matching this list of reference designators (comma-separated, wildcards supported) |
|
Include tracks and vias on outer conductor layers in export (time consuming). |
|
Include pads in export (time consuming). |
|
Include zones in export (time consuming). |
|
Include elements on inner conductor layers in export. |
|
Include silkscreen graphics in export as a set of flat faces. |
|
Include solder mask layers in export as a set of flat faces. |
|
Fuse overlapping geometry together in export (time consuming). |
|
Don’t cut via holes in conductor layers. |
|
Disable adding additional metal thickness to pads. When not used, pads have 0.005mm added to their metal thickness, which causes pads to be separate faces in the exported model, distinct from the surrounding metal. |
|
Tolerance for considering two points to be in the same location. Default:
|
|
Only include copper items belonging to nets matching this wildcard. |
|
Specify a custom origin for the output file, with X and Y coordinates. For
example, |
PCB Bohrdatei Export
Der Befehl „pcb export drill“ exportiert eine Bohrdatei aus einer Platine.
Usage: kicad-cli pcb export drill [--help] [--output OUTPUT_DIR] [--format FORMAT] [--drill-origin DRILL_ORIGIN] [--excellon-zeros-format ZEROS_FORMAT] [--excellon-oval-format OVAL_FORMAT] [--excellon-units UNITS] [--excellon-mirror-y] [--excellon-min-header] [--excellon-separate-th] [--generate-map] [--generate-report] [--report-path REPORT_FILE] [--generate-tenting] [--map-format MAP_FORMAT] [--gerber-precision VAR] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Hilfe für den Befehl zum Exportieren von Bohrdateien anzeigen. |
|
Das Ausgabeverzeichnis für die Bohrdatei(en). Wenn |
|
Das Bohrdateiformat. Optionen sind |
|
Der Koordinatenursprung für die Bohrdatei. Optionen sind |
|
Das Nullformat für die Bohrdatei. Optionen sind |
|
Den Bohrmodus für ovale Löcher steuern. Optionen sind |
|
Die Einheit für die Bohrdatei. Optionen sind |
|
Die Bohrdatei in Y-Richtung spiegeln. Gilt nur für Bohrdateien im Excellon-Format. |
|
Einen minimalen Header in der Bohrdatei verwenden. Gilt nur für Bohrdateien im Excellon-Format. |
|
Separate Bohrdateien für durchkontaktierte und nicht durchkontaktierte Bohrungen erstellen. Gilt nur für Bohrdateien im Excellon-Format. |
|
Zusätzlich zur Bohrdatei eine Kartendatei erstellen. |
|
Eine Berichtdatei mit allen Bohrpunkten erstellen. |
|
Der Ausgabedateiname für die Bohrberichtdatei.
Wenn |
|
Separate Bohrdateien für überzeltete Bohrungen generieren. Gilt nur für Bohrdateien im Gerber X2-Format. |
|
Das Format der Map-Datei. Optionen sind |
|
Die Genauigkeit (Anzahl der Stellen) für die Bohrdatei. Gültige Optionen sind |
PCB DXF-Export
Der Befehl „pcb export dxf“ exportiert ein Leiterplattendesign in eine DXF-Datei.
Usage: kicad-cli pcb export dxf [--help] [--output OUTPUT_DIR] [--layers LAYER_LIST] [--common-layers COMMON_LAYER_LIST] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--exclude-refdes] [--exclude-value] [--sketch-pads-on-fab-layers] [--hide-DNP-footprints-on-fab-layers] [--sketch-DNP-footprints-on-fab-layers] [--crossout-DNP-footprints-on-fab-layers] [--subtract-soldermask] [--use-contours] [--use-drill-origin] [--include-border-title] [--output-units UNITS] [--drill-shape-opt VAR] [--mode-single] [--mode-multi] [--plot-invisible-text] [--scale SCALE] [--check-zones] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the DXF export command. |
|
The output folder or filename for the exported files. When |
|
A comma-separated list of layer names to export from the footprint, such
as |
|
A comma-separated list of layer names to plot on all layers, such as
|
|
Path to drawing sheet to use in plot, overriding the drawing sheet specified in the board file. |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Exclude footprint reference designators from plot. |
|
Exclude footprint values from plot. |
|
Draw pad outlines and their numbers on front and back fab layers. |
|
Don’t plot text and graphics of DNP footprints on fab layers. |
|
Plot graphics of DNP footprints in sketch mode on fab layers. |
|
Plot an "X" over the courtyard of DNP footprints on fab layers, and strikeout their reference designators. |
|
Remove silkscreen from areas without soldermask. |
|
Plot graphic items using their contours. |
|
Plot using the drill/place file origin. |
|
Include sheet border and title block in plot. |
|
Output units. Options are |
|
The shape of drill marks in the plot. Options are |
|
Generates a single file with the output arg path acting as the complete directory and filename path. |
|
Plot the layers to one or more DXF files, with each file representing a
single layer from |
|
Force plotting of values and references, even if they are invisible. This argument is deprecated as of KiCad 9.0.1 and has no effect. It will be removed in a future version of KiCad. To plot invisible text, edit the board so that the text is no longer invisible. |
|
A scaling factor to use for plotting the PCB. The border and title block are not scaled. A scale factor of 0 autoscales the plot. |
|
Check zone fills and refill zones, if required, prior to export. Any zone fill updates are not saved in the board file. |
PCB GenCAD-Export
Der Befehl pcb export gencad exportiert ein Leiterplattendesign in eine GenCAD-Datei.
Usage: kicad-cli pcb export gencad [--help] [--output OUTPUT_DIR] [--define-var KEY=VALUE]… [--flip-bottom-pads] [--unique-pins] [--unique-footprints] [--use-drill-origin] [--store-origin-coord] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Hilfe für den DXF-Exportbefehl anzeigen. |
|
Der Ausgabedateiname. Wenn |
|
Projektvariablendefinitionen hinzufügen oder überschreiben. Kann mehrfach verwendet werden, um mehrere Variablen zu definieren. |
|
Untere Footprint-Padstacks umdrehen. |
|
Eindeutige Pin-Namen generieren. |
|
Erzeugt eine neue Form für jede Footprint-Instanz (Formate werden nicht wiederverwendet). |
|
Ursprung der Bohr-/Platzierungsdatei als Ursprung verwenden. |
|
Ursprungskoordinaten in der Datei speichern. |
PCB Gerber-Export: ein Layer pro Datei
Der Befehl pcb export gerbers exportiert ein Leiterplattendesign in Gerber-Dateien, wobei jede Datei einen Layer enthält.
Beachten Sie, dass es zwei unterschiedliche Gerber-Exportbefehle gibt: gerber und gerbers. Der Befehl gerber schreibt mehrere PCB-Layer in eine einzige Gerberdatei, während der Befehl gerbers mehrere Gerberdateien mit einem PCB-Layer pro Datei schreibt. Der Befehl gerbers ist in der Regel der richtige Befehl, um eine Platine herstellen zu lassen.
|
Usage: kicad-cli pcb export gerbers [--help] [--output OUTPUT_DIR] [--layers LAYER_LIST] [--common-layers COMMON_LAYER_LIST] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--exclude-refdes] [--exclude-value] [--include-border-title] [--sketch-pads-on-fab-layers] [--hide-DNP-footprints-on-fab-layers] [--sketch-DNP-footprints-on-fab-layers] [--crossout-DNP-footprints-on-fab-layers] [--no-x2] [--no-netlist] [--subtract-soldermask] [--disable-aperture-macros] [--use-drill-file-origin] [--precision PRECISION] [--no-protel-ext] [--plot-invisible-text] [--check-zones] [--board-plot-params] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the Gerber export command. |
|
The output folder for the exported files. One file is output for each
layer. When |
|
A comma-separated list of layer names to plot from the board, such as
|
|
A comma-separated list of layer names to plot on all layers, such as
|
|
Path to drawing sheet to use in plot, overriding the drawing sheet specified in the board file. |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Exclude footprint reference designators from plot. |
|
Exclude footprint values from plot. |
|
Include the sheet border and title block. |
|
Draw pad outlines and their numbers on front and back fab layers. |
|
Don’t plot text and graphics of DNP footprints on fab layers. |
|
Plot graphics of DNP footprints in sketch mode on fab layers. |
|
Plot an "X" over the courtyard of DNP footprints on fab layers, and strikeout their reference designators. |
|
Do not use the extended X2 format. |
|
Do not include netlist attributes. |
|
Remove silkscreen from areas without soldermask. |
|
Disable aperture macros. |
|
Use drill/place file origin instead of absolute origin. |
|
The precision (number of digits) for the Gerber files. Valid options are
|
|
Use |
|
Force plotting of values and references, even if they are invisible. This argument is deprecated as of KiCad 9.0.1 and has no effect. It will be removed in a future version of KiCad. To plot invisible text, edit the board so that the text is no longer invisible. |
|
Check zone fills and refill zones, if required, prior to export. Any zone fill updates are not saved in the board file. |
|
Use the Gerber plot settings already configured in the board file. |
PCB-Gerber-Export: mehrere Lagen pro Datei
Der Befehl pcb export gerber exportiert eine oder mehrere Lagen einer Leiterplatte in eine einzelne Gerber-Datei.
Beachten Sie, dass es zwei unterschiedliche Gerber-Exportbefehle gibt: gerber und gerbers. Der Befehl gerber schreibt mehrere PCB-Layer in eine einzige Gerberdatei, während der Befehl gerbers mehrere Gerberdateien mit einem PCB-Layer pro Datei schreibt. Der Befehl gerbers ist in der Regel der richtige Befehl, um eine Platine herstellen zu lassen.
|
Der Befehl pcb export gerber ist seit KiCad 9.0 veraltet und wird in KiCad 10.0 entfernt. Bitte verwenden Sie stattdessen den Befehl pcb export gerbers.
|
Usage: kicad-cli pcb export gerber [--help] [--output OUTPUT_FILE] [--layers LAYER_LIST] [--common-layers COMMON_LAYER_LIST] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--exclude-refdes] [--exclude-value] [--include-border-title] [--sketch-pads-on-fab-layers] [--hide-DNP-footprints-on-fab-layers] [--sketch-DNP-footprints-on-fab-layers] [--crossout-DNP-footprints-on-fab-layers] [--no-x2] [--no-netlist] [--subtract-soldermask] [--disable-aperture-macros] [--use-drill-file-origin] [--precision PRECISION] [--no-protel-ext] [--plot-invisible-text] [--check-zones] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the Gerber export command. |
|
The output filename. When |
|
A comma-separated list of layer names to plot from the board, such as
|
|
A comma-separated list of layer names to plot on all layers, such as
|
|
Path to drawing sheet to use in plot, overriding the drawing sheet specified in the board file. |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Exclude footprint reference designators from plot. |
|
Exclude footprint values from plot. |
|
Include the sheet border and title block. |
|
Draw pad outlines and their numbers on front and back fab layers. |
|
Don’t plot text and graphics of DNP footprints on fab layers. |
|
Plot graphics of DNP footprints in sketch mode on fab layers. |
|
Plot an "X" over the courtyard of DNP footprints on fab layers, and strikeout their reference designators. |
|
Do not use the extended X2 format. |
|
Do not include netlist attributes. |
|
Remove silkscreen from areas without soldermask. |
|
Disable aperture macros. |
|
Use drill/place file origin instead of absolute origin. |
|
The precision (number of digits) for the Gerber files. Valid options are
|
|
Use |
|
Force plotting of values and references, even if they are invisible. This argument is deprecated as of KiCad 9.0.1 and has no effect. It will be removed in a future version of KiCad. To plot invisible text, edit the board so that the text is no longer invisible. |
|
Check zone fills and refill zones, if required, prior to export. Any zone fill updates are not saved in the board file. |
PCB GLB-Export
Der Befehl pcb export glb exportiert ein Leiterplattendesign in eine GLB-Datei (binäre glTF) für 3D-Modelle.
Usage: kicad-cli pcb export glb [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--force] [--no-unspecified] [--no-dnp] [--grid-origin] [--drill-origin] [--subst-models] [--board-only] [--cut-vias-in-body] [--no-board-body] [--no-components] [--component-filter VAR] [--include-tracks] [--include-pads] [--include-zones] [--include-inner-copper] [--include-silkscreen] [--include-soldermask] [--fuse-shapes] [--fill-all-vias] [--no-extra-pad-thickness] [--min-distance MIN_DIST] [--net-filter VAR] [--user-origin VAR] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the GLB export command. |
|
The output filename. When |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Overwrite output file. |
|
Exclude 3D models of components with "unspecified" footprint type. |
|
Exclude 3D models of components with "Do not populate" attribute. |
|
Use grid origin as origin of output file. |
|
Use drill origin as origin of output file. |
|
Replace VRML models in footprints with STEP or IGS models of the same name, if they exist. |
|
Only include the board itself in the generated model; exclude all component models. |
|
Cut via holes in board body even if conductor layers are not exported. |
|
Exclude board body. |
|
Exclude 3D models for components. |
|
Only include component 3D models matching this list of reference designators (comma-separated, wildcards supported) |
|
Include tracks and vias on outer conductor layers in export (time consuming). |
|
Include pads in export (time consuming). |
|
Include zones in export (time consuming). |
|
Include elements on inner conductor layers in export. |
|
Include silkscreen graphics in export as a set of flat faces. |
|
Include solder mask layers in export as a set of flat faces. |
|
Fuse overlapping geometry together in export (time consuming). |
|
Don’t cut via holes in conductor layers. |
|
Disable adding additional metal thickness to pads. When not used, pads have 0.005mm added to their metal thickness, which causes pads to be separate faces in the exported model, distinct from the surrounding metal. |
|
Tolerance for considering two points to be in the same location. Default:
|
|
Only include copper items belonging to nets matching this wildcard. |
|
Specify a custom origin for the output file, with X and Y coordinates. For
example, |
PCB HPGL export
kicad-cli pcb export hpgl is not functional in KiCad 10.0.
|
The pcb export hpgl command is not functional in KiCad 10.0 as KiCad no longer supports HPGL output. In previous versions of KiCad it exported a board design to an HPGL file. It is included as a non-functional command for compatibility reasons. It will be removed in a future version of KiCad.
Usage: kicad-cli pcb export hpgl [--help] [--output OUTPUT_DIR] INPUT_FILE
PCB IPC-2581-Export
Der Befehl pcb export ipc2581 exportiert ein Leiterplattendesign im IPC-2581-Format.
Usage: kicad-cli pcb export ipc2581 [--help] [--output OUTPUT_FILE] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--precision PRECISION] [--compress] [--version VAR] [--units VAR] [--bom-col-int-id FIELD_NAME] [--bom-col-mfg-pn FIELD_NAME] [--bom-col-mfg FIELD_NAME] [--bom-col-dist-pn FIELD_NAME] [--bom-col-dist FIELD_NAME] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the IPC-2581 export command. |
|
The output filename. When |
|
Path to drawing sheet to use in plot, overriding the drawing sheet specified in the board file. |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
The precision (number of digits after the decimal separator) for the
exported file. The default is |
|
Compress output file as a ZIP file. |
|
IPC-2581 standard version to use. Options are |
|
Units to use in export. Options are |
|
Name of the part field to use for the Bill of Materials Internal ID column. This can be any footprint field, or blank to omit this column. |
|
Name of the part field to use for the Bill of Materials Manufacturer Part Number column. This can be any footprint field, or blank to omit this column. |
|
Name of the part field to use for the Bill of Materials Manufacturer column. This can be any footprint field, or blank to omit this column. |
|
Name of the part field to use for the Bill of Materials Distributor Part Number column. This can be any footprint field, or blank to omit this column. |
|
Name of the part field to use for the Bill of Materials Distributor column. This can be any footprint field, or blank to omit this column. |
PCB IPC-D-356-Export
Der Befehl pcb export ipcd356 generiert eine IPC-D-356-Netzliste aus dem Board-Design.
Verwendung: kicad-cli pcb export ipcd356 [--help] [--output OUTPUT_FILE] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Hilfe für den IPC-D-356-Exportbefehl anzeigen. |
|
Der Name der Ausgabedatei. Wenn |
PCB ODB++ Export
Der Befehl pcb export odb exportiert ein Leiterplattendesign im ODB++-Format.
Usage: kicad-cli pcb export odb [--help] [--output OUTPUT_FILE] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--precision PRECISION] [--compression VAR] [--units VAR] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Hilfe für den ODB++-Exportbefehl anzeigen. |
|
Der Ausgabedateiname oder Ordnername, wenn keine Komprimierung verwendet wird. |
|
Pfad zum Zeichnungsblatt, das beim Plotten verwendet werden soll, wobei das in der Board-Datei angegebene Zeichnungsblatt überschrieben wird |
|
Projektvariablendefinitionen hinzufügen oder überschreiben. Kann mehrfach verwendet werden, um mehrere Variablen zu definieren. |
|
Die Genauigkeit (Anzahl der Stellen nach dem Dezimaltrennzeichen) für die exportierte Datei. Der Standardwert ist |
|
Komprimierungsmodus. Optionen sind |
|
In der Ausgabedatei zu verwendende Einheiten. Optionen sind |
PCB PDF-Export
Der Befehl pcb export pdf exportiert ein Leiterplattendesign in eine PDF-Datei. Jede Lage kann als eigene Datei oder als Blatt in einer einzelnen Datei ausgegeben werden.
Usage: kicad-cli pcb export pdf [--help] [--output OUTPUT_DIR] [--layers LAYER_LIST] [--common-layers COMMON_LAYER_LIST] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--mirror] [--exclude-refdes] [--exclude-value] [--include-border-title] [--subtract-soldermask] [--sketch-pads-on-fab-layers] [--hide-DNP-footprints-on-fab-layers] [--sketch-DNP-footprints-on-fab-layers] [--crossout-DNP-footprints-on-fab-layers] [--negative] [--black-and-white] [--theme THEME_NAME] [--drill-shape-opt VAR] [--plot-invisible-text] [--mode-single] [--mode-separate] [--mode-multipage] [--scale SCALE] [--bg-color COLOR] [--check-zones] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the PDF export command. |
|
The output folder or filename for the exported files. When |
|
A comma-separated list of layer names to export from the board, such as
|
|
A comma-separated list of layer names to plot on all layers, such as
|
|
Path to drawing sheet to use in plot, overriding the drawing sheet specified in the board file. |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Mirror the board. This can be useful for showing bottom layers. |
|
Exclude footprint reference designators from plot. |
|
Exclude footprint values from plot. |
|
Include the sheet border and title block. |
|
Remove silkscreen from areas without soldermask. |
|
Draw pad outlines and their numbers on front and back fab layers. |
|
Don’t plot text and graphics of DNP footprints on fab layers. |
|
Plot graphics of DNP footprints in sketch mode on fab layers. |
|
Plot an "X" over the courtyard of DNP footprints on fab layers, and strikeout their reference designators. |
|
Plot in negative. |
|
Plot in black and white. |
|
The name of the theme to use for export. If no theme is given, the board editor’s currently selected theme is used. |
|
The shape of drill marks in the plot. Options are |
|
Force plotting of values and references, even if they are invisible. This argument is deprecated as of KiCad 9.0.1 and has no effect. It will be removed in a future version of KiCad. To plot invisible text, edit the board so that the text is no longer invisible. |
|
Generates a single file with the output arg path acting as the complete directory and filename path. |
|
Plot the layers to one or more PDF files, with each file representing a
single layer from |
|
Plot the layers to a single PDF file with multiple pages, with each page
representing a single layer from |
|
A scaling factor to use for plotting the PCB. The border and title block are not scaled. A scale factor of 0 autoscales the plot. |
|
A background color for the plot. The format can be hex ( |
|
Check zone fills and refill zones, if required, prior to export. Any zone fill updates are not saved in the board file. |
PCB PLY Dateiexport
Der Befehl pcb export ply exportiert ein Leiterplattendesign in eine PLY-3D-Modelldatei.
Usage: kicad-cli pcb export ply [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--force] [--no-unspecified] [--no-dnp] [--grid-origin] [--drill-origin] [--subst-models] [--board-only] [--cut-vias-in-body] [--no-board-body] [--no-components] [--component-filter VAR] [--include-tracks] [--include-pads] [--include-zones] [--include-inner-copper] [--include-silkscreen] [--include-soldermask] [--fuse-shapes] [--fill-all-vias] [--no-extra-pad-thickness] [--min-distance MIN_DIST] [--net-filter VAR] [--user-origin VAR] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the PLY export command. |
|
The output filename. When |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Overwrite output file. |
|
Exclude 3D models of components with "unspecified" footprint type. |
|
Exclude 3D models of components with "Do not populate" attribute. |
|
Use grid origin as origin of output file. |
|
Use drill origin as origin of output file. |
|
Replace VRML models in footprints with STEP or IGS models of the same name, if they exist. |
|
Only include the board itself in the generated model; exclude all component models. |
|
Cut via holes in board body even if conductor layers are not exported. |
|
Exclude board body. |
|
Exclude 3D models for components. |
|
Only include component 3D models matching this list of reference designators (comma-separated, wildcards supported) |
|
Include tracks and vias on outer conductor layers in export (time consuming). |
|
Include pads in export (time consuming). |
|
Include zones in export (time consuming). |
|
Include elements on inner conductor layers in export. |
|
Include silkscreen graphics in export as a set of flat faces. |
|
Include solder mask layers in export as a set of flat faces. |
|
Fuse overlapping geometry together in export (time consuming). |
|
Don’t cut via holes in conductor layers. |
|
Disable adding additional metal thickness to pads. When not used, pads have 0.005mm added to their metal thickness, which causes pads to be separate faces in the exported model, distinct from the surrounding metal. |
|
Tolerance for considering two points to be in the same location. Default:
|
|
Only include copper items belonging to nets matching this wildcard. |
|
Specify a custom origin for the output file, with X and Y coordinates. For
example, |
PCB Positionsdateiexport
Der Befehl pcb export pos exportiert eine Positionsdatei aus einem Leiterplattenentwurf.
Usage: kicad-cli pcb export pos [--help] [--output OUTPUT_FILE] [--side VAR] [--format FORMAT] [--units UNITS] [--bottom-negate-x] [--use-drill-file-origin] [--smd-only] [--exclude-fp-th] [--exclude-dnp] [--gerber-board-edge] [--variant VARIANT] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the position file export command. |
|
The output filename. When |
|
The side of the board to export. Options are |
|
The position file format. Options are |
|
Units for position file. Options are |
|
Use negative X coordinates for footprints on the bottom layer. This option has no effect for Gerber format. |
|
Use drill/place file origin instead of absolute origin. This option has no effect for Gerber format. |
|
Include only surface-mount components. This option has no effect for Gerber format. |
|
Exclude all footprints with through-hole pads. This option has no effect for Gerber format. |
|
Exclude all footprints with "Do not populate" attribute. |
|
Include board edge layer in export (Gerber format only). |
|
Board variant for variant-aware filtering (DNP, BOM, position file exclusions). |
PCB PostScript Export
Der Befehl pcb export ps exportiert ein Leiterplattendesign in eine PostScript-Datei.
Verwendung: kicad-cli pcb export ps [--help] [--output OUTPUT_DIR] [--layers LAYER_LIST] [--common-layers COMMON_LAYER_LIST] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--mirror] [--exclude-refdes] [--exclude-value] [--include-border-title] [--subtract-soldermask] [--sketch-pads-on-fab-layers] [--hide-DNP-footprints-on-fab-layers] [--sketch-DNP-footprints-on-fab-layers] [--crossout-DNP-footprints-on-fab-layers] [--negative] [--black-and-white] [--theme THEME_NAME] [--drill-shape-opt VAR] [--mode-single] [--mode-multi] [--track-width-correction TRACK_COR] [--x-scale-factor X_SCALE] [--y-scale-factor Y_SCALE] [--force-a4] [--scale SCALE] [--check-zones] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the PS export command. |
|
The output folder or filename for the exported files. When |
|
A comma-separated list of layer names to export from the board, such as
|
|
A comma-separated list of layer names to plot on all layers, such as
|
|
Path to drawing sheet to use in plot, overriding the drawing sheet specified in the board file. |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Mirror the board. This can be useful for showing bottom layers. |
|
Exclude footprint reference designators from plot. |
|
Exclude footprint values from plot. |
|
Include the sheet border and title block. |
|
Remove silkscreen from areas without soldermask. |
|
Draw pad outlines and their numbers on front and back fab layers. |
|
Don’t plot text and graphics of DNP footprints on fab layers. |
|
Plot graphics of DNP footprints in sketch mode on fab layers. |
|
Plot an "X" over the courtyard of DNP footprints on fab layers, and strikeout their reference designators. |
|
Plot in negative. |
|
Plot in black and white. |
|
The name of the theme to use for export. If no theme is given, the board editor’s currently selected theme is used. |
|
The shape of drill marks in the plot. Options are |
|
Generates a single file with the output arg path acting as the complete directory and filename path. |
|
Plot the layers to one or more PS files, with each file representing a
single layer from |
|
A global correction, in millimeters, that is added to the size of tracks, vias, and pads when plotted. This correction can be used to correct for errors in the PostScript output device to achieve an exact-scale output. |
|
X scale adjust for exact scale. |
|
Y scale adjust for exact scale. |
|
Force A4 paper size. |
|
A scaling factor to use for plotting the PCB. The border and title block are not scaled. A scale factor of 0 autoscales the plot. |
|
Check zone fills and refill zones, if required, prior to export. Any zone fill updates are not saved in the board file. |
PCB statistics export
The pcb export stats command exports a report of statistics about the board design.
Usage: kicad-cli pcb export stats [--help] [--output OUTPUT_FILE] [--format FORMAT] [--units UNITS] [--exclude-footprints-without-pads] [--subtract-holes-from-board] [--subtract-holes-from-copper] INPUT_FILE
Positionsargumente:
|
Board file to export statistics from. |
Optionale Argumente:
|
Show help for the statistics command. |
|
Output filename for the generated statistics report. When |
|
Report file format. Options are |
|
Units to use in the report. Options are |
|
Exclude footprints that do not contain any pads from component counts. |
|
Subtract the area of holes from the total board area. |
|
Subtract the area of holes from the total copper area. |
PCB STEP export
The pcb export step command exports a board design to a STEP file.
Usage: kicad-cli pcb export step [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--force] [--no-unspecified] [--no-dnp] [--grid-origin] [--drill-origin] [--subst-models] [--board-only] [--cut-vias-in-body] [--no-board-body] [--no-components] [--component-filter VAR] [--include-tracks] [--include-pads] [--include-zones] [--include-inner-copper] [--include-silkscreen] [--include-soldermask] [--fuse-shapes] [--fill-all-vias] [--no-extra-pad-thickness] [--min-distance MIN_DIST] [--net-filter VAR] [--no-optimize-step] [--user-origin VAR] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the STEP file export command. |
|
The output filename. When |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Overwrite output file. |
|
Exclude 3D models of components with "unspecified" footprint type. |
|
Exclude 3D models of components with "Do not populate" attribute. |
|
Use grid origin as origin of output file. |
|
Use drill origin as origin of output file. |
|
Replace VRML models in footprints with STEP or IGS models of the same name, if they exist. |
|
Only include the board itself in the generated model; exclude all component models. |
|
Cut via holes in board body even if conductor layers are not exported. |
|
Exclude board body. |
|
Exclude 3D models for components. |
|
Only include component 3D models matching this list of reference designators (comma-separated, wildcards supported) |
|
Include tracks and vias on outer conductor layers in export (time consuming). |
|
Include pads in export (time consuming). |
|
Include zones in export (time consuming). |
|
Include elements on inner conductor layers in export. |
|
Include silkscreen graphics in export as a set of flat faces. |
|
Include solder mask layers in export as a set of flat faces. |
|
Fuse overlapping geometry together in export (time consuming). |
|
Don’t cut via holes in conductor layers. |
|
Disable adding additional metal thickness to pads. When not used, pads have 0.005mm added to their metal thickness, which causes pads to be separate faces in the exported model, distinct from the surrounding metal. |
|
Tolerance for considering two points to be in the same location. Default:
|
|
Only include copper items belonging to nets matching this wildcard. |
|
Do not optimize STEP file. This enables writing parametric curves, which reduces file sizes and write/read times, but may reduce compatibility with other software. |
|
Specify a custom origin for the output file, with X and Y coordinates. For
example, |
PCB STL export
The pcb export stl command exports a board design to an STL 3D model file.
Usage: kicad-cli pcb export stl [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--force] [--no-unspecified] [--no-dnp] [--grid-origin] [--drill-origin] [--subst-models] [--board-only] [--cut-vias-in-body] [--no-board-body] [--no-components] [--component-filter VAR] [--include-tracks] [--include-pads] [--include-zones] [--include-inner-copper] [--include-silkscreen] [--include-soldermask] [--fuse-shapes] [--fill-all-vias] [--no-extra-pad-thickness] [--min-distance MIN_DIST] [--net-filter VAR] [--user-origin VAR] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the STL export command. |
|
The output filename. When |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Overwrite output file. |
|
Exclude 3D models of components with "unspecified" footprint type. |
|
Exclude 3D models of components with "Do not populate" attribute. |
|
Use grid origin as origin of output file. |
|
Use drill origin as origin of output file. |
|
Replace VRML models in footprints with STEP or IGS models of the same name, if they exist. |
|
Only include the board itself in the generated model; exclude all component models. |
|
Cut via holes in board body even if conductor layers are not exported. |
|
Exclude board body. |
|
Exclude 3D models for components. |
|
Only include component 3D models matching this list of reference designators (comma-separated, wildcards supported) |
|
Include tracks and vias on outer conductor layers in export (time consuming). |
|
Include pads in export (time consuming). |
|
Include zones in export (time consuming). |
|
Include elements on inner conductor layers in export. |
|
Include silkscreen graphics in export as a set of flat faces. |
|
Include solder mask layers in export as a set of flat faces. |
|
Fuse overlapping geometry together in export (time consuming). |
|
Don’t cut via holes in conductor layers. |
|
Disable adding additional metal thickness to pads. When not used, pads have 0.005mm added to their metal thickness, which causes pads to be separate faces in the exported model, distinct from the surrounding metal. |
|
Tolerance for considering two points to be in the same location. Default:
|
|
Only include copper items belonging to nets matching this wildcard. |
|
Specify a custom origin for the output file, with X and Y coordinates. For
example, |
PCB STEPZ export
The pcb export stpz command exports a board design to a STEPZ (GZIP-compressed STEP) file.
Usage: kicad-cli pcb export stpz [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--force] [--no-unspecified] [--no-dnp] [--grid-origin] [--drill-origin] [--subst-models] [--board-only] [--cut-vias-in-body] [--no-board-body] [--no-components] [--component-filter VAR] [--include-tracks] [--include-pads] [--include-zones] [--include-inner-copper] [--include-silkscreen] [--include-soldermask] [--fuse-shapes] [--fill-all-vias] [--no-extra-pad-thickness] [--min-distance MIN_DIST] [--net-filter VAR] [--no-optimize-step] [--user-origin VAR] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the STEPZ file export command. |
|
The output filename. When |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Overwrite output file. |
|
Exclude 3D models of components with "unspecified" footprint type. |
|
Exclude 3D models of components with "Do not populate" attribute. |
|
Use grid origin as origin of output file. |
|
Use drill origin as origin of output file. |
|
Replace VRML models in footprints with STEP or IGS models of the same name, if they exist. |
|
Only include the board itself in the generated model; exclude all component models. |
|
Cut via holes in board body even if conductor layers are not exported. |
|
Exclude board body. |
|
Exclude 3D models for components. |
|
Only include component 3D models matching this list of reference designators (comma-separated, wildcards supported) |
|
Include tracks and vias on outer conductor layers in export (time consuming). |
|
Include pads in export (time consuming). |
|
Include zones in export (time consuming). |
|
Include elements on inner conductor layers in export. |
|
Include silkscreen graphics in export as a set of flat faces. |
|
Include solder mask layers in export as a set of flat faces. |
|
Fuse overlapping geometry together in export (time consuming). |
|
Don’t cut via holes in conductor layers. |
|
Disable adding additional metal thickness to pads. When not used, pads have 0.005mm added to their metal thickness, which causes pads to be separate faces in the exported model, distinct from the surrounding metal. |
|
Tolerance for considering two points to be in the same location. Default:
|
|
Only include copper items belonging to nets matching this wildcard. |
|
Do not optimize STEP file. This enables writing parametric curves, which reduces file sizes and write/read times, but may reduce compatibility with other software. |
|
Specify a custom origin for the output file, with X and Y coordinates. For
example, |
PCB U3D export
The pcb export u3d command exports a board design to a PDF file containing an embedded 3D model of the board.
Usage: kicad-cli pcb export u3d [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--force] [--no-unspecified] [--no-dnp] [--grid-origin] [--drill-origin] [--subst-models] [--board-only] [--cut-vias-in-body] [--no-board-body] [--no-components] [--component-filter VAR] [--include-tracks] [--include-pads] [--include-zones] [--include-inner-copper] [--include-silkscreen] [--include-soldermask] [--fuse-shapes] [--fill-all-vias] [--no-extra-pad-thickness] [--min-distance MIN_DIST] [--net-filter VAR] [--user-origin VAR] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the 3D PDF export command. |
|
The output filename. When |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Overwrite output file. |
|
Exclude 3D models of components with "unspecified" footprint type. |
|
Exclude 3D models of components with "Do not populate" attribute. |
|
Use grid origin as origin of output file. |
|
Use drill origin as origin of output file. |
|
Replace VRML models in footprints with STEP or IGS models of the same name, if they exist. |
|
Only include the board itself in the generated model; exclude all component models. |
|
Cut via holes in board body even if conductor layers are not exported. |
|
Exclude board body. |
|
Exclude 3D models for components. |
|
Only include component 3D models matching this list of reference designators (comma-separated, wildcards supported) |
|
Include tracks and vias on outer conductor layers in export (time consuming). |
|
Include pads in export (time consuming). |
|
Include zones in export (time consuming). |
|
Include elements on inner conductor layers in export. |
|
Include silkscreen graphics in export as a set of flat faces. |
|
Include solder mask layers in export as a set of flat faces. |
|
Fuse overlapping geometry together in export (time consuming). |
|
Don’t cut via holes in conductor layers. |
|
Disable adding additional metal thickness to pads. When not used, pads have 0.005mm added to their metal thickness, which causes pads to be separate faces in the exported model, distinct from the surrounding metal. |
|
Tolerance for considering two points to be in the same location. Default:
|
|
Only include copper items belonging to nets matching this wildcard. |
|
Specify a custom origin for the output file, with X and Y coordinates. For
example, |
PCB SVG export
The pcb export svg command exports a board design to an SVG file.
Usage: kicad-cli pcb export svg [--help] [--output OUTPUT_DIR] [--layers LAYER_LIST] [--common-layers COMMON_LAYER_LIST] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--subtract-soldermask] [--mirror] [--theme THEME_NAME] [--negative] [--black-and-white] [--sketch-pads-on-fab-layers] [--hide-DNP-footprints-on-fab-layers] [--sketch-DNP-footprints-on-fab-layers] [--crossout-DNP-footprints-on-fab-layers] [--page-size-mode MODE] [--fit-page-to-board] [--exclude-drawing-sheet] [--drill-shape-opt SHAPE_OPTION] [--mode-single] [--mode-multi] [--plot-invisible-text] [--scale SCALE] [--check-zones] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the SVG file export command. |
|
The output folder or filename for the exported files. When |
|
A comma-separated list of layer names to export from the board, such as
|
|
A comma-separated list of layer names to plot on all layers, such as
|
|
Path to drawing sheet to use in plot, overriding the drawing sheet specified in the board file. |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Remove silkscreen from areas without soldermask. |
|
Mirror the board. This can be useful for showing bottom layers. |
|
The name of the theme to use for export. If no theme is given, the board editor’s currently selected theme is used. |
|
Plot in negative. |
|
Plot in black and white. |
|
Draw pad outlines and their numbers on front and back fab layers. |
|
Don’t plot text and graphics of DNP footprints on fab layers. |
|
Plot graphics of DNP footprints in sketch mode on fab layers. |
|
Plot an "X" over the courtyard of DNP footprints on fab layers, and strikeout their reference designators. |
|
Set page sizing mode. Options are |
|
Set the SVG size to match the board outline. This is equivalent to |
|
Plot SVG without a drawing sheet. |
|
The shape of drill marks in the plot. Options are |
|
Generates a single file with the output arg path acting as the complete directory and filename path. |
|
Plot the layers to one or more SVG files, with each file representing a
single layer from |
|
Force plotting of values and references, even if they are invisible. This argument is deprecated as of KiCad 9.0.1 and has no effect. It will be removed in a future version of KiCad. To plot invisible text, edit the board so that the text is no longer invisible. |
|
A scaling factor to use for plotting the PCB. The border and title block are not scaled. A scale factor of 0 autoscales the plot. |
|
Check zone fills and refill zones, if required, prior to export. Any zone fill updates are not saved in the board file. |
PCB VRML export
The pcb export vrml command exports a board design to a VRML 3D model file.
Usage: kicad-cli pcb export vrml [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--force] [--no-unspecified] [--no-dnp] [--user-origin VAR] [--units VAR] [--models-dir VAR] [--models-relative] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the VRML export command. |
|
The output filename. When |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Overwrite output file. |
|
Exclude 3D models of components with "unspecified" footprint type. |
|
Exclude 3D models of components with "Do not populate" attribute. |
|
Specify a custom origin for the output file, with X and Y coordinates. For
example, |
|
Units to use in the output file. Options are |
|
Name of output directory to copy component models into. If not used, component models are embedded into the output file. |
|
With |
PCB XAO export
The pcb export xao command exports a board design to an XAO (SALOME/Gmsh) 3D model file.
Usage: kicad-cli pcb export xao [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--force] [--no-unspecified] [--no-dnp] [--grid-origin] [--drill-origin] [--subst-models] [--board-only] [--cut-vias-in-body] [--no-board-body] [--no-components] [--component-filter VAR] [--include-tracks] [--include-pads] [--include-zones] [--include-inner-copper] [--include-silkscreen] [--include-soldermask] [--fuse-shapes] [--fill-all-vias] [--no-extra-pad-thickness] [--min-distance MIN_DIST] [--net-filter VAR] [--user-origin VAR] INPUT_FILE
Positionsargumente:
|
Zu exportierende Platinen-Datei. |
Optionale Argumente:
|
Show help for the XAO export command. |
|
The output filename. When |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Overwrite output file. |
|
Exclude 3D models of components with "unspecified" footprint type. |
|
Exclude 3D models of components with "Do not populate" attribute. |
|
Use grid origin as origin of output file. |
|
Use drill origin as origin of output file. |
|
Replace VRML models in footprints with STEP or IGS models of the same name, if they exist. |
|
Only include the board itself in the generated model; exclude all component models. |
|
Cut via holes in board body even if conductor layers are not exported. |
|
Exclude board body. |
|
Exclude 3D models for components. |
|
Only include component 3D models matching this list of reference designators (comma-separated, wildcards supported) |
|
Include tracks and vias on outer conductor layers in export (time consuming). |
|
Include pads in export (time consuming). |
|
Include zones in export (time consuming). |
|
Include elements on inner conductor layers in export. |
|
Include silkscreen graphics in export as a set of flat faces. |
|
Include solder mask layers in export as a set of flat faces. |
|
Fuse overlapping geometry together in export (time consuming). |
|
Don’t cut via holes in conductor layers. |
|
Disable adding additional metal thickness to pads. When not used, pads have 0.005mm added to their metal thickness, which causes pads to be separate faces in the exported model, distinct from the surrounding metal. |
|
Tolerance for considering two points to be in the same location. Default:
|
|
Only include copper items belonging to nets matching this wildcard. |
|
Specify a custom origin for the output file, with X and Y coordinates. For
example, |
PCB render
The pcb render command generates a raytraced rendering of the 3D model of the board and saves it to a PNG or JPEG file.
Usage: kicad-cli pcb render [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--width WIDTH] [--height HEIGHT] [--side SIDE] [--background BG] [--quality QUALITY] [--preset PRESET] [--use-board-stackup-colors VAR] [--floor] [--perspective] [--zoom ZOOM] [--pan VECTOR] [--pivot PIVOT] [--rotate ANGLES] [--light-top COLOR] [--light-bottom COLOR] [--light-side COLOR] [--light-camera COLOR] [--light-side-elevation ANGLE] INPUT_FILE
Positionsargumente:
|
Board file to render. |
Optionale Argumente:
|
Show help for the render command. |
|
The output filename. This argument must be given. The file extension given
in this argument determines the output image file format. The filename
must end with either |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Image width in pixels. Default: |
|
Image height in pixels. Default: |
|
The side of the board to render. Options are |
|
Image background. Options are |
|
Render quality. Options are |
|
Color preset. Options are |
|
Colors defined in the board stackup override colors from the preset. |
|
Enables floor, shadows and post-processing, even if disabled in quality preset. |
|
Use perspective projection instead of orthogonal. |
|
Camera zoom factor as an integer. Default: |
|
Set camera pan location, in millimeters, with the format |
|
Set pivot point relative to the board center in centimeters, with the
format |
|
Set board rotation around pivot point, in degrees, with the format
|
|
Top light intensity, format |
|
Bottom light intensity, format |
|
Side lights intensity, format |
|
Camera light intensity, format |
|
Side lights elevation angle in degrees, range: 0-90. |
PCB upgrade
The pcb upgrade command converts a KiCad board file from a previous KiCad board file format to the native format for the current version of KiCad. If the input board file is already in the current file format, no action is taken.
Usage: kicad-cli pcb upgrade [--help] [--force] INPUT_FILE
Positionsargumente:
|
Board file to upgrade. |
Optionale Argumente:
|
Show help for the upgrade command. |
|
Re-save the input board file even if it is already in the current file format. |
Schematic commands
The sch command runs an electrical rule check, exports a schematic to various other file formats, or exports a bill of materials or netlist. Each subcommand has its own options.
Schematic ERC
The sch erc command runs an electrical rule check on a schematic and generates a report.
Usage: kicad-cli sch erc [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE]… [--format VAR] [--units VAR] [--severity-all] [--severity-error] [--severity-warning] [--severity-exclusions] [--exit-code-violations] INPUT_FILE
Positionsargumente:
|
Schematic file to run ERC on. |
Optionale Argumente:
|
Show help for the ERC command. |
|
Output filename for the generated ERC report. When |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
Report file format. Options are |
|
Units to use in the report. Options are |
|
Report all ERC violations. This is equivalent to using all of the other ERC severity options. |
|
Report all error-level ERC violations. This can be combined with the other ERC severity options. |
|
Report all warning-level ERC violations. This can be combined with the other ERC severity options. |
|
Report all excluded ERC violations. This can be combined with the other ERC severity options. |
|
Return an exit code depending on whether or not ERC violations exist. The exit code is 0 if no violations are found, and 5 if any violations are found. |
Schematic bill of materials export
The sch export bom command exports a BOM from a schematic. The BOM export has a number of options for controlling the format and included fields. This export method is equivalent to exporting a BOM from the symbol fields table.
To export a BOM using the legacy XML and Python BOM script workflow, use
the sch export python-bom command.
|
Usage: kicad-cli sch export bom [--help] [--output OUTPUT_FILE] [--variant VAR]… [--preset PRESET] [--format-preset FMT_PRESET] [--fields FIELDS] [--labels LABELS] [--group-by GROUP_BY] [--sort-field SORT_BY] [--sort-asc VAR] [--filter FILTER] [--exclude-dnp] [--include-excluded-from-bom] [--field-delimiter FIELD_DELIM] [--string-delimiter STR_DELIM] [--ref-delimiter REF_DELIM] [--ref-range-delimiter REF_RANGE_DELIM] [--keep-tabs] [--keep-line-breaks] INPUT_FILE
Positionsargumente:
|
Schematic file to export. |
Optionale Argumente:
|
Shows help message and exits |
|
The output filename. When |
|
The name(s) of the variant(s) to output.
Can be used multiple times to output multiple variants.
When specifying multiple variants, use ${VARIANT} in the output path to generate separate files for each variant.
When |
|
Use a named BOM preset setting from the schematic, e.g. |
|
Use a named BOM format preset setting from the schematic, e.g. |
|
An ordered list of fields to export. |
|
An ordered list of labels to apply the exported fields (default:
|
|
Fields to group references by when field values match. |
|
Field name to sort by (default: |
|
If given, sort in ascending order. If not given, sort in descending order. |
|
Filter string to remove output lines. |
|
Exclude symbols with the "Do not populate" attribute. |
|
Include symbols marked "Exclude from BOM". This argument is deprecated as of KiCad 10.0 and has no effect. |
|
Separator between output fields/columns (default: |
|
Character to surround fields with (none by default). |
|
Character to place between individual references (default: |
|
Character to place in ranges of references (default: |
|
Keep tab characters from input fields. Stripped by default. |
|
Keep line break characters from input fields. Stripped by default. |
Schematic DXF export
The sch export dxf command exports a schematic to a DXF file. Each sheet in the design is exported to its own file.
Usage: kicad-cli sch export dxf [--help] [--output OUTPUT_DIR] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--variant VAR]… [--theme THEME_NAME] [--black-and-white] [--exclude-drawing-sheet] [--default-font VAR] [--draw-hop-over] [--pages PAGE_LIST] INPUT_FILE
Positionsargumente:
|
Schematic file to export. |
Optionale Argumente:
|
Show help for the DXF file export command. |
|
The output folder for the exported files. One file is output for each
sheet. When |
|
Path to drawing sheet to use in plot, overriding the drawing sheet specified in the schematic file. |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
The name(s) of the variant(s) to output.
Can be used multiple times to output multiple variants.
When specifying multiple variants, use ${VARIANT} in the output path to generate separate files for each variant.
When |
|
The name of the theme to use for export. If no theme is given, the schematic editor’s currently selected theme is used. |
|
Export schematic in black and white. |
|
Plot DXF without a drawing sheet. |
|
Default font name. Default: |
|
Draw hop-overs at wire crossings. |
|
Comma-separated list of pages to export. Blank or unspecified means all
pages. To plot specific pages, give the root sheet as |
Schematic HPGL export
kicad-cli sch export hpgl is not functional in KiCad 10.0.
|
The sch export hpgl command is not functional in KiCad 10.0 as KiCad no longer supports HPGL output. In previous versions of KiCad it exported a schematic to an HPGL file. It is included as a non-functional command for compatibility reasons. It will be removed in a future version of KiCad.
Usage: kicad-cli sch export hpgl [--help] [--output OUTPUT_DIR] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--variant VAR]… [--theme THEME_NAME] [--black-and-white] [--exclude-drawing-sheet] [--default-font VAR] [--draw-hop-over] [--pages PAGE_LIST] [--pen-size PEN_SIZE] [--origin ORIGIN] INPUT_FILE
Schematic netlist export
The sch export netlist command exports a netlist in various formats from a schematic.
Usage: kicad-cli sch export netlist [--help] [--output OUTPUT_FILE] [--variant VAR]… [--format FORMAT] INPUT_FILE
Positionsargumente:
|
Schematic file to export. |
Optionale Argumente:
|
Show help for the netlist export command. |
|
The output filename. When |
|
The name(s) of the variant(s) to output.
Can be used multiple times to output multiple variants.
When specifying multiple variants, use ${VARIANT} in the output path to generate separate files for each variant.
When |
|
The netlist output format. Options are |
Schematic PDF export
The sch export pdf command exports a schematic to a PDF file. Each sheet in the design is exported to its own page in the PDF file.
Usage: kicad-cli sch export pdf [--help] [--output OUTPUT_FILE] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--variant VAR]… [--theme THEME_NAME] [--black-and-white] [--exclude-drawing-sheet] [--default-font VAR] [--draw-hop-over] [--exclude-pdf-property-popups] [--exclude-pdf-hierarchical-links] [--exclude-pdf-metadata] [--no-background-color] [--pages PAGE_LIST] INPUT_FILE
Positionsargumente:
|
Schematic file to export. |
Optionale Argumente:
|
Show help for the PDF file export command. |
|
The output filename. When |
|
Path to drawing sheet to use in plot, overriding the drawing sheet specified in the schematic file. |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
The name(s) of the variant(s) to output.
Can be used multiple times to output multiple variants.
When specifying multiple variants, use ${VARIANT} in the output path to generate separate files for each variant.
When |
|
The name of the theme to use for export. If no theme is given, the schematic editor’s currently selected theme is used. |
|
Export schematic in black and white. |
|
Plot PDF without a drawing sheet. |
|
Default font name. Default: |
|
Draw hop-overs at wire crossings. |
|
Do not generate property popups in PDF. |
|
Do not generate clickable links for hierarchical elements in PDF. |
|
Do not generate PDF metadata from AUTHOR and SUBJECT variables. |
|
Export schematic without a background color, regardless of theme. |
|
Comma-separated list of pages to export. Blank or unspecified means all
pages. To plot specific pages, give the root sheet as |
Schematic PostScript export
The sch export ps command exports a schematic to a PostScript file. Each sheet in the design is exported to its own file.
Usage: kicad-cli sch export ps [--help] [--output OUTPUT_DIR] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--variant VAR]… [--theme THEME_NAME] [--black-and-white] [--exclude-drawing-sheet] [--default-font VAR] [--draw-hop-over] [--no-background-color] [--pages PAGE_LIST] INPUT_FILE
Positionsargumente:
|
Schematic file to export. |
Optionale Argumente:
|
Show help for the PS file export command. |
|
The output folder for the exported files. One file is output for each
sheet. When |
|
Path to drawing sheet to use in plot, overriding the drawing sheet specified in the schematic file. |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
The name(s) of the variant(s) to output.
Can be used multiple times to output multiple variants.
When specifying multiple variants, use ${VARIANT} in the output path to generate separate files for each variant.
When |
|
The name of the theme to use for export. If no theme is given, the schematic editor’s currently selected theme is used. |
|
Export schematic in black and white. |
|
Plot PS without a drawing sheet. |
|
Default font name. Default: |
|
Draw hop-overs at wire crossings. |
|
Export schematic without a background color, regardless of theme. |
|
Comma-separated list of pages to export. Blank or unspecified means all
pages. To plot specific pages, give the root sheet as |
Schematic bill of materials export (legacy BOM scripts)
The sch export python-bom command exports an XML BOM file from a schematic. The XML BOM file can then be processed into your desired BOM format using a custom script or one of the scripts described in the schematic BOM export documentation.
Usage: kicad-cli sch export python-bom [--help] [--output OUTPUT_FILE] INPUT_FILE
Positionsargumente:
|
Schematic file to export. |
Optionale Argumente:
|
Show help for the BOM export command. |
|
The output filename. When |
Schematic SVG export
The sch export svg command export a schematic to an SVG file. Each sheet in the design is exported to its own file.
Usage: kicad-cli sch export svg [--help] [--output OUTPUT_DIR] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE]… [--variant VAR]… [--theme THEME_NAME] [--black-and-white] [--exclude-drawing-sheet] [--default-font VAR] [--draw-hop-over] [--no-background-color] [--pages PAGE_LIST] INPUT_FILE
Positionsargumente:
|
Schematic file to export. |
Optionale Argumente:
|
Show help for the SVG file export command. |
|
The output folder for the exported files. When |
|
Path to drawing sheet to use in plot, overriding the drawing sheet specified in the schematic file. |
|
Add or override project variable definitions. Can be used multiple times to define multiple variables. |
|
The name(s) of the variant(s) to output.
Can be used multiple times to output multiple variants.
When specifying multiple variants, use ${VARIANT} in the output path to generate separate files for each variant.
When |
|
The name of the theme to use for export. If no theme is given, the schematic editor’s currently selected theme is used. |
|
Export schematic in black and white. |
|
Plot SVG without a drawing sheet. |
|
Default font name. Default: |
|
Draw hop-overs at wire crossings. |
|
Export schematic without a background color, regardless of theme. |
|
Comma-separated list of pages to export. Blank or unspecified means all
pages. To plot specific pages, give the root sheet as |
Schematic upgrade
The sch upgrade command converts a KiCad schematic file from a previous KiCad schematic file format to the native format for the current version of KiCad. If the input schematic file is already in the current file format, no action is taken.
| Only the specified schematic file is upgraded. If the schematic file contains any child sheets, the child sheets are not upgraded. |
Usage: kicad-cli sch upgrade [--help] [--force] INPUT_FILE
Positionsargumente:
|
Schematic file to upgrade. |
Optionale Argumente:
|
Show help for the upgrade command. |
|
Re-save the input schematic file even if it is already in the current file format. |
Symbol commands
The sym subcommand exports symbols to another format or upgrades symbol libraries to the current version of the KiCad symbol file format.
Symbol export
The sym export svg command exports one or more symbols from the specified library into SVG files.
Usage: kicad-cli sym export svg [--help] [--output OUTPUT_DIR] [--theme THEME_NAME] [--symbol SYMBOL] [--black-and-white] [--include-hidden-pins] [--include-hidden-fields] INPUT_FILE
Positionsargumente:
|
Symbol library file to use for export. |
Optionale Argumente:
|
Show help for the symbol SVG export command. |
|
The output folder for the exported files. Each symbol in the input library
is output to a separate file. When |
|
The name of the theme to use for export. If no theme is given, the symbol editor’s currently selected theme is used. |
|
The specific symbol to export from the library. When this argument is not used, all symbols in the library are exported. |
|
Export symbols in black and white. |
|
Export hidden pins in the exported SVG. |
|
Export hidden symbol fields in the exported SVG. |
Symbol upgrade
The sym upgrade command converts the specified symbol library from a legacy KiCad symbol format or a non-KiCad symbol format to the native format for the current version of KiCad. If the input library is already in the current file format, no action is taken.
Supported input symbol formats are:
-
KiCad symbol library (
.kicad_sym) -
KiCad (pre-6.0) symbol library (
.lib) -
Altium schematic library (
.SchLib) -
Altium integrierte Bibliothek (
.IntLib) -
CADSTAR parts library (
.lib) -
EAGLE XML-Bibliothek (
.lbr) -
EasyEDA (JLCEDA) Std-Datei (
.json) -
EasyEDA (JLCEDA) Pro-Datei (
.elibz,.epro,.zip)
Usage: kicad-cli sym upgrade [--help] [--output OUTPUT_FILE_OR_DIR] [--force] INPUT_FILE_OR_DIR
Positionsargumente:
|
Symbol or symbol library to upgrade.
This can be an unpacked symbol ( |
Optionale Argumente:
|
Show help for the upgrade command. |
|
The output file or directory for the upgraded symbol library.
When the output path is a file, the symbols are saved as a single-file ("packed") |
|
Re-save the input library even if it is already in the current file format. |
Version commands
The version command prints the KiCad version. Without any arguments, it simply prints the version number, for example 7.0.7. You can print the version in several other formats using the --format argument.
Use kicad-cli version --format about for version information to include
when submitting bug reports or feature requests on Gitlab.
|
Usage: kicad-cli version [--help] [--format VAR]
Optionale Argumente:
|
Show help for the version command. |
|
Format of the version number. Options are |