kicad-cli

KiCad CLI リファレンス

kicad-cli の完全なコマンドリファレンス（KiCad 8.x）

---

1. コマンド構造

kicad-cli <application> <command> [options] <input-file>

アプリケーション：

• sch - 回路図の操作
• pcb - PCB の操作
• fp - フットプリントの操作
• sym - シンボルの操作

---

2. 回路図コマンド

ネットリストのエクスポート

kicad-cli sch export netlist \
  --output project.net \
  project.kicad_sch

BOM のエクスポート

# Basic BOM
kicad-cli sch export bom \
  --output bom.csv \
  project.kicad_sch

# With specific fields
kicad-cli sch export bom \
  --output bom.csv \
  --fields "Reference,Value,Footprint,LCSC,MPN" \
  --group-by "Value,Footprint" \
  --sort-asc \
  project.kicad_sch

PDF のエクスポート

kicad-cli sch export pdf \
  --output schematic.pdf \
  --black-and-white \
  project.kicad_sch

SVG のエクスポート

kicad-cli sch export svg \
  --output ./svg/ \
  --black-and-white \
  project.kicad_sch

ERC（電気ルールチェック）の実行

kicad-cli sch erc \
  --output erc-report.rpt \
  --severity-all \
  --exit-code-violations \
  project.kicad_sch

オプション：

• --severity-all - すべての重大度を報告
• --severity-error - エラーのみ
• --exit-code-violations - 違反がある場合にゼロ以外を返す

---

3. PCB コマンド

DRC（デザインルールチェック）の実行

kicad-cli pcb drc \
  --output drc-report.rpt \
  --severity-all \
  --exit-code-violations \
  project.kicad_pcb

ガーバーデータのエクスポート

kicad-cli pcb export gerbers \
  --output ./gerbers/ \
  --layers "F.Cu,B.Cu,F.SilkS,B.SilkS,F.Mask,B.Mask,Edge.Cuts" \
  --subtract-soldermask \
  project.kicad_pcb

一般的なレイヤー：

• F.Cu、B.Cu - 銅箔レイヤー
• In1.Cu、In2.Cu - 内層銅箔レイヤー
• F.SilkS、B.SilkS - シルクスクリーン
• F.Mask、B.Mask - ソルダーマスク
• F.Paste、B.Paste - はんだペースト
• Edge.Cuts - 基板外形
• F.Fab、B.Fab - 製造レイヤー

ドリルファイルのエクスポート

kicad-cli pcb export drill \
  --output ./gerbers/ \
  --format excellon \
  --excellon-units mm \
  --generate-map \
  --map-format pdf \
  project.kicad_pcb

オプション：

• --format excellon - 標準ドリル形式
• --excellon-units mm または in
• --excellon-zeros-format decimal
• --generate-map - ドリルマップを作成
• --map-format gerberx2|ps|pdf|svg|dxf

配置／ピックアンドプレースデータのエクスポート

kicad-cli pcb export pos \
  --output positions.csv \
  --format csv \
  --units mm \
  --side front \
  --exclude-dnp \
  project.kicad_pcb

オプション：

• --format csv|ascii
• --units mm|in
• --side front|back|both
• --exclude-dnp - 実装しない部品を除外

3D モデルのエクスポート

# STEP format (for mechanical CAD)
kicad-cli pcb export step \
  --output project.step \
  --subst-models \
  project.kicad_pcb

# VRML format
kicad-cli pcb export vrml \
  --output project.wrl \
  project.kicad_pcb

PDF のエクスポート

kicad-cli pcb export pdf \
  --output pcb.pdf \
  --layers "F.Cu,B.Cu,Edge.Cuts" \
  --black-and-white \
  project.kicad_pcb

SVG のエクスポート

kicad-cli pcb export svg \
  --output pcb.svg \
  --layers "F.Cu,Edge.Cuts" \
  --black-and-white \
  project.kicad_pcb

DXF のエクスポート

kicad-cli pcb export dxf \
  --output pcb.dxf \
  --layers "Edge.Cuts" \
  project.kicad_pcb

---

4. フットプリントコマンド

SVG のエクスポート

