KiKit offers a simple CLI interface to perform common tasks easily. You can
obtain help of the interface by calling kikit --help.
The interface is structured into nested commands. On the top level, there are the following commands available:
- drc: Validate design rules of the board
- export: Export KiCAD boards
- fab: Export complete manufacturing data for given fabrication houses
- modify: Modify board items
- panelize: Panelize boards
- present: Prepare board presentation
- separate: Separate a single board out of a multi-board design.
- stencil: Create solder paste stencils
kikit export gerber <boardFile> [<outputDir>]- export gerber files ofboardFiletooutputDir. If no dir is specified, a new one<boardFile>-gerbersis created.kikit export dxf <boardFile> [<outputDir>]- export board outline and paste layers to DXF. The main use case for this command is making 3D printed solder paste stencils.
Read more in a separate documentation section or see a walkthrough.
Read more in a separate documentation section.
Read more in a separate documentation section.
kikit present boardpage --name <pagename> -d <descriptionFile> -b <name comment boadfile> -r <resource> --template <template> --repository <url> <outputdir>- generate single webpage providing board preview and a possibility to download board files (gerbers and sources). See an example of such page.- The description is a path to a markdown file with the main page content.
- You can specify multiple resources via
-ror--resource. Resources are files which will be copied to the output directory. Useful for images referred from description - You can specify multiple boards via
-bor--board - Template is an optional argument which is either a path to a custom template
or a name of built-in templates (currently, there is only one:
default). See template documentation for more information about templates.
kikit modify references --show/--hide --pattern <pattern> <board>hide or show all references on the board matching a regular pattern.