KiCad Nightly 参考手册
Copyright
本文档的版权归 (C) 2023-2024 所有,由下列贡献者提供。您可以根据 GNU 通用公共许可证 (http://www.gnu.org/licenses/gpl.html) 版本 3 或更高版本或知识共享署名许可证 (http://creativecommons.org/licenses/by/3.0/) 版本 3.0 或更高版本的条款分发和/或修改它。
本指南中的所有商标均属于其合法所有者。
Contributors
Graham Keeth
翻译人员
taotieren <[email protected]>, 2019-2025.
Feedback
KiCad 项目欢迎与软件或其文档相关的反馈、错误报告和建议。有关如何提交反馈或报告问题的更多信息,请参阅 https://www.kicad.org/help/report-an-issue/ 上的说明
Software and Documentation Version
本用户手册基于 KiCad 9.99 版本。其他版本的 KiCad 在功能和界面外观上可能存在差异。
文档修订版:8d8f7b76
。
KiCad 命令行界面简介
KiCad 提供了一个命令行界面,可以通过运行 kicad-cli
二进制文件来使用。使用命令行界面,您可以以自动化方式对原理图、PCB、符号和封装执行许多操作,例如绘制 PCB 设计中的 Gerber 文件或将符号库从传统文件格式升级到现代格式。
在 macOS 上,kicad-cli 可执行文件位于 /Applications/KiCad/KiCad.app/Contents/MacOS/kicad-cli 。
|
kicad-cli
命令包含 6 个子命令: fp
、jobset
、pcb
、sch
、sym
和 version
。每个子命令都可以有自己的子命令和参数。例如,要从 PCB 导出 Gerber 文件,您可以运行 kicad-cli pcb export gerbers example.kicad_pcb
。
您可以添加 --help
或 -h
标志来查看有关每个子命令的信息。例如,运行 kicad-cli pcb -h
打印有关 pcb
子命令的使用信息,而 kicad-cli pcb export gerbers -h
专门打印 pcb export gerbers
子命令的使用信息。
封装命令
fp
子命令将封装导出为另一种格式,或将封装库升级到 KiCad 封装文件格式的当前版本。
封装导出
fp export svg
命令将指定库中的一个或多个封装导出到 SVG 文件中。
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_DIR
位置参数:
|
要导出的封装库目录( |
可选参数:
|
显示封装 SVG 导出命令的帮助信息。 |
|
导出文件的输出文件夹。当未使用 |
|
要从封装中导出的图层名称的逗号分隔列表,例如 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
用于导出的主题名称。如果未指定主题,则使用封装编辑器当前选择的主题。 |
|
从库中导出的特定封装的名称。当未使用此参数时,库中的所有封装都会被导出。 |
|
在正面和背面 Fab 层上绘制焊盘轮廓及其编号。 |
|
不要在 Fab 层上绘制 DNP 封装的文本和图形。 |
|
在 Fab 层上以草图模式绘制 DNP 封装的图形。 |
|
在 Fab 层上的 DNP 封装的外框上画一个 "X",并划掉其位号。 |
|
以黑白形式导出封装。 |
封装升级
fp upgrade
命令将指定的封装库从旧的 KiCad 封装格式或非 KiCad 封装格式转换为当前版本 KiCad 的原生格式。如果输入库已经采用当前文件格式,则不会采取任何操作。
支持的输入封装格式为:
-
KiCad 封装库(包含
.kicad_mod
文件的.pretty
文件夹) -
KiCad(5.0 之前版本)封装库(
.mod
、.emp
) -
Altium 封装库 (
.PcbLib
) -
Altium 集成库 (
.IntLib
) -
CADSTAR PCB 存档文件 (
.cpa
) -
EAGLE XML 库 (
.lbr
) -
EasyEDA (JLCEDA) 标准版文件 (
.json
) -
EasyEDA (JLCEDA) 专业版文件 (
.elibz
,.epro
,.zip
) -
GEDA/PCB 库(包含
.fp
文件的文件夹)
Usage: kicad-cli fp upgrade [--help] [--output OUTPUT_DIR] [--force] INPUT_DIR
位置参数:
|
要升级的封装库目录。对于 KiCad 格式的封装库,这是 |
可选参数:
|
显示封装升级命令的帮助信息。 |
|
升级后的封装的输出目录。当未使用 |
|
即使输入库已采用当前文件格式,仍需重新保存该库。 |
jobset 命令
jobset run
命令用于运行预先定义的 jobset。
Usage: kicad-cli jobset run [--help] [--stop-on-error] [--file JOB_FILE] [--output OUTPUT] INPUT_FILE
位置参数:
|
与 jobset 配合使用的工程文件。 |
可选参数:
|
显示 jobset 命令的帮助信息。 |
|
由于任务按顺序执行,当某个任务失败时,将停止后续任务的执行。如果未指定此选项,则在任何任务失败后,后续任务将继续执行。 |
|
要运行的 jobset 文件( |
|
The jobset destination to generate. If no destination is specified, all destinations will be generated. The destination is specified by its description or by its unique ID. The specified description must be unique; if the jobset contains more than one destination with the given description, none of them will be run. IDs are inherently unique and can be used to refer to a destination even
if the destination’s description is not unique. The ID for each
destination is printed by the |
PCB 命令
pcb
命令用于执行设计规则检查或将电路板导出为多种其他文件格式,包括制造文件和 3D 文件。
PCB DRC
pcb drc
命令对电路板执行设计规则检查并生成报告。
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] INPUT_FILE
位置参数:
|
用于运行 DRC 的电路板文件。 |
|
显示 DRC 命令的帮助信息。 |
|
生成的 DRC 报告的输出文件名。当未使用 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
报告文件格式。可选格式为 |
|
为每条布线报告所有错误。 |
|
检查 PCB 与原理图之间的对齐情况。 |
|
报告中使用的单位。可选单位包括 |
|
报告所有 DRC 违规行为。这相当于使用所有其他 DRC 严重性选项。 |
|
报告所有错误级别的 DRC 违规项。此选项可与其他 DRC 严重性选项结合使用。 |
|
报告所有警告级别的 DRC 违规。这可以与其他 DRC 严重性选项结合使用。 |
|
报告所有被排除的 DRC 违规行为。这可以与其他 DRC 严重性选项结合使用。 |
|
根据是否存在 DRC 违规情况返回退出代码。如果未发现任何违规,退出代码为 0;如果发现任何违规,退出代码为 5。 |
PCB BREP (OCCT) 导出
pcb export brep
命令将电路板设计导出为 BREP(OCCT 原生边界表示)3D 模型文件。
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] [--min-distance MIN_DIST] [--net-filter VAR] [--user-origin VAR] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 BREP 导出命令的帮助信息。 |
|
输出文件名。当未使用 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
覆盖输出文件。 |
|
排除具有 “未指定” 封装类型的元件的 3D 模型。 |
|
排除具有 “DNP” 属性的元件的 3D 模型。 |
|
将网格原点作为输出文件的原点。 |
|
将钻孔原点作为输出文件的原点。 |
|
如果存在同名的 STEP 或 IGS 模型,则用它们替换封装中的 VRML 模型。 |
|
仅将电路板本身包含在生成的模型中;排除所有元件模型。 |
|
即使导电层未导出,仍需在电路板本体上开孔。 |
|
排除电路板主体。 |
|
排除元件的 3D 模型。 |
|
仅包含与以下位号列表匹配的元件 3D 模型(以逗号分隔,支持通配符) |
|
在导出时包含外层导电层上的布线和过孔(耗时)。 |
|
在导出时包含焊盘(耗时)。 |
|
在导出时包含敷铜(耗时)。 |
|
在导出时包含内导体层中的元素。 |
|
在导出时将丝印图形作为一组平面图形包含在内。 |
|
在导出时将阻焊层作为一组平面。 |
|
在导出时将重叠的几何体合并在一起(耗时)。 |
|
请勿通过导电层上的过孔进行切割。 |
|
将两个点视为位于同一位置的误差。默认值: |
|
仅包含与该通配符匹配的网络中的铜对象。 |
|
指定输出文件的自定义原点,包括 X 和 Y 坐标。例如, |
PCB 钻孔文件导出
pcb export drill
命令从电路板导出钻孔文件。
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] [--map-format MAP_FORMAT] [--gerber-precision VAR] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示钻孔文件导出命令的帮助信息。 |
|
钻孔文件的输出目录。当未使用 |
|
钻孔文件格式。可选格式为 |
|
钻孔文件的坐标原点。可选项包括 |
|
钻孔文件的零导格式。可选项包括 |
|
控制椭圆形孔的钻孔模式。可选模式为 |
|
钻孔文件的单位。可选单位为 |
|
将钻孔文件在 Y 方向上镜像。仅适用于 Excellon 格式的钻孔文件。 |
|
在钻孔文件中使用最小的钻头。仅适用于 Excellon 格式的钻孔文件。 |
|
为电镀孔和非电镀孔分别生成钻孔文件。 仅适用于 Excellon 格式的钻孔文件。 |
|
除了钻孔文件外,还生成一个映射文件。 |
|
映射文件格式。可选格式包括 |
|
钻孔文件的精度(位数)。有效选项为 |
PCB DXF 导出
pcb export dxf
命令将电路板设计导出为 DXF 文件。
Usage: kicad-cli pcb export dxf [--help] [--output OUTPUT_DIR] [--layers 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] [--common-layers COMMON_LAYER_LIST] [--mode-single] [--mode-multi] [--plot-invisible-text] [--scale SCALE] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 DXF 导出命令的帮助信息。 |
|
导出文件的输出文件夹或文件名。当使用 |
|
从封装中导出的图层名称列表,以逗号分隔,例如 |
|
用于绘制的图纸路径,覆盖板文件中指定的图纸。 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
从绘制中排除封装位号。 |
|
从绘制中排除封装值。 |
|
在正面和背面 Fab 层上绘制焊盘轮廓及其编号。 |
|
不要在 Fab 层上绘制 DNP 封装的文本和图形。 |
|
在 Fab 层上以草图模式绘制 DNP 封装的图形。 |
|
在 Fab 层上的 DNP 封装的外框上画一个 "X",并划掉其位号。 |
|
从没有阻焊层的区域去除丝印。 |
|
使用轮廓绘制图形对象。 |
|
使用钻孔/放置文件的原点进行绘制。 |
|
在绘制中包含图纸边框和标题栏。 |
|
输出单位。可选单位为 |
|
钻孔标记在图中的形状。选项包括: |
|
在所有图层上绘制的图层名称的逗号分隔列表,例如 |
|
生成一个单一文件,其中输出参数路径作为完整的目录和文件名路径。 |
|
将图层绘制到一个或多个 DXF 文件中,每个文件代表 |
|
强制绘制值和位号,即使它们不可见。此参数自 KiCad 9.0.1起已废弃且无效。它将在未来版本的 KiCad 中被移除。要绘制不可见文本,请编辑电路板以使文本不再不可见。 |
|
用于绘制 PCB 的缩放比例。边框和标题栏不进行缩放。缩放比例为 0 时,绘图将自动调整比例。 |
PCB GenCAD 导出
pcb export gencad
命令将电路板设计导出为 GenCAD 文件。
Usage: kicad-cli pcb export gencad [--help] [--output OUTPUT_FILE] [--define-var KEY=VALUE] [--flip-bottom-pads] [--unique-pins] [--unique-footprints] [--use-drill-origin] [--store-origin-coord] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 DXF 导出命令的帮助信息。 |
|
输出文件名。当未使用 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
翻转底部封装 padstacks。 |
|
生成唯一的引脚名称。 |
|
为每个封装实例生成一个新形状(不要重复使用形状)。 |
|
使用钻孔/放置文件的原点作为原点。 |
|
将原始坐标保存到文件中。 |
PCB Gerber 文件导出:每个文件包含多个层
pcb export gerbers
命令将电路板设计导出为 Gerber 文件,每个文件对应一层。
请注意,Gerber 导出命令有两个不同的版本,即 gerber 和 gerbers 。gerber 命令将多个 PCB 层绘制到一个 Gerber 文件中,而 gerbers 命令则将多个 Gerber 文件绘制出来,每个文件对应一个 PCB 层。通常情况下,gerbers 命令是用于 PCB 制造的正确命令。
|
Usage: kicad-cli pcb export gerbers [--help] [--output OUTPUT_DIR] [--layers 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] [--common-layers COMMON_LAYER_LIST] [--board-plot-params] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 Gerber 导出命令的帮助信息。 |
|
导出文件的输出文件夹。当未使用 |
|
从电路板中绘制的图层名称的逗号分隔列表,例如 |
|
用于绘制的图纸路径,覆盖板文件中指定的图纸。 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
从绘制中排除封装位号。 |
|
从绘制中排除封装值。 |
|
包含图纸边框和标题栏。 |
|
在正面和背面 Fab 层上绘制焊盘轮廓及其编号。 |
|
不要在 Fab 层上绘制 DNP 封装的文本和图形。 |
|
在 Fab 层上以草图模式绘制 DNP 封装的图形。 |
|
在 Fab 层上的 DNP 封装的外框上画一个 "X",并划掉其位号。 |
|
请勿使用扩展的 X2 格式。 |
|
请勿包含网表属性。 |
|
从没有阻焊层的区域去除丝印。 |
|
禁用光圈宏。 |
|
使用钻孔/放置文件原点而非绝对原点。 |
|
Gerber 文件的精度(位数)。有效选项为 |
|
使用 |
|
强制绘制值和位号,即使它们不可见。此参数自 KiCad 9.0.1起已废弃且无效。它将在未来版本的 KiCad 中被移除。要绘制不可见文本,请编辑电路板以使文本不再不可见。 |
|
在所有图层上绘制的图层名称的逗号分隔列表,例如 |
|
使用电路板文件中已配置的 Gerber 绘制设置。 |
PCB Gerber 文件导出:每个文件包含多个层
pcb export gerber
命令将一个或多个电路板层导出到单个 Gerber 文件中。
请注意,Gerber 导出命令有两个不同的版本,即 gerber 和 gerbers 。gerber 命令将多个 PCB 层绘制到一个 Gerber 文件中,而 gerbers 命令则将多个 Gerber 文件绘制出来,每个文件对应一个 PCB 层。通常情况下,gerbers 命令是用于 PCB 制造的正确命令。
|
pcb export gerber 命令在 KiCad 9.0 中已废弃,并在 KiCad 10.0 中将被移除。请改用 pcb export gerbers 命令。
|
Usage: kicad-cli pcb export gerber [--help] [--output OUTPUT_FILE] [--layers 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] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 Gerber 导出命令的帮助信息。 |
|
输出文件名。当未使用 |
|
从电路板绘制的图层名称的逗号分隔列表,例如 |
|
用于绘制的图纸路径,覆盖板文件中指定的图纸。 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
从绘制中排除封装位号。 |
|
从绘制中排除封装值。 |
|
包含图纸边框和标题栏。 |
|
在正面和背面 Fab 层上绘制焊盘轮廓及其编号。 |
|
不要在 Fab 层上绘制 DNP 封装的文本和图形。 |
|
在 Fab 层上以草图模式绘制 DNP 封装的图形。 |
|
在 Fab 层上的 DNP 封装的外框上画一个 "X",并划掉其位号。 |
|
请勿使用扩展的 X2 格式。 |
|
请勿包含网表属性。 |
|
从没有阻焊层的区域去除丝印。 |
|
禁用光圈宏。 |
|
使用钻孔/放置文件原点而非绝对原点。 |
|
Gerber 文件的精度(位数)。有效选项为 |
|
使用 |
|
强制绘制值和位号,即使它们不可见。此参数自 KiCad 9.0.1起已废弃且无效。它将在未来版本的 KiCad 中被移除。要绘制不可见文本,请编辑电路板以使文本不再不可见。 |
PCB GLB 导出
pcb export glb
命令将电路板设计导出为 GLB(二进制 glTF)3D 模型文件。
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] [--min-distance MIN_DIST] [--net-filter VAR] [--user-origin VAR] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 GLB 导出命令的帮助信息。 |
|
输出文件名。当未使用 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
覆盖输出文件。 |
|
排除具有 “未指定” 封装类型的元件的 3D 模型。 |
|
排除具有 “DNP” 属性的元件的 3D 模型。 |
|
将网格原点作为输出文件的原点。 |
|
将钻孔原点作为输出文件的原点。 |
|
如果存在同名的 STEP 或 IGS 模型,则用它们替换封装中的 VRML 模型。 |
|
仅将电路板本身包含在生成的模型中;排除所有元件模型。 |
|
即使导电层未导出,仍需在电路板本体上开孔。 |
|
排除电路板主体。 |
|
排除元件的 3D 模型。 |
|
仅包含与以下位号列表匹配的元件 3D 模型(以逗号分隔,支持通配符) |
|
在导出时包含外层导电层上的布线和过孔(耗时)。 |
|
在导出时包含焊盘(耗时)。 |
|
在导出时包含敷铜(耗时)。 |
|
在导出时包含内导体层中的元素。 |
|
在导出时将丝印图形作为一组平面图形包含在内。 |
|
在导出时将阻焊层作为一组平面。 |
|
在导出时将重叠的几何体合并在一起(耗时)。 |
|
请勿通过导电层上的过孔进行切割。 |
|
将两个点视为位于同一位置的误差。默认值: |
|
仅包含与该通配符匹配的网络中的铜对象。 |
|
指定输出文件的自定义原点,包括 X 和 Y 坐标。例如, |
PCB IPC-2581 导出
pcb export ipc2581
命令将电路板设计导出为 IPC-2581 格式。
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
|
导出电路板文件。 |
可选参数:
|
显示 IPC-2581 导出命令的帮助信息。 |
|
输出文件名。当未使用 |
|
用于绘制的图纸路径,覆盖板文件中指定的图纸。 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
导出文件的精度(小数点后位数)。默认值为 |
|
将输出文件压缩为 ZIP 文件。 |
|
使用 IPC-2581 标准版本。可选项为 |
|
用于导出的单位。可选单位为 |
|
用于 BOM 内部 ID 列的元件字段名称。可以是任何封装字段,或留空以省略该列。 |
|
用于 BOM 制造商元件编号列的元件字段名称。可以是任何封装字段,或留空以省略该列。 |
|
用于 BOM 制造商列的元件字段名称。可以是任何封装字段,或留空以省略该列。 |
|
用于 BOM 分销商元件编号列的元件字段名称。可以是任何封装字段,或留空以省略该列。 |
|
用于 BOM 分销商列的元件字段名称。可以是任何封装字段,或留空以省略该列。 |
PCB IPC-D-356 导出
pcb export ipcd356
命令从电路板设计中生成 IPC-D-356 网表。
Usage: kicad-cli pcb export ipcd356 [--help] [--output OUTPUT_FILE] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 IPC-D-356 导出命令的帮助信息。 |
|
输出文件名。当未使用 |
PCB ODB++ 导出
pcb export odb
命令将电路板设计导出为 ODB++ 格式。
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
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 ODB++ 导出命令的帮助信息。 |
|
输出文件名,或在不使用压缩时为文件夹名。 |
|
用于绘制的图纸路径,覆盖板文件中指定的图纸。 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
导出文件的精度(小数点后位数)。默认值为 |
|
压缩模式。可选项为 |
|
输出文件中使用的单位。可选单位为 |
PCB PDF 导出
pcb export pdf
命令将电路板设计导出为 PDF 文件。每个层可以单独导出为独立的文件,也可以作为单个文件中的一个页面进行导出。
Usage: kicad-cli pcb export pdf [--help] [--output OUTPUT_DIR] [--layers 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] [--common-layers COMMON_LAYER_LIST] [--plot-invisible-text] [--mode-single] [--mode-separate] [--mode-multipage] [--scale SCALE] [--bg-color COLOR] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 PDF 导出命令的帮助信息。 |
|
The output folder or filename for the exported files. When |
|
从电路板中导出的图层名称列表,以逗号分隔,例如 |
|
用于绘制的图纸路径,覆盖板文件中指定的图纸。 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
镜像电路板。这对于显示底层电路非常有用。 |
|
从绘制中排除封装位号。 |
|
从绘制中排除封装值。 |
|
包含图纸边框和标题栏。 |
|
从没有阻焊层的区域去除丝印。 |
|
在正面和背面 Fab 层上绘制焊盘轮廓及其编号。 |
|
不要在 Fab 层上绘制 DNP 封装的文本和图形。 |
|
在 Fab 层上以草图模式绘制 DNP 封装的图形。 |
|
在 Fab 层上的 DNP 封装的外框上画一个 "X",并划掉其位号。 |
|
在负片上绘制。 |
|
黑白绘制。 |
|
用于导出的主题名称。如果未指定主题,则使用板编辑器当前选定的主题。 |
|
钻孔标记在图中的形状。选项包括: |
|
在所有图层上绘制的图层名称的逗号分隔列表,例如 |
|
强制绘制值和位号,即使它们不可见。此参数自 KiCad 9.0.1起已废弃且无效。它将在未来版本的 KiCad 中被移除。要绘制不可见文本,请编辑电路板以使文本不再不可见。 |
|
生成一个单一文件,输出参数路径作为完整的目录和文件名路径。在此模式下, |
|
将图层绘制为一个或多个 PDF 文件,每个文件代表 |
|
将图层绘制到一个包含多页的 PDF 文件中,每页代表 |
|
用于绘制 PCB 的缩放比例。边框和标题栏不进行缩放。缩放比例为 0 时,绘图将自动调整比例。 |
|
为图表设置背景颜色。格式可以是十六进制( |
PCB PLY 文件导出
pcb export ply
命令将电路板设计导出为 PLY 3D 模型文件。
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] [--min-distance MIN_DIST] [--net-filter VAR] [--user-origin VAR] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 PLY 导出命令的帮助信息。 |
|
输出文件名。当未使用 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
覆盖输出文件。 |
|
排除具有 “未指定” 封装类型的元件的 3D 模型。 |
|
排除具有 “DNP” 属性的元件的 3D 模型。 |
|
将网格原点作为输出文件的原点。 |
|
将钻孔原点作为输出文件的原点。 |
|
如果存在同名的 STEP 或 IGS 模型,则用它们替换封装中的 VRML 模型。 |
|
仅将电路板本身包含在生成的模型中;排除所有元件模型。 |
|
即使导电层未导出,仍需在电路板本体上开孔。 |
|
排除电路板主体。 |
|
排除元件的 3D 模型。 |
|
仅包含与以下位号列表匹配的元件 3D 模型(以逗号分隔,支持通配符) |
|
在导出时包含外层导电层上的布线和过孔(耗时)。 |
|
在导出时包含焊盘(耗时)。 |
|
在导出时包含敷铜(耗时)。 |
|
在导出时包含内导体层中的元素。 |
|
在导出时将丝印图形作为一组平面图形包含在内。 |
|
在导出时将阻焊层作为一组平面。 |
|
在导出时将重叠的几何体合并在一起(耗时)。 |
|
请勿通过导电层上的过孔进行切割。 |
|
将两个点视为位于同一位置的误差。默认值: |
|
仅包含与该通配符匹配的网络中的铜对象。 |
|
指定输出文件的自定义原点,包括 X 和 Y 坐标。例如, |
PCB 位置文件导出
pcb export pos
命令从电路板设计中导出位置文件。
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] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示位置文件导出命令的帮助信息。 |
|
输出文件名。当未使用 |
|
要导出的电路板侧面。可选项为 |
|
位置文件格式。可选格式包括 |
|
位置文件的单位。可选值为 |
|
在底层的封装中使用负 X 坐标。此选项对 Gerber 格式无效。 |
|
使用钻孔/放置文件原点而非绝对原点。此选项对 Gerber 格式无效。 |
|
仅包含表面贴装元件。此选项对 Gerber 格式无效。 |
|
排除所有带有通孔焊盘的焊盘。此选项对 Gerber 格式无效。 |
|
排除所有具有 “DNP” 属性的封装。 |
|
在导出时包含电路板边缘层(仅限 Gerber 格式)。 |
PCB PostScript 导出
pcb export ps
命令将电路板设计导出为 PostScript 文件。
Usage: 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] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 PS 导出命令的帮助信息。 |
|
导出文件的输出文件夹或文件名。当使用 |
|
从电路板中导出的图层名称列表,以逗号分隔,例如 |
|
在所有图层上绘制的图层名称的逗号分隔列表,例如 |
|
用于绘制的图纸路径,覆盖板文件中指定的图纸。 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
镜像电路板。这对于显示底层电路非常有用。 |
|
从绘制中排除封装位号。 |
|
从绘制中排除封装值。 |
|
包含图纸边框和标题栏。 |
|
从没有阻焊层的区域去除丝印。 |
|
在正面和背面 Fab 层上绘制焊盘轮廓及其编号。 |
|
不要在 Fab 层上绘制 DNP 封装的文本和图形。 |
|
在 Fab 层上以草图模式绘制 DNP 封装的图形。 |
|
在 Fab 层上的 DNP 封装的外框上画一个 "X",并划掉其位号。 |
|
在负片上绘制。 |
|
黑白绘制。 |
|
用于导出的主题名称。如果未指定主题,则使用板编辑器当前选定的主题。 |
|
钻孔标记在图中的形状。选项包括: |
|
生成一个单一文件,其中输出参数路径作为完整的目录和文件名路径。 |
|
将图层绘制为一个或多个 PDF 文件,每个文件代表 |
|
全局校正,以毫米为单位,在绘制时添加到走线、过孔和焊盘的尺寸上。此校正可用于修正 PostScript 输出设备的误差,以实现精确比例的输出。 |
|
X 轴比例调整以实现精确比例。 |
|
Y 轴比例调整以实现精确比例。 |
|
强制使用 A4 纸张尺寸。 |
|
用于绘制 PCB 的缩放比例因子。边框和标题栏不进行缩放。缩放因子为 0 时,自动调整绘图比例。 |
PCB STEP 导出
pcb export step
命令将电路板设计导出为 STEP 文件。
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] [--min-distance MIN_DIST] [--net-filter VAR] [--no-optimize-step] [--user-origin VAR] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
|
|
输出文件名。当未使用 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
覆盖输出文件。 |
|
排除具有 “未指定” 封装类型的元件的 3D 模型。 |
|
排除具有 “DNP” 属性的元件的 3D 模型。 |
|
将网格原点作为输出文件的原点。 |
|
将钻孔原点作为输出文件的原点。 |
|
如果存在同名的 STEP 或 IGS 模型,则用它们替换封装中的 VRML 模型。 |
|
仅将电路板本身包含在生成的模型中;排除所有元件模型。 |
|
即使导电层未导出,仍需在电路板本体上开孔。 |
|
排除电路板主体。 |
|
排除元件的 3D 模型。 |
|
仅包含与以下位号列表匹配的元件 3D 模型(以逗号分隔,支持通配符) |
|
在导出时包含外层导电层上的布线和过孔(耗时)。 |
|
在导出时包含焊盘(耗时)。 |
|
在导出时包含敷铜(耗时)。 |
|
在导出时包含内导体层中的元素。 |
|
在导出时将丝印图形作为一组平面图形包含在内。 |
|
在导出时将阻焊层作为一组平面。 |
|
在导出时将重叠的几何体合并在一起(耗时)。 |
|
请勿通过导电层上的过孔进行切割。 |
|
将两个点视为位于同一位置的误差。默认值: |
|
仅包含与该通配符匹配的网络中的铜对象。 |
|
请勿优化 STEP 文件。此操作可实现参数化曲线的写入,从而减少文件大小并缩短写入/读取时间,但可能降低与其他软件的兼容性。 |
|
指定输出文件的自定义原点,包括 X 和 Y 坐标。例如, |
PCB STL 导出
pcb export stl
命令将电路板设计导出为 STL 3D 模型文件。
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] [--min-distance MIN_DIST] [--net-filter VAR] [--user-origin VAR] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 STL 导出命令的帮助信息。 |
|
输出文件名。当未使用 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
覆盖输出文件。 |
|
排除具有 “未指定” 封装类型的元件的 3D 模型。 |
|
排除具有 “DNP” 属性的元件的 3D 模型。 |
|
将网格原点作为输出文件的原点。 |
|
将钻孔原点作为输出文件的原点。 |
|
如果存在同名的 STEP 或 IGS 模型,则用它们替换封装中的 VRML 模型。 |
|
仅将电路板本身包含在生成的模型中;排除所有元件模型。 |
|
即使导电层未导出,仍需在电路板本体上开孔。 |
|
排除电路板主体。 |
|
排除元件的 3D 模型。 |
|
仅包含与以下位号列表匹配的元件 3D 模型(以逗号分隔,支持通配符) |
|
在导出时包含外层导电层上的布线和过孔(耗时)。 |
|
在导出时包含焊盘(耗时)。 |
|
在导出时包含敷铜(耗时)。 |
|
在导出时包含内导体层中的元素。 |
|
在导出时将丝印图形作为一组平面图形包含在内。 |
|
在导出时将阻焊层作为一组平面。 |
|
在导出时将重叠的几何体合并在一起(耗时)。 |
|
请勿通过导电层上的过孔进行切割。 |
|
将两个点视为位于同一位置的误差。默认值: |
|
仅包含与该通配符匹配的网络中的铜对象。 |
|
指定输出文件的自定义原点,包括 X 和 Y 坐标。例如, |
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] [--min-distance MIN_DIST] [--net-filter VAR] [--no-optimize-step] [--user-origin VAR] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
Show help for the STEPZ file export command. |
|
The output filename. When |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
覆盖输出文件。 |
|
排除具有 “未指定” 封装类型的元件的 3D 模型。 |
|
排除具有 “DNP” 属性的元件的 3D 模型。 |
|
将网格原点作为输出文件的原点。 |
|
将钻孔原点作为输出文件的原点。 |
|
如果存在同名的 STEP 或 IGS 模型,则用它们替换封装中的 VRML 模型。 |
|
仅将电路板本身包含在生成的模型中;排除所有元件模型。 |
|
即使导电层未导出,仍需在电路板本体上开孔。 |
|
排除电路板主体。 |
|
排除元件的 3D 模型。 |
|
仅包含与以下位号列表匹配的元件 3D 模型(以逗号分隔,支持通配符) |
|
在导出时包含外层导电层上的布线和过孔(耗时)。 |
|
在导出时包含焊盘(耗时)。 |
|
在导出时包含敷铜(耗时)。 |
|
在导出时包含内导体层中的元素。 |
|
在导出时将丝印图形作为一组平面图形包含在内。 |
|
在导出时将阻焊层作为一组平面。 |
|
在导出时将重叠的几何体合并在一起(耗时)。 |
|
请勿通过导电层上的过孔进行切割。 |
|
将两个点视为位于同一位置的误差。默认值: |
|
仅包含与该通配符匹配的网络中的铜对象。 |
|
请勿优化 STEP 文件。此操作可实现参数化曲线的写入,从而减少文件大小并缩短写入/读取时间,但可能降低与其他软件的兼容性。 |
|
指定输出文件的自定义原点,包括 X 和 Y 坐标。例如, |
PCB SVG 导出
pcb export svg
命令将电路板设计导出为 SVG 文件。
Usage: kicad-cli pcb export svg [--help] [--output OUTPUT_DIR] [--layers 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] [--common-layers COMMON_LAYER_LIST] [--mode-single] [--mode-multi] [--plot-invisible-text] [--scale SCALE] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 SVG 文件导出命令的帮助信息。 |
|
导出文件的输出文件夹或文件名。当使用 |
|
从电路板导出的图层名称列表,以逗号分隔,例如 |
|
用于绘制的图纸路径,覆盖板文件中指定的图纸。 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
从没有阻焊层的区域去除丝印。 |
|
镜像电路板。这对于显示底层电路非常有用。 |
|
用于导出的主题名称。如果未指定主题,则使用板编辑器当前选定的主题。 |
|
在负片上绘制。 |
|
黑白绘制。 |
|
在正面和背面 Fab 层上绘制焊盘轮廓及其编号。 |
|
不要在 Fab 层上绘制 DNP 封装的文本和图形。 |
|
在 Fab 层上以草图模式绘制 DNP 封装的图形。 |
|
在 Fab 层上的 DNP 封装的外框上画一个 "X",并划掉其位号。 |
|
设置页面尺寸模式。选项为 |
|
将 SVG 大小设置为与电路板外框匹配。这相当于 |
|
在没有图框的情况下绘制 SVG。 |
|
钻孔标记在图中的形状。选项包括: |
|
在所有图层上绘制的图层名称的逗号分隔列表,例如 |
|
生成一个单一文件,其中输出参数路径作为完整的目录和文件名路径。 |
|
将图层绘制到一个或多个 SVG 文件中,每个文件代表 |
|
强制绘制值和位号,即使它们不可见。此参数自 KiCad 9.0.1起已废弃且无效。它将在未来版本的 KiCad 中被移除。要绘制不可见文本,请编辑电路板以使文本不再不可见。 |
|
用于绘制 PCB 的缩放比例。边框和标题栏不进行缩放。缩放比例为 0 时,绘图将自动调整比例。 |
PCB VRML 导出
pcb export vrml
命令将电路板设计导出为 VRML 3D 文件。
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
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 VRML 导出命令的帮助信息。 |
|
输出文件名。当未使用 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
覆盖输出文件。 |
|
排除具有 “未指定” 封装类型的元件的 3D 模型。 |
|
排除具有 “DNP” 属性的元件的 3D 模型。 |
|
指定输出文件的自定义原点,包括 X 和 Y 坐标。例如, |
|
输出文件中使用的单位。可选单位包括 |
|
输出目录的名称,用于复制组件模型。如果未指定,组件模型将嵌入到输出文件中。 |
|
使用 |
PCB XAO 导出
pcb export xao
命令将电路板设计导出为 XAO(SALOME/Gmsh)3D 模型文件。
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] [--min-distance MIN_DIST] [--net-filter VAR] [--user-origin VAR] INPUT_FILE
位置参数:
|
导出电路板文件。 |
可选参数:
|
显示 XAO 导出命令的帮助信息。 |
|
输出文件名。当未使用 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
覆盖输出文件。 |
|
排除具有 “未指定” 封装类型的元件的 3D 模型。 |
|
排除具有 “DNP” 属性的元件的 3D 模型。 |
|
将网格原点作为输出文件的原点。 |
|
将钻孔原点作为输出文件的原点。 |
|
如果存在同名的 STEP 或 IGS 模型,则用它们替换封装中的 VRML 模型。 |
|
仅将电路板本身包含在生成的模型中;排除所有元件模型。 |
|
即使导电层未导出,仍需在电路板本体上开孔。 |
|
排除电路板主体。 |
|
排除元件的 3D 模型。 |
|
仅包含与以下位号列表匹配的元件 3D 模型(以逗号分隔,支持通配符) |
|
在导出时包含外层导电层上的布线和过孔(耗时)。 |
|
在导出时包含焊盘(耗时)。 |
|
在导出时包含敷铜(耗时)。 |
|
在导出时包含内导体层中的元素。 |
|
在导出时将丝印图形作为一组平面图形包含在内。 |
|
在导出时将阻焊层作为一组平面。 |
|
在导出时将重叠的几何体合并在一起(耗时)。 |
|
请勿通过导电层上的过孔进行切割。 |
|
将两个点视为位于同一位置的误差。默认值: |
|
仅包含与该通配符匹配的网络中的铜对象。 |
|
指定输出文件的自定义原点,包括 X 和 Y 坐标。例如, |
PCB 渲染
pcb render
命令会生成电路板 3D 模型的光线追踪渲染图,并将其保存为 PNG 或 JPEG 文件。
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] [--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
位置参数:
|
渲染电路板文件。 |
可选参数:
|
显示渲染命令的帮助信息。 |
|
输出文件名。此参数必须指定。此参数中指定的文件扩展名决定了输出图像文件的格式。文件名必须以 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
图像宽度(以像素为单位)。默认值: |
|
图像高度(以像素为单位)。默认值: |
|
要渲染的板面。可选项包括 |
|
图像背景。可选项为 |
|
渲染质量。可选项包括 |
|
颜色预设。可选项包括 |
|
启用地面、阴影和后期处理效果,即使在质量预设中已禁用。 |
|
使用透视投影而非正交投影。 |
|
相机变焦倍数,以整数形式表示。默认值: |
|
设置摄像头平移位置,单位为毫米,格式为 |
|
将枢轴点相对于板中心的位置以厘米为单位设置,格式为’X,Y,Z'`,例如’-10,2,0'`。 |
|
设置板面绕枢轴点的旋转角度,单位为度,格式为 |
|
顶部光强度,格式为 |
|
底部光强度,格式为 |
|
侧灯亮度,格式为 |
|
相机光线强度,格式为 |
|
侧灯仰角(单位:度),范围:0-90。 |
原理图命令
sch
命令可运行电气规则检查、将原理图导出为各种其他文件格式,或导出 BOM 或网表。每个子命令都有自己的选项。
原理图 ERC
sch erc
命令对原理图进行电气规则检查并生成报告。
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
位置参数:
|
运行 ERC 的原理图文件。 |
可选参数:
|
显示 ERC 命令的帮助信息。 |
|
生成的 ERC 报告的输出文件名。当未使用 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
报告文件格式。可选格式为 |
|
报告中使用的单位。可选单位包括 |
|
报告所有 ERC 违规行为。这相当于使用所有其他 ERC 严重性选项。 |
|
报告所有错误级别的 ERC 违规行为。这可以与其他 ERC 严重性选项结合使用。 |
|
报告所有警告级别的 ERC 违规行为。这可以与其他 ERC 严重性选项结合使用。 |
|
报告所有被排除的 ERC 违规行为。这可以与其他 ERC 严重性选项结合使用。 |
|
根据是否存在 ERC 违规情况返回退出代码。如果未发现违规,退出代码为 0;如果发现任何违规,退出代码为 5。 |
原理图 BOM 导出
sch export bom
命令从原理图导出 BOM。BOM 导出有多个选项可用于控制格式和包含的字段。此导出方法相当于从符号字段表导出 BOM (导出 BOM)。
要使用旧版 XML 和 Python BOM 脚本工作流导出 BOM,请使用 sch export python-bom 命令。
|
Usage: kicad-cli sch export bom [--help] [--output OUTPUT_FILE] [--preset PRESET] [--format-preset FMT_PRESET] [--fields FIELDS] [--labels LABELS] [--group-by GROUP_BY] [--sort-field SORT_BY] [--sort-asc] [--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
位置参数:
|
导出原理图文件。 |
可选参数:
|
显示帮助信息并退出 |
|
输出文件名。当未使用 |
|
使用原理图中的命名 BOM 预设设置,例如 |
|
使用原理图中的命名 BOM 格式预设设置,例如 |
|
要导出的字段的有序列表。 |
|
应用导出字段的标签有序列表(默认值: |
|
当字段值匹配时,用于按字段分组引用。 |
|
按字段名称排序(默认: |
|
如果指定了排序方式,则按升序排序。如果未指定排序方式,则按降序排序。 |
|
过滤字符串以移除输出行。 |
|
排除具有 "DNP" 性的符号。 |
|
Include symbols marked "Exclude from BOM". This argument is deprecated as of KiCad 10.0 and has no effect. |
|
输出字段/列之间的分隔符(默认: |
|
用于包围字段的字符(默认为空)。 |
|
用于分隔各个位号之间的字符(默认: |
|
用于指定位号范围的字符(默认值: |
|
保留输入字段中的制表符。默认情况下会被移除。 |
|
保留输入字段中的换行符。默认情况下会被移除。 |
原理图 DXF 导出
命令 sch export dxf
将原理图导出到 DXF 文件。设计中的每张图纸都会导出到各自的文件中。
Usage: kicad-cli sch export dxf [--help] [--output OUTPUT_DIR] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE] [--theme THEME_NAME] [--black-and-white] [--exclude-drawing-sheet] [--default-font VAR] [--pages PAGE_LIST] INPUT_FILE
位置参数:
|
导出原理图文件。 |
可选参数:
|
显示 DXF 文件导出命令的帮助信息。 |
|
导出文件的输出文件夹。当未使用 |
|
用于绘图的图框路径,覆盖原理图文件中指定的图框。 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
用于导出的主题名称。如果未指定主题,则使用原理图编辑器当前选择的主题。 |
|
以黑白形式导出原理图。 |
|
在没有图框的情况下绘制 DXF。 |
|
默认字体名称。默认值: |
|
以逗号分隔的要导出的页面列表。空白或未指定表示所有页面。要绘制特定页面,请将根页面作为 |
原理图网表导出
命令 sch export netlist
将原理图中的网表以 各种格式 导出。
Usage: kicad-cli sch export netlist [--help] [--output OUTPUT_FILE] [--format FORMAT] INPUT_FILE
位置参数:
|
导出原理图文件。 |
可选参数:
|
显示网表导出命令的帮助信息。 |
|
输出文件名。当未使用 |
|
网表输出格式。可选格式包括 |
原理图 PDF 导出
sch export pdf
命令将原理图导出到 PDF 文件。设计中的每个图纸都会导出到 PDF 文件中的单独页面。
Usage: kicad-cli sch export pdf [--help] [--output OUTPUT_FILE] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE] [--theme THEME_NAME] [--black-and-white] [--exclude-drawing-sheet] [--default-font VAR] [--exclude-pdf-property-popups] [--exclude-pdf-hierarchical-links] [--exclude-pdf-metadata] [--no-background-color] [--pages PAGE_LIST] INPUT_FILE
位置参数:
|
导出原理图文件。 |
可选参数:
|
显示 PDF 文件导出命令的帮助信息。 |
|
输出文件名。当未使用 |
|
用于绘图的图框路径,覆盖原理图文件中指定的图框。 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
用于导出的主题名称。如果未指定主题,则使用原理图编辑器当前选择的主题。 |
|
以黑白形式导出原理图。 |
|
绘制无图框的 PDF。 |
|
默认字体名称。默认值: |
|
请勿在 PDF 中生成属性弹出窗口。 |
|
请勿为 PDF 中的层次结构元素生成可点击链接。 |
|
请勿从 “作者” 和 “主题” 变量生成 PDF 元数据。 |
|
无论主题如何,均以无背景色的形式导出原理图。 |
|
以逗号分隔的要导出的页面列表。空白或未指定表示所有页面。要绘制特定页面,请将根页面作为 |
原理图 PostScript 导出
命令 sch export ps
将原理图导出到 PostScript 文件。设计中的每个图纸都会导出到各自的文件中。
Usage: kicad-cli sch export ps [--help] [--output OUTPUT_DIR] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE] [--theme THEME_NAME] [--black-and-white] [--exclude-drawing-sheet] [--default-font VAR] [--no-background-color] [--pages PAGE_LIST] INPUT_FILE
位置参数:
|
导出原理图文件。 |
可选参数:
|
显示 PS 文件导出命令的帮助信息。 |
|
导出文件的输出文件夹。当未使用 |
|
用于绘图的图框路径,覆盖原理图文件中指定的图框。 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
用于导出的主题名称。如果未指定主题,则使用原理图编辑器当前选择的主题。 |
|
以黑白形式导出原理图。 |
|
在没有图框的情况下绘制 PS。 |
|
默认字体名称。默认值: |
|
无论主题如何,均以无背景色的形式导出原理图。 |
|
以逗号分隔的要导出的页面列表。空白或未指定表示所有页面。要绘制特定页面,请将根页面作为 |
原理图 BOM 导出(旧版 BOM 脚本)
命令 sch export python-bom
可从原理图导出 XML BOM 文件。然后,可使用自定义脚本或 原理图 BOM 导出文档 中描述的脚本之一,将 XML BOM 文件处理成所需的 BOM 格式。
Usage: kicad-cli sch export python-bom [--help] [--output OUTPUT_FILE] INPUT_FILE
位置参数:
|
导出原理图文件。 |
可选参数:
|
显示 BOM 导出命令的帮助信息。 |
|
输出文件名。当未使用 |
原理图 SVG 导出
命令 sch export svg
将原理图导出到 SVG 文件。设计中的每个图纸都会导出到各自的文件中。
Usage: kicad-cli sch export svg [--help] [--output OUTPUT_DIR] [--drawing-sheet SHEET_PATH] [--define-var KEY=VALUE] [--theme THEME_NAME] [--black-and-white] [--exclude-drawing-sheet] [--default-font VAR] [--no-background-color] [--pages PAGE_LIST] INPUT_FILE
位置参数:
|
导出原理图文件。 |
可选参数:
|
显示 SVG 文件导出命令的帮助信息。 |
|
导出文件的输出文件夹。当未使用 |
|
用于绘图的图框路径,覆盖原理图文件中指定的图框。 |
|
添加或覆盖项目变量定义。可多次使用以定义多个变量。 |
|
用于导出的主题名称。如果未指定主题,则使用原理图编辑器当前选择的主题。 |
|
以黑白形式导出原理图。 |
|
在没有图框的情况下绘制 SVG。 |
|
默认字体名称。默认值: |
|
无论主题如何,均以无背景色的形式导出原理图。 |
|
以逗号分隔的要导出的页面列表。空白或未指定表示所有页面。要绘制特定页面,请将根页面作为 |
符号命令
sym
子命令用于将符号导出到另一种格式,或将符号库升级到 KiCad 符号文件格式的当前版本。
符合导出
sym export svg
命令将指定库中的一个或多个符号导出为 SVG 文件。
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
位置参数:
|
用于导出的符号库文件。 |
可选参数:
|
显示 SVG 导出命令的帮助信息。 |
|
导出文件的输出文件夹。当未使用 |
|
用于导出的主题名称。如果未指定主题,则使用符号编辑器当前选定的主题。 |
|
从库中导出的具体符号。当未使用此参数时,库中的所有符号均会被导出。 |
|
以黑白形式导出符号。 |
|
在导出的 SVG 中导出隐藏引脚。 |
|
在导出的 SVG 文件中导出隐藏的符号字段。 |
符号升级
sym upgrade
命令将指定的符号库从旧版 KiCad 符号格式或非 KiCad 符号格式转换为当前版本 KiCad 的原生格式。如果输入库已采用当前文件格式,则不执行任何操作。
支持的输入符号格式包括:
-
KiCad 符号库(
.kicad_sym
) -
KiCad(6.0之前版本)符号库(
.lib
) -
Altium 原理图库(
.SchLib
) -
Altium 集成库 (
.IntLib
) -
CADSTAR 元件库(
.lib
) -
EAGLE XML 库 (
.lbr
) -
EasyEDA (JLCEDA) 标准版文件 (
.json
) -
EasyEDA (JLCEDA) 专业版文件 (
.elibz
,.epro
,.zip
)
Usage: kicad-cli sym upgrade [--help] [--output OUTPUT_FILE] [--force] INPUT_FILE
位置参数:
|
符号库升级。 |
可选参数:
|
显示符号升级命令的帮助信息。 |
|
升级后符号库的输出文件名。当未使用 |
|
即使输入库已采用当前文件格式,仍需重新保存该库。 |
版本命令
version
命令用于显示 KiCad 的版本信息。若不带任何参数,它将直接显示版本号,例如 7.0.7
。您还可以通过使用 --format
参数以其他格式显示版本信息。
使用 kicad-cli version --format about 命令获取版本信息,并在提交 GitLab 上的 bug 报告或功能请求时包含此信息。
|
Usage: kicad-cli version [--help] [--format VAR]
可选参数:
|
版本号的格式。可选项包括 |