kicad-plugin-setup

Register a local jBOM KiCad plugin in Eeschema for iterative testing.

3|Updated Dec 14, 2025
One-click install
npx skills add https://github.com/plocher/jBOM --skill kicad-plugin-setup
Or copy as Structured Prompt for Agentโ–ผ
Please help me install this Agent Skill.
Skill: kicad-plugin-setup
Source: https://github.com/plocher/jBOM/tree/main/.agents/skills/kicad-plugin-setup
Command: npx skills add https://github.com/plocher/jBOM --skill kicad-plugin-setup

SYSTEM DOCUMENTATION & REQUIREMENTS

๐Ÿ’ก This Skill requires python3, jbom, openpyxl, numbers-parser.

What problem does it solve?

This Skill solves the friction of testing code changes in the jBOM KiCad plugin by allowing developers to register a local working copy directly in Eeschema, bypassing the slow Plugin and Content Manager publish-and-install cycle.

Core Features & Use Cases

  • Manual Plugin Registration: Provides the exact steps to link a local Python script to KiCad's BOM generation dialog.
  • Iterative Development: Enables rapid testing of plugin logic, fabricator-specific output formats, and inventory matching without re-packaging.
  • Use Case: A developer modifying the jBOM plugin logic can immediately verify their changes by running the updated script directly from the Eeschema Tools menu.

Quick Start

Register the local kicad_jbom_plugin.py script in the KiCad Eeschema BOM dialog by adding a new plugin entry with the command line pointing to your absolute path and including the required inventory file argument.

Frequently Asked Questions about kicad-plugin-setup

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I test a local KiCad plugin in Eeschema without repackaging it?โ–ผ

Yes, you can register a local Python script in the KiCad Eeschema BOM dialog to test BOM generation logic. You need a local Python 3.10+ environment and the jBOM package installed via pip to execute the script.

Why should I use a local development setup for my KiCad BOM plugin?โ–ผ

A local development setup bypasses the slow Plugin and Content Manager publish-and-install cycle. It allows you to immediately verify code changes, fabricator-specific output formats, and inventory matching directly from the Eeschema Tools menu.

Do I need a specific Python version to run jBOM in KiCad?โ–ผ

Yes, running jBOM in KiCad requires a local Python 3.10+ environment. You also need the jBOM package installed via pip to ensure the BOM generation logic functions correctly within Eeschema.

How do I add a custom BOM plugin to the KiCad Eeschema BOM dialog?โ–ผ

To add a custom BOM plugin, open the Eeschema BOM dialog and add a new plugin entry. Set the command line to point to the absolute path of your local kicad_jbom_plugin.py script and include the required inventory file argument.

What is the best way to iterate on fabricator-specific BOM outputs in KiCad?โ–ผ

The best way to iterate on fabricator-specific BOM outputs is to register your local jBOM plugin script in Eeschema. This enables rapid testing of custom BOM generation logic without re-packaging your plugin.