https://github.com/hashdefineelectronics/kicad_bom_wizard
This is a javascript script for creating Kicad HTML BOM.
https://github.com/hashdefineelectronics/kicad_bom_wizard
bom csv html javascript kicad kicad-bom-wizard kicad-plugin
Last synced: 11 months ago
JSON representation
This is a javascript script for creating Kicad HTML BOM.
- Host: GitHub
- URL: https://github.com/hashdefineelectronics/kicad_bom_wizard
- Owner: HashDefineElectronics
- Created: 2016-01-13T06:09:54.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2022-03-23T19:21:13.000Z (about 4 years ago)
- Last Synced: 2025-03-20T22:22:44.972Z (about 1 year ago)
- Topics: bom, csv, html, javascript, kicad, kicad-bom-wizard, kicad-plugin
- Language: JavaScript
- Size: 1.67 MB
- Stars: 59
- Watchers: 6
- Forks: 18
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# 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](http://hashdefineelectronics.com)
Twitter: [@Opticalworm](https://twitter.com/Opticalworm) [@HashDefineElec](https://twitter.com/HashDefineElec)
### Project Information
- Repository: [github.com](https://github.com/HashDefineElectronics/KiCad_BOM_Wizard.git)
- Project Page: [hashdefineelectronics.com](http://hashdefineelectronics.com/kicad-bom-wizard/)
- Forum: [kiCad.info](https://forum.kicad.info/t/kicad-bom-wizard-plugin-with-customisable-output-can-make-html-and-csv-bom/2142/7?u=opticalworm)
- Coding Standard
[](http://standardjs.com/)
___
# Video Instructions
[](https://youtu.be/JlaQqHQE1Ec)
___
# Install and Setup
To use KiCad_BOM_Wizard, you will need [NodeJs](https://nodejs.org/en/) and [NPM](https://www.npmjs.com/) 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](./Doc/git_download_install.md).
#### 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](./Doc/git_clone_install.md).
---
# Short codes
These are the list of short code that are used in the template files.
[Shortcode cheatsheet - shortcode.md](./Doc/shortcode.md)
---
# Frequently asked question
Pleased don't forget to checkout the [FAQ.md](./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](http://hashdefineelectronics.com/kicad-bom-wizard/).