polyvection / kicad_bom_wizard

KiCad BOM Wizard Plugin

KiCad_BOM_Wizard is nodeJs script for generating custom KiCad BOMs. It uses template files to describe and define the content of the output.

KiCad_BOM_Wizard can either be integrated into KiCad’s BOM plugin manager for easier use or executed directly via your system's terminal.

KiCad_BOM_Wizard comes with three templates examples, one for generate HTML BOMs, one for generating a CSV BOM and the final one for generating PDF BOMs.

---

Author

Ronald Sousa hashdefineelectronics.com

Twitter: @Opticalworm @HashDefineElec

Project Information

• Repository: github.com

• Project Page: hashdefineelectronics.com

• Forum: kiCad.info

• Coding Standard

---

Video Instructions

---

Install and Setup

To use KiCad_BOM_Wizard, you will need NodeJs and NPM installed and configured in your system.

There are two options for installing and using KiCad_BOM_Wizard.

1. github download method

This method if for anyone who's new to git and rather download the project directly from github.

• github download method.

2. git clone method

This method if for anyone who prefers to use git.

This is particularly useful if you are planning on using git submodule to keep a copy of KiCad_BOM_Wizard per KiCad projects.

• git clone method.

---

Short codes

These are the list of short code that are used in the template files.

Shortcode cheatsheet - shortcode.md

---

Frequently asked question

Pleased don't forget to checkout the FAQ.md document if you have any issue with the document.

---

For more details on how to use your own template for KiCad_BOM_Wizard then head over to the project Homepage.