kicad-cli fp export svg \
  --output footprint.svg \
  footprint.kicad_mod

フットプリントライブラリのアップグレード

kicad-cli fp upgrade \
  --output ./upgraded/ \
  ./library.pretty/

---

5. シンボルコマンド

SVG のエクスポート

kicad-cli sym export svg \
  --output ./symbols/ \
  library.kicad_sym

シンボルライブラリのアップグレード

kicad-cli sym upgrade \
  --output upgraded.kicad_sym \
  legacy.lib

---

6. 共通オプション

オプション	説明
--help	コマンドのヘルプを表示
--output、-o	出力ファイル／ディレクトリ
--define-var	テキスト変数を定義
--force、-f	既存のファイルを上書き

---

7. 自動化の例

CI/CD ビルドスクリプト

#!/bin/bash
set -euo pipefail

PROJECT="myproject"

# Run ERC
echo "Running ERC..."
kicad-cli sch erc \
  --output reports/erc.rpt \
  --exit-code-violations \
  ${PROJECT}.kicad_sch

# Run DRC  
echo "Running DRC..."
kicad-cli pcb drc \
  --output reports/drc.rpt \
  --exit-code-violations \
  ${PROJECT}.kicad_pcb

# Generate manufacturing files
echo "Generating manufacturing files..."
mkdir -p output/gerbers

kicad-cli pcb export gerbers \
  --output output/gerbers/ \
  --layers "F.Cu,B.Cu,F.SilkS,B.SilkS,F.Mask,B.Mask,Edge.Cuts" \
  ${PROJECT}.kicad_pcb

kicad-cli pcb export drill \
  --output output/gerbers/ \
  --format excellon \
  ${PROJECT}.kicad_pcb

# Generate BOM
kicad-cli sch export bom \
  --output output/bom.csv \
  --fields "Reference,Value,Footprint,LCSC,MPN" \
  ${PROJECT}.kicad_sch

# Generate position file
kicad-cli pcb export pos \
  --output output/positions.csv \
  --format csv \
  --units mm \
  ${PROJECT}.kicad_pcb

echo "Done!"

JLCPCB 用の準備

#!/bin/bash
PROJECT="$1"
OUTPUT="./jlcpcb"
mkdir -p "$OUTPUT"

# Gerbers (zip for upload)
kicad-cli pcb export gerbers \
  --output "$OUTPUT/" \
  --layers "F.Cu,B.Cu,F.SilkS,B.SilkS,F.Mask,B.Mask,Edge.Cuts" \
  "${PROJECT}.kicad_pcb"

kicad-cli pcb export drill \
  --output "$OUTPUT/" \
  --format excellon \
  --excellon-units mm \
  "${PROJECT}.kicad_pcb"

cd "$OUTPUT" && zip -r gerbers.zip *.g* *.drl && cd -

# BOM for assembly
kicad-cli sch export bom \
  --output "$OUTPUT/bom.csv" \
  --fields "Comment,Designator,Footprint,LCSC" \
  "${PROJECT}.kicad_sch"

# CPL (Component Placement List)
kicad-cli pcb export pos \
  --output "$OUTPUT/cpl.csv" \
  --format csv \
  --units mm \
  --side front \
  "${PROJECT}.kicad_pcb"

---

8. 終了コード

コード	意味
0	成功
1	一般的なエラー
2	DRC/ERC 違反が見つかった（--exit-code-violations を指定した場合）

---

9. 重要な注意事項

kicad-cli でできること

• ファイルのエクスポート（ガーバー、PDF、SVG、ネットリスト、BOM、3D）
• 検証の実行（DRC、ERC）
• ライブラリ形式のアップグレード
• 自動化と CI/CD

kicad-cli でできないこと

• デザインの変更（コンポーネントや配線の追加）
• 回路図／PCB の内容の編集
• インタラクティブな操作

デザインを変更するには、次の方法を使用してください：

• ファイル操作（S 式形式）
• KiCad Python スクリプティングコンソール
• KiCad IPC API（実験的）

---

バージョン： このリファレンスは KiCad 8.x 用です。コマンドは旧バージョンでは異なる場合があります。