KiBot (formerly KiPlot)

This is the documentation for KiBot v1.6.3 for the current development read here.

Important for CI/CD:

The GitHub actions now use the full/test docker images. So now they include PanDoc and also Blender.
If you are looking for the GitHub Actions documentation, and you already know how to use KiBot, or want a quick start, read: GitHub Actions

New on v1.6.3

Parametrizable imports
value_split and spec_to_field filters

Index

Introduction
Installation
Configuration
Usage
Usage for CI/CD
- GitHub Actions
  - GitHub Actions tags
- GitHub Cache
Contributing
Notes about Gerber format
Notes about the position file
- XYRS files
Notes about 3D models
Proposed advanced KiCad usage
- One circuit and more than one PCB implementation
- System with more than one PCB
Credits

Introduction

KiBot is a program which helps you to generate the fabrication and documentation files for your KiCad projects easily, repeatable, and most of all, scriptably. This means you can use a Makefile to export your KiCad PCBs just as needed, or do it in a CI/CD environment.

For example, it's common that you might want for each board rev:

Check ERC/DRC one last time (using KiCad Automation Scripts)
Gerbers, drills and drill maps for a fab in their favourite format
Fab docs for the assembler, including the BoM (Bill of Materials), costs spreadsheet and board view
Pick and place files
PCB 3D model in STEP, VRML and PCB3D formats
PCB 3D render in PNG format
Compare PCB/SCHs
Panelization
Stencil creation

You want to do this in a one-touch way, and make sure everything you need to do so is securely saved in version control, not on the back of an old datasheet.

KiBot lets you do this. The following picture depicts the data flow:

If you want to see this concept applied to a real world project visit the Spora CI/CD example.

Installation

KiBot main target is Linux, but some users successfully use it on Windows. For Windows you'll need to install tools to mimic a Linux environment. Running KiBot on MacOSX should be possible now that KiCad migrated to Python 3.x.

You can also run KiBot using docker images in a CI/CD environment like GitHub or GitLab. In this case you don't need to install anything locally.

Dependencies

Notes:

When installing from the Debian repo you don't need to worry about dependencies, just pay attention to recommended and suggested packages.
When installing using pip the dependencies marked with will be automatically installed.
The dependencies marked with can be downloaded on-demand by KiBot. Note this is poorly tested and is mostly oriented to 64 bits Linux systems. Please report problems.
The kibot-check tool can help you to know which dependencies are missing.
Note that on some systems (i.e. Debian) ImageMagick disables PDF manipulation in its policy.xml file. Comment or remove lines like this: <policy domain="coder" rights="none" pattern="PDF" /> (On Debian: /etc/ImageMagick-6/policy.xml)
Link to Debian stable package.
This is a Python module, not a separated tool.
This is an independent tool, can be a binary or a Python script.

Lark

Mandatory

PyYAML

Mandatory

Requests

Mandatory

KiCad Automation tools v2.2.1

Mandatory for: dxf_sch_print, gencad, hpgl_sch_print, netlist, pdf_pcb_print, pdf_sch_print, ps_sch_print, render_3d, run_drc, run_erc, step, svg_pcb_print, svg_sch_print, update_xml, vrml
Optional to:
- Compare schematics for diff (v2.2.0)
- Show KiAuto installation information for info (v2.0.0)
- Print the page frame in GUI mode for pcb_print (v1.6.7)

KiKit v1.3.0.4

Mandatory for: panelize, stencil_3d, stencil_for_jig
Optional to separate multiboard projects for general use

LXML

Mandatory for: pcb_print, pcbdraw

OpenSCAD

Mandatory for: stencil_3d, stencil_for_jig

Xvfb

Mandatory for: stencil_3d, stencil_for_jig

Xvfbwrapper

Mandatory for: stencil_3d, stencil_for_jig

KiCost v1.1.8

Mandatory for kicost
Optional to find components costs and specs for bom

Blender v3.4.0

Mandatory for blender_export

Interactive HTML BoM v2.4.1.4

Mandatory for ibom

KiBoM v1.8.0

Mandatory for kibom

KiCad PCB/SCH Diff v2.4.4

Mandatory for diff

markdown2

Mandatory for kikit_present

mistune

Mandatory for populate

QRCodeGen

Mandatory for qr_lib

Colorama

Optional to get color messages in a portable way for general use

Git

Optional to:
- Compare with files in the repo for diff
- Find commit hash and/or date for kikit_present
- Find commit hash and/or date for pcb_replace
- Find commit hash and/or date for sch_replace
- Find commit hash and/or date for set_text_variables

ImageMagick

Optional to:
- Automatically crop images for blender_export
- Create outputs preview for navigate_results
- Create monochrome prints and scaled PNG files for pcb_print
- Create JPG and BMP images for pcbdraw
- Automatically crop images for render_3d

RSVG tools

Optional to:
- Create outputs preview for navigate_results
- Create PNG icons for navigate_results
- Create PDF, PNG, PS and EPS formats for pcb_print
- Create PNG, JPG and BMP images for pcbdraw

Bash

Optional to:
- Run external commands to create replacement text for pcb_replace
- Run external commands to create replacement text for sch_replace
- Run external commands to create replacement text for set_text_variables

Ghostscript

Optional to:
- Create outputs preview for navigate_results
- Create PNG, PS and EPS formats for pcb_print

numpy

Optional to automatically adjust SVG margin for pcbdraw

Pandoc

Optional to create PDF/ODF/DOCX files for report
Note: In CI/CD environments: the kicad_auto_test docker image contains it.

RAR

Optional to compress in RAR format for compress

XLSXWriter

Optional to create XLSX files for bom

Installation on Ubuntu or Debian

The easiest way is to use the repo, but if you want to manually install the individual .deb files you can:

Get the Debian package from the releases section and run:

sudo apt install ./kibot*_all.deb

Important note: Sometimes the release needs another packages that aren't part of the stable Debian distribution. In this case the packages are also included in the release page. As an example version 0.6.0 needs:

sudo apt install ./python3-mcpy_2.0.2-1_all.deb ./kibot_0.6.0-1_all.deb

Important note: The KiCad Automation Scripts packages are a mandatory dependency. The KiBoM, InteractiveHtmlBom and PcbDraw are recommended.

Installation using pip

pip install --no-compile kibot

Note that pip has the dubious idea of compiling everything it downloads. There is no advantage in doing it and it interferes with the mcpy macros. Also note that in modern Linux systems pip was renamed to pip3, to avoid confusion with pip from Python 2.

If you are installing at system level I recommend generating the compilation caches after installing. As root just run:

kibot --help-outputs > /dev/null

Note that pip will automatically install all the needed Python dependencies. But it won't install other interesting dependencies. In particular you should take a look at the KiCad Automation Scripts dependencies. If you have a Debian based OS I strongly recommend trying to use the .deb packages for all the tools.

If you want to install the code only for the current user add the --user option.

If you want to install the last git code from GitHub using pip use:

pip3 install --user git+https://github.com/INTI-CMNB/KiBot.git

You can also clone the repo, change to its directory and install using:

pip3 install --user -e .

In this way you can change the code and you won't need to install again.

Notes about virtualenv

If you try to use a Python virtual environment you'll need to find a way to make the KiCad module (pcbnew) available on it. I don't know how to make it.

In addition: note that the virtual env will change the system share data paths. They will no longer point to things like /usr/share/ but to a virtual env place. So you'll need to either define environment variables to tell KiBot where are the libs or just add symlinks from the virtual env to the system level libs.

Installation on other targets

Install KiCad 5.1.6 or newer
Install Python 3.5 or newer
Install the Python Yaml and requests modules
Run the script src/kibot

Configuration

KiBot uses a configuration file where you can specify what outputs to generate and which preflight (before launching the outputs generation) actions to perform. By default you'll generate all of them, but you can specify which ones from the command line.

The configuration file should be named using the .kibot.yaml suffix, i.e. my_project.kibot.yaml. The format used is YAML. This is basically a text file with some structure. This file can be compressed using gzip file format.

If you never used YAML read the following explanation. Note that the explanation could be useful even if you know YAML.

Quick start

If you want to learn by examples, or you just want to take a look a what KiBot can do, you can use the --quick-start command line option.

First change to the directory where your project (or projects) is located. Now run KiBot like this:

kibot --quick-start

This will look for KiCad projects starting from the current directory and going down the directory structure. For each project found KiBot will generate a configuration file showing some common outputs. After creating the configuration files KiBot will start the outputs generation.

Here is an example of what's generated using the following example repo.

You can use the generated files as example of how to configure KiBot. If you want to just generate the configuration files and not the outputs use:

kibot --quick-start --dry

If you want to know about all the possible options for all the available outputs you can try:

kibot --example

This will generate a configuration file with all the available outputs and all their options.

Section order

The file is divided in various sections. Some of them are optional.

The order in which they are declared is not relevant, they are interpreted in the following order:

kiplot/kibot see The header
import see Importing outputs from another file, Importing filters and variants from another file and Importing internal templates
global see Default global options
filters see Filters and variants
variants see Filters and variants
preflight see The preflight section
outputs see The outputs section
groups see Grouping outputs

The header

All configuration files must start with:

kibot:
  version: 1

This tells to KiBot that this file is using version 1 of the format.

The preflight section

This section is used to specify tasks that will be executed before generating any output.

Supported preflight options:

annotate_pcb: [dict] Annotates the PCB according to physical coordinates. This preflight modifies the PCB and schematic, use it only in revision control environments. Used to assign references according to footprint coordinates. The project must be fully annotated first.
- Valid keys:
  - bottom_main_ascending: [boolean=true] Sort the main axis in ascending order for the bottom layer. For X this is left to right and for Y top to bottom.
  - bottom_main_axis: [string='y'] [x,y] Use this axis as main sorting criteria for the bottom layer.
  - bottom_secondary_ascending: [boolean=true] Sort the secondary axis in ascending order for the bottom layer. For X this is left to right and for Y top to bottom.
  - bottom_start: [number=101] First number for references at the bottom layer. Use -1 to continue from the last top reference.
  - grid: [number=1.0] Grid size in millimeters.
  - top_main_ascending: [boolean=true] Sort the main axis in ascending order for the top layer. For X this is left to right and for Y top to bottom.
  - top_main_axis: [string='y'] [x,y] Use this axis as main sorting criteria for the top layer.
  - top_secondary_ascending: [boolean=true] Sort the secondary axis in ascending order for the top layer. For X this is left to right and for Y top to bottom.
  - top_start: [number=1] First number for references at the top layer.
  - use_position_of: [string='footprint'] [footprint,reference] Which coordinate is used.
annotate_power: [boolean=false] Annotates all power components. This preflight modifies the schematic, use it only in revision control environments. Used to solve ERC problems when using filters that remove power reference numbers.
check_zone_fills: [boolean=false] Zones are filled before doing any operation involving PCB layers. The original PCB remains unchanged. If you need to abort when the zone fill creates significant changes to a layer use the CheckZoneFill internal template.
erc_warnings: [boolean=false] Option for run_erc. ERC warnings are considered errors.
fill_zones: [boolean=false] Fill all zones again and save the PCB.
filters: [list(dict)] A list of entries to filter out ERC/DRC messages. Note that ignored errors will become KiBot warnings (i.e. (W058) ...). To farther ignore these warnings use the filters option in the global section.
- Valid keys:
  - error: [string=''] Error id we want to exclude. A name for KiCad 6 or a number for KiCad 5, but always a string.
  - error_number: Alias for number.
  - filter: [string=''] Name for the filter, for documentation purposes.
  - filter_msg: Alias for filter.
  - number: [number=0] Error number we want to exclude. KiCad 5 only.
  - regex: [string=''] Regular expression to match the text for the error we want to exclude.
  - regexp: Alias for regex.
ignore_unconnected: [boolean=false] Option for run_drc. Ignores the unconnected nets. Useful if you didn't finish the routing. It will also ignore KiCad 6 warnings.
pcb_replace: [dict] Replaces tags in the PCB. I.e. to insert the git hash or last revision date. This is useful for KiCad 5, use set_text_variables when using KiCad 6. This preflight modifies the PCB. Even when a back-up is done use it carefully.
- Valid keys:
  - date_command: [string=''] Command to get the date to use in the PCB.
    git log -1 --format='%as' -- "$KIBOT_PCB_NAME"
    Will return the date in YYYY-MM-DD format.
    date -d @`git log -1 --format='%at' -- "$KIBOT_PCB_NAME"` +%Y-%m-%d_%H-%M-%S
    Will return the date in YYYY-MM-DD_HH-MM-SS format.
    Important: on KiCad 6 the title block data is optional. This command will work only if you have a date in the PCB/Schematic.
  - replace_tags: [dict|list(dict)] Tag or tags to replace.
    - Valid keys:
      - after: [string=''] Text to add after the output of command.
      - before: [string=''] Text to add before the output of command.
      - command: [string=''] Command to execute to get the text, will be used only if text is empty. KIBOT_PCB_NAME variable is the name of the current PCB.
      - tag: [string=''] Name of the tag to replace. Use version for a tag named @version@.
      - tag_delimiter: [string='@'] Character used to indicate the beginning and the end of a tag. Don't change it unless you really know about KiCad's file formats.
      - text: [string=''] Text to insert instead of the tag.
run_drc: [boolean=false] Runs the DRC (Distance Rules Check). To ensure we have a valid PCB. The report file name is controlled by the global output pattern (%i=drc %x=txt). Note that the KiCad 6+ Test for parity between PCB and schematic option is not supported. If you need to check the parity use the update_xml preflight. KiCad 6 introduced warnings they are currently counted be the unconnected counter of KiBot. This will change in the future.
run_erc: [boolean=false] Runs the ERC (Electrical Rules Check). To ensure the schematic is electrically correct. The report file name is controlled by the global output pattern (%i=erc %x=txt).
sch_replace: [dict] Replaces tags in the schematic. I.e. to insert the git hash or last revision date. This is useful for KiCad 5, use set_text_variables when using KiCad 6. This preflight modifies the schematics. Even when a back-up is done use it carefully.
- Valid keys:
  - date_command: [string=''] Command to get the date to use in the SCH.
    git log -1 --format='%as' -- "$KIBOT_SCH_NAME"
    Will return the date in YYYY-MM-DD format.
    date -d @`git log -1 --format='%at' -- "$KIBOT_SCH_NAME"` +%Y-%m-%d_%H-%M-%S
    Will return the date in YYYY-MM-DD_HH-MM-SS format.
    Important: on KiCad 6 the title block data is optional. This command will work only if you have a date in the SCH/Schematic.
  - replace_tags: [dict|list(dict)] Tag or tags to replace.
    - Valid keys:
      - after: [string=''] Text to add after the output of command.
      - before: [string=''] Text to add before the output of command.
      - command: [string=''] Command to execute to get the text, will be used only if text is empty. KIBOT_SCH_NAME variable is the name of the current sheet. KIBOT_TOP_SCH_NAME variable is the name of the top sheet.
      - tag: [string=''] Name of the tag to replace. Use version for a tag named @version@.
      - tag_delimiter: [string='@'] Character used to indicate the beginning and the end of a tag. Don't change it unless you really know about KiCad's file formats.
      - text: [string=''] Text to insert instead of the tag.
set_text_variables: [dict|list(dict)] Defines KiCad 6 variables. They are expanded using ${VARIABLE}, and stored in the project file. This preflight replaces pcb_replace and sch_replace when using KiCad 6. The KiCad project file is modified.
- Valid keys:
  - after: [string=''] Text to add after the output of command.
  - before: [string=''] Text to add before the output of command.
  - command: [string=''] Command to execute to get the text, will be used only if text is empty. This command will be executed using the Bash shell. Be careful about spaces in file names (i.e. use "$KIBOT_PCB_NAME"). The KIBOT_PCB_NAME environment variable is the PCB file and the KIBOT_SCH_NAME environment variable is the schematic file.
  - expand_kibot_patterns: [boolean=true] Expand %X patterns. The context is schematic.
  - name: [string=''] Name of the variable. The version variable will be expanded using ${version}.
  - text: [string=''] Text to insert instead of the variable.
  - variable: Alias for name.
update_qr: [boolean=false] Update the QR codes. Complements the qr_lib output. The KiCad 6 files and the KiCad 5 PCB needs manual update, generating a new library isn't enough.
update_xml: [boolean=false|dict] Update the XML version of the BoM (Bill of Materials). To ensure our generated BoM is up to date. Note that this isn't needed when using the internal BoM generator (bom). You can compare the PCB and schematic netlists using it.
- Valid keys:
  - check_pcb_parity: [boolean=false] Check if the PCB and Schematic are synchronized. This is equivalent to the Test for parity between PCB and schematic of the DRC dialog. Only available for KiCad 6.
  - as_warnings: [boolean=false] Inform the problems as warnings and don't stop.
  - enabled: [boolean=true] Enable the update. This is the replacement for the boolean value.

Here is an example of a preflight section:

preflight:
  run_erc: true
  update_xml: true
  run_drc: true
  check_zone_fills: true
  ignore_unconnected: false

More about pcb_replace and sch_replace

These options are supposed to be used in a version control environment. This is because, unlike other options, they modify the PCB and/or schematic and might damage them. In a version control environment you can just roll-back the changes.

Don't be afraid, they make a back-up of the files and also tries to disable dangerous changes. But should be used carefully. They are ideal for CI/CD environment where you don't actually commit any changes.

Filtering DRC and ERC errors

Sometimes KiCad reports DRC or ERC errors that you can't get rid off. This could be just because you are part of a team including lazy people that doesn't want to take the extra effort to solve some errors that aren't in fact errors, just small violations made on purpose. In this case you could exclude some known errors.

For this you must declare filters entry in the preflight section. Then you can add as many filter entries as you want. Each filter entry has an optional description and defines to which error type is applied (number) and a regular expression that the error must match to be ignored (regex). Like this:

  filters:
    - filter: 'Optional filter description'
      error: 'Error_type'
      regex:  'Expression to match'

Here is a KiCad 5 example, suppose you are getting the following errors:

** Found 1 DRC errors **
ErrType(4): Track too close to pad
    @(177.185 mm, 78.315 mm): Track 1.000 mm [Net-(C3-Pad1)] on F.Cu, length: 1.591 mm
    @(177.185 mm, 80.715 mm): Pad 2 of C3 on F.Cu and others

** Found 1 unconnected pads **
ErrType(2): Unconnected items
    @(177.185 mm, 73.965 mm): Pad 2 of C4 on F.Cu and others
    @(177.185 mm, 80.715 mm): Pad 2 of C3 on F.Cu and others

And you want to ignore them. You can add the following filters:

  filters:
    - filter: 'Ignore C3 pad 2 too close to anything'
      error: '4'
      regex:  'Pad 2 of C3'
    - filter: 'Ignore unconnected pad 2 of C4'
      error: '2'
      regex:  'Pad 2 of C4'

If you need to match text from two different lines in the error message try using (?s)TEXT(.*)TEXT_IN_OTHER_LINE.

If you have two or more different options for a text to match try using (OPTION1|OPTION2).

A complete Python regular expressions explanation is out of the scope of this manual. For a complete reference consult the Python manual.

KiCad 6 uses strings to differentiate errors, use them for the error field. To keep compatibility you can use the number or error_number options for KiCad 5.

Note that this will ignore the errors, but they will be reported as warnings. If you want to suppress these warnings take a look at Filtering KiBot warnings

Important note: this will create a file named kibot_errors.filter in the output directory.

Default global options

The section global contains default global options that affects all the outputs. Currently only a few option are supported.

Default output option

This option controls the default file name pattern used by all the outputs. This makes all the file names coherent. You can always choose the file name for a particular output.

The pattern uses the following expansions:

%c company from pcb/sch metadata.
%Cn comments line n from pcb/sch metadata.
%d pcb/sch date from metadata if available, file modification date otherwise.
%D date the script was started.
%f original pcb/sch file name without extension.
%F original pcb/sch file name without extension. Including the directory part of the name.
%g the file_id of the global variant.
%G the name of the global variant.
%i a contextual ID, depends on the output type.
%I an ID defined by the user for this output.
%M directory where the pcb/sch resides. Only the last component i.e. /a/b/c/name.kicad_pcb -> c
%p title from pcb/sch metadata.
%r revision from pcb/sch metadata.
%S sub-PCB name (related to multiboards).
%T time the script was started.
%x a suitable extension for the output type.
%v the file_id of the current variant, or the global variant if outside a variant scope.
%V the name of the current variant, or the global variant if outside a variant scope.

They are compatible with the ones used by IBoM. The default value for global.output is %f-%i%I%v.%x. If you want to include the revision you could add the following definition:

global:
  output: '%f_rev_%r-%i.%x'

Note that the following patterns: %c, %Cn, %d, %f, %F, %p and %r depends on the context. If you use them for an output related to the PCB these values will be obtained from the PCB. If you need to force the origin of the data you can use %bX for the PCB and %sX for the schematic, where X is the pattern to expand.

You can also use text variables (introduced in KiCad 6). To expand a text variable use ${VARIABLE}. In addition you can also use environment variables, defined in your OS shell or defined in the global section.

Default dir option

The default dir value for any output is .. You can change it here.

Expansion patterns are allowed.

Note that you can use this value as a base for output's dir options. In this case the value defined in the output must start with +. In this case the + is replaced by the default dir value defined here.

Default variant option

This option controls the default variant applied to all the outputs. Example:

global:
  variant: 'production'

Default units option

This option controls the default value for the position and bom outputs. If you don't define it then the internal defaults of each output are applied. But when you define it the default is the defined value.

On KiCad 6 the dimensions has units. When you create a new dimension it uses automatic units. This means that KiCad uses the units currently selected. This selection isn't stored in the PCB file. The global units value is used by KiBot instead.

Output directory option

The out_dir option can define the base output directory. This is the same as the -d/--out-dir command line option. Note that the command line option has precedence over it.

Expansion patterns are applied to this value, but you should avoid using patterns that expand according to the context, i.e. %c, %d, %f, %F, %p and %r. The behavior of these patterns isn't fully defined in this case and the results may change in the future.

You can also use text variables (introduced in KiCad 6). To expand a text variable use ${VARIABLE}. In addition you can also use environment variables, defined in your OS shell or defined in the global section.

Date format option

The %d, %sd and %bd patterns use the date and time from the PCB and schematic. When abscent they use the file timestamp, and the date_time_format global option controls the format used. When available, and in ISO format, the date_format controls the format used. You can disable this reformatting assigning false to the date_reformat option.
The %D format is controlled by the date_format global option.
The %T format is controlled by the time_format global option.

In all cases the format is the one used by the strftime POSIX function, for more information visit this site.

PCB details options

The following variables control the default colors and they are used for documentation purposes:

pcb_material [FR4] PCB core material. Currently known are FR1 to FR5
solder_mask_color [green] Color for the solder mask. Currently known are green, black, white, yellow, purple, blue and red.
silk_screen_color [white] Color for the markings. Currently known are black and white.
pcb_finish [HAL] Finishing used to protect pads. Currently known are None, HAL, HASL, ENIG and ImAg.

Filtering KiBot warnings

KiBot warnings are marked with (Wn) where n is the warning id.

Some warnings are just recommendations and you could want to avoid them to focus on details that are more relevant to your project. In this case you can define filters in a similar way used to filter DRC/ERC errors.

As an example, if you have the following warning:

WARNING:(W43) Missing component `l1:FooBar`

You can create the following filter to remove it:

global:
  filters:
    - number: 43
      regex:  'FooBar'

All available global options

global:

Valid keys:
- aliases_for_3d_models: [list(dict)] List of aliases for the 3D models (KiCad 6). KiCad stores 3D aliases with the user settings, not locally. This makes impossible to create self contained projects. You can define aliases here to workaround this problem. The values defined here has precedence over the KiCad configuration. Related to https://gitlab.com/kicad/code/kicad/-/issues/3792.
  - Valid keys:
    - alias: Alias for name.
    - name: [string=''] Name of the alias.
    - text: Alias for value.
    - value: [string=''] Path to the 3D model.
    - variable: Alias for name.
- allow_blind_buried_vias: [boolean=true] Allow the use of buried vias. This value is only used for KiCad 7+. For KiCad 5 and 6 use the design rules settings, stored in the project.
- allow_microvias: [boolean=true] Allow the use of micro vias. This value is only used for KiCad 7+. For KiCad 5 and 6 use the design rules settings, stored in the project.
- cache_3d_resistors: [boolean=false] Use a cache for the generated 3D models of colored resistors. Will save time, but you could need to remove the cache if you need to regenerate them.
- castellated_pads: [boolean=false] Has the PCB castellated pads? KiCad 6: you should set this in the Board Setup -> Board Finish -> Has castellated pads.
- colored_tht_resistors: [boolean=true] Try to add color bands to the 3D models of KiCad THT resistors.
- copper_finish: Alias for pcb_finish.
- copper_thickness: [number|string] Copper thickness in micrometers (1 Oz is 35 micrometers). KiCad 6: you should set this in the Board Setup -> Physical Stackup.
- cross_footprints_for_dnp: [boolean=true] Draw a cross for excluded components in the Fab layer.
- cross_no_body: [boolean=false] Cross components even when they don't have a body. Only for KiCad 6 and internal cross.
- cross_using_kicad: [boolean=true] When using KiCad 7+ let KiCad cross the components.
- csv_accept_no_ref: [boolean=false] Accept aggregating CSV files without references (Experimental).
- date_format: [string='%Y-%m-%d'] Format used for the day we started the script. Is also used for the PCB/SCH date formatting when time_reformat is enabled (default behavior). Uses the strftime format.
- date_time_format: [string='%Y-%m-%d_%H-%M-%S'] Format used for the PCB and schematic date when using the file timestamp. Uses the strftime format.
- default_resistor_tolerance: [number=20] When no tolerance is specified we use this value. Note that I know 5% is a common default, but technically speaking 20% is the default. Used while creating colored resistors.
- dir: [string=''] Default pattern for the output directories. It also applies to the preflights, unless use_dir_for_preflights is disabled.
- disable_3d_alias_as_env: [boolean=false] Disable the use of environment and text variables as 3D models aliases.
- drc_exclusions_workaround: [boolean=false] KiCad 6 introduced DRC exclusions. They are stored in the project but ignored by the Python API. This is reported as bug number 11562 (https://gitlab.com/kicad/code/kicad/-/issues/11562). If you really need exclusions enable this option, this will use the GUI version of the DRC (slower). Current KiCad version is 6.0.7 and the bug is still there.
- drill_size_increment: [number=0.05] This is the difference between drill tools in millimeters. A manufacturer with 0.05 of increment has drills for 0.1, 0.15, 0.2, 0.25, etc..
- edge_connector: [string='no'] [yes,no,bevelled] Has the PCB edge connectors? KiCad 6: you should set this in the Board Setup -> Board Finish -> Edge card connectors.
- edge_plating: [boolean=false] Has the PCB a plated board edge? KiCad 6: you should set this in the Board Setup -> Board Finish -> Plated board edge.
- environment: [dict] Used to define environment variables used by KiCad. The values defined here are exported as environment variables and has more precedence than KiCad paths defined in the GUI. You can make reference to any OS environment variable using ${VARIABLE}. The KIPRJMOD is also available for expansion.
  - Valid keys:
    - define_old: [boolean=false] Also define legacy versions of the variables. Useful when using KiCad 6+ and some libs uses old KiCad 5 names.
    - extra_os: [list(dict)] Extra variables to export as OS environment variables. Note that you can also define them using - NAME: VALUE.
      - Valid keys:
        
        name: [string=''] Name of the variable.
        
        value: [string=''] Value for the variable.
    - footprints: [string=''] System level footprints (aka modules) dir. KiCad 5: KICAD_FOOTPRINT_DIR and KISYSMOD. KiCad 6: KICAD6_FOOTPRINT_DIR.
    - models_3d: [string=''] System level 3D models dir. KiCad 5: KISYS3DMOD. KiCad 6: KICAD6_3DMODEL_DIR.
    - symbols: [string=''] System level symbols dir. KiCad 5: KICAD_SYMBOL_DIR. KiCad 6: KICAD6_SYMBOL_DIR.
    - templates: [string=''] System level templates dir. KiCad 5: KICAD_TEMPLATE_DIR. KiCad 6: KICAD6_TEMPLATE_DIR.
    - third_party: [string=''] 3rd party dir. KiCad 6: KICAD6_3RD_PARTY.
    - user_templates: [string=''] User level templates dir. KiCad 5/6: KICAD_USER_TEMPLATE_DIR.
- erc_grid: [number=50] Grid size used for the ERC. This value must be in mils. This is needed for KiCad 7 in order to run the off grid check. Shouldn't be needed in KiCad 8. https://gitlab.com/kicad/code/kicad/-/issues/14110.
- extra_pth_drill: [number=0.1] How many millimeters the manufacturer will add to plated holes. This is because the plating reduces the hole, so you need to use a bigger drill. For more information consult: https://www.eurocircuits.com/pcb-design-guidelines/drilled-holes/.
- field_3D_model: [string='_3D_model'] Name for the field controlling the 3D models used for a component.
- field_lcsc_part: [string=''] The name of the schematic field that contains the part number for the LCSC/JLCPCB distributor. When empty KiBot will try to discover it.
- field_package: [string|list(string)] Name/s of the field/s used for the package, not footprint. I.e. 0805, SOT-23, etc. Used for the value split filter. The default is ['package', 'pkg'].
- field_power: [string|list(string)] Name/s of the field/s used for the power raiting. Used for the value split filter. The default is ['power', 'pow'].
- field_temp_coef: [string|list(string)] Name/s of the field/s used for the temperature coefficient. I.e. X7R, NP0, etc. Used for the value split filter. The default is ['temp_coef', 'tmp_coef'].
- field_tolerance: [string|list(string)] Name/s of the field/s used for the tolerance. Used while creating colored resistors and for the value split filter. The default is ['tolerance', 'tol'].
- field_voltage: [string|list(string)] Name/s of the field/s used for the voltage raiting. Used for the value split filter. The default is ['voltage', 'v'].
- filters: [list(dict)] KiBot warnings to be ignored.
  - Valid keys:
    - error: [string=''] Error id we want to exclude.
    - error_number: Alias for number.
    - filter: [string=''] Name for the filter, for documentation purposes.
    - filter_msg: Alias for filter.
    - number: [number=0] Error number we want to exclude.
    - regex: [string=''] Regular expression to match the text for the error we want to exclude.
    - regexp: Alias for regex.
- git_diff_strategy: [string='worktree'] [worktree,stash] When computing a PCB/SCH diff it configures how do we preserve the current working state. The worktree mechanism creates a separated worktree, that then is just removed. The stash mechanism uses git stash push/pop to save the current changes. Using worktree is the preferred mechanism.
- hide_excluded: [boolean=false] Default value for the hide_excluded option of various PCB outputs.
- impedance_controlled: [boolean=false] The PCB needs specific dielectric characteristics. KiCad 6: you should set this in the Board Setup -> Physical Stackup.
- invalidate_pcb_text_cache: [string='auto'] [auto,yes,no] Remove any cached text variable in the PCB. This is needed in order to force a text variables update when using set_text_variables. You might want to disable it when applying some changes to the PCB and create a new copy to send to somebody without changing the cached values. The auto value will remove the cached values only when using set_text_variables.
- kiauto_time_out_scale: [number=0.0] Time-out multiplier for KiAuto operations.
- kiauto_wait_start: [number=0] Time to wait for KiCad in KiAuto operations.
- kicad_dnp_applied: [boolean=true] The KiCad v7 PCB flag Do Not Populate is applied to our fitted flag before running any filter.
- kicad_dnp_applies_to_3D: [boolean=true] The KiCad v7 PCB flag Do Not Populate is applied to our fitted flag for 3D models, even when no filter/variant is specified. Disabling kicad_dnp_applied also disables this flag.
- out_dir: [string=''] Base output dir, same as command line --out-dir.
- output: [string='%f-%i%I%v.%x'] Default pattern for output file names. Affected by global options.
- pcb_finish: [string='HAL'] Finishing used to protect pads. Currently used for documentation and to choose default colors. KiCad 6: you should set this in the Board Setup -> Board Finish -> Copper Finish option. Currently known are None, HAL, HASL, HAL SnPb, HAL lead-free, ENIG, ENEPIG, Hard gold, ImAg, Immersion Silver, Immersion Ag, ImAu, Immersion Gold, Immersion Au, Immersion Tin, Immersion Nickel, OSP and HT_OSP.
- pcb_material: [string='FR4'] PCB core material. Currently used for documentation and to choose default colors. Currently known are FR1 to FR5.
- remove_adhesive_for_dnp: [boolean=true] When applying filters and variants remove the adhesive (glue) for components that won't be included.
- remove_solder_paste_for_dnp: [boolean=true] When applying filters and variants remove the solder paste for components that won't be included.
- resources_dir: [string='kibot_resources'] Directory where various resources are stored. Currently we support colors and fonts. They must be stored in sub-dirs. I.e. kibot_resources/fonts/MyFont.ttf Note this is mainly useful for CI/CD, so you can store fonts and colors in your repo. Also note that the fonts are installed using a mechanism known to work on Debian, which is used by the KiBot docker images, on other OSs your mileage may vary.
- restore_project: [boolean=false] Restore the KiCad project after execution. Note that this option will undo operations like set_text_variables.
- set_text_variables_before_output: [boolean=false] Run the set_text_variables preflight before running each output that involves variants. This can be used when a text variable uses the variant and you want to create more than one variant in the same run. Note that this could be slow because it forces a board reload each time you run an output that uses variants.
- silk_screen_color: [string='white'] Color for the markings. Currently used for documentation and to choose default colors. KiCad 6: you should set this in the Board Setup -> Physical Stackup. Currently known are black and white.
- silk_screen_color_bottom: [string=''] Color for the bottom silk screen. When not defined silk_screen_color is used. Read silk_screen_color help.
- silk_screen_color_top: [string=''] Color for the top silk screen. When not defined silk_screen_color is used. Read silk_screen_color help.
- solder_mask_color: [string='green'] Color for the solder mask. Currently used for documentation and to choose default colors. KiCad 6: you should set this in the Board Setup -> Physical Stackup. Currently known are green, black, white, yellow, purple, blue and red.
- solder_mask_color_bottom: [string=''] Color for the bottom solder mask. When not defined solder_mask_color is used. Read solder_mask_color help.
- solder_mask_color_top: [string=''] Color for the top solder mask. When not defined solder_mask_color is used. Read solder_mask_color help.
- time_format: [string='%H-%M-%S'] Format used for the time we started the script. Uses the strftime format.
- time_reformat: [boolean=true] Tries to reformat the PCB/SCH date using the date_format. This assumes you let KiCad fill this value and hence the time is in ISO format (YY-MM-DD).
- units: [string=''] [millimeters,inches,mils] Default units. Affects position, bom and panelize outputs. Also KiCad 6 dimensions.
- use_dir_for_preflights: [boolean=true] Use the global dir as subdir for the preflights.
- use_os_env_for_expand: [boolean=true] In addition to KiCad text variables also use the OS environment variables when expanding ${VARIABLE}.
- variant: [string=''] Default variant to apply to all outputs.

Filters and variants

The filters and variants are mechanisms used to modify the circuit components. Both concepts are closely related. In fact variants can use filters.

The current implementation of the filters allow to exclude components from some of the processing stages. The most common use is to exclude them from some output. You can also change components fields/properties and also the 3D model.

Variants are currently used to create assembly variants. This concept is used to manufacture one PCB used for various products. You can learn more about KiBot variants on the following example repo. The example is currently using KiCad 6, if you want to see the example files for KiCad 5 go here.

As mentioned above the current use of filters is to mark some components. Mainly to exclude them, but also to mark them as special. This is the case of do not change components in the BoM.

Filters and variants are defined in separated sections. A filter section looks like this:

filters:
 - name: 'a_short_name'
   type: 'generic'
   comment: 'A description'
   # Filter options

Supported filters:

expand_text_vars: Expand_Text_Vars This filter expands KiCad 6 text variables (${VARIABLE}).
- Valid keys:
  - comment: [string=''] A comment for documentation purposes.
  - include_kicad_env: [boolean=true] Also expand KiCad environment variables.
  - include_os_env: [boolean=false] Also expand system environment variables.
  - name: [string=''] Used to identify this particular filter definition.
field_modify: Field_Modify Changes the content of one or more fields.
- Valid keys:
  - comment: [string=''] A comment for documentation purposes.
  - fields: [string|list(string)='Datasheet'] Fields to convert.
  - include: [string|list(string)=''] Name of the filter to select which components will be affected. Applied to all if nothing specified here.
  - name: [string=''] Used to identify this particular filter definition.
  - regex: [string='(https?://\S+)'] Regular expression to match the field content. Only fields that matches will be modified. An empty regex will match anything. The example matches an HTTP URL.
  - replace: [string='\1'] Text to replace, can contain references to sub-expressions. The example converts an HTTP URL into an HTML link, like the URLify filter.
field_rename: Field_Rename This filter implements a field renamer. The internal _kicost_rename filter emulates the KiCost behavior.
- Valid keys:
  - comment: [string=''] A comment for documentation purposes.
  - name: [string=''] Used to identify this particular filter definition.
  - rename: [list(dict)] Fields to rename.
    - Valid keys:
      - field: [string=''] Name of the field to rename.
      - name: [string=''] New name.
generic: Generic filter This filter is based on regular expressions. It also provides some shortcuts for common situations. Note that matches aren't case sensitive and spaces at the beginning and the end are removed. The internal _mechanical filter emulates the KiBoM behavior for default exclusions. The internal _kicost_dnp filter emulates KiCost's dnp field.
- Valid keys:
  - comment: [string=''] A comment for documentation purposes.
  - config_field: [string='Config'] Name of the field used to classify components.
  - config_separators: [string=' ,'] Characters used to separate options inside the config field.
  - exclude_all_hash_ref: [boolean=false] Exclude all components with a reference starting with #.
  - exclude_any: [list(dict)] A series of regular expressions used to exclude parts. If a component matches ANY of these, it will be excluded. Column names are case-insensitive.
    - Valid keys:
      - column: [string=''] Name of the column to apply the regular expression. Use _field_lcsc_part to get the value defined in the global options.
      - field: Alias for column.
      - invert: [boolean=false] Invert the regex match result.
      - match_if_field: [boolean=false] Match if the field exists, no regex applied. Not affected by invert.
      - match_if_no_field: [boolean=false] Match if the field doesn't exists, no regex applied. Not affected by invert.
      - regex: [string=''] Regular expression to match.
      - regexp: Alias for regex.
      - skip_if_no_field: [boolean=false] Skip this test if the field doesn't exist.
  - exclude_bottom: [boolean=false] Exclude components on the bottom side of the PCB.
  - exclude_config: [boolean=false] Exclude components containing a key value in the config field. Separators are applied.
  - exclude_empty_val: [boolean=false] Exclude components with empty 'Value'.
  - exclude_field: [boolean=false] Exclude components if a field is named as any of the keys.
  - exclude_not_in_bom: [boolean=false] Exclude components marked Exclude from bill of materials (KiCad 6+).
  - exclude_not_on_board: [boolean=false] Exclude components marked Exclude from board (KiCad 6+).
  - exclude_refs: [list(string)] List of references to be excluded. Use R* for all references with R prefix.
  - exclude_smd: [boolean=false] Exclude components marked as smd in the PCB.
  - exclude_tht: [boolean=false] Exclude components marked as through-hole in the PCB.
  - exclude_top: [boolean=false] Exclude components on the top side of the PCB.
  - exclude_value: [boolean=false] Exclude components if their 'Value' is any of the keys.
  - exclude_virtual: [boolean=false] Exclude components marked as virtual in the PCB.
  - include_only: [list(dict)] A series of regular expressions used to include parts. If there are any regex defined here, only components that match against ANY of them will be included. Column/field names are case-insensitive. If empty this rule is ignored.
    - Valid keys:
      - column: [string=''] Name of the column to apply the regular expression. Use _field_lcsc_part to get the value defined in the global options.
      - field: Alias for column.
      - invert: [boolean=false] Invert the regex match result.
      - match_if_field: [boolean=false] Match if the field exists, no regex applied. Not affected by invert.
      - match_if_no_field: [boolean=false] Match if the field doesn't exists, no regex applied. Not affected by invert.
      - regex: [string=''] Regular expression to match.
      - regexp: Alias for regex.
      - skip_if_no_field: [boolean=false] Skip this test if the field doesn't exist.
  - invert: [boolean=false] Invert the result of the filter.
  - keys: [string|list(string)=dnf_list] [dnc_list,dnf_list] List of keys to match. The dnf_list and dnc_list internal lists can be specified as strings. Use dnf_list for ['dnf', 'dnl', 'dnp', 'do not fit', 'do not load', 'do not place', 'no stuff', 'nofit', 'noload', 'noplace', 'nostuff', 'not fitted', 'not loaded', 'not placed']. Use dnc_list for ['dnc', 'do not change', 'fixed', 'no change'].
  - name: [string=''] Used to identify this particular filter definition.
rot_footprint: Rot_Footprint This filter can rotate footprints, used for the positions file generation. Some manufacturers use a different rotation than KiCad. The internal _rot_footprint filter implements the simplest case.
- Valid keys:
  - comment: [string=''] A comment for documentation purposes.
  - extend: [boolean=true] Extends the internal list of rotations with the one provided. Otherwise just use the provided list.
  - invert_bottom: [boolean=false] Rotation for bottom components is negated, resulting in either: (- component rot - angle) or when combined with negative_bottom, (angle - component rot).
  - name: [string=''] Used to identify this particular filter definition.
  - negative_bottom: [boolean=true] Rotation for bottom components is computed via subtraction as (component rot - angle).
  - rotations: [list(list(string))] A list of pairs regular expression/rotation. Components matching the regular expression will be rotated the indicated angle.
  - skip_bottom: [boolean=false] Do not rotate components on the bottom.
  - skip_top: [boolean=false] Do not rotate components on the top.
spec_to_field: Spec_to_Field This filter extracts information from the specs obtained from component distributors and fills fields. I.e. create a field with the RoHS status of a component. In order to make it work you must be able to get prices using the KiCost options of the bom output. Make sure you can do this before trying to use this filter. Usage example.
- Valid keys:
  - from_output: [string=''] Name of the output used to collect the specs. Currently this must be a bom output with KiCost enabled and a distributor that returns specs.
  - check_dist_coherence: [boolean=true] Check that the data we got from different distributors is equivalent.
  - check_dist_fields: [string|list(string)=''] List of fields to include in the check. For a full list of fields consult the specs option.
  - comment: [string=''] A comment for documentation purposes.
  - name: [string=''] Used to identify this particular filter definition.
  - specs: [list(dict)|dict] *One or more specs to be copied.
    - Valid keys:
      - field: [string=''] Name of the destination field.
      - collision: [string='warning'] [warning,error,ignore] How to report a collision between the current value and the new value.
      - policy: [string='overwrite'] [overwrite,update,new] Controls the behavior of the copy mechanism. overwrite always copy the spec value, update copy only if the field already exist, new copy only if the field doesn't exist..
      - spec: [string|list(string)=''] *Name/s of the source spec/s. The following names are uniform across distributors: '_desc', '_value', '_tolerance', '_footprint', '_power', '_current', '_voltage', '_frequency', '_temp_coeff', '_manf' and '_size'.
      - type: [string='string'] [percent,voltage,power,current,value,string] How we compare the current value to determine a collision. value is the component value i.e. resistance for R*.
subparts: Subparts This filter implements the KiCost subparts mechanism.
- Valid keys:
  - check_multiplier: [list(string)] List of fields to include for multiplier computation. If empty all fields in split_fields and manf_pn_field are used.
  - comment: [string=''] A comment for documentation purposes.
  - manf_field: [string='manf'] Field for the manufacturer name.
  - manf_pn_field: [string='manf#'] Field for the manufacturer part number.
  - modify_first_value: [boolean=true] Modify even the value for the first component in the list (KiCost behavior).
  - modify_value: [boolean=true] Add '- p N/M' to the value.
  - mult_separators: [string=':'] Separators used for the multiplier. Each character in this string is a valid separator.
  - multiplier: [boolean=true] Enables the subpart multiplier mechanism.
  - name: [string=''] Used to identify this particular filter definition.
  - ref_sep: [string='#'] Separator used in the reference (i.e. R10#1).
  - separators: [string=';,'] Separators used between subparts. Each character in this string is a valid separator.
  - split_fields: [list(string)] List of fields to split, usually the distributors part numbers.
  - split_fields_expand: [boolean=false] When true the fields in split_fields are added to the internal names.
  - use_ref_sep_for_first: [boolean=true] Force the reference separator use even for the first component in the list (KiCost behavior).
  - value_alt_field: [string='value_subparts'] Field containing replacements for the Value field. So we get real values for split parts.
urlify: URLify Converts URL text in fields to HTML URLs.
- Valid keys:
  - comment: [string=''] A comment for documentation purposes.
  - fields: [string|list(string)='Datasheet'] Fields to convert.
  - name: [string=''] Used to identify this particular filter definition.
value_split: Value_Split This filter extracts information from the value and fills other fields. I.e. extracts the tolerance and puts it in the tolerance field. Usage example.
- Valid keys:
  - autoplace: [boolean=true] Try to figure out the position for the added fields.
  - autoplace_mechanism: [string='bottom'] [bottom,top] Put the new field at the bottom/top of the last field.
  - comment: [string=''] A comment for documentation purposes.
  - name: [string=''] Used to identify this particular filter definition.
  - package: [string='yes'] [yes,no,soft] Policy for the package. yes = overwrite existing value, no = don't touch, soft = copy if not defined.
  - power: [string='yes'] [yes,no,soft] Policy for the power rating. yes = overwrite existing value, no = don't touch, soft = copy if not defined.
  - replace_source: [boolean=true] Replace the content of the source field using a normalized representation of the interpreted value.
  - source: [string='Value'] Name of the field to use as source of information.
  - temp_coef: [string='yes'] [yes,no,soft] Policy for the temperature coefficient. yes = overwrite existing value, no = don't touch, soft = copy if not defined.
  - tolerance: [string='yes'] [yes,no,soft] Policy for the tolerance. yes = overwrite existing value, no = don't touch, soft = copy if not defined.
  - visible: [boolean=false] Make visible the modified fields.
  - voltage: [string='yes'] [yes,no,soft] Policy for the voltage rating. yes = overwrite existing value, no = don't touch, soft = copy if not defined.
var_rename: Var_Rename This filter implements the VARIANT:FIELD=VALUE renamer to get FIELD=VALUE when VARIANT is in use.
- Valid keys:
  - comment: [string=''] A comment for documentation purposes.
  - force_variant: [string=''] Use this variant instead of the current variant. Useful for IBoM variants.
  - name: [string=''] Used to identify this particular filter definition.
  - separator: [string=':'] Separator used between the variant and the field name.
  - variant_to_value: [boolean=false] Rename fields matching the variant to the value of the component.
var_rename_kicost: Var_Rename_KiCost This filter implements the kicost.VARIANT:FIELD=VALUE renamer to get FIELD=VALUE when VARIANT is in use. It applies the KiCost concept of variants (a regex to match the VARIANT). The internal _var_rename_kicost filter emulates the KiCost behavior.
- Valid keys:
  - comment: [string=''] A comment for documentation purposes.
  - name: [string=''] Used to identify this particular filter definition.
  - prefix: [string='kicost.'] A mandatory prefix. Is not case sensitive.
  - separator: [string=':'] Separator used between the variant and the field name.
  - variant: [string=''] Variant regex to match the VARIANT part. When empty the currently selected variant is used.
  - variant_to_value: [boolean=false] Rename fields matching the variant to the value of the component.

Examples for filters

The tests/yaml_samples directory contains all the regression tests. Many of them test the filters functionality.

int_bom_exclude_any.kibot.yaml: Shows how to use regular expressions to match fields and exclude components. Is the more powerful filter mechanism.
int_bom_fil_1.kibot.yaml: Shows various mechanisms. In particular how to change the list of keywords, usually used to match 'DNF', meaning you can exclude components with arbitrary text.
int_bom_fil_2.kibot.yaml: Shows how to use KiCad 5 module attributes (from the PCB) to filter SMD, THT and Virtual components. Note KiCad 6 is redefining the attributes.
int_bom_include_only.kibot.yaml: Shows how to use regular expressions to match only some components, instead of including a few.
int_bom_var_t2is_csv.kibot.yaml: Shows how to use filters and variants simultaneously, not a good idea, but possible.
print_pdf_no_inductors_1.kibot.yaml: Shows how to change the dnf_filter for a KiBoM variant.
print_pdf_no_inductors_2.kibot.yaml: Shows how to do what print_pdf_no_inductors_1.kibot.yaml does but without the need of a variant.

Built-in filters

_datasheet_link converts Datasheet fields containing URLs into HTML links
_expand_text_vars is a default expand_text_vars filter
_kibom_dnc_Config it uses the internal dnc_list to exclude components with
- Value matching any of the keys
- Any of the keys in the Config field (comma or space separated)
_kibom_dnf_Config it uses the internal dnf_list to exclude components with
- Value matching any of the keys
- Any of the keys in the Config field (comma or space separated)
_kicost_dnp used emulate the way KiCost handles the dnp field.
- If the field is 0 the component is included, otherwise excluded.
_kicost_rename is a field_rename filter that applies KiCost renamings.
- Includes all manf# and manf variations supported by KiCost
- Includes all distributor part number variations supported by KiCost
- 'version' -> 'variant'
- 'nopop' -> 'dnp'
- 'description' -> 'desc'
- 'pdf' -> 'datasheet'
_mechanical is used to exclude:
- References that start with #
- Virtual components
- References that match: '^TP[0-9]*' or '^FID'
- Part names that match: 'regex': 'mount.*hole' or 'solder.*bridge' or 'solder.*jump' or 'test.*point'
- Footprints that match: 'test.*point' or 'mount.*hole' or 'fiducial'
_none does nothing, useful when you want to remove a filter with default value
_only_smd is used to get only SMD parts
_only_tht is used to get only THT parts
_only_virtual is used to get only virtual parts
_rot_footprint is a default rot_footprint filter
_value_split splits the Value field but the field remains and the extra data is not visible
_value_split_replace splits the Value field and replaces it
_var_rename is a default var_rename filter
_var_rename_kicost is a default var_rename_kicost filter

Note that the kibom... filters uses a field named Config, but you can customise them invoking _kibom_dnf_FIELD. This will create an equivalent filter, but using the indicated FIELD.

Supported variants:

ibom: IBoM variant style The Config field (configurable) contains a value. If this value matches with a value in the whitelist is included. If this value matches with a value in the blacklist is excluded.
- Valid keys:
  - comment: [string=''] A comment for documentation purposes.
  - dnc_filter: [string|list(string)=''] Name of the filter to mark components as 'Do Not Change'. Use '_kibom_dnc' for the default KiBoM behavior.
  - dnf_filter: [string|list(string)=''] Name of the filter to mark components as 'Do Not Fit'. Use '_kibom_dnf' for the default KiBoM behavior. Use '_kicost_dnp'' for the default KiCost behavior.
  - exclude_filter: [string|list(string)=''] Name of the filter to exclude components from BoM processing. Use '_mechanical' for the default KiBoM behavior.
  - file_id: [string=''] Text to use as the replacement for %v expansion.
  - name: [string=''] Used to identify this particular variant definition.
  - pre_transform: [string|list(string)=''] Name of the filter to transform fields before applying other filters. Use '_var_rename' to transform VARIANT:FIELD fields. Use '_var_rename_kicost' to transform kicost.VARIANT:FIELD fields. Use '_kicost_rename' to apply KiCost field rename rules.
  - sub_pcbs: [list(dict)] Used for multi-board workflows as defined by KiKit. I don't recommend using it, for detail read this. But if you really need it you can define the sub-PCBs here. Then you just use VARIANT[SUB_PCB_NAME] instead of just VARIANT.
    - Valid keys:
      - name: [string=''] Name for this sub-pcb.
      - ref: Alias for reference.
      - reference: [string=''] Use it for the annotations method. This is the reference for the kikit:Board footprint used to identify the sub-PCB. Note that you can use any footprint as long as its position is inside the PCB outline. When empty the sub-PCB is specified using a rectangle.
      - bottom_right_x: Alias for brx.
      - bottom_right_y: Alias for bry.
      - brx: [number|string] The X position of the bottom right corner for the rectangle that contains the sub-PCB.
      - bry: [number|string] The Y position of the bottom right corner for the rectangle that contains the sub-PCB.
      - center_result: [boolean=true] Move the resulting PCB to the center of the page. You can disable it only for the internal tool, KiKit should always do it.
      - file_id: [string=''] Text to use as the replacement for %v expansion. When empty we use the parent file_id plus the name of the sub-PCB.
      - strip_annotation: [boolean=false] Remove the annotation footprint. Note that KiKit will remove all annotations, but the internal implementation just the one indicated by ref. If you need to remove other annotations use an exclude filter.
      - tlx: [number|string] The X position of the top left corner for the rectangle that contains the sub-PCB.
      - tly: [number|string] The Y position of the top left corner for the rectangle that contains the sub-PCB.
      - tolerance: [number|string] Used to enlarge the selected rectangle to include elements outside the board. KiCad 5: To avoid rounding issues this value is set to 0.000002 mm when 0 is specified.
      - tool: [string='internal'] [internal,kikit] Tool used to extract the sub-PCB..
      - top_left_x: Alias for tlx.
      - top_left_y: Alias for tly.
      - units: [string='mm'] [millimeters,inches,mils,mm,cm,dm,m,mil,inch,in] Units used when omitted.
  - variant_field: [string='Config'] Name of the field that stores board variant for component.
  - variants_blacklist: [string|list(string)=''] List of board variants to exclude from the BOM.
  - variants_whitelist: [string|list(string)=''] List of board variants to include in the BOM.
kibom: KiBoM variant style The Config field (configurable) contains a comma separated list of variant directives. -VARIANT excludes a component from VARIANT. +VARIANT includes the component only if we are using this variant.
- Valid keys:
  - comment: [string=''] A comment for documentation purposes.
  - config_field: [string='Config'] Name of the field used to classify components.
  - dnc_filter: [string|list(string)='_kibom_dnc_CONFIG_FIELD'] Name of the filter to mark components as 'Do Not Change'. Use '_kibom_dnc' for the default KiBoM behavior.
  - dnf_filter: [string|list(string)='_kibom_dnf_CONFIG_FIELD'] Name of the filter to mark components as 'Do Not Fit'. Use '_kibom_dnf' for the default KiBoM behavior. Use '_kicost_dnp'_kibom_dnf_CONFIG_FIELD' for the default KiCost behavior.
  - exclude_filter: [string|list(string)='_mechanical'] Name of the filter to exclude components from BoM processing. Use '_mechanical' for the default KiBoM behavior.
  - file_id: [string=''] Text to use as the replacement for %v expansion.
  - name: [string=''] Used to identify this particular variant definition.
  - pre_transform: [string|list(string)=''] Name of the filter to transform fields before applying other filters. Use '_var_rename' to transform VARIANT:FIELD fields. Use '_var_rename_kicost' to transform kicost.VARIANT:FIELD fields. Use '_kicost_rename' to apply KiCost field rename rules.
  - sub_pcbs: [list(dict)] Used for multi-board workflows as defined by KiKit. I don't recommend using it, for detail read this. But if you really need it you can define the sub-PCBs here. Then you just use VARIANT[SUB_PCB_NAME] instead of just VARIANT.
    - Valid keys:
      - name: [string=''] Name for this sub-pcb.
      - ref: Alias for reference.
      - reference: [string=''] Use it for the annotations method. This is the reference for the kikit:Board footprint used to identify the sub-PCB. Note that you can use any footprint as long as its position is inside the PCB outline. When empty the sub-PCB is specified using a rectangle.
      - bottom_right_x: Alias for brx.
      - bottom_right_y: Alias for bry.
      - brx: [number|string] The X position of the bottom right corner for the rectangle that contains the sub-PCB.
      - bry: [number|string] The Y position of the bottom right corner for the rectangle that contains the sub-PCB.
      - center_result: [boolean=true] Move the resulting PCB to the center of the page. You can disable it only for the internal tool, KiKit should always do it.
      - file_id: [string=''] Text to use as the replacement for %v expansion. When empty we use the parent file_id plus the name of the sub-PCB.
      - strip_annotation: [boolean=false] Remove the annotation footprint. Note that KiKit will remove all annotations, but the internal implementation just the one indicated by ref. If you need to remove other annotations use an exclude filter.
      - tlx: [number|string] The X position of the top left corner for the rectangle that contains the sub-PCB.
      - tly: [number|string] The Y position of the top left corner for the rectangle that contains the sub-PCB.
      - tolerance: [number|string] Used to enlarge the selected rectangle to include elements outside the board. KiCad 5: To avoid rounding issues this value is set to 0.000002 mm when 0 is specified.
      - tool: [string='internal'] [internal,kikit] Tool used to extract the sub-PCB..
      - top_left_x: Alias for tlx.
      - top_left_y: Alias for tly.
      - units: [string='mm'] [millimeters,inches,mils,mm,cm,dm,m,mil,inch,in] Units used when omitted.
  - variant: [string|list(string)=''] Board variant(s).
kicost: KiCost variant style The variant field (configurable) contains one or more values. If any of these values matches the variant regex the component is included. By default a pre-transform filter is applied to support kicost.VARIANT:FIELD and field name aliases used by KiCost. Also a default dnf_filter implements the KiCost DNP mechanism.
- Valid keys:
  - comment: [string=''] A comment for documentation purposes.
  - dnc_filter: [string|list(string)=''] Name of the filter to mark components as 'Do Not Change'. Use '_kibom_dnc' for the default KiBoM behavior.
  - dnf_filter: [string|list(string)=''] Name of the filter to mark components as 'Do Not Fit'. Use '_kibom_dnf' for the default KiBoM behavior. Use '_kicost_dnp'' for the default KiCost behavior.
  - exclude_filter: [string|list(string)=''] Name of the filter to exclude components from BoM processing. Use '_mechanical' for the default KiBoM behavior.
  - file_id: [string=''] Text to use as the replacement for %v expansion.
  - name: [string=''] Used to identify this particular variant definition.
  - pre_transform: [string|list(string)=''] Name of the filter to transform fields before applying other filters. Use '_var_rename' to transform VARIANT:FIELD fields. Use '_var_rename_kicost' to transform kicost.VARIANT:FIELD fields. Use '_kicost_rename' to apply KiCost field rename rules.
  - separators: [string=',;/ '] Valid separators for variants in the variant field. Each character is a valid separator. Only supported internally, don't use it if you plan to use KiCost.
  - sub_pcbs: [list(dict)] Used for multi-board workflows as defined by KiKit. I don't recommend using it, for detail read this. But if you really need it you can define the sub-PCBs here. Then you just use VARIANT[SUB_PCB_NAME] instead of just VARIANT.
    - Valid keys:
      - name: [string=''] Name for this sub-pcb.
      - ref: Alias for reference.
      - reference: [string=''] Use it for the annotations method. This is the reference for the kikit:Board footprint used to identify the sub-PCB. Note that you can use any footprint as long as its position is inside the PCB outline. When empty the sub-PCB is specified using a rectangle.
      - bottom_right_x: Alias for brx.
      - bottom_right_y: Alias for bry.
      - brx: [number|string] The X position of the bottom right corner for the rectangle that contains the sub-PCB.
      - bry: [number|string] The Y position of the bottom right corner for the rectangle that contains the sub-PCB.
      - center_result: [boolean=true] Move the resulting PCB to the center of the page. You can disable it only for the internal tool, KiKit should always do it.
      - file_id: [string=''] Text to use as the replacement for %v expansion. When empty we use the parent file_id plus the name of the sub-PCB.
      - strip_annotation: [boolean=false] Remove the annotation footprint. Note that KiKit will remove all annotations, but the internal implementation just the one indicated by ref. If you need to remove other annotations use an exclude filter.
      - tlx: [number|string] The X position of the top left corner for the rectangle that contains the sub-PCB.
      - tly: [number|string] The Y position of the top left corner for the rectangle that contains the sub-PCB.
      - tolerance: [number|string] Used to enlarge the selected rectangle to include elements outside the board. KiCad 5: To avoid rounding issues this value is set to 0.000002 mm when 0 is specified.
      - tool: [string='internal'] [internal,kikit] Tool used to extract the sub-PCB..
      - top_left_x: Alias for tlx.
      - top_left_y: Alias for tly.
      - units: [string='mm'] [millimeters,inches,mils,mm,cm,dm,m,mil,inch,in] Units used when omitted.
  - variant: [string=''] Variants to match (regex).
  - variant_field: [string='variant'] Name of the field that stores board variant/s for component. Only supported internally, don't use it if you plan to use KiCost.

Changing the 3D model, simple mechanism

This mechanism allows small changes to the 3D model. Is simple to use, but the information is located in the schematic.

If a component defines the field _3D_model then its value will replace the 3D model. You can use var_rename or var_rename_kicost filter to define this field only for certain variants. In this way you can change the 3D model according to the component variant.

When the component has more than one 3D model you must provide a comma separated list of models to replace the current models.

Changing the 3D model, complex mechanism

When the a component has a long list of 3D models and you want to keep all the information in the PCB you can use this mechanism.

The information is stored in the Text items of the footprint. If you want to change the 3D models for certain variant you must add an item containing:

%VARIANT_NAME:SLOT1,SLOT2,SLOTN%

Where VARIANT_NAME is the name of the variant that will change the list of 3D models. The SLOT1,SLOT2,SLOTN is a comma separated list of 3D model positions in the list of 3D models. All the slots listed will be enabled, the rest will be disabled.

Here is an example. In this example we have a display whose aspect and connectio can radically change according to the variant. We have two variants:

left, uses a ERM1602DNS-2.1 with a connector on the left and two other pins on the right
top, uses a WH1602B-TMI-JT# with a single connector on the top

We have the following list of 3D models:

${KISYS3DMOD}/Connector_PinHeader_2.54mm.3dshapes/PinHeader_2x07_P2.54mm_Vertical.wrl
${KISYS3DMOD}/Connector_PinHeader_2.54mm.3dshapes/PinHeader_1x16_P2.54mm_Vertical.wrl
${KISYS3DMOD}/Connector_PinHeader_2.54mm.3dshapes/PinHeader_1x01_P2.54mm_Vertical.wrl
${KISYS3DMOD}/Connector_PinHeader_2.54mm.3dshapes/PinHeader_1x01_P2.54mm_Vertical.wrl
${KIPRJMOD}/steps/WH1602B-TMI-JT#.step
${KIPRJMOD}/steps/ERM1602DNS-2.1.step

The ERM1602DNS-2.1 uses slots 1, 3, 4 and 6. So the effective list will be:

${KISYS3DMOD}/Connector_PinHeader_2.54mm.3dshapes/PinHeader_2x07_P2.54mm_Vertical.wrl
${KISYS3DMOD}/Connector_PinHeader_2.54mm.3dshapes/PinHeader_1x01_P2.54mm_Vertical.wrl
${KISYS3DMOD}/Connector_PinHeader_2.54mm.3dshapes/PinHeader_1x01_P2.54mm_Vertical.wrl
${KIPRJMOD}/steps/ERM1602DNS-2.1.step

The WH1602B-TMI-JT# uses slots 2 and 5. So the effective list will be:

${KISYS3DMOD}/Connector_PinHeader_2.54mm.3dshapes/PinHeader_1x16_P2.54mm_Vertical.wrl
${KIPRJMOD}/steps/WH1602B-TMI-JT#.step

To achieve it we define the following texts in the footprint: %left:1,3,4,6% and %top:2,5%. Here are both variants:

If you preffer to use the variant specific matching mechanism you can use the following syntax:

$TEXT_TO_MATCH:SLOT1,SLOT2,SLOTN$

In this case the variant will be applied to the TEXT_TO_MATCH, if it matches (equivalent to a component fitted) the SLOT will be used.

Some important notes:

If you want to control what models are used when no variant is used you'll need to create a default variant. This is what the above example does. In this case the default variant shows all the connectors, but no display. Note that changing the 3D model needs the variants infrastructure.
If you are using variants and a lot of them select the same slots you can add a special text: %_default_:SLOTS%. This will be used if none %VARIANT_NAME:SLOT%` matched.
If you want to disable a model and avoid any kind of warning add _Disabled_by_KiBot to the 3D model path. This could be needed if you want to remove some model and you don't want to adjust the slot numbers.
This mechanism can be used with any of the available variants. For this reason we use the VARIANT_NAME and we avoid relying on any variant specific mechanism. But you can use the alternative syntax if you preffer the variant specific matching system.

DNF and DNC internal keys

The current list of DNF keys is:

dnf
dnl
dnp
do not fit
do not place
do not load
nofit
nostuff
noplace
noload
not fitted
not loaded
not placed
no stuff

The current list of DNC keys is:

dnc
do not change
no change
fixed

You can define your own lists as the int_bom_fil_1.kibot.yaml shows.

The outputs section

In this section you put all the things that you want to generate. This section contains one or more outputs. Each output contain the following data:

name a name so you can easily identify it.
comment a short description of this output.
type selects which type of output will be generated. Examples are gerbers, drill files and pick & place files
dir is the directory where this output will be stored.
extends used to use another output's options as base.
run_by_default indicates this output will be created when no specific outputs are requested.
disable_run_by_default can be used to disable the run_by_default status of other output.
output_id text to use for the %I expansion content.
options contains one or more options to configure this output.
layers a list of layers used for this output. Not all outputs needs this subsection.

Important note about the layers: In the original kiplot (from John Beard) the name of the inner layers was Inner.N where N is the number of the layer, i.e. Inner.1 is the first inner layer. This format is supported for compatibility. Note that this generated a lot of confusion because the default KiCad name for the first inner layer is In1.Cu. People filled issues and submitted pull-requests to fix it, thinking that inner layers weren't supported. Currently KiCad allows renaming these layers, so this version of kiplot supports the name used in KiCad. Just use the same name you see in the user interface.

The available values for type are:

Plot formats:
- gerber the gerbers for fabrication.
- ps postscript plot
- hpgl format for laser printers
- svg scalable vector graphics
- pdf portable document format
- dxf mechanical CAD format
Drill formats:
- excellon data for the drilling machine
- gerb_drill drilling positions in a gerber file
Pick & place
- position of the components for the pick & place machine
Documentation
- pdf_sch_print schematic in PDF format
- svg_sch_print schematic in SVG format
- ps_sch_print schematic in PS format
- dxf_sch_print schematic in DXF format
- hpgl_sch_print schematic in HPGL format
- pdf_pcb_print PDF file containing one or more layer and the page frame
- svg_pcb_print SVG file containing one or more layer and the page frame
- pcb_print PDF/SVG/PNG/EPS/PS, similar to pdf_pcb_print and svg_pcb_print, with more flexibility
- report generates a report about the PDF. Can include images from the above outputs.
- diff creates PDF files showing schematic or PCB changes.
Bill of Materials
- bom The internal BoM generator.
- kibom BoM in HTML or CSV format generated by KiBoM
- ibom Interactive HTML BoM generated by InteractiveHtmlBom
- kicost BoM in XLSX format with costs generated by KiCost
3D model:
- step Standard for the Exchange of Product Data for the PCB
- vrml Virtual Reality Modeling Language for the PCB
- render_3d PCB render, from the KiCad's 3D Viewer
- blender_export PCB export to Blender and high quality 3D render. Including export to: fbx (Kaydara's Filmbox), 'obj' (Wavefront), 'x3d' (ISO/IEC standard), gltf (GL format), stl (3D printing) and 'ply' (Stanford).
Web pages:
- populate To create step-by-step assembly instructions.
- kikit_present To create a project presentation web page.
- navigate_results generates web pages to navigate the generated outputs.
Fabrication helpers:
- panelize creates a PCB panel containing N copies of the PCB.
- stencil_3d creates a 3D self-registering printable stencil.
- stencil_for_jig creates steel stencils and 3D register.
Others:
- boardview creates a file useful to repair the board, but without disclosing the full layout.
- gencad exports the PCB in GENCAD format.
- compress creates an archive containing generated data.
- download_datasheets downloads the datasheets for all the components.
- pcbdraw nice images of the PCB in customized colors.
- pdfunite joins various PDF files into one.
- qr_lib generates symbol and footprints for QR codes.
- sch_variant the schematic after applying all filters and variants, including crossed components.
- pcb_variant the PCB after applying all filters and variants, including modified 3D models.
- copy_files used to copy generated files and source material.
- info creates a report about the tools used during the KiBot run.
- netlist generates the list of connections for the project (classic and IPC-D-356 formats).

Here is an example of a configuration file to generate the gerbers for the top and bottom layers:

kibot:
  version: 1

preflight:
  run_drc: true

outputs:

  - name: 'gerbers'
    comment: "Gerbers for the board house"
    type: gerber
    dir: gerberdir
    options:
      # generic layer options
      exclude_edge_layer: false
      exclude_pads_from_silkscreen: false
      plot_sheet_reference: false
      plot_footprint_refs: true
      plot_footprint_values: true
      force_plot_invisible_refs_vals: false
      tent_vias: true
      line_width: 0.15

      # gerber options
      use_aux_axis_as_origin: false
      subtract_mask_from_silk: true
      use_protel_extensions: false
      gerber_precision: 4.5
      create_gerber_job_file: true
      use_gerber_x2_attributes: true
      use_gerber_net_attributes: false

    layers:
      - 'F.Cu'
      - 'B.Cu'

Most options are the same you'll find in the KiCad dialogs.

Outputs are generated in the order they are declared in the YAML file. To create them in an arbitrary order use the --cli-order command line option and they will be created in the order specified in the command line.

Specifying the layers

You have various ways to specify the layers. If you need to specify just one layer you can just use its name:

    layers: 'F.Cu'

If you want to specify all the available layers:

    layers: 'all'

You can also select the layers you want in KiCad (using File, Plot dialog) and save your PCB. Then you just need to use:

    layers: 'selected'

You can also use any of the following grup of layers:

copper all the copper layers
technical all the technical layers (silk sreen, solder mask, paste, adhesive, etc.)
user all the user layers (draw, comments, eco, margin, edge cuts, etc.)

You can also mix the above definitions using a list:

    layers:
      - 'copper'
      - 'Dwgs.User'

This will select all the copper layers and the user drawings. Note that the above mentioned options will use file name suffixes and descriptions selected automatically. If you want to use a particular suffix and provide better descriptions you can use the following format:

    layers:
      - layer: 'F.Cu'
        suffix: 'F_Cu'
        description: 'Front copper'
      - layer: 'B.Cu'
        suffix: 'B_Cu'
        description: 'Bottom copper'

You can also mix the styles:

    layers:
      - 'copper'
      - layer: 'Cmts.User'
        suffix: 'Cmts_User'
        description: 'User comments'
      - 'Dwgs.User'

If you need to use the same list of layers for various outputs you can use YAML anchors. The first time you define the list of layers just assign an anchor, here is an example:

    layers: &copper_and_cmts
      - copper
      - 'Cmts.User'

Next time you need this list just use an alias, like this:

    layers: *copper_and_cmts

Supported outputs:

Notes:

Most relevant options are listed first and in bold. Which ones are more relevant is quite arbitrary, comments are welcome.
Aliases are listed in italics.

Blender Export Experimental
- Type: blender_export
- Description: Exports the PCB in various 3D file formats. Also renders the PCB with high-quality. Needs KiCad 6 or newer. This output is complex to setup and needs very big dependencies. Please be patient when using it. You need Blender with the pcb2blender plug-in installed. Visit: pcb2blender. You can just generate the exported PCB if no output is specified. You can also export the PCB and render it at the same time
- Valid keys:
  - comment: [string=''] A comment for documentation purposes. It helps to identify the output.
  - dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
  - name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
  - options: [dict] Options for the blender_export output.
    - Valid keys:
      - pcb3d: [string|dict] Options to export the PCB to Blender. You can also specify the name of the output that generates the PCB3D file. See the PCB2Blender_2_1 and PCB2Blender_2_1_haschtl templates.
        
        Valid keys:
        
        download: [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR. They are downloaded to a temporal directory and discarded. If you want to cache the downloaded files specify a directory using the KIBOT_3D_MODELS environment variable.
        
        no_virtual: [boolean=false] Used to exclude 3D models for components with 'virtual' attribute.
        
        show_components: [list(string)|string=all] [none,all] List of components to draw, can be also a string for none or all. Unlike the pcbdraw output, the default is all.
        
        dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
        
        highlight: [list(string)=[]] List of components to highlight.
        
        highlight_on_top: [boolean=false] Highlight over the component (not under).
        
        highlight_padding: [number=1.5] [0,1000] How much the highlight extends around the component [mm].
        
        kicad_3d_url: [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models.
        
        kicad_3d_url_suffix: [string=''] Text added to the end of the download URL. Can be used to pass variables to the GET request, i.e. ?VAR1=VAL1&VAR2=VAL2.
        
        output: [string='%f-%i%I%v.%x'] Name for the generated PCB3D file (%i='blender_export' %x='pcb3d'). Affected by global options.
        
        pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
        
        solder_paste_for_populated: [boolean=true] Add solder paste only for the populated components. Populated components are the ones listed in show_components.
        
        variant: [string=''] Board variant to apply.
        
        version: [string='2.1'] [2.1,2.1_haschtl] Variant of the format used.
      - point_of_view: [dict|list(dict)] How the object is viewed by the camera.
        
        Valid keys:
        
        view: [string='top'] [top,bottom,front,rear,right,left,z,Z,y,Y,x,X] Point of view. Compatible with render_3d.
        
        file_id: [string=''] String to diferentiate the name of this view. When empty we use the view.
        
        rotate_x: [number=0] Angle to rotate the board in the X axis, positive is clockwise [degrees].
        
        rotate_y: [number=0] Angle to rotate the board in the Y axis, positive is clockwise [degrees].
        
        rotate_z: [number=0] Angle to rotate the board in the Z axis, positive is clockwise [degrees].
      - render_options: [dict] Controls how the render is done for the render output type.
        
        Valid keys:
        
        samples: [number=10] How many samples we create. Each sample is a raytracing render. Use 1 for a raw preview, 10 for a draft and 100 or more for the final render.
        
        transparent_background: [boolean=false] Make the background transparent.
        
        auto_crop: [boolean=false] When enabled the image will be post-processed to remove the empty space around the image. In this mode the background2 is changed to be the same as background1.
        
        background1: [string='#66667F'] First color for the background gradient.
        
        background2: [string='#CCCCE5'] Second color for the background gradient.
        
        height: Alias for resolution_y.
        
        resolution_x: [number=1280] Width of the image.
        
        resolution_y: [number=720] Height of the image.
        
        width: Alias for resolution_x.
      - add_default_light: [boolean=true] Add a default light when none specified. The default light is located at (-size3.33, size3.33, size*5) where size is max(width, height) of the PCB.
      - camera: [dict] Options for the camera. If none specified KiBot will create a suitable camera. If no position is specified for the camera KiBot will look for a suitable position.
        
        Valid keys:
        
        name: [string=''] Name for the camera.
        
        pos_x: [number|string] X position [m]. You can use width, height and size for PCB dimensions.
        
        pos_y: [number|string] Y position [m]. You can use width, height and size for PCB dimensions.
        
        pos_z: [number|string] Z position [m]. You can use width, height and size for PCB dimensions.
        
        type: [string='perspective'] [perspective,orthographic,panoramic] Type of camera.
      - light: [dict|list(dict)] Options for the light/s.
        
        Valid keys:
        
        energy: [number=0] How powerful is the light. Using 0 for POINT and SUN KiBot will try to use something useful.
        
        name: [string=''] Name for the light.
        
        pos_x: [number|string] X position [m]. You can use width, height and size for PCB dimensions.
        
        pos_y: [number|string] Y position [m]. You can use width, height and size for PCB dimensions.
        
        pos_z: [number|string] Z position [m]. You can use width, height and size for PCB dimensions.
        
        type: [string='POINT'] [POINT, SUN, SPOT, HEMI, AREA] Type of light. SUN lights will illuminate more evenly.
      - outputs: [dict|list(dict)] Outputs to generate in the same run.
        
        Valid keys:
        
        type: [string='render'] [fbx,obj,x3d,gltf,stl,ply,blender,render] The format for the output. The render type will generate a PNG image of the render result. fbx is Kaydara's Filmbox, 'obj' is the Wavefront, 'x3d' is the new ISO/IEC standard that replaced VRML, gltf is the standardized GL format, stl is the 3D printing format, 'ply' is Polygon File Format (Stanford). Note that some formats includes the light and camera and others are just the 3D model (i.e. STL and PLY).
        
        output: [string='%f-%i%I%v.%x'] Name for the generated file (%i='3D_blender_$VIEW' %x=VARIABLE). The extension is selected from the type. Affected by global options.
      - pcb_import: Options to configure how Blender imports the PCB. The default values are good for most cases.
        
        Valid keys:
        
        center: [boolean=true] Center the PCB at the coordinates origin.
        
        components: [boolean=true] Import the components.
        
        cut_boards: [boolean=true] Separate the sub-PCBs in separated 3D models.
        
        enhance_materials: [boolean=true] Create good looking materials.
        
        merge_materials: [boolean=true] Reuse materials.
        
        solder_joints: [string='SMART'] [NONE,SMART,ALL] The plug-in can add nice looking solder joints. This option controls if we add it for none, all or only for THT/SMD pads with solder paste.
        
        stack_boards: [boolean=true] Move the sub-PCBs to their relative position.
        
        texture_dpi: [number=1016.0] [508-2032] Texture density in dots per inch.
  - category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
  - disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
  - extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
  - groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
  - output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
  - priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
  - run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.
BoardView
- Type: boardview
- Description: Exports the PCB in board view format. This format allows simple pads and connections navigation, mainly for circuit debug. The output can be loaded using Open Board View (https://openboardview.org/)
- Valid keys:
  - comment: [string=''] A comment for documentation purposes. It helps to identify the output.
  - dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
  - name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
  - options: [dict] Options for the boardview output.
    - Valid keys:
      - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=boardview, %x=brd). Affected by global options.
      - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
      - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
      - variant: [string=''] Board variant to apply. Used for sub-PCBs.
  - category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
  - disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
  - extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
  - groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
  - output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
  - priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
  - run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.
BoM (Bill of Materials)
- Type: bom
- Description: Used to generate the BoM in CSV, HTML, TSV, TXT, XML or XLSX format using the internal BoM. This output can generate XYRS files (pick and place files). Is compatible with KiBoM, but doesn't need to update the XML netlist because the components are loaded from the schematic. Important differences with KiBoM output: - All options are in the main options section, not in conf subsection. - The Component column is named Row and works just like any other column. This output is what you get from the 'Tools/Generate Bill of Materials' menu in eeschema.
- Valid keys:
  - comment: [string=''] A comment for documentation purposes. It helps to identify the output.
  - dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
  - name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
  - options: [dict] Options for the bom output.
    - Valid keys:
      - columns: [list(dict)|list(string)] List of columns to display. Can be just the name of the field.
        
        Valid keys:
        
        field: [string=''] Name of the field to use for this column. Use _field_lcsc_part to get the value defined in the global options.
        
        name: [string=''] Name to display in the header. The field is used when empty.
        
        comment: [string=''] Used as explanation for this column. The XLSX output uses it.
        
        join: [list(dict)|list(string)|string=''] List of fields to join to this column.
        
        Valid keys:
        
        field: [string=''] Name of the field.
        
        text: [string=''] Text to use instead of a field. This option is incompatible with the field option. Any space to separate it should be added in the text. Use \n for newline and \t for tab.
        
        text_after: [string=''] Text to add after the field content. Will be added only if the field isn't empty. Any space to separate it should be added in the text. Use \n for newline and \t for tab.
        
        text_before: [string=''] Text to add before the field content. Will be added only if the field isn't empty. Any space to separate it should be added in the text. Use \n for newline and \t for tab.
        
        level: [number=0] Used to group columns. The XLSX output uses it to collapse columns.
      - csv: [dict] Options for the CSV, TXT and TSV formats.
        
        Valid keys:
        
        quote_all: [boolean=false] Enclose all values using double quotes.
        
        separator: [string=','] CSV Separator. TXT and TSV always use tab as delimiter. Only one character can be specified.
        
        hide_header: [boolean=false] Hide the header line (names of the columns).
        
        hide_pcb_info: [boolean=false] Hide project information.
        
        hide_stats_info: [boolean=false] Hide statistics information.
      - format: [string=''] [HTML,CSV,TXT,TSV,XML,XLSX,HRTXT] format for the BoM. Defaults to CSV or a guess according to the options. HRTXT stands for Human Readable TeXT.
      - group_fields: [list(string)] List of fields used for sorting individual components into groups. Components which match (comparing all fields) will be grouped together. Field names are case-insensitive. If empty: ['Part', 'Part Lib', 'Value', 'Footprint', 'Footprint Lib', 'Voltage', 'Tolerance', 'Current', 'Power'] is used.
      - hrtxt: [dict] Options for the HRTXT formats.
        
        Valid keys:
        
        separator: [string='I'] Column Separator.
        
        header_sep: [string='-'] Separator between the header and the data.
        
        hide_header: [boolean=false] Hide the header line (names of the columns).
        
        hide_pcb_info: [boolean=false] Hide project information.
        
        hide_stats_info: [boolean=false] Hide statistics information.
        
        justify: [string='left'] [left,right,center] Text justification.
      - html: [dict] Options for the HTML format.
        
        Valid keys:
        
        datasheet_as_link: [string=''] Column with links to the datasheet.
        
        generate_dnf: [boolean=true] Generate a separated section for DNF (Do Not Fit) components.
        
        logo: [string|boolean=''] PNG file to use as logo, use false to remove.
        
        title: [string='KiBot Bill of Materials'] BoM title.
        
        col_colors: [boolean=true] Use colors to show the field type.
        
        digikey_link: [string|list(string)=''] Column/s containing Digi-Key part numbers, will be linked to web page.
        
        extra_info: [string|list(string)=''] Information to put after the title and before the pcb and stats info.
        
        hide_pcb_info: [boolean=false] Hide project information.
        
        hide_stats_info: [boolean=false] Hide statistics information.
        
        highlight_empty: [boolean=true] Use a color for empty cells. Applies only when col_colors is true.
        
        mouser_link: [string|list(string)=''] Column/s containing Mouser part numbers, will be linked to web page.
        
        style: [string='modern-blue'] Page style. Internal styles: modern-blue, modern-green, modern-red and classic. Or you can provide a CSS file name. Please use .css as file extension..
      - ignore_dnf: [boolean=true] Exclude DNF (Do Not Fit) components.
      - normalize_values: [boolean=false] Try to normalize the R, L and C values, producing uniform units and prefixes.
      - number: [number=1] Number of boards to build (components multiplier).
      - output: [string='%f-%i%I%v.%x'] filename for the output (%i=bom). Affected by global options.
      - sort_style: [string='type_value'] [type_value,type_value_ref,ref] Sorting criteria.
      - units: [string='millimeters'] [millimeters,inches,mils] Units used for the positions ('Footprint X' and 'Footprint Y' columns). Affected by global options.
      - xlsx: [dict] Options for the XLSX format.
        
        Valid keys:
        
        datasheet_as_link: [string=''] Column with links to the datasheet.
        
        generate_dnf: [boolean=true] Generate a separated section for DNF (Do Not Fit) components.
        
        kicost: [boolean=false] Enable KiCost worksheet creation. Note: an example of how to use it on CI/CD can be found here.
        
        logo: [string|boolean=''] PNG file to use as logo, use false to remove.
        
        specs: [boolean=false] Enable Specs worksheet creation. Contains specifications for the components. Works with only some KiCost APIs.
        
        title: [string='KiBot Bill of Materials'] BoM title.
        
        col_colors: [boolean=true] Use colors to show the field type.
        
        digikey_link: [string|list(string)=''] Column/s containing Digi-Key part numbers, will be linked to web page.
        
        extra_info: [string|list(string)=''] Information to put after the title and before the pcb and stats info.
        
        hide_pcb_info: [boolean=false] Hide project information.
        
        hide_stats_info: [boolean=false] Hide statistics information.
        
        highlight_empty: [boolean=true] Use a color for empty cells. Applies only when col_colors is true.
        
        kicost_api_disable: [string|list(string)=''] List of KiCost APIs to disable.
        
        kicost_api_enable: [string|list(string)=''] List of KiCost APIs to enable.
        
        kicost_config: [string=''] KiCost configuration file. It contains the keys for the different distributors APIs. The regular KiCost config is used when empty. Important for CI/CD environments: avoid exposing your API secrets! To understand how to achieve this, and also how to make use of the cache please visit the kicost_ci_test repo.
        
        kicost_dist_desc: [boolean=false] Used to add a column with the distributor's description. So you can check this is the right component.
        
        logo_scale: [number=2] Scaling factor for the logo. Note that this value isn't honored by all spreadsheet software.
        
        max_col_width: [number=60] [20,999] Maximum column width (characters).
        
        mouser_link: [string|list(string)=''] Column/s containing Mouser part numbers, will be linked to web page.
        
        specs_columns: [list(dict)|list(string)] Which columns are included in the Specs worksheet. Use References for the references, 'Row' for the order and 'Sep' to separate groups at the same level. By default all are included. Column names are distributor specific, the following aren't: '_desc', '_value', '_tolerance', '_footprint', '_power', '_current', '_voltage', '_frequency', '_temp_coeff', '_manf', '_size'.
        
        Valid keys:
        
        field: [string=''] Name of the field to use for this column. Use _field_lcsc_part to get the value defined in the global options.
        
        name: [string=''] Name to display in the header. The field is used when empty.
        
        comment: [string=''] Used as explanation for this column. The XLSX output uses it.
        
        join: [list(dict)|list(string)|string=''] List of fields to join to this column.
        
        Valid keys:
        
        field: [string=''] Name of the field.
        
        text: [string=''] Text to use instead of a field. This option is incompatible with the field option. Any space to separate it should be added in the text. Use \n for newline and \t for tab.
        
        text_after: [string=''] Text to add after the field content. Will be added only if the field isn't empty. Any space to separate it should be added in the text. Use \n for newline and \t for tab.
        
        text_before: [string=''] Text to add before the field content. Will be added only if the field isn't empty. Any space to separate it should be added in the text. Use \n for newline and \t for tab.
        
        level: [number=0] Used to group columns. The XLSX output uses it to collapse columns.
        
        style: [string='modern-blue'] Head style: modern-blue, modern-green, modern-red and classic.
    - aggregate: [list(dict)] Add components from other projects. You can use CSV files, the first row must contain the names of the fields. The Reference and Value are mandatory, in most cases Part is also needed. The Part column should contain the name/type of the component. This is important for passive components (R, L, C, etc.). If this information isn't available consider configuring the grouping to exclude the Part..
      - Valid keys:
        
        delimiter: [string=','] Delimiter used for CSV files.
        
        file: [string=''] Name of the schematic to aggregate.
        
        name: [string=''] Name to identify this source. If empty we use the name of the schematic.
        
        number: [number=1] Number of boards to build (components multiplier). Use negative to subtract.
        
        ref_id: [string=''] A prefix to add to all the references from this project.
    - angle_positive: [boolean=true] Always use positive values for the footprint rotation.
    - bottom_negative_x: [boolean=false] Use negative X coordinates for footprints on bottom layer (for XYRS).
    - component_aliases: [list(list(string))] A series of values which are considered to be equivalent for the part name. Each entry is a list of equivalen names. Example: ['c', 'c_small', 'cap' ] will ensure the equivalent capacitor symbols can be grouped together. If empty the following aliases are used: - ['r', 'r_small', 'res', 'resistor'] - ['l', 'l_small', 'inductor'] - ['c', 'c_small', 'cap', 'capacitor'] - ['sw', 'switch'] - ['zener', 'zenersmall'] - ['d', 'diode', 'd_small'].
    - cost_extra_columns: [list(dict)|list(string)] List of columns to add to the global section of the cost. Can be just the name of the field.
      - Valid keys:
        
        field: [string=''] Name of the field to use for this column. Use _field_lcsc_part to get the value defined in the global options.
        
        name: [string=''] Name to display in the header. The field is used when empty.
        
        comment: [string=''] Used as explanation for this column. The XLSX output uses it.
        
        join: [list(dict)|list(string)|string=''] List of fields to join to this column.
        
        Valid keys:
        
        field: [string=''] Name of the field.
        
        text: [string=''] Text to use instead of a field. This option is incompatible with the field option. Any space to separate it should be added in the text. Use \n for newline and \t for tab.
        
        text_after: [string=''] Text to add after the field content. Will be added only if the field isn't empty. Any space to separate it should be added in the text. Use \n for newline and \t for tab.
        
        text_before: [string=''] Text to add before the field content. Will be added only if the field isn't empty. Any space to separate it should be added in the text. Use \n for newline and \t for tab.
        
        level: [number=0] Used to group columns. The XLSX output uses it to collapse columns.
    - count_smd_tht: [boolean=false] Show the stats about how many of the components are SMD/THT. You must provide the PCB.
    - distributors: [string|list(string)] Include this distributors list. Default is all the available.
    - dnc_filter: [string|list(string)='_kibom_dnc'] Name of the filter to mark components as 'Do Not Change'. The default filter marks components with a DNC value or DNC in the Config field. This option is for simple cases, consider using a full variant for complex cases.
    - dnf_filter: [string|list(string)='_kibom_dnf'] Name of the filter to mark components as 'Do Not Fit'. The default filter marks components with a DNF value or DNF in the Config field. This option is for simple cases, consider using a full variant for complex cases.
    - exclude_filter: [string|list(string)='_mechanical'] Name of the filter to exclude components from BoM processing. The default filter excludes test points, fiducial marks, mounting holes, etc. This option is for simple cases, consider using a full variant for complex cases.
    - exclude_marked_in_pcb: [boolean=false] Exclude components marked with Exclude from BOM in the PCB. This is a KiCad 6 option.
    - exclude_marked_in_sch: [boolean=true] Exclude components marked with Exclude from bill of materials in the schematic. This is a KiCad 6 option.
    - expand_text_vars: [boolean=true] Expand KiCad 6 text variables after applying all filters and variants. This is done using a _expand_text_vars filter. If you need to customize the filter, or apply it before, you can disable this option and add a custom filter to the filter chain.
    - fit_field: [string='Config'] Field name used for internal filters (not for variants).
    - footprint_populate_values: [string|list(string)='no,yes'] Values for the Footprint Populate column.
    - footprint_type_values: [string|list(string)='SMD,THT,VIRTUAL'] Values for the Footprint Type column.
    - group_connectors: [boolean=true] Connectors with the same footprints will be grouped together, independent of the name of the connector.
    - group_fields_fallbacks: [list(string)] List of fields to be used when the fields in group_fields are empty. The first field in this list is the fallback for the first in group_fields, and so on.
    - int_qtys: [boolean=true] Component quantities are always expressed as integers. Using the ceil() function.
    - merge_blank_fields: [boolean=true] Component groups with blank fields will be merged into the most compatible group, where possible.
    - merge_both_blank: [boolean=true] When creating groups two components with empty/missing field will be interpreted as with the same value.
    - no_conflict: [list(string)] List of fields where we tolerate conflicts. Use it to avoid undesired warnings. By default the field indicated in fit_field, the field used for variants and the field part are excluded.
    - no_distributors: [string|list(string)] Exclude this distributors list. They are removed after computing distributors.
    - normalize_locale: [boolean=false] When normalizing values use the locale decimal point.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. This option is for simple cases, consider using a full variant for complex cases.
    - ref_id: [string=''] A prefix to add to all the references from this project. Used for multiple projects.
    - ref_separator: [string=' '] Separator used for the list of references.
    - source_by_id: [boolean=false] Generate the Source BoM column using the reference ID instead of the project name.
    - use_alt: [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18.
    - use_aux_axis_as_origin: [boolean=true] Use the auxiliary axis as origin for coordinates (KiCad default) (for XYRS).
    - variant: [string=''] Board variant, used to determine which components are output to the BoM..
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Archiver (files compressor)

Type: compress
Description: Generates a compressed file containing output files. This is used to generate groups of files in compressed file format.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the compress output.
  - Valid keys:
    - files: [list(dict)] Which files will be included.
      - Valid keys:
        
        from_output: [string=''] Collect files from the selected output. When used the source option is ignored.
        
        source: [string='*'] File names to add, wildcards allowed. Use ** for recursive match. By default this pattern is applied to the output dir specified with -d command line option. See the from_cwd and from_output_dir options.
        
        dest: [string=''] Destination directory inside the archive, empty means the same of the file.
        
        filter: [string='.*'] A regular expression that source files must match.
        
        from_cwd: [boolean=false] Use the current working directory instead of the dir specified by -d.
        
        from_output_dir: [boolean=false] Use the current directory specified by the output instead of the dir specified by -d. Note that it only applies when using from_output and no dest is specified. It has more prescedence than from_cwd.
    - format: [string='ZIP'] [ZIP,TAR,RAR] Output file format.
    - output: [string='%f-%i%I%v.%x'] Name for the generated archive (%i=name of the output %x=according to format). Affected by global options.
    - compression: [string='auto'] [auto,stored,deflated,bzip2,lzma] Compression algorithm. Use auto to let KiBot select a suitable one.
    - follow_links: [boolean=true] Store the file pointed by symlinks, not the symlink.
    - move_files: [boolean=false] Move the files to the archive. In other words: remove the files after adding them to the archive.
    - remove_files: Alias for move_files.
    - skip_not_run: [boolean=false] Skip outputs with run_by_default: false.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=10] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Files copier

Type: copy_files
Description: Used to copy files to the output directory. Useful when an external tool is used to compress the output directory. Note that you can use the compress output to create archives
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the copy_files output.
  - Valid keys:
    - download: [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR. They are downloaded to a temporal directory and discarded. If you want to cache the downloaded files specify a directory using the KIBOT_3D_MODELS environment variable.
    - files: [list(dict)] Which files will be included.
      - Valid keys:
        
        source: [string='*'] File names to add, wildcards allowed. Use ** for recursive match. By default this pattern is applied to the current working dir. See the from_outdir option.
        
        source_type: [string='files'] [files,out_files,output,3d_models] How to interpret source. files: is a pattern for files relative to the working directory. out_files: is a pattern for files relative to output dir specified with -d command line option. output: is the name of an output. 3d_models: is a pattern to match the name of the 3D models extracted from the PCB..
        
        dest: [string=''] Destination directory inside the output dir, empty means the same of the file relative to the source directory. For the 3d_models type you can use DIR+ to create subdirs under DIR.
        
        filter: [string='.*'] A regular expression that source files must match.
        
        save_pcb: [boolean=false] Only usable for the 3d_models mode. Save a PCB copy modified to use the copied 3D models.
    - no_virtual: [boolean=false] Used to exclude 3D models for components with 'virtual' attribute.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - follow_links: [boolean=true] Store the file pointed by symlinks, not the symlink.
    - kicad_3d_url: [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models.
    - kicad_3d_url_suffix: [string=''] Text added to the end of the download URL. Can be used to pass variables to the GET request, i.e. ?VAR1=VAL1&VAR2=VAL2.
    - link_no_copy: [boolean=false] Create symlinks instead of copying files.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=11] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Diff

Type: diff
Description: Generates a PDF with the differences between two PCBs or schematics. Recursive git submodules aren't supported (submodules inside submodules)
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to use. When empty all available layers are used. Note that if you want to support adding/removing layers you should specify a list here.
  - Valid keys:
    - description: [string=''] A description for the layer, for documentation purposes.
    - layer: [string=''] Name of the layer. As you see it in KiCad.
    - suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the diff output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=diff_pcb/diff_sch, %x=pdf). Affected by global options.
    - add_link_id: [boolean=false] When enabled we create a symlink to the output file with a name that contains the git hashes involved in the comparison. If you plan to compress the output don't forget to disable the follow_links option.
    - always_fail_if_missing: [boolean=false] Always fail if the old/new file doesn't exist. Currently we don't fail if they are from a repo. So if you refer to a repo point where the file wasn't created KiBot will use an empty file. Enabling this option KiBot will report an error.
    - cache_dir: [string=''] Directory to cache the intermediate files. Leave it blank to disable the cache.
    - copy_instead_of_link: [boolean=false] Modifies the behavior of add_link_id to create a copy of the file instead of a symlink. Useful for some Windows setups.
    - diff_mode: [string='red_green'] [red_green,stats] In the red_green mode added stuff is green and red when removed. The stats mode is used to meassure the amount of difference. In this mode all changes are red, but you can abort if the difference is bigger than certain threshold.
    - force_checkout: [boolean=false] When old_type and/or new_type are git KiBot will checkout the indicated point. Before doing it KiBot will stash any change. Under some circumstances git could fail to do a checkout, even after stashing, this option can workaround the problem. Note that using it you could potentially lose modified files. For more information read https://stackoverflow.com/questions/1248029/git-pull-error-entry-foo-not-uptodate-cannot-merge.
    - fuzz: [number=5] [0,100] Color tolerance (fuzzyness) for the stats mode.
    - new: [string|list(string)] The file you want to compare. Leave it blank for the current PCB/SCH. A list is accepted only for the multivar type. Consult the old option for more information.
    - new_type: [string='current'] [git,file,output,multivar,current] How to interpret the new name. Use git for a git hash, branch, etc. Use current for the currently loaded PCB/Schematic. Use file for a file name. Use output to specify the name of a pcb_variant/sch_variant output. Use multivar to compare a set of variants, in this mode new is the list of outputs for the variants. This is an extension of the output mode. If old is also multivar then it becomes the reference, otherwise we compare using pairs of variants.
    - old: [string='HEAD'] Reference file. When using git use HEAD to refer to the last commit. Use HEAD~ to refer the previous to the last commit. As HEAD is for the whole repo you can use KIBOT_LAST-n to make reference to the changes in the PCB/SCH. The n value is how many changes in the history you want to go back. A 0 is the same as HEAD, a 1 means the last time the PCB/SCH was changed, etc. Use KIBOT_TAG-n to search for the last tag skipping n tags. Important: when using the checkout GitHub action you just get the last commit. To clone the full repo use fetch-depth: '0'.
    - old_type: [string='git'] [git,file,output,multivar] How to interpret the old name. Use git for a git hash, branch, etc. Use file for a file name. Use output to specify the name of a pcb_variant/sch_variant output. Use multivar to specify a reference file when new_type is also multivar.
    - only_different: [boolean=false] Only include the pages with differences in the output PDF. Note that when no differeces are found we get a page saying No diff.
    - only_first_sch_page: [boolean=false] Compare only the main schematic page (root page).
    - pcb: [boolean=true] Compare the PCB, otherwise compare the schematic.
    - threshold: [number=0] [0,1000000] Error threshold for the stats mode, 0 is no error. When specified a difference bigger than the indicated value will make the diff fail. KiBot will return error level 29 and the diff generation will be aborted.
    - use_file_id: [boolean=false] When creating the link name of an output file related to a variant use the variant file_id instead of its name.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Datasheets downloader

Type: download_datasheets
Description: Downloads the datasheets for the project
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the download_datasheets output.
  - Valid keys:
    - field: [string='Datasheet'] Name of the field containing the URL.
    - dnf: [boolean=false] Include the DNF components.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - link_repeated: [boolean=true] Instead of download things we already downloaded use symlinks.
    - output: [string='${VALUE}.pdf'] Name used for the downloaded datasheet. ${FIELD} will be replaced by the FIELD content.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - repeated: [boolean=false] Download URLs that we already downloaded. It only makes sense if the output field makes their output different.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

DXF (Drawing Exchange Format)

Type: dxf
Description: Exports the PCB to 2D mechanical EDA tools (like AutoCAD). This output is what you get from the File/Plot menu in pcbnew. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to plot.
  - Valid keys:
    - description: [string=''] A description for the layer, for documentation purposes.
    - layer: [string=''] Name of the layer. As you see it in KiCad.
    - suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the dxf output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Output file name, the default KiCad name if empty. IMPORTANT! KiCad will always create the file using its own name and then we can rename it. For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options.
    - plot_sheet_reference: [boolean=false] Include the frame and title block. Only available for KiCad 6+ and you get a poor result (i.e. always the default worksheet style, also problems expanding text variables). The pcb_print output can do a better job for PDF, SVG, PS, EPS and PNG outputs.
    - scaling: [number=1] Scale factor (0 means autoscaling).
    - custom_reports: [list(dict)] A list of customized reports for the manufacturer.
      - Valid keys:
        
        content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
        
        output: [string='Custom_report.txt'] File name for the custom report.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - drill_marks: [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale).
    - edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
    - exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
    - exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
    - force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
    - individual_page_scaling: [boolean=true] Tell KiCad to apply the scaling for each layer as a separated entity. Disabling it the pages are coherent and can be superposed.
    - inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
    - metric_units: [boolean=false] Use mm instead of inches.
    - plot_footprint_refs: [boolean=true] Include the footprint references.
    - plot_footprint_values: [boolean=true] Include the footprint values.
    - polygon_mode: [boolean=true] Plot using the contour, instead of the center line. You must disable it to get the dimensions (See https://gitlab.com/kicad/code/kicad/-/issues/11901).
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - sketch_pad_line_width: [number=0.1] Line width for the sketched pads [mm], see sketch_pads_on_fab_layers (KiCad 6+) Note that this value is currently ignored by KiCad (6.0.9).
    - sketch_pads_on_fab_layers: [boolean=false] Draw only the outline of the pads on the *.Fab layers (KiCad 6+).
    - sketch_plot: [boolean=false] Don't fill objects, just draw the outline.
    - tent_vias: [boolean=true] Cover the vias.
    - uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
    - use_aux_axis_as_origin: [boolean=false] Use the auxiliary axis as origin for coordinates.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

DXF Schematic Print (Drawing Exchange Format)

Type: dxf_sch_print
Description: Exports the schematic to a format commonly used for CAD software. This output is what you get from the 'File/Plot' menu in eeschema. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the dxf_sch_print output.
  - Valid keys:
    - frame: [boolean=true] Include the frame and title block.
    - all_pages: [boolean=true] Generate with all hierarchical sheets.
    - background_color: [boolean=false] Use the background color from the color_theme (KiCad 6).
    - color_theme: [string=''] Color theme used, this must exist in the KiCad config (KiCad 6).
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - monochrome: [boolean=false] Generate a monochromatic output.
    - output: [string='%f-%i%I%v.%x'] Filename for the output DXF (%i=schematic, %x=dxf). Affected by global options.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - title: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.
    - variant: [string=''] Board variant to apply. Not fitted components are crossed.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Excellon drill format

Type: excellon
Description: This is the main format for the drilling machine. You can create a map file for documentation purposes. This output is what you get from the 'File/Fabrication output/Drill Files' menu in pcbnew.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the excellon output.
  - Valid keys:
    - metric_units: [boolean=true] Use metric units instead of inches.
    - mirror_y_axis: [boolean=false] Invert the Y axis.
    - output: [string='%f-%i%I%v.%x'] name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options.
    - pth_and_npth_single_file: [boolean=true] Generate one file for both, plated holes and non-plated holes, instead of two separated files.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - left_digits: [number=0] number of digits for integer part of coordinates (0 is auto).
    - map: [dict|string] [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map. Not generated unless a format is specified.
      - Valid keys:
        
        output: [string='%f-%i%I%v.%x'] Name for the map file, KiCad defaults if empty (%i='PTH_drill_map'). Affected by global options.
        
        type: [string='pdf'] [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map.
    - minimal_header: [boolean=false] Use a minimal header in the file.
    - npth_id: [string] Force this replacement for %i when generating NPTH files.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - pth_id: [string] Force this replacement for %i when generating PTH and unified files.
    - report: [dict|string] Name of the drill report. Not generated unless a name is specified.
      - Valid keys:
        
        filename: [string=''] Name of the drill report. Not generated unless a name is specified. (%i='drill_report' %x='txt').
    - right_digits: [number=0] number of digits for mantissa part of coordinates (0 is auto).
    - route_mode_for_oval_holes: [boolean=true] Use route command for oval holes (G00), otherwise use G85.
    - use_aux_axis_as_origin: [boolean=false] Use the auxiliary axis as origin for coordinates.
    - variant: [string=''] Board variant to apply. Used for sub-PCBs.
    - zeros_format: [string='DECIMAL_FORMAT'] [DECIMAL_FORMAT,SUPPRESS_LEADING,SUPPRESS_TRAILING,KEEP_ZEROS] How to handle the zeros.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

GenCAD

Type: gencad
Description: Exports the PCB in GENCAD format. This format is interpreted by some CADCAM software and helps certain manufacturers
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the gencad output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=gencad, %x=cad). Affected by global options.
    - aux_origin: [boolean=false] Use auxiliary axis as origin.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - flip_bottom_padstacks: [boolean=false] Flip bottom footprint padstacks.
    - no_reuse_shapes: [boolean=false] Generate a new shape for each footprint instance (Do not reuse shapes).
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - save_origin: [boolean=false] Save the origin coordinates in the file.
    - unique_pin_names: [boolean=false] Generate unique pin names.
    - variant: [string=''] Board variant to apply. Used for sub-PCBs.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Gerber drill format

Type: gerb_drill
Description: This is the information for the drilling machine in gerber format. You can create a map file for documentation purposes. This output is what you get from the 'File/Fabrication output/Drill Files' menu in pcbnew.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the gerb_drill output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] name for the drill file, KiCad defaults if empty (%i='PTH_drill'). Affected by global options.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - map: [dict|string] [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map. Not generated unless a format is specified.
      - Valid keys:
        
        output: [string='%f-%i%I%v.%x'] Name for the map file, KiCad defaults if empty (%i='PTH_drill_map'). Affected by global options.
        
        type: [string='pdf'] [hpgl,ps,gerber,dxf,svg,pdf] Format for a graphical drill map.
    - npth_id: [string] Force this replacement for %i when generating NPTH files.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - pth_id: [string] Force this replacement for %i when generating PTH and unified files.
    - report: [dict|string] Name of the drill report. Not generated unless a name is specified.
      - Valid keys:
        
        filename: [string=''] Name of the drill report. Not generated unless a name is specified. (%i='drill_report' %x='txt').
    - use_aux_axis_as_origin: [boolean=false] Use the auxiliary axis as origin for coordinates.
    - variant: [string=''] Board variant to apply. Used for sub-PCBs.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Gerber format

Type: gerber
Description: This is the main fabrication format for the PCB. This output is what you get from the File/Plot menu in pcbnew. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to plot.
  - Valid keys:
    - description: [string=''] A description for the layer, for documentation purposes.
    - layer: [string=''] Name of the layer. As you see it in KiCad.
    - suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the gerber output.
  - Valid keys:
    - create_gerber_job_file: [boolean=true] Creates a file with information about all the generated gerbers. You can use it in gerbview to load all gerbers at once.
    - output: [string='%f-%i%I%v.%x'] Output file name, the default KiCad name if empty. IMPORTANT! KiCad will always create the file using its own name and then we can rename it. For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options.
    - plot_sheet_reference: [boolean=false] Include the frame and title block. Only available for KiCad 6+ and you get a poor result (i.e. always the default worksheet style, also problems expanding text variables). The pcb_print output can do a better job for PDF, SVG, PS, EPS and PNG outputs.
    - subtract_mask_from_silk: [boolean=false] Subtract the solder mask from the silk screen.
    - use_gerber_net_attributes: [boolean=true] Include netlist metadata.
    - use_gerber_x2_attributes: [boolean=true] Use the extended X2 format (otherwise use X1 formerly RS-274X).
    - use_protel_extensions: [boolean=false] Use legacy Protel file extensions.
    - custom_reports: [list(dict)] A list of customized reports for the manufacturer.
      - Valid keys:
        
        content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
        
        output: [string='Custom_report.txt'] File name for the custom report.
    - disable_aperture_macros: [boolean=false] Disable aperture macros (workaround for buggy CAM software) (KiCad 6).
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
    - exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
    - exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
    - force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
    - gerber_job_file: [string='%f-%i%I%v.%x'] Name for the gerber job file (%i='job', %x='gbrjob'). Affected by global options.
    - gerber_precision: [number=4.6] This the gerber coordinate format, can be 4.5 or 4.6.
    - inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
    - line_width: [number=0.1] [0.02,2] Line_width for objects without width [mm] (KiCad 5).
    - plot_footprint_refs: [boolean=true] Include the footprint references.
    - plot_footprint_values: [boolean=true] Include the footprint values.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - sketch_pad_line_width: [number=0.1] Line width for the sketched pads [mm], see sketch_pads_on_fab_layers (KiCad 6+) Note that this value is currently ignored by KiCad (6.0.9).
    - sketch_pads_on_fab_layers: [boolean=false] Draw only the outline of the pads on the *.Fab layers (KiCad 6+).
    - tent_vias: [boolean=true] Cover the vias.
    - uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
    - use_aux_axis_as_origin: [boolean=false] Use the auxiliary axis as origin for coordinates.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

HPGL (Hewlett & Packard Graphics Language)

Type: hpgl
Description: Exports the PCB for plotters and laser printers. This output is what you get from the File/Plot menu in pcbnew. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to plot.
  - Valid keys:
    - description: [string=''] A description for the layer, for documentation purposes.
    - layer: [string=''] Name of the layer. As you see it in KiCad.
    - suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the hpgl output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Output file name, the default KiCad name if empty. IMPORTANT! KiCad will always create the file using its own name and then we can rename it. For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options.
    - plot_sheet_reference: [boolean=false] Include the frame and title block. Only available for KiCad 6+ and you get a poor result (i.e. always the default worksheet style, also problems expanding text variables). The pcb_print output can do a better job for PDF, SVG, PS, EPS and PNG outputs.
    - custom_reports: [list(dict)] A list of customized reports for the manufacturer.
      - Valid keys:
        
        content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
        
        output: [string='Custom_report.txt'] File name for the custom report.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - drill_marks: [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale).
    - edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
    - exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
    - exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
    - force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
    - individual_page_scaling: [boolean=true] Tell KiCad to apply the scaling for each layer as a separated entity. Disabling it the pages are coherent and can be superposed.
    - inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
    - mirror_plot: [boolean=false] Plot mirrored.
    - pen_number: [number=1] [1,16] Pen number.
    - pen_speed: [number=20] [1,99] Pen speed.
    - pen_width: [number=15] [0,100] Pen diameter in MILS, useful to fill areas. However, it is in mm in HPGL files.
    - plot_footprint_refs: [boolean=true] Include the footprint references.
    - plot_footprint_values: [boolean=true] Include the footprint values.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - scaling: [number=0] Scale factor (0 means autoscaling).
    - sketch_pad_line_width: [number=0.1] Line width for the sketched pads [mm], see sketch_pads_on_fab_layers (KiCad 6+) Note that this value is currently ignored by KiCad (6.0.9).
    - sketch_pads_on_fab_layers: [boolean=false] Draw only the outline of the pads on the *.Fab layers (KiCad 6+).
    - sketch_plot: [boolean=false] Don't fill objects, just draw the outline.
    - tent_vias: [boolean=true] Cover the vias.
    - uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

HPGL Schematic Print (Hewlett & Packard Graphics Language)

Type: hpgl_sch_print
Description: Exports the schematic to the most common plotter format. This output is what you get from the 'File/Plot' menu in eeschema. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the hpgl_sch_print output.
  - Valid keys:
    - frame: [boolean=true] Include the frame and title block.
    - all_pages: [boolean=true] Generate with all hierarchical sheets.
    - background_color: [boolean=false] Use the background color from the color_theme (KiCad 6).
    - color_theme: [string=''] Color theme used, this must exist in the KiCad config (KiCad 6).
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - monochrome: [boolean=false] Generate a monochromatic output.
    - origin: [string='bottom_left'] [bottom_left,centered,page_fit,content_fit] Origin and scale.
    - output: [string='%f-%i%I%v.%x'] Filename for the output HPGL (%i=schematic, %x=plt). Affected by global options.
    - pen_size: [number=0.4826] Pen size (diameter) [mm].
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - title: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.
    - variant: [string=''] Board variant to apply. Not fitted components are crossed.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

IBoM (Interactive HTML BoM)

Type: ibom
Description: Generates an interactive web page useful to identify the position of the components in the PCB. For more information: https://github.com/INTI-CMNB/InteractiveHtmlBom This output is what you get from the InteractiveHtmlBom plug-in (pcbnew).
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the ibom output.
  - Valid keys:
    - board_rotation: [number=0] Board rotation in degrees (-180 to 180). Will be rounded to multiple of 5.
    - bom_view: [string='left-right'] [bom-only,left-right,top-bottom] Default BOM view.
    - extra_fields: [string=''] Comma separated list of extra fields to pull from netlist or xml file. Using 'X,Y' is a shortcut for show_fields and group_fields with values 'Value,Footprint,X,Y'.
    - include_tracks: [boolean=false] Include track/zone information in output. F.Cu and B.Cu layers only.
    - layer_view: [string='FB'] [F,FB,B] Default layer view.
    - normalize_field_case: [boolean=false] Normalize extra field name case. E.g. 'MPN' and 'mpn' will be considered the same field.
    - output: [string='%f-%i%I%v.%x'] Filename for the output, use '' to use the IBoM filename (%i=ibom, %x=html). Affected by global options.
    - show_fields: [string=''] Comma separated list of fields to show in the BOM. Value and Footprint are displayed when nothing is specified.
    - blacklist: [string=''] List of comma separated blacklisted components or prefixes with . E.g. 'X1,MH'. IBoM option, avoid using in conjunction with KiBot variants/filters.
    - blacklist_empty_val: [boolean=false] Blacklist components with empty value. IBoM option, avoid using in conjunction with KiBot variants/filters.
    - checkboxes: [string='Sourced,Placed'] Comma separated list of checkbox columns.
    - dark_mode: [boolean=false] Default to dark mode.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. Avoid using it in conjunction with IBoM native filtering options.
    - dnp_field: [string=''] Name of the extra field that indicates do not populate status. Components with this field not empty will be blacklisted. IBoM option, avoid using in conjunction with KiBot variants/filters.
    - extra_data_file: [string=''] Path to netlist or xml file. You can use '%F.xml' to avoid specifying the project name. Leave it blank for most uses, data will be extracted from the PCB.
    - group_fields: [string=''] Comma separated list of fields that components will be grouped by. Value and Footprint are used when nothing is specified.
    - hide_excluded: [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant. Affected by global options.
    - hide_pads: [boolean=false] Hide footprint pads by default.
    - hide_silkscreen: [boolean=false] Hide silkscreen by default.
    - highlight_pin1: [boolean=false] Highlight pin1 by default.
    - include_nets: [boolean=false] Include netlist information in output..
    - name_format: [string='ibom'] Output file name format supports substitutions: %f : original pcb file name without extension. %p : pcb/project title from pcb metadata. %c : company from pcb metadata. %r : revision from pcb metadata. %d : pcb date from metadata if available, file modification date otherwise. %D : bom generation date. %T : bom generation time. Extension .html will be added automatically. Note that this name is used only when output is ''.
    - netlist_file: Alias for extra_data_file.
    - no_blacklist_virtual: [boolean=false] Do not blacklist virtual components. IBoM option, avoid using in conjunction with KiBot variants/filters.
    - no_compression: [boolean=false] Disable compression of pcb data.
    - no_redraw_on_drag: [boolean=false] Do not redraw pcb on drag by default.
    - offset_back_rotation: [boolean=false] Offset the back of the pcb by 180 degrees.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - show_fabrication: [boolean=false] Show fabrication layer by default.
    - sort_order: [string='C,R,L,D,U,Y,X,F,SW,A,~~,HS,CNN,J,P,NT,MH'] Default sort order for components. Must contain '~~' once.
    - variant: [string=''] Board variant to apply. Avoid using it in conjunction with IBoM native filtering options.
    - variant_field: [string=''] Name of the extra field that stores board variant for component. IBoM option, avoid using in conjunction with KiBot variants/filters.
    - variants_blacklist: [string=''] List of board variants to exclude from the BOM. IBoM option, avoid using in conjunction with KiBot variants/filters.
    - variants_whitelist: [string=''] List of board variants to include in the BOM. IBoM option, avoid using in conjunction with KiBot variants/filters.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Info

Type: info
Description: Records information about the current run. It can be used to know more about the environment used to generate the files. Please don't rely on the way things are reported, its content could change, adding or removing information
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the info output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=info, %x=txt). Affected by global options.
    - environment: [string='names'] [names,none,full] List environment variables. IMPORTANT: Don't use full unless you know you are not leaking sensitive information.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

KiBoM (KiCad Bill of Materials)

Type: kibom
Description: Used to generate the BoM in HTML or CSV format using the KiBoM plug-in. For more information: https://github.com/INTI-CMNB/KiBoM Note that this output is provided as a compatibility tool. We recommend using the bom output instead. This output is what you get from the 'Tools/Generate Bill of Materials' menu in eeschema. Also note that here the KiBot concept of variants doesn't apply.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the kibom output.
  - Valid keys:
    - format: [string='HTML'] [HTML,CSV,XML,XLSX] Format for the BoM.
    - number: [number=1] Number of boards to build (components multiplier).
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=bom). Affected by global options.
    - conf: [string|dict] BoM configuration file, relative to PCB. Environment variables and ~ allowed. You can also define the configuration here, will be stored in config.kibom.ini.
      - Valid keys:
        
        columns: [list(dict)|list(string)] List of columns to display. Can be just the name of the field.
        
        Valid keys:
        
        field: [string=''] Name of the field to use for this column. Use _field_lcsc_part to get the value defined in the global options.
        
        name: [string=''] Name to display in the header. The field is used when empty.
        
        join: [list(string)|string=''] List of fields to join to this column.
        
        fit_field: [string='Config'] Field name used to determine if a particular part is to be fitted (also DNC and variants).
        
        group_fields: [list(string)] List of fields used for sorting individual components into groups. Components which match (comparing all fields) will be grouped together. Field names are case-insensitive. If empty: ['Part', 'Part Lib', 'Value', 'Footprint', 'Footprint Lib'] is used.
        
        ignore_dnf: [boolean=true] Exclude DNF (Do Not Fit) components.
        
        number_rows: [boolean=true] First column is the row number.
        
        component_aliases: [list(list(string))] A series of values which are considered to be equivalent for the part name. Each entry is a list of equivalen names. Example: ['c', 'c_small', 'cap' ] will ensure the equivalent capacitor symbols can be grouped together. If empty the following aliases are used: - ['r', 'r_small', 'res', 'resistor'] - ['l', 'l_small', 'inductor'] - ['c', 'c_small', 'cap', 'capacitor'] - ['sw', 'switch'] - ['zener', 'zenersmall'] - ['d', 'diode', 'd_small'].
        
        datasheet_as_link: [string=''] Column with links to the datasheet (HTML only).
        
        digikey_link: [string|list(string)=''] Column/s containing Digi-Key part numbers, will be linked to web page (HTML only).
        
        exclude_any: [list(dict)] A series of regular expressions used to exclude parts. If a component matches ANY of these, it will be excluded. Column names are case-insensitive. If empty the following list is used: - column: References regex: '^TP[0-9]*' - column: References regex: '^FID' - column: Part regex: 'mount.*hole' - column: Part regex: 'solder.*bridge' - column: Part regex: 'test.*point' - column: Footprint regex 'test.*point' - column: Footprint regex: 'mount.*hole' - column: Footprint regex: 'fiducial'.
        
        Valid keys:
        
        column: [string=''] Name of the column to apply the regular expression. Use _field_lcsc_part to get the value defined in the global options.
        
        field: Alias for column.
        
        regex: [string=''] Regular expression to match.
        
        regexp: Alias for regex.
        
        group_connectors: [boolean=true] Connectors with the same footprints will be grouped together, independent of the name of the connector.
        
        hide_headers: [boolean=false] Hide column headers.
        
        hide_pcb_info: [boolean=false] Hide project information.
        
        html_generate_dnf: [boolean=true] Generate a separated section for DNF (Do Not Fit) components (HTML only).
        
        include_only: [list(dict)] A series of regular expressions used to select included parts. If there are any regex defined here, only components that match against ANY of them will be included. Column names are case-insensitive. If empty all the components are included.
        
        Valid keys:
        
        column: [string=''] Name of the column to apply the regular expression. Use _field_lcsc_part to get the value defined in the global options.
        
        field: Alias for column.
        
        regex: [string=''] Regular expression to match.
        
        regexp: Alias for regex.
        
        merge_blank_fields: [boolean=true] Component groups with blank fields will be merged into the most compatible group, where possible.
        
        mouser_link: [string|list(string)=''] Column/s containing Mouser part numbers, will be linked to web page (HTML only).
        
        ref_separator: [string=' '] Separator used for the list of references.
        
        test_regex: [boolean=true] Each component group will be tested against a number of regular-expressions (see ``)..
        
        use_alt: [boolean=false] Print grouped references in the alternate compressed style eg: R1-R7,R18.
    - separator: [string=','] CSV Separator.
    - variant: [string=''] Board variant(s), used to determine which components are output to the BoM. To specify multiple variants, with a BOM file exported for each variant, separate variants with the ';' (semicolon) character. This isn't related to the KiBot concept of variants.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

KiCost (KiCad Cost calculator)

Type: kicost
Description: Generates a spreadsheet containing components costs. For more information: https://github.com/INTI-CMNB/KiCost This output is what you get from the KiCost plug-in (eeschema). You can get KiCost costs using the internal BoM output (bom).
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the kicost output.
  - Valid keys:
    - board_qty: Alias for number.
    - currency: [string|list(string)=USD] Currency priority. Use ISO4217 codes (i.e. USD, EUR).
    - distributors: [string|list(string)] Include this distributors list. Default is all the available.
    - no_distributors: [string|list(string)] Exclude this distributors list. They are removed after computing distributors.
    - no_price: [boolean=false] Do not look for components price. For testing purposes.
    - number: [number=100] Number of boards to build (components multiplier).
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=kicost, %x=xlsx). Affected by global options.
    - aggregate: [list(dict)] Add components from other projects.
      - Valid keys:
        
        board_qty: Alias for number.
        
        file: [string=''] Name of the XML to aggregate.
        
        number: [number=100] Number of boards to build (components multiplier).
        
        variant: [string=' '] Variant for this project.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill. Don't use the kicost_variant when using internal variants/filters.
    - fields: [string|list(string)] List of fields to be added to the global data section.
    - group_fields: [string|list(string)] List of fields that can be different for a group. Parts with differences in these fields are grouped together, but displayed individually.
    - ignore_fields: [string|list(string)] List of fields to be ignored.
    - kicost_variant: [string=''] Regular expression to match the variant field (KiCost option, not internal variants).
    - no_collapse: [boolean=false] Do not collapse the part references (collapse=R1-R4).
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - show_cat_url: [boolean=false] Include the catalogue links in the catalogue code.
    - split_extra_fields: [string|list(string)] Declare part fields to include in multipart split process.
    - translate_fields: [list(dict)] Fields to rename (KiCost option, not internal filters).
      - Valid keys:
        
        field: [string=''] Name of the field to rename.
        
        name: [string=''] New name.
    - variant: [string=''] Board variant to apply. Don't use the kicost_variant when using internal variants/filters.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

KiKit's Present - Project Presentation

Type: kikit_present
Description: Creates an HTML file showing your project. It can contain one or more PCBs, showing their top and bottom sides. Also includes a download link and the gerbers.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the kikit_present output.
  - Valid keys:
    - description: [string=''] Name for a markdown file containing the main part of the page to be generated. This is mandatory and is the description of your project. You can embed the markdown code. If the text doesn't map to a file and contains more than one line KiBot will assume this is the markdown.
    - boards: [dict|list(dict)] One or more boards that compose your project. When empty we will use only the main PCB for the current project.
      - Valid keys:
        
        name: [string=''] Name for this board. If empty we use the name of the PCB. Applies to all modes.
        
        back_image: [string=''] How to obtain the back view of the PCB. local: the name of an output to render it. If empty we use the first renderer. file: the name of the rendered image. external: ignored, we use extrenal_config.
        
        comment: [string=''] A comment or description for this board. Applies to all modes.
        
        external_config: [string=''] Name of an external KiBot configuration. Only used in the external mode.
        
        front_image: [string=''] How to obtain the front view of the PCB. local: the name of an output to render it. If empty we use the first renderer. file: the name of the rendered image. external: ignored, we use extrenal_config.
        
        gerbers: [string=''] How to obtain an archive with the gerbers. local: the name of a gerber output. If empty we use the first gerber output. file: the name of a compressed archive. external: ignored, we use extrenal_config.
        
        mode: [string='local'] [local,file,external] How images and gerbers are obtained. local: Only applies to the currently selected PCB. You must provide the names of the outputs used to render the images and compress the gerbers. When empty KiBot will use the first render/gerber output it finds. To apply variants use pcb_from_output and a pcb_variant output. file: You must specify the file names used for the images and the gerbers. external: You must specify an external KiBot configuration. It will be applied to the selected PCB to create the images and the gerbers. The front image must be generated in a dir called front, the back image in a dir called back and the gerbers in a dir called gerbers.
        
        pcb_file: [string=''] Name of the KiCad PCB file. When empty we use the current PCB. Is ignored for the local mode.
        
        pcb_from_output: [string=''] Use the PCB generated by another output. Is ignored for the file mode.
    - name: [string=''] Name of the project. Will be passed to the template. If empty we use the name of the KiCad project. The default template uses it for things like the page title.
    - repository: [string=''] URL of the repository. Will be passed to the template. If empty we will try to find it using git remote get-url origin. The default template uses it to create an URL for the current commit.
    - resources: [string|list(string)=''] A list of file name patterns for additional resources to be included. I.e. images referenced in description. They will be copied relative to the output dir.
    - template: [string='default'] Path to a template directory or a name of built-in one. See KiKit's doc/present.md for template specification.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Navigate Results

Type: navigate_results
Description: Generates a web page to navigate the generated outputs
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the navigate_results output.
  - Valid keys:
    - link_from_root: [string=''] The name of a file to create at the main output directory linking to the home page.
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=html, %x=navigate). Affected by global options.
    - skip_not_run: [boolean=false] Skip outputs with run_by_default: false.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=10] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Netlist

Type: netlist
Description: Generates the list of connections for the project. The netlist can be generated in the classic format and in IPC-D-356 format, useful for board testing
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the netlist output.
  - Valid keys:
    - format: [string='classic'] [classic,ipc] The classic format is the KiCad internal format, and is generated from the schematic. The ipc format is the IPC-D-356 format, useful for PCB testing, is generated from the PCB.
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=netlist/IPC-D-356, %x=net/d356). Affected by global options.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - variant: [string=''] Board variant to apply. Used for sub-PCBs.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Panelize

Type: panelize
Description: Creates a panel to fabricate various copies of the PCB at once. It currently uses the KiKit tool, which must be available. Consult KiKit docs for detailed information. KiKit panelization docs. Current versions of KiKit only support KiCad 6 and my tests using KiKit 1.0.5 (the last to support KiCad 5) shown some incompatibilities. Note that you don't need to specify the units for all distances. If they are omitted they are assumed to be units. The same is valid for angles, using default_angles
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the Panelize output.
  - Valid keys:
    - configs: [list(dict)|list(string)|string] One or more configurations used to create the panel. Use a string to include an external configuration, i.e. myDefault.json. You can also include a preset using :name, i.e. :vcuts. Use a dict to specify the options using the KiBot YAML file.
      - Valid keys:
        
        cuts: [dict] Specify how to perform the cuts on the tabs separating the board.
        
        Valid keys:
        
        type: [string='none'] [none,mousebites,vcuts,layer,plugin] Layer: When KiKit reports it cannot perform cuts, you can render the cuts into a layer with this option to understand what's going on. Shouldn't be used for the final design.
        
        arg: [string=''] Argument to pass to the plugin. Used for plugin.
        
        clearance: [number|string] Specify clearance for copper around V-cuts.
        
        code: [string=''] Plugin specification (PACKAGE.FUNCTION or PYTHON_FILE.FUNCTION). Used for plugin.
        
        cut_curves: Alias for cutcurves.
        
        cutcurves: [boolean=false] Specify if curves should be approximated by straight cuts (e.g., for cutting tabs on circular boards). Used for vcuts.
        
        drill: [number|string] Drill size used for the mousebites.
        
        layer: [string='Cmts.User'] Specify the layer to render V-cuts on. Also used for the layer type.
        
        offset: [number|string] Specify the mousebites and vcuts offset, positive offset puts the cuts into the board, negative puts the cuts into the tabs.
        
        prolong: [number|string] Distance for tangential prolongation of the cuts (to cut through the internal corner fillets caused by milling). Used for mousebites and layer.
        
        spacing: [number|string] The spacing of the holes used for the mousebites.
        
        fiducials: [dict] Used to add fiducial marks to the (rail/frame of) the panel.
        
        Valid keys:
        
        type: [string='none'] [none,3fid,4fid,plugin] Add none, 3 or 4 fiducials to the (rail/frame of) the panel.
        
        copper_size: Alias for coppersize.
        
        coppersize: [number|string] Diameter of the copper spot.
        
        hoffset: [number|string] Horizontal offset from panel edges.
        
        opening: [number|string] Diameter of the solder mask opening.
        
        voffset: [number|string] Vertical offset from panel edges.
        
        framing: [dict] Specify the frame around the boards.
        
        Valid keys:
        
        type: [string='none'] [none,railstb,railslr,frame,tightframe,plugin] Railstb: Add rails on top and bottom. Railslr: Add rails on left and right. Frame: Add a frame around the board. Tighframe: Add a frame around the board which fills the whole area of the panel - the boards have just a milled slot around their perimeter. Plugin: Uses an external python function, only code and arg are relevant.
        
        arg: [string=''] Argument to pass to the plugin. Used for plugin.
        
        chamfer: [number|string] Specify the size of chamfer frame corners.
        
        code: [string=''] Plugin specification (PACKAGE.FUNCTION or PYTHON_FILE.FUNCTION). Used for plugin.
        
        cuts: [string='both'] [none,both,v,h] Specify whether to add cuts to the corners of the frame for easy removal. Used for frame.
        
        fillet: [number|string] Specify radius of fillet frame corners.
        
        hspace: [number|string] Specify the horizontal space between PCB and the frame/rail.
        
        min_total_height: Alias for mintotalheight.
        
        min_total_width: Alias for mintotalwidth.
        
        mintotalheight: [number|string] If needed, add extra material to the rail or frame to meet the minimal requested size. Useful for services that require minimal panel size.
        
        mintotalwidth: [number|string] If needed, add extra material to the rail or frame to meet the minimal requested size. Useful for services that require minimal panel size.
        
        slot_width: Alias for slotwidth.
        
        slotwidth: [number|string] Width of the milled slot for tightframe.
        
        space: [number|string] Specify the space between PCB and the frame/rail. Overrides hspace and vspace.
        
        vspace: [number|string] Specify the vertical space between PCB and the frame/rail.
        
        width: [number|string] Specify with of the rails or frame.
        
        layout: [dict] Layout used for the panel.
        
        Valid keys:
        
        cols: [number=1] Specify the number of columns of boards in the grid pattern.
        
        rows: [number=1] Specify the number of rows of boards in the grid pattern.
        
        alternation: [string='none'] [none,rows,cols,rowsCols] Specify alternations of board rotation. none: Do not alternate. rows: Rotate boards by 180° on every next row. cols: Rotate boards by 180° on every next column. rowsCols: Rotate boards by 180° based on a chessboard pattern.
        
        arg: [string=''] Argument to pass to the plugin. Used for plugin.
        
        bake_text: Alias for baketext.
        
        baketext: [boolean=true] A flag that indicates if text variables should be substituted or not.
        
        code: [string=''] Plugin specification (PACKAGE.FUNCTION or PYTHON_FILE.FUNCTION). Used for plugin.
        
        hbackbone: [number|string] The width of horizontal backbone (0 means no backbone). The backbone does not increase the spacing of the boards.
        
        hbonecut: [boolean=true] If there are both backbones specified, specifies if there should be a horizontal cut where the backbones cross.
        
        hboneskip: [number=0] Skip every n horizontal backbones. I.e., 1 means place only every other backbone.
        
        hspace: [number|string] Specify the horizontal gap between the boards.
        
        rename_net: Alias for renamenet.
        
        rename_ref: Alias for renameref.
        
        renamenet: [string='Board_{n}-{orig}'] A pattern by which to rename the nets. You can use {n} and {orig} to get the board number and original name.
        
        renameref: [string='{orig}'] A pattern by which to rename the references. You can use {n} and {orig} to get the board number and original name.
        
        rotation: [number|string] Rotate the boards before placing them in the panel.
        
        space: [number|string] Specify the gap between the boards, overwrites hspace and vspace.
        
        type: [string='grid'] [grid,plugin] In the plugin type only code and arg are relevant.
        
        vbackbone: [number|string] The width of vertical backbone (0 means no backbone). The backbone does not increase the spacing of the boards.
        
        vbonecut: [boolean=true] If there are both backbones specified, specifies if there should be a vertical cut where the backbones cross.
        
        vboneskip: [number=0] Skip every n vertical backbones. I.e., 1 means place only every other backbone.
        
        vspace: [number|string] Specify the vertical gap between the boards.
        
        page: [dict] Sets page size on the resulting panel and position the panel in the page.
        
        Valid keys:
        
        page_size: Alias for type.
        
        size: Alias for type.
        
        type: [string='inherit'] [inherit,custom,A0,A1,A2,A3,A4,A5,A,B,C,D,E,USLetter,USLegal,USLedger,A0-portrait,A1-portrait,A2-portrait, A3-portrait,A4-portrait,A5-portrait,A-portrait,B-portrait,C-portrait,D-portrait,E-portrait, USLetter-portrait,USLegal-portrait,USLedger-portrait] Paper size. The default inherit option inherits paper size from the source board. This feature is not supported on KiCAD 5.
        
        anchor: [string='tl'] [tl,tr,bl,br,mt,mb,ml,mr,c] Point of the panel to be placed at given position. Can be one of tl, tr, bl, br (corners), mt, mb, ml, mr (middle of sides), c (center). The anchors refer to the panel outline.
        
        height: [number|string] Height for the custom paper size.
        
        pos_x: Alias for posx.
        
        pos_y: Alias for posy.
        
        posx: [number|string] The X position of the panel on the page.
        
        posy: [number|string] The Y position of the panel on the page.
        
        width: [number|string] Width for the custom paper size.
        
        tabs: [dict] Style of the tabs used to join the PCB copies.
        
        Valid keys:
        
        type: [string='spacing'] [fixed,spacing,full,annotation,plugin] Fixed: Place given number of tabs on the PCB edge. Spacing: Place tabs on the PCB edges based on spacing. Full: Create tabs that are full width of the PCB. Corner: Create tabs in the corners of the PCB. Annotation: Add tabs based on PCB annotations. Plugin: Uses an external python function, only code and arg are relevant.
        
        arg: [string=''] Argument to pass to the plugin. Used for plugin.
        
        code: [string=''] Plugin specification (PACKAGE.FUNCTION or PYTHON_FILE.FUNCTION). Used for plugin.
        
        cutout: [number|string] When your design features open pockets on the side, this parameter specifies extra cutout depth in order to ensure that a sharp corner of the pocket can be milled. Used for full.
        
        hcount: [number=1] Number of tabs in the horizontal direction. Used for fixed.
        
        hwidth: [number|string] The width of tabs in the horizontal direction. Used for fixed and spacing.
        
        min_distance: Alias for mindistance.
        
        mindistance: [number|string] Minimal spacing between the tabs. If there are too many tabs, their count is reduced. Used for fixed.
        
        spacing: [number|string] The maximum spacing of the tabs. Used for spacing.
        
        tab_footprints: Alias for tabfootprints.
        
        tabfootprints: [string='kikit:Tab'] The footprint/s used for the annotation type. You can specify a list of footprints separated by comma.
        
        vcount: [number=1] Number of tabs in the vertical direction. Used for fixed.
        
        vwidth: [number|string] The width of tabs in the vertical direction. Used for fixed and spacing.
        
        width: [number|string] The width of tabs in both directions. Overrides both vwidth and hwidth. Used for fixed, spacing, corner and annotation.
        
        tooling: [dict] Used to add tooling holes to the (rail/frame of) the panel.
        
        Valid keys:
        
        type: [string='none'] [none,3hole,4hole,plugin] Add none, 3 or 4 holes to the (rail/frame of) the panel.
        
        arg: [string=''] Argument to pass to the plugin. Used for plugin.
        
        code: [string=''] Plugin specification (PACKAGE.FUNCTION or PYTHON_FILE.FUNCTION). Used for plugin.
        
        hoffset: [number|string] Horizontal offset from panel edges.
        
        paste: [boolean=false] If True, the holes are included in the paste layer (therefore they appear on the stencil).
        
        size: [number|string] Diameter of the holes.
        
        voffset: [number|string] Vertical offset from panel edges.
        
        copperfill: [dict] Fill non-board areas of the panel with copper.
        
        Valid keys:
        
        type: [string='none'] [none,solid,hatched] How to fill non-board areas of the panel with copper.
        
        clearance: [number|string] Extra clearance from the board perimeters. Suitable for, e.g., not filling the tabs with copper.
        
        layers: [string|list(string)] List of layers to fill. Can be a comma-separated string. Using all means all external copper layers.
        
        orientation: [number|string] The orientation of the hatched strokes.
        
        spacing: [number|string] The space between the hatched strokes.
        
        width: [number|string] The width of the hatched strokes.
        
        debug: [dict] Debug options.
        
        Valid keys:
        
        deterministic: [boolean=false] Deterministic.
        
        drawBackboneLines: [boolean=false] Draw backbone lines.
        
        drawPartitionLines: [boolean=false] Draw partition lines.
        
        drawboxes: [boolean=false] Draw boxes.
        
        drawtabfail: [boolean=false] Draw tab fail.
        
        trace: [boolean=false] Trace.
        
        extends: [string=''] A configuration to use as base for this one. Use the following format: OUTPUT_NAME[CFG_NAME].
        
        name: [string=''] A name to identify this configuration. If empty will be the order in the list, starting with 1. Don't use just a number or it will be confused as an index.
        
        post: [dict] Finishing touches to the panel.
        
        Valid keys:
        
        copperfill: [boolean=false] Fill tabs and frame with copper (e.g., to save etchant or to increase rigidity of flex-PCB panels).
        
        mill_radius: Alias for millradius.
        
        millradius: [number|string] Simulate the milling operation (add fillets to the internal corners). Specify mill radius (usually 1 mm). 0 radius disables the functionality.
        
        origin: [string='tl'] [tl,tr,bl,br,mt,mb,ml,mr,c] Specify if the auxiliary origin an grid origin should be placed. Can be one of tl, tr, bl, br (corners), mt, mb, ml, mr (middle of sides), c (center). Empty string does not changes the origin.
        
        reconstruct_arcs: Alias for reconstructarcs.
        
        reconstructarcs: [boolean=false] The panelization process works on top of a polygonal representation of the board. This options allows to reconstruct the arcs in the design before saving the panel.
        
        refill_zones: Alias for refillzones.
        
        refillzones: [boolean=false] Refill the user zones after the panel is build. This is only necessary when you want your zones to avoid cuts in panel.
        
        script: [string=''] A path to custom Python file. The file should contain a function kikitPostprocess(panel, args) that receives the prepared panel as the kikit.panelize.Panel object and the user-supplied arguments as a string - see scriptarg. The function can make arbitrary changes to the panel - you can append text, footprints, alter labels, etc. The function is invoked after the whole panel is constructed (including all other postprocessing). If you try to add a functionality for a common fabrication houses via scripting, consider submitting PR for KiKit.
        
        script_arg: Alias for scriptarg.
        
        scriptarg: [string=''] An arbitrary string passed to the user post-processing script specified in script.
        
        type: [string='auto'] [auto] Currently fixed.
        
        source: [dict] Used to adjust details of which part of the PCB is panelized.
        
        Valid keys:
        
        type: [string='auto'] [auto,rectangle,annotation] How we select the area of the PCB tu used for the panelization. auto uses all the area reported by KiCad, rectangle a specified rectangle and annotation selects a contour marked by a kikit:Board footprint.
        
        brx: [number|string] Bottom right X coordinate of the rectangle used. Used for rectangle.
        
        bry: [number|string] Bottom right Y coordinate of the rectangle used. Used for rectangle.
        
        ref: [string=''] Reference for the kikit:Board footprint used to select the contour. Used for annotation.
        
        stack: [string='inherit'] [inherit,2layer,4layer,6layer] Used to reduce the number of layers used for the panel.
        
        tlx: [number|string] Top left X coordinate of the rectangle used. Used for rectangle.
        
        tly: [number|string] Top left Y coordinate of the rectangle used. Used for rectangle.
        
        tolerance: [number|string] Extra space around the PCB reported size to be included. Used for auto and annotation.
        
        text: [dict] Used to add text to the panel.
        
        Valid keys:
        
        text: [string=''] The text to be displayed. Note that you can escape ; via . Available variables in text: date formats current date as --, time24 formats current time in 24-hour format, boardTitle the title from the source board, boardDate the date from the source board, boardRevision the revision from the source board, boardCompany the company from the source board, boardComment1-boardComment9 comments from the source board.
        
        type: [string='none'] [none,simple] Currently fixed. BTW: don't ask me about this ridiculous default, is how KiKit works.
        
        anchor: [string='mt'] [tl,tr,bl,br,mt,mb,ml,mr,c] Origin of the text. Can be one of tl, tr, bl, br (corners), mt, mb, ml, mr (middle of sides), c (center). The anchors refer to the panel outline.
        
        height: [number|string] Height of the characters (the same parameters as KiCAD uses).
        
        hjustify: [string='center'] [left,right,center] Horizontal justification of the text.
        
        hoffset: [number|string] Specify the horizontal offset from anchor. Respects KiCAD coordinate system.
        
        layer: [string='F.SilkS'] Specify text layer.
        
        orientation: [number|string] Specify the orientation (angle).
        
        plugin: [string=''] Specify the plugin that provides extra variables for the text.
        
        thickness: [number|string] Stroke thickness.
        
        vjustify: [string='center'] [left,right,center] Vertical justification of the text.
        
        voffset: [number|string] Specify the vertical offset from anchor. Respects KiCAD coordinate system.
        
        width: [number|string] Width of the characters (the same parameters as KiCAD uses).
        
        text2: [dict] Used to add text to the panel.
        
        Valid keys:
        
        text: [string=''] The text to be displayed. Note that you can escape ; via . Available variables in text: date formats current date as --, time24 formats current time in 24-hour format, boardTitle the title from the source board, boardDate the date from the source board, boardRevision the revision from the source board, boardCompany the company from the source board, boardComment1-boardComment9 comments from the source board.
        
        type: [string='none'] [none,simple] Currently fixed. BTW: don't ask me about this ridiculous default, is how KiKit works.
        
        anchor: [string='mt'] [tl,tr,bl,br,mt,mb,ml,mr,c] Origin of the text. Can be one of tl, tr, bl, br (corners), mt, mb, ml, mr (middle of sides), c (center). The anchors refer to the panel outline.
        
        height: [number|string] Height of the characters (the same parameters as KiCAD uses).
        
        hjustify: [string='center'] [left,right,center] Horizontal justification of the text.
        
        hoffset: [number|string] Specify the horizontal offset from anchor. Respects KiCAD coordinate system.
        
        layer: [string='F.SilkS'] Specify text layer.
        
        orientation: [number|string] Specify the orientation (angle).
        
        plugin: [string=''] Specify the plugin that provides extra variables for the text.
        
        thickness: [number|string] Stroke thickness.
        
        vjustify: [string='center'] [left,right,center] Vertical justification of the text.
        
        voffset: [number|string] Specify the vertical offset from anchor. Respects KiCAD coordinate system.
        
        width: [number|string] Width of the characters (the same parameters as KiCAD uses).
        
        text3: [dict] Used to add text to the panel.
        
        Valid keys:
        
        text: [string=''] The text to be displayed. Note that you can escape ; via . Available variables in text: date formats current date as --, time24 formats current time in 24-hour format, boardTitle the title from the source board, boardDate the date from the source board, boardRevision the revision from the source board, boardCompany the company from the source board, boardComment1-boardComment9 comments from the source board.
        
        type: [string='none'] [none,simple] Currently fixed. BTW: don't ask me about this ridiculous default, is how KiKit works.
        
        anchor: [string='mt'] [tl,tr,bl,br,mt,mb,ml,mr,c] Origin of the text. Can be one of tl, tr, bl, br (corners), mt, mb, ml, mr (middle of sides), c (center). The anchors refer to the panel outline.
        
        height: [number|string] Height of the characters (the same parameters as KiCAD uses).
        
        hjustify: [string='center'] [left,right,center] Horizontal justification of the text.
        
        hoffset: [number|string] Specify the horizontal offset from anchor. Respects KiCAD coordinate system.
        
        layer: [string='F.SilkS'] Specify text layer.
        
        orientation: [number|string] Specify the orientation (angle).
        
        plugin: [string=''] Specify the plugin that provides extra variables for the text.
        
        thickness: [number|string] Stroke thickness.
        
        vjustify: [string='center'] [left,right,center] Vertical justification of the text.
        
        voffset: [number|string] Specify the vertical offset from anchor. Respects KiCAD coordinate system.
        
        width: [number|string] Width of the characters (the same parameters as KiCAD uses).
        
        text4: [dict] Used to add text to the panel.
        
        Valid keys:
        
        text: [string=''] The text to be displayed. Note that you can escape ; via . Available variables in text: date formats current date as --, time24 formats current time in 24-hour format, boardTitle the title from the source board, boardDate the date from the source board, boardRevision the revision from the source board, boardCompany the company from the source board, boardComment1-boardComment9 comments from the source board.
        
        type: [string='none'] [none,simple] Currently fixed. BTW: don't ask me about this ridiculous default, is how KiKit works.
        
        anchor: [string='mt'] [tl,tr,bl,br,mt,mb,ml,mr,c] Origin of the text. Can be one of tl, tr, bl, br (corners), mt, mb, ml, mr (middle of sides), c (center). The anchors refer to the panel outline.
        
        height: [number|string] Height of the characters (the same parameters as KiCAD uses).
        
        hjustify: [string='center'] [left,right,center] Horizontal justification of the text.
        
        hoffset: [number|string] Specify the horizontal offset from anchor. Respects KiCAD coordinate system.
        
        layer: [string='F.SilkS'] Specify text layer.
        
        orientation: [number|string] Specify the orientation (angle).
        
        plugin: [string=''] Specify the plugin that provides extra variables for the text.
        
        thickness: [number|string] Stroke thickness.
        
        vjustify: [string='center'] [left,right,center] Vertical justification of the text.
        
        voffset: [number|string] Specify the vertical offset from anchor. Respects KiCAD coordinate system.
        
        width: [number|string] Width of the characters (the same parameters as KiCAD uses).
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=panel, %x=kicad_pcb). Affected by global options.
    - create_preview: [boolean=false] Use PcbDraw to create a preview of the panel.
    - default_angles: [string='deg'] [deg,°,rad] Angles used when omitted.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - title: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.
    - units: [string='mm'] [millimeters,inches,mils,mm,cm,dm,m,mil,inch,in] Units used when omitted.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

PCB2Blender Tools

Type: pcb2blender_tools
Description: A bunch of tools used to generate PCB3D files used to export PCBs to Blender. Blender is the most important free software 3D render package. This output needs KiCad 6 or newer. The PCB3D file format is used by the PCB2Blender project (https://github.com/30350n/pcb2blender) to import KiCad PCBs in Blender. You need to install a Blender plug-in to load PCB3D files. The tools in this output are used by internal templates used to generate PCB3D files.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the pcb2blender_tools output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=pcb2blender, %x=pcb3d). Affected by global options.
    - show_components: [list(string)|string=all] [none,all] List of components to include in the pads list, can be also a string for none or all. The default is all.
    - board_bounds_create: [boolean=true] Create the file that informs the size of the used PCB area. This is the bounding box reported by KiCad for the PCB edge with 1 mm of margin.
    - board_bounds_dir: [string='layers'] Sub-directory where the bounds file is stored.
    - board_bounds_file: [string='bounds'] Name of the bounds file.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - pads_info_create: [boolean=true] Create the files containing the PCB pads information.
    - pads_info_dir: [string='pads'] Sub-directory where the pads info files are stored.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - stackup_create: [boolean=false] Create a JSON file containing the board stackup.
    - stackup_dir: [string='.'] Directory for the stackup file.
    - stackup_file: [string='board.yaml'] Name for the stackup file.
    - sub_boards_bounds_file: [string='bounds'] File name for the sub-PCBs bounds.
    - sub_boards_create: [boolean=true] Extract sub-PCBs and their Z axis position.
    - sub_boards_dir: [string='boards'] Directory for the boards definitions.
    - sub_boards_stacked_prefix: [string='stacked_'] Prefix used for the stack files.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

PCB Print

Type: pcb_print
Description: Prints the PCB using a mechanism that is more flexible than pdf_pcb_print and svg_pcb_print. Supports PDF, SVG, PNG, EPS and PS formats. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the pcb_print output.
  - Valid keys:
    - color_theme: [string='_builtin_classic'] Selects the color theme. Only applies to KiCad 6. To use the KiCad 6 default colors select _builtin_default. Usually user colors are stored as user, but you can give it another name.
    - force_edge_cuts: [boolean=false] Add the Edge.Cuts to all the pages.
    - format: [string='PDF'] [PDF,SVG,PNG,EPS,PS] Format for the output file/s. Note that for PS you need ghostscript which isn't part of the default docker images.
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=assembly, %x=pdf/ps)/(%i=assembly_page_NN, %x=svg/png/eps). Consult the page_number_as_extension and page_id options. Affected by global options.
    - output_name: Alias for output.
    - pages: [list(dict)] List of pages to include in the output document. Each page contains one or more layers of the PCB.
      - Valid keys:
        
        layers: [list(dict)|list(string)|string] List of layers printed in this page. Order is important, the last goes on top. You can reuse other layers lists, some options aren't used here, but they are valid.
        
        Valid keys:
        
        color: [string=''] Color used for this layer.
        
        description: [string=''] A description for the layer, for documentation purposes.
        
        force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
        
        layer: [string=''] Name of the layer. As you see it in KiCad.
        
        plot_footprint_refs: [boolean=true] Include the footprint references.
        
        plot_footprint_values: [boolean=true] Include the footprint values.
        
        suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
        
        scaling: [number=1.0] Scale factor (0 means autoscaling).
        
        sort_layers: [boolean=false] Try to sort the layers in the same order that uses KiCad for printing.
        
        autoscale_margin_x: [number=0] Horizontal margin used for the autoscaling mode [mm].
        
        autoscale_margin_y: [number=0] Vertical margin used for the autoscaling mode [mm].
        
        colored_holes: [boolean=true] Change the drill holes to be colored instead of white.
        
        exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
        
        holes_color: [string='#000000'] Color used for the holes when colored_holes is enabled.
        
        line_width: [number=0.1] [0.02,2] For objects without width [mm] (KiCad 5).
        
        mirror: [boolean=false] Print mirrored (X axis inverted).
        
        monochrome: [boolean=false] Print in gray scale.
        
        negative_plot: [boolean=false] Invert black and white. Only useful for a single layer.
        
        page_id: [string='%02d'] Text to differentiate the pages. Use %d (like in C) to get the page number.
        
        repeat_for_layer: [string=''] Use this page as a pattern to create more pages. The other pages will change the layer mentioned here. This can be used to generate a page for each copper layer, here you put F.Cu. See repeat_layers.
        
        repeat_inherit: [boolean=true] If we will inherit the options of the layer we are replacing. Disable it if you specify the options in repeat_layers, which is unlikely.
        
        repeat_layers: [list(dict)|list(string)|string] List of layers to replace repeat_for_layer. This can be used to generate a page for each copper layer, here you put copper.
        
        Valid keys:
        
        color: [string=''] Color used for this layer.
        
        description: [string=''] A description for the layer, for documentation purposes.
        
        force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
        
        layer: [string=''] Name of the layer. As you see it in KiCad.
        
        plot_footprint_refs: [boolean=true] Include the footprint references.
        
        plot_footprint_values: [boolean=true] Include the footprint values.
        
        suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
        
        sheet: [string='Assembly'] Text to use for the sheet in the title block. Pattern (%*) and text variables are expanded. In addition when you use repeat_for_layer the following patterns are available: %ln layer name, %ls layer suffix and %ld layer description.
        
        sheet_reference_color: [string=''] Color to use for the frame and title block.
        
        sketch_pad_line_width: [number=0.1] Line width for the sketched pads [mm], see sketch_pads_on_fab_layers (KiCad 6+) Note that this value is currently ignored by KiCad (6.0.9).
        
        sketch_pads_on_fab_layers: [boolean=false] Draw only the outline of the pads on the *.Fab layers (KiCad 6+).
        
        tent_vias: [boolean=true] Cover the vias.
        
        title: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.
    - plot_sheet_reference: [boolean=true] Include the title-block (worksheet, frame, etc.).
    - scaling: [number=1.0] Default scale factor (0 means autoscaling).
    - add_background: [boolean=false] Add a background to the pages, see background_color.
    - autoscale_margin_x: [number=0] Default horizontal margin used for the autoscaling mode [mm].
    - autoscale_margin_y: [number=0] Default vertical margin used for the autoscaling mode [mm].
    - background_color: [string='#FFFFFF'] Color for the background when add_background is enabled.
    - background_image: [string=''] Background image, must be an SVG, only when add_background is enabled.
    - blind_via_color: [string=''] Color used for blind/buried colored_vias.
    - colored_pads: [boolean=true] Plot through-hole in a different color. Like KiCad GUI does.
    - colored_vias: [boolean=true] Plot vias in a different color. Like KiCad GUI does.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - dpi: [number=360] [36,1200] Resolution (Dots Per Inch) for the output file. Most objects are vectors, but thing like the the solder mask are handled as images by the conversion tools.
    - drill_marks: [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale).
    - forced_edge_cuts_color: [string=''] Color used for the force_edge_cuts option.
    - frame_plot_mechanism: [string='internal'] [gui,internal,plot] Plotting the frame from Python is problematic. This option selects a workaround strategy. gui: uses KiCad GUI to do it. Is slow but you get the correct frame. But it can't keep track of page numbers. internal: KiBot loads the .kicad_wks and does the drawing work. Best option, but some details are different from what the GUI generates. plot: uses KiCad Python API. Only available for KiCad 6. You get the default frame and some substitutions doesn't work.
    - hide_excluded: [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant. Affected by global options.
    - individual_page_scaling: [boolean=true] Tell KiCad to apply the scaling for each page as a separated entity. Disabling it the pages are coherent and can be superposed.
    - keep_temporal_files: [boolean=false] Store the temporal page and layer files in the output dir and don't delete them.
    - micro_via_color: [string=''] Color used for micro colored_vias.
    - pad_color: [string=''] Color used for colored_pads.
    - page_number_as_extension: [boolean=false] When enabled the %i is always assembly, the %x will be NN.FORMAT (i.e. 01.png). Note: page numbers can be customized using the page_id option for each page.
    - png_width: [number=1280] [0,7680] Width of the PNG in pixels. Use 0 to use as many pixels as the DPI needs for the page size.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - realistic_solder_mask: [boolean=true] Try to draw the solder mask as a real solder mask, not the negative used for fabrication. In order to get a good looking select a color with transparency, i.e. '#14332440'. PcbDraw must be installed in order to use this option.
    - sheet_reference_layout: [string=''] Worksheet file (.kicad_wks) to use. Leave empty to use the one specified in the project.
    - svg_precision: [number=4] [0,6] Scale factor used to represent 1 mm in the SVG (KiCad 6). The value is how much zeros has the multiplier (1 mm = 10 power svg_precision units). Note that for an A4 paper Firefox 91 and Chrome 105 can't handle more than 5.
    - title: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.
    - variant: [string=''] Board variant to apply.
    - via_color: [string=''] Color used for through-hole colored_vias.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

PCB with variant generator

Type: pcb_variant
Description: Creates a copy of the PCB with all the filters and variants applied. This copy isn't intended for development. Is just a tweaked version of the original where you can look at the results.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the pcb_variant output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=variant, %x=kicad_pcb). Affected by global options.
    - copy_project: [boolean=true] Copy the KiCad project to the destination directory.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - hide_excluded: [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant. Affected by global options.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - title: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

PcbDraw - Beautiful 2D PCB render

Type: pcbdraw
Description: Exports the PCB as a 2D model (SVG, PNG or JPG). Uses configurable colors. Can also render the components if the 2D models are available. Note that this output is fast for simple PCBs, but becomes useless for huge ones. You can easily create very complex PCBs using the panelize output. In this case you can use other outputs, like render_3d, which are slow for small PCBs but can handle big ones
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the pcbdraw output.
  - Valid keys:
    - bottom: [boolean=false] Render the bottom side of the board (default is top side).
    - format: [string='svg'] [svg,png,jpg,bmp] Output format. Only used if no output is specified.
    - mirror: [boolean=false] Mirror the board.
    - output: [string='%f-%i%I%v.%x'] Name for the generated file. Affected by global options.
    - show_components: [list(string)|string=none] [none,all] List of components to draw, can be also a string for none or all. The default is none. There two ways of using this option, please consult the add_to_variant option. You can use _kf(FILTER) as an element in the list to get all the components that pass the filter. You can even use _kf(FILTER1;FILTER2) to concatenate filters.
    - style: [string|dict] PCB style (colors). An internal name, the name of a JSON file or the style options.
      - Valid keys:
        
        board: [string='#208b47'] Color for the board without copper (covered by solder mask).
        
        clad: [string='#cabb3e'] Color for the PCB core (not covered by solder mask).
        
        copper: [string='#285e3a'] Color for the copper zones (covered by solder mask).
        
        outline: [string='#000000'] Color for the outline.
        
        pads: [string='#8b898c'] Color for the exposed pads (metal finish).
        
        silk: [string='#d5dce4'] Color for the silk screen.
        
        highlight_on_top: [boolean=false] Highlight over the component (not under).
        
        highlight_padding: [number=1.5] [0,1000] How much the highlight extends around the component [mm].
        
        highlight_style: [string='stroke:none;fill:#ff0000;opacity:0.5;'] SVG code for the highlight style.
        
        vcut: [string='#bf2600'] Color for the V-CUTS.
    - add_to_variant: [boolean=true] The show_components list is added to the list of components indicated by the variant (fitted and not excluded). This is the old behavior, but isn't intuitive because the show_components meaning changes when a variant is used. In this mode you should avoid using show_components and variants. To get a more coherent behavior disable this option, and none will always be none. Also all will be what the variant says.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - dpi: [number=300] [10,1200] Dots per inch (resolution) of the generated image.
    - highlight: [list(string)=[]] List of components to highlight. Filter expansion is also allowed here, see show_components.
    - libs: [list(string)=[]] List of libraries.
    - margin: [number|dict] Margin around the generated image [mm]. Using a number the margin is the same in the four directions.
      - Valid keys:
        
        bottom: [number=0] Bottom margin [mm].
        
        left: [number=0] Left margin [mm].
        
        right: [number=0] Right margin [mm].
        
        top: [number=0] Top margin [mm].
    - no_drillholes: [boolean=false] Do not make holes transparent.
    - outline_width: [number=0.15] [0,10] Width of the trace to draw the PCB border [mm]. Note this also affects the drill holes.
    - placeholder: [boolean=false] Show placeholder for missing components.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - remap: [dict|None] (DEPRECATED) Replacements for PCB references using specified components (lib:component). Use remap_components instead.
    - remap_components: [list(dict)] Replacements for PCB references using specified components. Replaces remap with type check.
      - Valid keys:
        
        comp: [string=''] Component to use (from lib).
        
        component: Alias for comp.
        
        lib: [string=''] Library to use.
        
        library: Alias for lib.
        
        ref: [string=''] Reference for the component to change.
        
        reference: Alias for ref.
    - resistor_flip: [string|list(string)=''] List of resistors to flip its bands.
    - resistor_remap: [list(dict)] List of resitors to be remapped. You can change the value of the resistors here.
      - Valid keys:
        
        ref: [string=''] Reference for the resistor to change.
        
        reference: Alias for ref.
        
        val: [string=''] Value to use for ref.
        
        value: Alias for val.
    - show_solderpaste: [boolean=true] Show the solder paste layers.
    - size_detection: [string='kicad_edge'] [kicad_edge,kicad_all,svg_paths] Method used to detect the size of the resulting image. The kicad_edge method uses the size of the board as reported by KiCad, components that extend beyond the PCB limit will be cropped. You can manually adjust the margins to make them visible. The kicad_all method uses the whole size reported by KiCad. Usually includes extra space. The svg_paths uses all visible drawings in the image. To use this method you must install the numpy Python module (may not be available in docker images).
    - svg_precision: [number=4] [3,6] Scale factor used to represent 1 mm in the SVG (KiCad 6). The value is how much zeros has the multiplier (1 mm = 10 power svg_precision units). Note that for an A4 paper Firefox 91 and Chrome 105 can't handle more than 5.
    - variant: [string=''] Board variant to apply.
    - vcuts: [boolean=false] Render V-CUTS on the vcuts_layer layer.
    - vcuts_layer: [string='Cmts.User'] Layer to render the V-CUTS, only used when vcuts is enabled. Note that any other content from this layer will be included.
    - warnings: [string='visible'] [visible,all,none] Using visible only the warnings about components in the visible side are generated.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

PDF (Portable Document Format)

Type: pdf
Description: Exports the PCB to the most common exchange format. Suitable for printing. Note that this output isn't the best for documating your project. This output is what you get from the File/Plot menu in pcbnew. The pcb_print is usually a better alternative. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to plot.
  - Valid keys:
    - description: [string=''] A description for the layer, for documentation purposes.
    - layer: [string=''] Name of the layer. As you see it in KiCad.
    - suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the pdf output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Output file name, the default KiCad name if empty. IMPORTANT! KiCad will always create the file using its own name and then we can rename it. For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options.
    - plot_sheet_reference: [boolean=false] Include the frame and title block. Only available for KiCad 6+ and you get a poor result (i.e. always the default worksheet style, also problems expanding text variables). The pcb_print output can do a better job for PDF, SVG, PS, EPS and PNG outputs.
    - scaling: [number=1] Scale factor (0 means autoscaling).
    - custom_reports: [list(dict)] A list of customized reports for the manufacturer.
      - Valid keys:
        
        content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
        
        output: [string='Custom_report.txt'] File name for the custom report.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - drill_marks: [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale).
    - edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
    - exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
    - exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
    - force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
    - individual_page_scaling: [boolean=true] Tell KiCad to apply the scaling for each layer as a separated entity. Disabling it the pages are coherent and can be superposed.
    - inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
    - line_width: [number=0.1] [0.02,2] For objects without width [mm] (KiCad 5).
    - mirror_plot: [boolean=false] Plot mirrored.
    - negative_plot: [boolean=false] Invert black and white.
    - plot_footprint_refs: [boolean=true] Include the footprint references.
    - plot_footprint_values: [boolean=true] Include the footprint values.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - sketch_pad_line_width: [number=0.1] Line width for the sketched pads [mm], see sketch_pads_on_fab_layers (KiCad 6+) Note that this value is currently ignored by KiCad (6.0.9).
    - sketch_pads_on_fab_layers: [boolean=false] Draw only the outline of the pads on the *.Fab layers (KiCad 6+).
    - tent_vias: [boolean=true] Cover the vias.
    - uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
    - variant: [string=''] Board variant to apply.
- output: [string='%f-%i%I%v.%x'] Output file name, the default KiCad name if empty. IMPORTANT! KiCad will always create the file using its own name and then we can rename it. For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options.
- plot_sheet_reference: [boolean=false] Include the frame and title block. Only available for KiCad 6+ and you get a poor result (i.e. always the default worksheet style, also problems expanding text variables). The pcb_print output can do a better job for PDF, SVG, PS, EPS and PNG outputs.
- scaling: [number=1] Scale factor (0 means autoscaling).
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- custom_reports: [list(dict)] A list of customized reports for the manufacturer.
  - Valid keys:
    - content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
    - output: [string='Custom_report.txt'] File name for the custom report.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
- drill_marks: [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale).
- edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
- exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
- exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- individual_page_scaling: [boolean=true] Tell KiCad to apply the scaling for each layer as a separated entity. Disabling it the pages are coherent and can be superposed.
- inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- plot_footprint_refs: [boolean=true] Include the footprint references.
- plot_footprint_values: [boolean=true] Include the footprint values.
- pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.
- sketch_pad_line_width: [number=0.1] Line width for the sketched pads [mm], see sketch_pads_on_fab_layers (KiCad 6+) Note that this value is currently ignored by KiCad (6.0.9).
- sketch_pads_on_fab_layers: [boolean=false] Draw only the outline of the pads on the *.Fab layers (KiCad 6+).
- tent_vias: [boolean=true] Cover the vias.
- uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
- variant: [string=''] Board variant to apply.

PDF PCB Print (Portable Document Format) Deprecated

Type: pdf_pcb_print
Description: Exports the PCB to the most common exchange format. Suitable for printing. This is the main format to document your PCB. This output is what you get from the 'File/Print' menu in pcbnew. The pcb_print is usually a better alternative. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to include in the PDF.
  - Valid keys:
    - description: [string=''] A description for the layer, for documentation purposes.
    - layer: [string=''] Name of the layer. As you see it in KiCad.
    - suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the pdf_pcb_print output.
  - Valid keys:
    - plot_sheet_reference: [boolean=true] Include the title-block.
    - scaling: [number=1.0] Scale factor (0 means autoscaling). You should disable plot_sheet_reference when using it.
    - separated: [boolean=false] Print layers in separated pages.
    - color_theme: [string='_builtin_classic'] Selects the color theme. Onlyu applies to KiCad 6. To use the KiCad 6 default colors select _builtin_default. Usually user colors are stored as user, but you can give it another name.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - drill_marks: [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale).
    - force_edge_cuts: [boolean=true] Only useful for KiCad 6 when printing in one page, you can disable the edge here. KiCad 5 forces it by default, and you can't control it from config files. Same for KiCad 6 when printing to separated pages.
    - hide_excluded: [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant. Affected by global options.
    - mirror: [boolean=false] Print mirrored (X axis inverted). ONLY for KiCad 6.
    - monochrome: [boolean=false] Print in black and white.
    - output: [string='%f-%i%I%v.%x'] Filename for the output PDF (%i=layers, %x=pdf). Affected by global options.
    - output_name: Alias for output.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - title: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

PDF Schematic Print (Portable Document Format)

Type: pdf_sch_print
Description: Exports the schematic to the most common exchange format. Suitable for printing. This is the main format to document your schematic. This output is what you get from the 'File/Plot' menu in eeschema. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the pdf_sch_print output.
  - Valid keys:
    - frame: [boolean=true] Include the frame and title block.
    - all_pages: [boolean=true] Generate with all hierarchical sheets.
    - background_color: [boolean=false] Use the background color from the color_theme (KiCad 6).
    - color_theme: [string=''] Color theme used, this must exist in the KiCad config (KiCad 6).
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - monochrome: [boolean=false] Generate a monochromatic output.
    - output: [string='%f-%i%I%v.%x'] Filename for the output PDF (%i=schematic, %x=pdf). Affected by global options.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - title: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.
    - variant: [string=''] Board variant to apply. Not fitted components are crossed.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

PDF joiner

Type: pdfunite
Description: Generates a new PDF from other outputs. This is just a PDF joiner, using pdfunite from Poppler Utils.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the pdfunite output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Name for the generated PDF (%i=name of the output %x=pdf). Affected by global options.
    - outputs: [list(dict)] Which files will be included.
      - Valid keys:
        
        from_output: [string=''] Collect files from the selected output. When used the source option is ignored.
        
        source: [string='*.pdf'] File names to add, wildcards allowed. Use ** for recursive match. By default this pattern is applied to the output dir specified with -d command line option. See the from_cwd option.
        
        filter: [string='.*.pdf'] A regular expression that source files must match.
        
        from_cwd: [boolean=false] Use the current working directory instead of the dir specified by -d.
    - use_external_command: [boolean=false] Use the pdfunite tool instead of PyPDF2 Python module.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Populate - Assembly instructions builder

Type: populate
Description: Creates a markdown and/or HTML file explaining how to assembly a PCB. Each step shows the already soldered components and the ones to add highlighted. This is equivalent to the PcbDraw's Populate command, but integrated to KiBot. For more information about the input markdown file please consult the documentation
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the populate output.
  - Valid keys:
    - format: [string='html'] [html,md] Format for the generated output.
    - input: [string=''] Name of the input file describing the assembly. Must be a markdown file. Note that the YAML section of the file will be skipped, all the needed information comes from this output and the renderer output.
    - renderer: [string=''] Name of the output used to render the PCB steps. Currently this must be a pcbdraw or render_3d output.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - imgname: [string='img/populating_%d.%x'] Pattern used for the image names. The %d is replaced by the image number. The %x is replaced by the extension. Note that the format is selected by the renderer.
    - initial_components: [string|list(string)=''] List of components soldered before the first step.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - template: [string] The name of the handlebars template used for the HTML output. The extension must be .handlebars, it will be added when missing. The simple.handlebars template is a built-in template.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Pick & place

Type: position
Description: Generates the file with position information for the PCB components, used by the pick and place machine. This output is what you get from the 'File/Fabrication output/Footprint position (.pos) file' menu in pcbnew.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the position output.
  - Valid keys:
    - format: [string='ASCII'] [ASCII,CSV] Format for the position file.
    - only_smd: [boolean=true] Only include the surface mount components.
    - output: [string='%f-%i%I%v.%x'] Output file name (%i='top_pos'|'bottom_pos'|'both_pos', %x='pos'|'csv'). Important: when using separate files you must use %i to differentiate them. Affected by global options.
    - separate_files_for_front_and_back: [boolean=true] Generate two separated files, one for the top and another for the bottom.
    - units: [string='millimeters'] [millimeters,inches,mils] Units used for the positions. Affected by global options.
    - bottom_negative_x: [boolean=false] Use negative X coordinates for footprints on bottom layer.
    - columns: [list(dict)|list(string)] Which columns are included in the output.
      - Valid keys:
        
        id: [string=''] [Ref,Val,Package,PosX,PosY,Rot,Side] Internal name.
        
        name: [string=''] Name to use in the output file. The id is used when empty.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - include_virtual: [boolean=false] Include virtual components. For special purposes, not pick & place. Note that virtual components is a KiCad 5 concept. For KiCad 6+ we replace this concept by the option to exclude from position file.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - quote_all: [boolean=false] When generating the CSV quote all values, even numbers.
    - right_digits: [number=4] number of digits for mantissa part of coordinates (0 is auto).
    - use_aux_axis_as_origin: [boolean=true] Use the auxiliary axis as origin for coordinates (KiCad default).
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

PS (Postscript)

Type: ps
Description: Exports the PCB to a format suitable for printing. This output is what you get from the File/Plot menu in pcbnew. The pcb_print is usually a better alternative. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to plot.
  - Valid keys:
    - description: [string=''] A description for the layer, for documentation purposes.
    - layer: [string=''] Name of the layer. As you see it in KiCad.
    - suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the ps output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Output file name, the default KiCad name if empty. IMPORTANT! KiCad will always create the file using its own name and then we can rename it. For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options.
    - plot_sheet_reference: [boolean=false] Include the frame and title block. Only available for KiCad 6+ and you get a poor result (i.e. always the default worksheet style, also problems expanding text variables). The pcb_print output can do a better job for PDF, SVG, PS, EPS and PNG outputs.
    - scaling: [number=1] Scale factor (0 means autoscaling).
    - a4_output: [boolean=true] Force A4 paper size.
    - custom_reports: [list(dict)] A list of customized reports for the manufacturer.
      - Valid keys:
        
        content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
        
        output: [string='Custom_report.txt'] File name for the custom report.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - drill_marks: [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale).
    - edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
    - exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
    - exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
    - force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
    - individual_page_scaling: [boolean=true] Tell KiCad to apply the scaling for each layer as a separated entity. Disabling it the pages are coherent and can be superposed.
    - inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
    - line_width: [number=0.15] [0.02,2] For objects without width [mm] (KiCad 5).
    - mirror_plot: [boolean=false] Plot mirrored.
    - negative_plot: [boolean=false] Invert black and white.
    - plot_footprint_refs: [boolean=true] Include the footprint references.
    - plot_footprint_values: [boolean=true] Include the footprint values.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - scale_adjust_x: [number=1.0] Fine grain adjust for the X scale (floating point multiplier).
    - scale_adjust_y: [number=1.0] Fine grain adjust for the Y scale (floating point multiplier).
    - sketch_pad_line_width: [number=0.1] Line width for the sketched pads [mm], see sketch_pads_on_fab_layers (KiCad 6+) Note that this value is currently ignored by KiCad (6.0.9).
    - sketch_pads_on_fab_layers: [boolean=false] Draw only the outline of the pads on the *.Fab layers (KiCad 6+).
    - sketch_plot: [boolean=false] Don't fill objects, just draw the outline.
    - tent_vias: [boolean=true] Cover the vias.
    - uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
    - variant: [string=''] Board variant to apply.
    - width_adjust: [number=0] This width factor is intended to compensate PS printers/plotters that do not strictly obey line width settings. Only used to plot pads and tracks.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

PS Schematic Print (Postscript)

Type: ps_sch_print
Description: Exports the schematic in postscript. Suitable for printing. This output is what you get from the 'File/Plot' menu in eeschema. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the ps_sch_print output.
  - Valid keys:
    - frame: [boolean=true] Include the frame and title block.
    - all_pages: [boolean=true] Generate with all hierarchical sheets.
    - background_color: [boolean=false] Use the background color from the color_theme (KiCad 6).
    - color_theme: [string=''] Color theme used, this must exist in the KiCad config (KiCad 6).
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - monochrome: [boolean=false] Generate a monochromatic output.
    - output: [string='%f-%i%I%v.%x'] Filename for the output postscript (%i=schematic, %x=ps). Affected by global options.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - title: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.
    - variant: [string=''] Board variant to apply. Not fitted components are crossed.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

QR_Lib

Type: qr_lib
Description: Generates a QR code symbol and footprint. This output creates a library containing a symbol and footprint for a QR code. To refresh the generated symbols and footprints use the update_qr preflight. The workflow is as follows: - Create the symbol and footprints using this output. - Use them in your schematic and PCB. - To keep them updated add the update_qr preflight
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the boardview output.
  - Valid keys:
    - lib: [string='QR'] Short name for the library.
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=qr, %x=lib). Affected by global options.
    - qrs: [list(dict)] QR codes to include in the library.
      - Valid keys:
        
        layer: [string='silk'] [silk,copper] Layer for the footprint.
        
        name: [string='QR'] Name for the symbol/footprint.
        
        size_pcb: [number=15] Size of the QR footprint.
        
        size_sch: [number=15] Size of the QR symbol.
        
        text: [string='%p %r'] Text to encode as QR.
        
        correction_level: [string='low'] [low,medium,quartile,high] Error correction level.
        
        pcb_negative: [boolean=false] Generate a negative image for the PCB.
        
        size_units: [string='millimeters'] [millimeters,inches] Units used for the size.
    - reference: [string='QR'] The reference prefix.
    - use_sch_dir: [boolean=true] Generate the libs relative to the schematic/PCB dir.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=90] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

3D render of the PCB

Type: render_3d
Description: Exports the image generated by KiCad's 3D viewer.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the render_3d output.
  - Valid keys:
    - download: [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR. They are downloaded to a temporal directory and discarded. If you want to cache the downloaded files specify a directory using the KIBOT_3D_MODELS environment variable.
    - move_x: [number=0] Steps to move in the X axis, positive is to the right. Just like pressing the right arrow in the 3D viewer.
    - move_y: [number=0] Steps to move in the Y axis, positive is up. Just like pressing the up arrow in the 3D viewer.
    - no_virtual: [boolean=false] Used to exclude 3D models for components with 'virtual' attribute.
    - output: [string='%f-%i%I%v.%x'] Name for the generated image file (%i='3D_$VIEW' %x='png'). Affected by global options.
    - ray_tracing: [boolean=false] Enable the ray tracing. Much better result, but slow, and you'll need to adjust wait_rt.
    - rotate_x: [number=0] Steps to rotate around the X axis, positive is clockwise. Each step is currently 10 degrees. Only for KiCad 6 or newer.
    - rotate_y: [number=0] Steps to rotate around the Y axis, positive is clockwise. Each step is currently 10 degrees. Only for KiCad 6 or newer.
    - rotate_z: [number=0] Steps to rotate around the Z axis, positive is clockwise. Each step is currently 10 degrees. Only for KiCad 6 or newer.
    - show_components: [list(string)|string=all] [none,all] List of components to draw, can be also a string for none or all. Unlike the pcbdraw output, the default is all.
    - view: [string='top'] [top,bottom,front,rear,right,left,z,Z,y,Y,x,X] Point of view.
    - zoom: [number=0] Zoom steps. Use positive to enlarge, get closer, and negative to reduce. Same result as using the mouse wheel in the 3D viewer.
    - auto_crop: [boolean=false] When enabled the image will be post-processed to remove the empty space around the image. In this mode the background2 is changed to be the same as background1.
    - background1: [string='#66667F'] First color for the background gradient.
    - background2: [string='#CCCCE5'] Second color for the background gradient.
    - board: [string='#332B16'] Color for the board without copper or solder mask.
    - clip_silk_on_via_annulus: [boolean=true] Clip silkscreen at via annuli (KiCad 6+).
    - copper: [string='#8b898c'] Color for the copper.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - height: [number=720] Image height (aprox.).
    - highlight: [list(string)=[]] List of components to highlight.
    - highlight_on_top: [boolean=false] Highlight over the component (not under).
    - highlight_padding: [number=1.5] [0,1000] How much the highlight extends around the component [mm].
    - kicad_3d_url: [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models.
    - kicad_3d_url_suffix: [string=''] Text added to the end of the download URL. Can be used to pass variables to the GET request, i.e. ?VAR1=VAL1&VAR2=VAL2.
    - no_smd: [boolean=false] Used to exclude 3D models for surface mount components.
    - no_tht: [boolean=false] Used to exclude 3D models for through hole components.
    - orthographic: [boolean=false] Enable the orthographic projection mode (top view looks flat).
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - realistic: [boolean=true] When disabled we use the colors of the layers used by the GUI. KiCad 6 or newer.
    - show_adhesive: [boolean=false] Show the content of F.Adhesive/B.Adhesive layers. KiCad 6 or newer.
    - show_board_body: [boolean=true] Show the PCB core material. KiCad 6 or newer.
    - show_comments: [boolean=false] Show the content of the User.Comments layer. KiCad 6 or newer and ray tracing disabled.
    - show_eco: [boolean=false] Show the content of the Eco1.User/Eco2.User layers. KiCad 6 or newer and ray tracing disabled.
    - show_silkscreen: [boolean=true] Show the silkscreen layers (KiCad 6+).
    - show_soldermask: [boolean=true] Show the solder mask layers (KiCad 6+).
    - show_solderpaste: [boolean=true] Show the solder paste layers (KiCad 6+).
    - show_zones: [boolean=true] Show filled areas in zones (KiCad 6+).
    - silk: [string='#d5dce4'] Color for the silk screen.
    - solder_mask: [string='#208b47'] Color for the solder mask.
    - solder_paste: [string='#808080'] Color for the solder paste.
    - subtract_mask_from_silk: [boolean=true] Clip silkscreen at solder mask edges (KiCad 6+).
    - transparent_background: [boolean=false] When enabled the image will be post-processed to make the background transparent. In this mode the background1 and background2 colors are ignored.
    - transparent_background_color: [string='#00ff00'] Color used for the chroma key. Adjust it if some regions of the board becomes transparent.
    - transparent_background_fuzz: [number=15] [0,100] Chroma key tolerance (percent). Bigger values will remove more pixels.
    - variant: [string=''] Board variant to apply.
    - wait_ray_tracing: Alias for wait_render.
    - wait_render: [number=-600] How many seconds we must wait before capturing the render (ray tracing or normal). Lamentably KiCad can save an unfinished image. Enlarge it if your image looks partially rendered. Use negative values to enable the auto-detect using CPU load. In this case the value is interpreted as a time-out..
    - width: [number=1280] Image width (aprox.).
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Design report

Type: report
Description: Generates a report about the design. Mainly oriented to be sent to the manufacturer or check PCB details. You can expand internal values, KiCad text variables and environment variables using ${VARIABLE}
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the report output.
  - Valid keys:
    - convert_to: [string='pdf'] Target format for the report conversion. See do_convert.
    - do_convert: [boolean=false] Run Pandoc to convert the report. Note that Pandoc must be installed. The conversion is done assuming the report is in convert_from format. The output file will be in convert_to format. The available formats depends on the Pandoc installation. In CI/CD environments: the kicad_auto_test docker image contains it. In Debian/Ubuntu environments: install pandoc, texlive, texlive-latex-base and texlive-latex-recommended.
    - output: [string='%f-%i%I%v.%x'] Output file name (%i='report', %x='txt'). Affected by global options.
    - template: [string='full'] Name for one of the internal templates (full, full_svg, simple) or a custom template file. Environment variables and ~ are allowed. Note: when converting to PDF PanDoc can fail on some Unicode values (use simple_ASCII).
    - convert_from: [string='markdown'] Original format for the report conversion. Current templates are markdown. See do_convert.
    - converted_output: [string='%f-%i%I%v.%x'] Converted output file name (%i='report', %x=convert_to). Note that the extension should match the convert_to value. Affected by global options.
    - eurocircuits_class_target: [string='10F'] Which Eurocircuits class are we aiming at.
    - eurocircuits_reduce_holes: [number=0.45] When computing the Eurocircuits category: Final holes sizes smaller or equal to this given diameter can be reduced to accommodate the correct annular ring values. Use 0 to disable it.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Schematic with variant generator

Type: sch_variant
Description: Creates a copy of the schematic with all the filters and variants applied. This copy isn't intended for development. Is just a tweaked version of the original where you can look at the results.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the sch_variant output.
  - Valid keys:
    - copy_project: [boolean=false] Copy the KiCad project to the destination directory. Disabled by default for compatibility with older versions.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - title: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

3D Printed Stencils

Type: stencil_3d
Description: Creates a 3D self-registering model of a stencil you can easily print on SLA printer, you can use it to apply solder paste to your PCB. These stencils are quick solution when you urgently need a stencil but probably they don't last long and might come with imperfections. It currently uses KiKit, so please read KiKit docs. Note that we don't implement --ignore option, you should use a variant for this
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the stencil_3d output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i='stencil_3d_top'|'stencil_3d_bottom'|'stencil_3d_edge', %x='stl'|'scad'|'dxf'|'png'). Affected by global options.
    - thickness: [number=0.15] Stencil thickness [mm]. Defines amount of paste dispensed.
    - create_preview: [boolean=true] Creates a PNG showing the generated 3D model.
    - cutout: [string|list(string)] List of components to add a cutout based on the component courtyard. This is useful when you have already pre-populated board and you want to populate more components.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - enlarge_holes: Alias for enlarge_holes.
    - enlargeholes: [number=0] Enlarge pad holes by x mm.
    - frame_clearance: Alias for frameclearance.
    - frame_width: Alias for framewidth.
    - frameclearance: [number=0] Clearance for the stencil register [mm].
    - framewidth: [number=1] Register frame width.
    - include_scad: [boolean=true] Include the generated OpenSCAD files. Note that this also includes the DXF files.
    - pcb_thickness: Alias for pcbthickness.
    - pcbthickness: [number=0] PCB thickness [mm]. If 0 we will ask KiCad.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - side: [string='auto'] [top,bottom,auto,both] Which side of the PCB we want. Using auto will detect which side contains solder paste.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Steel Stencils for Alignment Jig

Type: stencil_for_jig
Description: Creates the gerber files needed to create steel stencils. These stencils are designed to be used with an acrilic alignment jig and a 3D printable support, that is also generated. KiKit docs. Note that we don't implement --ignore option, you should use a variant for this
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the stencil_for_jig output.
  - Valid keys:
    - jig_height: Alias for jigheight.
    - jig_thickness: Alias for jigthickness.
    - jig_width: Alias for jigwidth.
    - jigheight: [number=100] Jig frame height [mm].
    - jigthickness: [number=3] Jig thickness [mm].
    - jigwidth: [number=100] Jig frame width [mm].
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i='stencil_for_jig_top'|'stencil_for_jig_bottom', %x='stl'|'scad'|'gbp'|'gtp'|'gbrjob'|'png'). Affected by global options.
    - create_preview: [boolean=true] Creates a PNG showing the generated 3D model.
    - cutout: [string|list(string)] List of components to add a cutout based on the component courtyard. This is useful when you have already pre-populated board and you want to populate more components.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - include_scad: [boolean=true] Include the generated OpenSCAD files.
    - pcb_thickness: Alias for pcbthickness.
    - pcbthickness: [number=0] PCB thickness [mm]. If 0 we will ask KiCad.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - register_border_inner: Alias for registerborderinner.
    - register_border_outer: Alias for registerborderouter.
    - registerborderinner: [number=1] Inner register border [mm].
    - registerborderouter: [number=3] Outer register border [mm].
    - side: [string='auto'] [top,bottom,auto,both] Which side of the PCB we want. Using auto will detect which side contains solder paste.
    - tolerance: [number=0.05] Enlarges the register by the tolerance value [mm].
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure)

Type: step
Description: Exports the PCB as a 3D model. This is the most common 3D format for exchange purposes. This output is what you get from the 'File/Export/STEP' menu in pcbnew.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the step output.
  - Valid keys:
    - download: [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR. They are downloaded to a temporal directory and discarded. If you want to cache the downloaded files specify a directory using the KIBOT_3D_MODELS environment variable.
    - no_virtual: [boolean=false] Used to exclude 3D models for components with 'virtual' attribute.
    - origin: [string='grid'] Determines the coordinates origin. Using grid the coordinates are the same as you have in the design sheet. The drill option uses the auxiliary reference defined by the user. You can define any other origin using the format 'X,Y', i.e. '3.2,-10'.
    - output: [string='%f-%i%I%v.%x'] Name for the generated STEP file (%i='3D' %x='step'). Affected by global options.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - kicad_3d_url: [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models.
    - kicad_3d_url_suffix: [string=''] Text added to the end of the download URL. Can be used to pass variables to the GET request, i.e. ?VAR1=VAL1&VAR2=VAL2.
    - metric_units: [boolean=true] Use metric units instead of inches.
    - min_distance: [number=-1] The minimum distance between points to treat them as separate ones (-1 is KiCad default: 0.01 mm).
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - subst_models: [boolean=true] Substitute STEP or IGS models with the same name in place of VRML models.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

SVG (Scalable Vector Graphics)

Type: svg
Description: Exports the PCB to a format suitable for 2D graphics software. Unlike bitmaps SVG drawings can be scaled without losing resolution. This output is what you get from the File/Plot menu in pcbnew. The pcb_print is usually a better alternative. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to plot.
  - Valid keys:
    - description: [string=''] A description for the layer, for documentation purposes.
    - layer: [string=''] Name of the layer. As you see it in KiCad.
    - suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the svg output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Output file name, the default KiCad name if empty. IMPORTANT! KiCad will always create the file using its own name and then we can rename it. For this reason you must avoid generating two variants at the same directory when one of them uses the default KiCad name. Affected by global options.
    - plot_sheet_reference: [boolean=false] Include the frame and title block. Only available for KiCad 6+ and you get a poor result (i.e. always the default worksheet style, also problems expanding text variables). The pcb_print output can do a better job for PDF, SVG, PS, EPS and PNG outputs.
    - scaling: [number=1] Scale factor (0 means autoscaling).
    - custom_reports: [list(dict)] A list of customized reports for the manufacturer.
      - Valid keys:
        
        content: [string=''] Content for the report. Use ${basename} for the project name without extension. Use ${filename(LAYER)} for the file corresponding to LAYER.
        
        output: [string='Custom_report.txt'] File name for the custom report.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - drill_marks: [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale).
    - edge_cut_extension: [string=''] Used to configure the edge cuts layer extension for Protel mode. Include the dot.
    - exclude_edge_layer: [boolean=true] Do not include the PCB edge layer.
    - exclude_pads_from_silkscreen: [boolean=false] Do not plot the component pads in the silk screen (KiCad 5.x only).
    - force_plot_invisible_refs_vals: [boolean=false] Include references and values even when they are marked as invisible.
    - individual_page_scaling: [boolean=true] Tell KiCad to apply the scaling for each layer as a separated entity. Disabling it the pages are coherent and can be superposed.
    - inner_extension_pattern: [string=''] Used to change the Protel style extensions for inner layers. The replacement pattern can contain %n for the inner layer number and %N for the layer number. Example '.g%n'.
    - limit_viewbox: [boolean=false] When enabled the view box is limited to a selected area. This option can't be enabled when using a scale.
    - line_width: [number=0.25] [0.02,2] For objects without width [mm] (KiCad 5).
    - margin: [number|dict] Margin around the view box [mm]. Using a number the margin is the same in the four directions. See limit_viewbox option.
      - Valid keys:
        
        bottom: [number=0] Bottom margin [mm].
        
        left: [number=0] Left margin [mm].
        
        right: [number=0] Right margin [mm].
        
        top: [number=0] Top margin [mm].
    - mirror_plot: [boolean=false] Plot mirrored.
    - negative_plot: [boolean=false] Invert black and white.
    - plot_footprint_refs: [boolean=true] Include the footprint references.
    - plot_footprint_values: [boolean=true] Include the footprint values.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - size_detection: [string='kicad_edge'] [kicad_edge,kicad_all] Method used to detect the size of the view box. The kicad_edge method uses the size of the board as reported by KiCad, components that extend beyond the PCB limit will be cropped. You can manually adjust the margin to make them visible. The kicad_all method uses the whole size reported by KiCad. Usually includes extra space. See limit_viewbox option.
    - sketch_pad_line_width: [number=0.1] Line width for the sketched pads [mm], see sketch_pads_on_fab_layers (KiCad 6+) Note that this value is currently ignored by KiCad (6.0.9).
    - sketch_pads_on_fab_layers: [boolean=false] Draw only the outline of the pads on the *.Fab layers (KiCad 6+).
    - svg_precision: [number=4] [0,6] Scale factor used to represent 1 mm in the SVG (KiCad 6). The value is how much zeros has the multiplier (1 mm = 10 power svg_precision units). Note that for an A4 paper Firefox 91 and Chrome 105 can't handle more than 5.
    - tent_vias: [boolean=true] Cover the vias.
    - uppercase_extensions: [boolean=false] Use uppercase names for the extensions.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

SVG PCB Print (Scalable Vector Graphics) Deprecated

Type: svg_pcb_print
Description: Exports the PCB to the scalable vector graphics format. This output is what you get from the 'File/Print' menu in pcbnew. The pcb_print is usually a better alternative. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- layers: [list(dict)|list(string)|string] [all,selected,copper,technical,user] List of PCB layers to include in the PDF.
  - Valid keys:
    - description: [string=''] A description for the layer, for documentation purposes.
    - layer: [string=''] Name of the layer. As you see it in KiCad.
    - suffix: [string=''] Suffix used in file names related to this layer. Derived from the name if not specified.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the pdf_pcb_print output.
  - Valid keys:
    - output: [string='%f-%i%I%v.%x'] Filename for the output SVG (%i=layers, %x=svg). Affected by global options.
    - output_name: Alias for output.
    - plot_sheet_reference: [boolean=true] Include the title-block.
    - scaling: [number=1.0] Scale factor (0 means autoscaling). You should disable plot_sheet_reference when using it.
    - separated: [boolean=false] Print layers in separated pages.
    - color_theme: [string='_builtin_classic'] Selects the color theme. Onlyu applies to KiCad 6. To use the KiCad 6 default colors select _builtin_default. Usually user colors are stored as user, but you can give it another name.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - drill_marks: [string='full'] [none,small,full] What to use to indicate the drill places, can be none, small or full (for real scale).
    - enable_ki5_page_fix: [boolean=true] Enable workaround for KiCad 5 bug.
    - enable_ki6_page_fix: [boolean=true] Enable workaround for KiCad 6 bug #11033.
    - force_edge_cuts: [boolean=true] Only useful for KiCad 6 when printing in one page, you can disable the edge here. KiCad 5 forces it by default, and you can't control it from config files. Same for KiCad 6 when printing to separated pages.
    - hide_excluded: [boolean=false] Hide components in the Fab layer that are marked as excluded by a variant. Affected by global options.
    - mirror: [boolean=false] Print mirrored (X axis inverted). ONLY for KiCad 6.
    - monochrome: [boolean=false] Print in black and white.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - title: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

SVG Schematic Print

Type: svg_sch_print
Description: Exports the schematic in a vectorized graphics format. This is a format to document your schematic. This output is what you get from the 'File/Plot' menu in eeschema. If you use custom fonts and/or colors please consult the resources_dir global variable.
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the svg_sch_print output.
  - Valid keys:
    - frame: [boolean=true] Include the frame and title block.
    - all_pages: [boolean=true] Generate with all hierarchical sheets.
    - background_color: [boolean=false] Use the background color from the color_theme (KiCad 6).
    - color_theme: [string=''] Color theme used, this must exist in the KiCad config (KiCad 6).
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - monochrome: [boolean=false] Generate a monochromatic output.
    - output: [string='%f-%i%I%v.%x'] Filename for the output SVG (%i=schematic, %x=svg). Affected by global options.
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - title: [string=''] Text used to replace the sheet title. %VALUE expansions are allowed. If it starts with + the text is concatenated.
    - variant: [string=''] Board variant to apply. Not fitted components are crossed.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

VRML (Virtual Reality Modeling Language)

Type: vrml
Description: Exports the PCB as a 3D model (WRL file). This is intended for rendering, unlike STEP which is intended to be an exact mechanic model
Valid keys:
- comment: [string=''] A comment for documentation purposes. It helps to identify the output.
- dir: [string='./'] Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.
- name: [string=''] Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.
- options: [dict] Options for the vrml output.
  - Valid keys:
    - download: [boolean=true] Downloads missing 3D models from KiCad git. Only applies to models in KISYS3DMOD and KICAD6_3DMODEL_DIR. They are downloaded to a temporal directory and discarded. If you want to cache the downloaded files specify a directory using the KIBOT_3D_MODELS environment variable.
    - no_virtual: [boolean=false] Used to exclude 3D models for components with 'virtual' attribute.
    - output: [string='%f-%i%I%v.%x'] Filename for the output (%i=vrml, %x=wrl). Affected by global options.
    - show_components: [list(string)|string=all] [none,all] List of components to draw, can be also a string for none or all. Unlike the pcbdraw output, the default is all.
    - dir_models: [string='shapes3D'] Subdirectory used to store the 3D models for the components. If you want to create a monolithic file just use '' here. Note that the WRL file will contain relative paths to the models.
    - dnf_filter: [string|list(string)='_none'] Name of the filter to mark components as not fitted. A short-cut to use for simple cases where a variant is an overkill.
    - highlight: [list(string)=[]] List of components to highlight.
    - highlight_on_top: [boolean=false] Highlight over the component (not under).
    - highlight_padding: [number=1.5] [0,1000] How much the highlight extends around the component [mm].
    - kicad_3d_url: [string='https://gitlab.com/kicad/libraries/kicad-packages3D/-/raw/master/'] Base URL for the KiCad 3D models.
    - kicad_3d_url_suffix: [string=''] Text added to the end of the download URL. Can be used to pass variables to the GET request, i.e. ?VAR1=VAL1&VAR2=VAL2.
    - model_units: [string='millimeters'] [millimeters,meters,deciinches,inches] Units used for the VRML (1 deciinch = 0.1 inches).
    - pre_transform: [string|list(string)='_none'] Name of the filter to transform fields before applying other filters. A short-cut to use for simple cases where a variant is an overkill.
    - ref_units: [string='millimeters'] [millimeters,inches'] Units for ref_x and ref_y.
    - ref_x: [number=0] X coordinate to use as reference when use_pcb_center_as_ref and use_pcb_center_as_ref are disabled.
    - ref_y: [number=0] Y coordinate to use as reference when use_pcb_center_as_ref and use_pcb_center_as_ref are disabled.
    - use_aux_axis_as_origin: [boolean=false] Use the auxiliary axis as origin for coordinates. Has more precedence than use_pcb_center_as_ref.
    - use_pcb_center_as_ref: [boolean=true] The center of the PCB will be used as reference point. When disabled the ref_x, ref_y and ref_units will be used.
    - variant: [string=''] Board variant to apply.
- category: [string|list(string)=''] The category for this output. If not specified an internally defined category is used. Categories looks like file system paths, i.e. PCB/fabrication/gerber. The categories are currently used for navigate_results.
- disable_run_by_default: [string|boolean] Use it to disable the run_by_default status of other output. Useful when this output extends another and you don't want to generate the original. Use the boolean true value to disable the output you are extending.
- extends: [string=''] Copy the options section from the indicated output. Used to inherit options from another output of the same type.
- groups: [string|list(string)=''] One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.
- output_id: [string=''] Text to use for the %I expansion content. To differentiate variations of this output.
- priority: [number=50] [0,100] Priority for this output. High priority outputs are created first. Internally we use 10 for low priority, 90 for high priority and 50 for most outputs.
- run_by_default: [boolean=true] When enabled this output will be created when no specific outputs are requested.

Consolidating BoMs

Some times your project is composed by various boards, other times you are producing various products at the same time. In both cases you would want to consolidate the components acquisition in one operation. Of course you can create individual BoMs for each project in CSV format and then consolidate them using a spreadsheet editor. But KiBot offers another option: you create a BoM for your main project and then aggregate the components from the other projects.

Here is a simple example. Suppose you have three projects: merge_1, merge_2 and merge_3. For the merge_1 project you could use the following output:

kibot:
  version: 1

outputs:
  - name: 'bom_csv'
    comment: "Bill of Materials in CSV format"
    type: bom
    dir: BoM
    options:
      use_alt: true

Using the tests/board_samples/kicad_5/merge_1.sch from the git repo and storing the above example in m1.kibot.yaml you could run:

src/kibot -c m1.kibot.yaml -e tests/board_samples/kicad_5/merge_1.sch -d test_merge

And get test_merge/BoM/merge_1-bom.csv:

Row	Description	Part	References	Value	Quantity Per PCB	Datasheet
1	Unpolarized capacitor	C	C1	1nF	1	~
2	Unpolarized capacitor	C	C2	10nF	1	~
3	Resistor	R	R1-R3	1k	3	~

Project info:
Schematic:	merge_1
Variant:	default
Revision:
Date:	2021-02-02_12-12-27
KiCad Version:	5.1.9-73d0e3b20d~88~ubuntu21.04.1
Statistics:
Component Groups:	3
Component Count:	5
Fitted Components:	5
Number of PCBs:	1
Total Components:	5

This CSV says you have five components groped in three different types. They are one 1 nF capacitor, one 10 nF capacitor and three 1 k resistors. Now lets generate BoMs for the merge_2 example:

src/kibot -c m1.kibot.yaml -e tests/board_samples/kicad_5/merge_2.sch -d test_merge

We'll get test_merge/BoM/merge_2-bom.csv:

Row	Description	Part	References	Value	Quantity Per PCB	Datasheet
1	Unpolarized capacitor	C	C2	1nF	1	~
2	Unpolarized capacitor	C	C1	10nF	1	~
3	Resistor	R	R2-R4	1000	3	~
4	Resistor	R	R1	10k	1	~

Project info:
Schematic:	merge_2
Variant:	default
Revision:
Date:	2021-01-27_10-19-46
KiCad Version:	5.1.9-73d0e3b20d~88~ubuntu21.04.1
Statistics:
Component Groups:	4
Component Count:	6
Fitted Components:	6
Number of PCBs:	1
Total Components:	6

In this project we have six components from four different types. They are similar to merge_1 but now we also have a 10 k resistor. We don't need to generate this BoM to consolidate our projects, but is good to know what we have. And now lets generate BoMs for the merge_3 example:

src/kibot -c m1.kibot.yaml -e tests/board_samples/kicad_5/merge_3.sch -d test_merge

We'll get test_merge/BoM/merge_3-bom.csv:

Row	Description	Part	References	Value	Footprint	Quantity Per PCB	Status	Datasheet
1	Resistor	R	R5	1k		1		~
2	Resistor	R	R1-R4	10k		4		~

Project info:
Schematic:	merge_3
Variant:	default
Revision:
Date:	2021-01-27_10-21-29
KiCad Version:	5.1.9-73d0e3b20d~88~ubuntu21.04.1
Statistics:
Component Groups:	2
Component Count:	5
Fitted Components:	5
Number of PCBs:	1
Total Components:	5

This time we also have five components, but from two different types. They are one 1 k resistor and four 10 k resistors. Now suppose we want to create 10 boards for merge_1, 20 for merge_2 and 30 for merge_3. We could use the following configuration:

kibot:
  version: 1

outputs:
  - name: 'bom_csv'
    comment: "Bill of Materials in CSV format"
    type: bom
    dir: BoM
    options:
      use_alt: true
      number: 10
      aggregate:
        - file: tests/board_samples/kicad_5/merge_2.sch
          number: 20
        - file: tests/board_samples/kicad_5/merge_3.sch
          number: 30

Save it as m2.kibot.yaml and run:

src/kibot -c m2.kibot.yaml -e tests/board_samples/kicad_5/merge_1.sch -d test_merge_consolidate

The test_merge_consolidate/BoM/merge_1-bom.csv file will be generated containing:

Row	Description	Part	References	Value	Quantity Per PCB	Build Quantity	Datasheet	Source BoM
1	Unpolarized capacitor	C	C1 C2	1nF	2	30	~	merge_1(1) merge_2(1)
2	Unpolarized capacitor	C	C2 C1	10nF	2	30	~	merge_1(1) merge_2(1)
3	Resistor	R	R1-R3 R2-R4 R5	1k	7	120	~	merge_1(3) merge_2(3) merge_3(1)
4	Resistor	R	R1 R1-R4	10k	5	140	~	merge_2(1) merge_3(4)

Project info:
Variant:	default
KiCad Version:	5.1.9-73d0e3b20d~88~ubuntu21.04.1
Global statistics:
Component Groups:	4
Component Count:	16
Fitted Components:	16
Number of PCBs:	60
Total Components:	320
Project info:	merge_1
Schematic:	merge_1
Revision:
Date:	2021-02-02_12-12-27
Company:	Test company
Statistics:	merge_1
Component Groups:	3
Component Count:	5
Fitted Components:	5
Number of PCBs:	10
Total Components:	50
Project info:	merge_2
Schematic:	merge_2
Revision:
Date:	2021-01-27_10-19-46
Statistics:	merge_2
Component Groups:	4
Component Count:	6
Fitted Components:	6
Number of PCBs:	20
Total Components:	120
Project info:	merge_3
Schematic:	merge_3
Revision:
Date:	2021-01-27_10-21-29
Statistics:	merge_3
Component Groups:	2
Component Count:	5
Fitted Components:	5
Number of PCBs:	30
Total Components:	150

You can see that now we have much more stats. They say we have four different types, thirteen for board sets, a total of 60 boards and 250 components. Then we have individual stats for each project. The capacitors are easy to interpret, we have 30 1 nF capacitors merge_1 project has one and merge_2 another. As we have 10 merge_1 and 20 merge_2 boards this is clear. But looking at the 1 k resistors is harder. We have 80, three from merge_1, one from merge_2 and another from merge_3. So we have 103+203+30=120, this is clear, but the BoM says they are R1-R3 R2-R4 R5, which is a little bit confusing. In this simple example is easy to correlate R1-R3 to merge_1, R2-R4 to merge_2 and R5 to merge_1. For bigger projects this gets harder. Lets assign an id to each project, we'll use 'A' for merge_1, 'B' for merge_2 and 'C' for merge_3:

kibot:
  version: 1

outputs:
  - name: 'bom_csv'
    comment: "Bill of Materials in CSV format"
    type: bom
    dir: BoM
    options:
      use_alt: true
      number: 10
      ref_id: 'A:'
      aggregate:
        - file: tests/board_samples/kicad_5/merge_2.sch
          number: 20
          ref_id: 'B:'
        - file: tests/board_samples/kicad_5/merge_3.sch
          number: 30
          ref_id: 'C:'

Now test_merge_consolidate/BoM/merge_1-bom.csv will have the following information:

Row	Description	Part	References	Value	Quantity Per PCB	Build Quantity	Datasheet	Source BoM
1	Unpolarized capacitor	C	A:C1 B:C2	1nF	2	30	~	merge_1(1) merge_2(1)
2	Unpolarized capacitor	C	A:C2 B:C1	10nF	2	30	~	merge_1(1) merge_2(1)
3	Resistor	R	A:R1-A:R3 B:R2-B:R4 C:R5	1k	7	120	~	merge_1(3) merge_2(3) merge_3(1)
4	Resistor	R	B:R1 C:R1-C:R4	10k	5	140	~	merge_2(1) merge_3(4)

As you can see now we know A has R1-R3, B R2-R4 and for C R5 is the 1k resistor. If we want to compact the Source BoM column we just need to enable the source_by_id option:

kibot:
  version: 1

outputs:
  - name: 'bom_csv'
    comment: "Bill of Materials in CSV format"
    type: bom
    dir: BoM
    options:
      use_alt: true
      number: 10
      ref_id: 'A:'
      source_by_id: true
      aggregate:
        - file: tests/board_samples/kicad_5/merge_2.sch
          number: 20
          ref_id: 'B:'
        - file: tests/board_samples/kicad_5/merge_3.sch
          number: 30
          ref_id: 'C:'

And we'll get:

Row	Description	Part	References	Value	Quantity Per PCB	Build Quantity	Datasheet	Source BoM
1	Unpolarized capacitor	C	A:C1 B:C2	1nF	2	30	~	A:(1) B:(1)
2	Unpolarized capacitor	C	A:C2 B:C1	10nF	2	30	~	A:(1) B:(1)
3	Resistor	R	A:R1-A:R3 B:R2-B:R4 C:R5	1k	7	120	~	A:(3) B:(3) C:(1)
4	Resistor	R	B:R1 C:R1-C:R4	10k	5	140	~	B:(1) C:(4)

Importing outputs from another file

In some cases you may want to reuse configuration files. An example of this are the example files that generate gerbers and drill files for various manufacturers (see).

In this case you can create a section named import containing a list of configuration files. Here is an example:

import:
  - configs/Elecrow.kibot.yaml
  - configs/FusionPCB.kibot.yaml
  - configs/JLCPCB.kibot.yaml
  - configs/P-Ban.kibot.yaml
  - configs/PCBWay.kibot.yaml

This will import all the outputs from the listed files.

Importing other stuff from another file

This is a more complex case of the previous Importing outputs from another file. In this case you must use the more general syntax:

import:
  - file: FILE_CONTAINING_THE_YAML_DEFINITIONS
    outputs: LIST_OF_OUTPUTS
    preflights: LIST_OF_PREFLIGHTS
    filters: LIST_OF_FILTERS
    variants: LIST_OF_VARIANTS
    global: LIST_OF_GLOBALS
    groups: LIST_OF_GROUPS

This syntax is flexible. If you don't define which outputs, preflights, filters, variants, global and/or groups all will be imported. So you can just omit them, like this:

import:
  - file: FILE_CONTAINING_THE_YAML_DEFINITIONS

The LIST_OF_items can be a YAML list or just one string. Here is an example:

import:
  - file: FILE_CONTAINING_THE_YAML_DEFINITIONS
    outputs: one_name
    filters: ['name1', 'name2']

This will import the one_name output and the name1 and name2 filters. As variants is omitted, all variants will be imported. The same applies to other things like globals and groups. You can also use the all and none special names, like this:

import:
  - file: FILE_CONTAINING_THE_YAML_DEFINITIONS
    outputs: all
    filters: all
    variants: none
    global: none

This will import all outputs and filters, but not variants or globals. Also note that imported globals has more precedence than the ones defined in the same file. If you want to give more priority to the local values use:

kibot:
  version: 1
  imported_global_has_less_priority: true

import:
...

Another important detail is that global options that are lists gets the values merged. The last set of values found is inserted at the beginning of the list. You can collect filters for all the imported global sections.

Imports are processed recursively: An import section in an imported file is also processed (so importing A.yaml that imports B.yaml effectively imports both).

If an import filename is a relative path, it is resolved relative to the config file that contains the import (so it works regardless of the working directory and, in case of recursive imports, of where top-level config lives).

It's recommended to always use some file extension in the FILE_CONTAINING_THE_YAML_DEFINITIONS name. If you don't use any file extension and you use a relative path this name could be confused with an internal template. See Importing internal templates. If you need to use a name without any extension and a relative path, and this name is the same used for a KiBot template use the is_external option:

import:
  - file: Elecrow
    is_external: true

Parametrizable imports

You can create imports that are parametrizable. For this you must use the mechanism explained in the Doing YAML substitution or preprocessing section.

Importing internal templates

KiBot has some internally defined outputs, groups and filters. You can easily use them with the import mechanism. Use the file mechanism and don't include the extension for the file. When importing an internal template you don't need to specify its location. Here is an example:

import:
  - file: Elecrow

This will import the definitions for the internal Elecrow configuration. Here is a list of currently defined templates:

They include support for:

CheckZoneFill: enables the check_zone_fills preflight and checks the refilled PCB doesn't changed too much.
- _diff_cur_pcb_show: Makes a diff between the PCB in memory and the one on disk
- _diff_cur_pcb_check: Computes the difference between PCB in memory and the one on disk. Aborts if more than 100 pixels changed.
- Note: The _KIBOT_CHKZONE_THRESHOLD parameter can be used to adjust the number of changed pixels that we tolerate. Consult the Definitions during import section to know about parameters.
Elecrow: contain fabrication outputs compatible with Elecrow
- _Elecrow_gerbers: Gerbers
- _Elecrow_drill: Drill files
- _Elecrow_compress: Gerbers and drill files compressed in a ZIP
- _Elecrow: _Elecrow_gerbers+_Elecrow_drill
Elecrow_stencil: same as Elecrow, but also generates gerbers for F.Paste and B.Paste layers.
FusionPCB: contain fabrication outputs compatible with FusionPCB
- _FusionPCB_gerbers: Gerbers
- _FusionPCB_drill: Drill files
- _FusionPCB_compress: Gerbers and drill files compressed in a ZIP
- _FusionPCB: _FusionPCB_gerbers+_FusionPCB_drill
FusionPCB_stencil: same as FusionPCB, but also generates gerbers for F.Paste and B.Paste layers.
JLCPCB: contain fabrication outputs compatible with JLC PCB. Only SMD components. Use the field_lcsc_part global option to specify the LCSC part number field if KiBot fails to detect it.
- _JLCPCB_gerbers: Gerbers.
- _JLCPCB_drill: Drill files
- _JLCPCB_position: Pick and place, applies the _rot_footprint filter. You can change this filter.
- _JLCPCB_bom: List of LCSC parts, assumes a field named LCSC# contains the LCSC codes. You can change this filter.
- _JLCPCB_compress: Gerbers, drill, position and BoM files compressed in a ZIP
- _JLCPCB_fab: _JLCPCB_gerbers+_JLCPCB_drill
- _JLCPCB_assembly: _JLCPCB_position+_JLCPCB_bom
- _JLCPCB: _JLCPCB_fab+_JLCPCB_assembly
JLCPCB_stencil: same as JLCPCB, but also generates gerbers for F.Paste and B.Paste layers.
JLCPCB_with_THT: same as JLCPCB, but also including THT components.
JLCPCB_stencil_with_THT: same as JLCPCB_stencil, but also including THT components.
MacroFab_XYRS: XYRS position file in MacroFab format
- _macrofab_xyrs: Position file in XYRS format compatible with MacroFab.
PanelDemo_4x4: creates a 4x4 panel of the board, showing some of the panelize options
- _PanelDemo_4x4: The panel
P-Ban: contain fabrication outputs compatible with P-Ban
- _P-Ban_gerbers: Gerbers. You need to define the layers for more than 8.
- _P-Ban_drill: Drill files
- _P-Ban: _P-Ban_gerbers+_P-Ban_drill
P-Ban_stencil: same as P-Ban, but also generates gerbers for F.Paste and B.Paste layers.
PCB2Blender_2_1
- _PCB2Blender_layers_2_1: The layers in SVG format. Disabled by default.
- _PCB2Blender_vrml_2_1: The VRML for the board. Disabled by default.
- _PCB2Blender_tools_2_1: Pads and bounds information. Disabled by default.
- _PCB2Blender_2_1: The PCB3D file. Is enabled and creates the other files.
- _PCB2Blender_elements_2_1: _PCB2Blender_tools_2_1+_PCB2Blender_layers_2_1+_PCB2Blender_vrml_2_1
PCB2Blender_2_1_haschtl
- Imports PCB2Blender_2_1 and disables _PCB2Blender_2_1
- _PCB2Blender_tools_2_1_haschtl: Pads, bounds and stack-up information. Disabled by default.
- _PCB2Blender_2_1_haschtl: The PCB3D file. Is enabled and creates the other files.
- _PCB2Blender_elements_2_1_haschtl: _PCB2Blender_tools_2_1_haschtl+_PCB2Blender_layers_2_1+_PCB2Blender_vrml_2_1
PCBWay: contain fabrication outputs compatible with PCBWay
- _PCBWay_gerbers: Gerbers
- _PCBWay_drill: Drill files
- _PCBWay_compress: Gerbers and drill files compressed in a ZIP
- _PCBWay: _PCBWay_gerbers+_PCBWay_drill
PCBWay_stencil: same as PCBWay, but also generates gerbers for F.Paste and B.Paste layers.

Using other output as base for a new one

If you need to define an output that is similar to another, and you want to avoid copying the options from the former, you can extend an output. To achieve it just specify the name of the base output in the extends value. Note that this will use the options of the other output as base, not other data as the comment.

Also note that you can use YAML anchors, but this won't work if you are importing the base output from other file.

Additionally you must be aware that extending an output doesn't disable the base output. If you need to disable the original output use disable_run_by_default option.

Grouping outputs

Sometimes you want to generate various outputs together. An example could be the fabrication files, or the documentation for the project.

To explain it we will use an example where you have six outputs. Three are used for fabrication: gerbers, excellon_drill and position. Another three are used for documentation: SVG, PcbDraw and PcbDraw2. The YAML config containing this example can be found here. If you need to generate the fabrication outputs you must run:

kibot gerbers excellon_drill position

One mechanism to group the outputs is to create a compress output that just includes the outputs you want to group. Here is one example:

  - name: compress_fab
    comment: "Generates a ZIP file with all the fab outputs"
    type: compress
    run_by_default: false
    options:
      files:
        - from_output: gerbers
        - from_output: excellon_drill
        - from_output: position

The compress_fab output will generate the gerbers, excellon_drill and position outputs. Then it will create a ZIP file containing the files generated by these outputs. The command line invocation for this is:

kibot compress_fab

Using this mechanism you are forced to create a compressed output. To avoid it you can use groups. The groups section is used to create groups of outputs. Here is the example for fabrication files:

groups:
  - name: fab
    outputs:
      - gerbers
      - excellon_drill
      - position

So now you can just run:

kibot fab

The gerbers, excellon_drill and position outputs will be generated without the need to generate an extra file. Groups can be nested, here is an example:

groups:
  - name: fab
    outputs:
      - gerbers
      - excellon_drill
      - position
  - name: plot
    outputs:
      - SVG
      - PcbDraw
      - PcbDraw2
  - name: fab_svg
    outputs:
      - fab
      - SVG

Here the fab_svg group will contain gerbers, excellon_drill, position and SVG.

Groups can be imported from another YAML file.

Avoid naming groups using _ as first character. These names are reserved for KiBot.

Doing YAML substitution or preprocessing

Sometimes you could want to change values in the YAML depending on external stuff, or just want to be able to change something for each variant run.

In this case you can use external tools to create various YAML files using a template, but you can also use KiBot's definitions.

The definitions allows you to replace tags like @VARIABLE@ by some specified value. These definitions can be specified at the command line using the -E option. As an example: -E UNITS=millimeters will replace all @UNITS@ markers by millimeters. This is applied to all YAML files loaded, so this propagates to all the imported YAML files.

You can use -E as many times as you need.

Default definitions

A configuration file using the @VARIABLE@ tags won't be usable unless you provide proper values for all de used variables. When using various tags this could be annoying. KiBot supports defining default values for the tags. Here is an example:

kibot:
  version: 1

outputs:
  - name: 'gerbers_@ID@'
    comment: "Gerbers with definitions"
    type: gerber
    output_id: _@ID@
    layers: @LAYERS@
...
definitions:
  ID: def_id
  LAYERS: F.Cu

Note that from the YAML point this is two documents in the same file. The second document is used to provide default values for the definitions. As defaults they have the lowest precedence.

Definitions during import

When importing a configuration you can specify values for the @VARIABLE@ tags. This enables the creation of parametrizable imports. Using the example depicted in Default definitions saved to a file named simple.kibot.yaml you can use:

kibot:
  version: 1

import:
  - file: simple.kibot.yaml
    definitions:
      ID: external_copper
      LAYERS: "[F.Cu, B.Cu]"

This will import simple.kibot.yaml and use these particular values. Note that they have more precedence than the definitions found in simple.kibot.yaml, but less precedence than any value passed from the command line.

Recursive definitions expansion

When KiBot expands the @VARIABLE@ tags it first applies all the replacements defined in the command line, and then all the values collected from the definitions. After doing a round of replacements KiBot tries to do another. This process is repeated until nothing is replaced or we reach 20 iterations. So you can define a tag that contains another tag.

As an example, if the configuration shown in Definitions during import is stored in a file named top.kibot.yaml you could use:

kibot -v -c top.kibot.yaml -E ID=@LAYERS@

This will generate gerbers for the front/top and bottom layers using [F.Cu, B.Cu] as output id. So you'll get light_control-B_Cu_[F.Cu, B.Cu].gbr and light_control-F_Cu_[F.Cu, B.Cu].gbr.

Usage

For a quick start just go to the project's dir and run:

kibot --quick-start

This will generate a configuration and generate outputs. If you want to just generate the configuration, and not the outputs, use:

kibot --quick-start --dry

If you need a more exhaustive configuration file try:

kibot --example

This will generate a file named example.kibot.yaml containing all the available options and comments about them. You can use it to create your own configuration file.

If you want to use the layers of a particular PCB in the example use:

kibot -b PCB_FILE --example

And if you want to use the same options selected in the plot dialog use:

kibot -b PCB_FILE -p --example

If the current directory contains only one PCB file and only one configuration file (named *.kibot.yaml) you can just call kibot. No arguments needed. The tool will figure out which files to use.

If more than one file is found in the current directory kibot will use the first found and issue a warning. If you need to use other file just tell it explicitly:

kibot -b PCB_FILE.kicad_pcb -c CONFIG.kibot.yaml

A simple target can be added to your makefile, so you can just run make pcb_files or integrate into your current build process.

pcb_files:
    kibot -b $(PCB) -c $(KIBOT_CFG)

If you need to suppress messages use --quiet or -q and if you need to get more information about what's going on use --verbose or -v.

If you want to generate only some of the outputs use:

kibot OUTPUT_1 OUTPUT_2

If you want to generate all outputs with some exceptions use:

kibot --invert-sel OUTPUT_1 OUTPUT_2

Note that you can use the run_by_default option of the output you want to exclude from the default runs.

If you want to skip the DRC and ERC use:

kibot --skip-pre run_erc,run_drc

If you want to skip all the preflight tasks use:

kibot --skip-pre all

All outputs are generated using the current directory as base. If you want to use another directory as base use:

kibot --out-dir OTHER_PLACE

If you want to list the available outputs defined in the configuration file use:

kibot --list

Command line help

KiBot: KiCad automation tool for documents generation

Usage:
  kibot [-b BOARD] [-e SCHEMA] [-c CONFIG] [-d OUT_DIR] [-s PRE] [-D]
         [-q | -v...] [-L LOGFILE] [-C | -i | -n] [-m MKFILE] [-A] [-g DEF] ...
         [-E DEF] ... [-w LIST] [--banner N] [TARGET...]
  kibot [-v...] [-b BOARD] [-e SCHEMA] [-c PLOT_CONFIG] [--banner N]
         [-E DEF] ... [--config-outs] [--only-pre|--only-groups] [--only-names]
         [--output-name-first] --list
  kibot [-v...] [-c PLOT_CONFIG] [--banner N] [-E DEF] ... [--only-names]
         --list-variants
  kibot [-v...] [-b BOARD] [-d OUT_DIR] [-p | -P] [--banner N] --example
  kibot [-v...] [--start PATH] [-d OUT_DIR] [--dry] [--banner N]
         [-t, --type TYPE]... --quick-start
  kibot [-v...] --help-filters
  kibot [-v...] [--markdown|--json] --help-dependencies
  kibot [-v...] --help-global-options
  kibot [-v...] --help-list-outputs
  kibot [-v...] --help-output=HELP_OUTPUT
  kibot [-v...] --help-outputs
  kibot [-v...] --help-preflights
  kibot [-v...] --help-variants
  kibot [-v...] --help-banners
  kibot -h | --help
  kibot --version

Arguments:
  TARGET    Outputs to generate, default is all

Options:
  -A, --no-auto-download           Disable dependencies auto-download
  -b BOARD, --board-file BOARD     The PCB .kicad-pcb board file
  --banner N                       Display banner number N (-1 == random)
  -c CONFIG, --plot-config CONFIG  The plotting config file to use
  -C, --cli-order                  Generate outputs using the indicated order
  --config-outs                    Configure all outputs before listing them
  -d OUT_DIR, --out-dir OUT_DIR    The output directory [default: .]
  -D, --dont-stop                  Try to continue if an output fails
  -e SCHEMA, --schematic SCHEMA    The schematic file (.sch/.kicad_sch)
  -E DEF, --define DEF             Define preprocessor value (VAR=VAL)
  -g DEF, --global-redef DEF       Overwrite a global value (VAR=VAL)
  -i, --invert-sel                 Generate the outputs not listed as targets
  -l, --list                       List available outputs, preflights and
                                   groups (in the config file).
                                   You don't need to specify an SCH/PCB unless
                                   using --config-outs
  --list-variants                  List the available variants and exit
  -L, --log LOGFILE                Log to LOGFILE using maximum debug level.
                                   Is independent of what is logged to stderr
  -m MKFILE, --makefile MKFILE     Generate a Makefile (no targets created)
  -n, --no-priority                Don't sort targets by priority
  -p, --copy-options               Copy plot options from the PCB file
  --only-names                     Print only the names. Note that for --list
                                   if no other --only-* option is provided it
                                   also acts as a virtual --only-outputs
  --only-groups                    Print only the groups.
  --only-pre                       Print only the preflights
  --output-name-first              Use the output name first when listing
  -P, --copy-and-expand            As -p but expand the list of layers
  -q, --quiet                      Remove information logs
  -s PRE, --skip-pre PRE           Skip preflights, comma separated or `all`
  -v, --verbose                    Show debugging information
  -V, --version                    Show program's version number and exit
  -w, --no-warn LIST               Exclude the mentioned warnings (comma sep)
  -x, --example                    Create a template configuration file

Quick start options:
  --quick-start                    Generates demo config files and their outputs
  --dry                            Just generate the config files
  --start PATH                     Starting point for the search [default: .]
  -t, --type TYPE                  Generate examples only for the indicated type/s

Help options:
  -h, --help                       Show this help message and exit
  --help-banners                   Show all available banners
  --help-dependencies              List dependencies in human readable format
  --help-filters                   List supported filters and details
  --help-global-options            List supported global variables
  --help-list-outputs              List supported outputs
  --help-output HELP_OUTPUT        Help for this particular output
  --help-outputs                   List supported outputs and details
  --help-preflights                List supported preflights and details
  --help-variants                  List supported variants and details

Usage for CI/CD

When using a GitHub or GitLab repo you can use KiBot to generate all the needed stuff each time you commit a change to the schematic and/or PCB file.

If you want a quick demo of what KiBot can do on a GitHub project try the following workflow. You just need to enable GitHub workflows and copy this workflow to your .github/workflows/ folder. In this mode KiBot will detect the project files, create a configuration and generate the targets. This workflow collects the generated files in Automatic_outputs.zip.

Examples of how to use KiBot can be found here for GitHub and here for GitLab.

In order to run KiBot on these environments you need a lot of software installed. The usual mechanism to achieve this is using docker. Docker images containing KiBot, all the supporting scripts and a corresponding KiCad can be found in the kicad5_auto, kicad6_auto and kicad7_auto GitHub packages. More complete images, with Pandoc, LaTeX, Blender and testing tools, can be found in the following packages: kicad5_auto_full, kicad6_auto_full and kicad7_auto_full GitHub packages. Old images can be found at Docker Hub as setsoft/kicad_auto and setsoft/kicad_auto_test.

The images are based on kicad5_debian, kicad6_debian and kicad7_debian. (setsoft/kicad_debian on Docker Hub), containing KiCad on Debian GNU/Linux.

If you need to run the current development version of KiBot you can use the following docker images: ghcr.io/inti-cmnb/kicad5_auto_full:dev, ghcr.io/inti-cmnb/kicad6_auto_full:dev or ghcr.io/inti-cmnb/kicad7_auto_full:dev (setsoft/kicad_auto:dev). These images are based on the full (also named test) images.

The most important images are:

Name	KiBot	KiCad
ghcr.io/inti-cmnb/kicad5_auto_full:latest	last release	5.1.9
ghcr.io/inti-cmnb/kicad6_auto_full:latest	last release	6.x
ghcr.io/inti-cmnb/kicad7_auto_full:latest	last release	7.x
ghcr.io/inti-cmnb/kicad5_auto:latest	last release	5.1.9
ghcr.io/inti-cmnb/kicad6_auto:latest	last release	6.x
ghcr.io/inti-cmnb/kicad7_auto:latest	last release	7.x
ghcr.io/inti-cmnb/kicad5_auto_full:dev	git code	5.1.9
ghcr.io/inti-cmnb/kicad6_auto_full:dev	git code	6.x
ghcr.io/inti-cmnb/kicad7_auto_full:dev	git code	7.x
ghcr.io/inti-cmnb/kicad5_auto_full:1.6.0	1.6.0	5.1.9
ghcr.io/inti-cmnb/kicad6_auto_full:1.6.0	1.6.0	6.0.10
ghcr.io/inti-cmnb/kicad5_auto_full:1.5.1	1.5.1	5.1.9
ghcr.io/inti-cmnb/kicad6_auto_full:1.5.1	1.5.1	6.0.10
ghcr.io/inti-cmnb/kicad5_auto_full:1.4.0	1.4.0	5.1.9
ghcr.io/inti-cmnb/kicad6_auto_full:1.4.0	1.4.0	6.0.9
ghcr.io/inti-cmnb/kicad5_auto_full:1.3.0	1.3.0	5.1.9
ghcr.io/inti-cmnb/kicad6_auto_full:1.3.0	1.3.0	6.0.7
ghcr.io/inti-cmnb/kicad5_auto:1.2.0	1.2.0	5.1.9
ghcr.io/inti-cmnb/kicad6_auto:1.2.0	1.2.0	6.0.5

For more information about the docker images visit kicad_debian and kicad_auto.

Usage of GitHub Actions

Note: You can also use --quick-start functionality with GitHub actions, an example is this workflow. This is the fastest way to test KiBot functionality.

You need to put a config.kibot.yaml file into the KiCad project folder.

Here is an example of workflow file using the GitHub Action:

name: example

on:
  push:
    paths:
    - '**.sch'
    - '**.kicad_pcb'
  pull_request:
    paths:
      - '**.sch'
      - '**.kicad_pcb'

jobs:
  example:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - uses: INTI-CMNB/KiBot@v2
      with:
        # Required - kibot config file
        config: config.kibot.yaml
        # optional - prefix to output defined in config
        dir: output
        # optional - schematic file
        schema: 'schematic.sch'
        # optional - PCB design file
        board: 'pcb.kicad_pcb'
    - name: upload results
      uses: actions/upload-artifact@v2
      with:
        name: output
        path: output

For KiCad 6 use v2_k6 instead of v2 (v2_k7 for KiCad 7). These actions use the last KiBot stable release, to use the current development code use v2_dk6 (KiCad 6) and v2_d (KiCad 5).

A working example applied to a repo can be found here (spora_main.yml). Another example, but using variants can be found here (kibot_action.yml for KiCad 6, kibot_action.yml for KiCad 5)

The available options are:

additional_args: Additional text to add to the KiBot invocation. This is intended for advanced use, report problems.
cache3D: When YES you can cache the downloaded 3D models. An example can be found here.
config: The KiBot config file to use. The first file that matches *.kibot.yaml is used when omitted.
dir: Output directory for the generated files. The current directory is used when omitted.
board: Name of the PCB file. The first file that matches *.kicad_pcb is used when omitted.
install3D: When YES installs the KiCad 3D models. Note that this will download more than 360 MiB and install more than 5 GiB of files.
quickstart: When YES ignores all the other options and runs in --quick-start mode. No configuration needed.
schema: Name of the schematic file. The first file that matches *.*sch is used when omitted.
skip: Skip preflights, comma separated or all. Nothing is skipped when omitted.
targets: List of targets to generate separated by spaces. To only run preflights use NONE. All targets are generated when omitted.
variant: Global variant to use. No variant is applied when omitted.
verbose: Level of verbosity. Valid values are 0, 1, 2 or 3. Default is 0.

GitHub Actions tags

There are several tags you can choose:

Tag	API	KiBot	KiCad
v1	1	1.2.0	5.1.9
v1_k6	1	1.2.0	6.0.5
v2_1_2_0	2	1.2.0	5.1.9
v2_k6_1_2_0	2	1.2.0	6.0.5
v2_1_3_0	2	1.3.0	5.1.9
v2_k6_1_3_0	2	1.3.0	6.0.7
v2_1_4_0	2	1.4.0	5.1.9
v2_k6_1_4_0	2	1.4.0	6.0.9
v2_1_5_1	2	1.5.1	5.1.9
v2_k6_1_5_1	2	1.5.1	6.0.9
v2_1_6_0	2	1.6.0	5.1.9
v2_k6_1_6_0	2	1.6.0	6.0.9
v2_1_6_2	2	1.6.2	5.1.9
v2_k6_1_6_2	2	1.6.2	6.0.11
v2_k7_1_6_2	2	1.6.2	7.0.5.1
v2	2	last release	5.1.9
v2_k6	2	last release	6.x
v2_k7	2	last release	7.x
v2_d	2	git code	5.1.9
v2_dk6	2	git code	6.x
v2_dk7	2	git code	7.x

The main differences between API 1 and 2 are:

API 2 adds support for variants and quick-start
In API 2 you can select which targets are created
In API 1 you must specify the input files, in API 2 can be omitted
API 1 supports wildcards in the filenames, API 2 doesn't
API 2 supports spaces in the filenames, API 1 doesn't

Also note that v2 images are currently using the full docker image (v1.5 and newer). It includes things like PanDoc and Blender.

GitHub Cache

GitHub offers a mechanism to cache data between runs. One interesting use is to make the KiCost prices cache persistent, here is an example

Another use is to cache downloaded 3D models

Contributing

If you find KiBot useful please consider contributing to the project. There various ways to contribute. Of course donations are welcome (donate), but there are other ways to contribute:

In general:
- Your workflow: What's missing in KiBot for your workflow? Comment it in the discussions
- Configuration for a manufacturer: If you have a configuration known to work for a manufacturer please consider contributing it. Even if this is a small manufacurer, this helps to know what are the most common options.
- Mention KiBot: If your project or company uses KiBot you can mention it, so people know about KiBot. Also if you are reporting a KiCad issue, currently KiCad developers doesn't pay much attention to automation details.
If you are a Windows/Mac OS X user:
- If you managed to run it locally consider contributing a tutorial of how to do it.
- If you run KiBot on CI/CD and want to run it locally: consider investing some time on tests. Just comment in the discussions and I'll help you to run tests to adapt the code. Now that KiCad 6 uses Python 3 most of KiBot functionality should work on Windows and Mac OS X. People are using WSL to run KiBot, but we don't have a tutorial about how to do it.
If you use a Linux that isn't derived from Debian:
- Consider helping to add better support for it. Do you know the name of the packages for the dependencies? Do you know how to create a package for your distro?
If you are good writing tutorials:
- Consider writing some tutorial about using KiBot. Some examples:
  - How to start using it
  - How to use filters/variants
  - How to create good BoMs
If you know Python:
- Create a new output: KiBot is modular, creating a new output can be done just using some of the kibot/out_* files as template. The outputs works as plugins and they are automatically discovered by KiBot. Note that you can add them to ~/.config/kibot/plugins
- Add regression tests: If you know about Python testing you can add tests to tests/test_plot/. We try to cover 100% of the code. Even simple tests that check the code executes are welcome.
If you know HTML/CSS:
- Internal BoM styles: You can just take a look at the generated HTMLs and contribute a CSS, or take a look at the code (kibot/bom/html_writer.py) and add more functionality.
- Navigate results styles: Similar to the above but for the navigate_results output (kibot/out_navigate_results.py).
If you have drawing skills:
- Navigate results icons: Currently we have only one set of icons, they are from KiCad 6. Alternative icons are welcome.

Notes about Gerber format

I found this topic poorly documented and quite complex. So here is what I know, feel free to send me any corrections. Note that this is a very dynamic topic and this text was written in november 2020.

The gerber format is controlled by Ucamco, a leading manufacturer of equipment and software for PCB fabrication. Even when this isn't an open standard they release the spec for free and interact with Jean-Pierre Charras (father of KiCad). So KiCad support for gerber format is really updated.

The gerber format evolved with time, here are the versions I know:

RS-274D obsolete version of the format.
RS-274X (aka X1) this is the extended version of the format. Is the most widely supported, but has some limitations.
X2 this is the format currently recommended by Ucamco and the default for modern KiCad versions. This extension adds important meta-data to the files. It helps CAM operators to know what's every drawing in the image. So you know which are pads, tracks, etc. And also more interesting information: impedance controlled tracks, the role of each file, etc. Using X2 you can know what is each file without the need of special names or file extensions. KiCad can generate drill files using X2.
X3 this is the current draft. One interesting addition is the Components role. These files replaces the position files, adding important information about the footprint.

In addition to them is the spec for the Gerber Job file. This file was introduced between X2 and X3, and is used to group all the gerber files. The gbrjob file contains all the missing stack-up information.

KiCad 5 can generate X1, X2 and gerber job files, including drill information in gerber format. KiCad 5.99 (6.0 pre-release) can also generate X3 files (position files in gerber format).

As you can see the idea of Ucamco is to unify all fabrication information in one format.

The X2 format was designed in a way that software that fully implement X1 can just ignore the added meta-data. In an ideal world you shouldn't bother about it and generate X2 files. Just use the gbr file extension and a gbrjob file. The problem is with poorly implemented CAM tools. In particular CAM350, used by various important cheap China manufacturers. This software has known issues interpretating aperture macros and some X2 data. If your manufacturer has problems with your files check the following:

Put gerber, drill and position files in the same directory.
Disable X2 extensions (use_gerber_x2_attributes set to false)
Use arcaic role mechanism (use_protel_extensions set to true)
Disable aperture macros (KiCad 6 only: disable_aperture_macros set to true)

The kicad-gerberzipper is an action plugin for KiCad oriented to help to generate gerber and drill files for some manufacturers. I adapted the configurations from kicad-gerberzipper to KiBot configurations, they are available as internal templates.

Notes about the position file

Position files are quite simple. You can generate them as plain text (ASCII) or as a spreadsheet (CSV).

But some conventions can make them tricky. Some manufacturers, like JLCPCB, uses conventions that are incompatible with KiCad.

The following blog explains how to adapt the position files generated by KiCad to what JLCPCB needs. To achieve it the author uses a script called JLCKicadTools.

You can achieve the same using KiBot. Here is a configuration example that generates the BoM and position files in the same way JLCKicadTools does:

kibot:
  version: 1

filters:
  - name: only_jlc_parts
    comment: 'Only parts with JLC code'
    type: generic
    include_only:
      - column: 'LCSC#'
        regex: '^C\d+'

variants:
  - name: rotated
    comment: 'Just a place holder for the rotation filter'
    type: kibom
    variant: rotated
    pre_transform: _rot_footprint

outputs:
  - name: 'position'
    comment: "Pick and place file, JLC style"
    type: position
    options:
      variant: rotated
      output: '%f_cpl_jlc.%x'
      format: CSV
      units: millimeters
      separate_files_for_front_and_back: false
      only_smd: true
      columns:
        - id: Ref
          name: Designator
        - Val
        - Package
        - id: PosX
          name: "Mid X"
        - id: PosY
          name: "Mid Y"
        - id: Rot
          name: Rotation
        - id: Side
          name: Layer

  - name: 'bom'
    comment: "BoM for JLC"
    type: bom
    options:
      output: '%f_%i_jlc.%x'
      exclude_filter: 'only_jlc_parts'
      ref_separator: ','
      columns:
        - field: Value
          name: Comment
        - field: References
          name: Designator
        - Footprint
        - field: 'LCSC#'
          name: 'LCSC Part #'
      csv:
        hide_pcb_info: true
        hide_stats_info: true
        quote_all: true

The only_jlc_parts filter is used to generate the BoM and assumes you put the JLC component code in a field named LCSC# (JLC uses LCSC as supplier). Note that the author of the blog simply used Field4 for this and his script searches for any field containing the ^C\d+ pattern. I think this isn't a good idea and I suggest using a defined name, like in this example.

The rotated variant is used only to apply the _rot_footprint transformation filter. This filter is an internal filter of type rot_footprint. Here is the same configuration file making explicit use of the rotation filter:

kibot:
  version: 1

filters:
  - name: fix_rotation
    comment: 'Adjust rotation for JLC'
    type: rot_footprint

  - name: only_jlc_parts
    comment: 'Only parts with JLC code'
    type: generic
    include_only:
      - column: 'LCSC#'
        regex: '^C\d+'

variants:
  - name: rotated
    comment: 'Just a place holder for the rotation filter'
    type: kibom
    variant: rotated
    pre_transform: fix_rotation

outputs:
  - name: 'position'
    comment: "Pick and place file, JLC style"
    type: position
    options:
      variant: rotated
      output: '%f_cpl_jlc.%x'
      format: CSV
      units: millimeters
      separate_files_for_front_and_back: false
      only_smd: true
      columns:
        - id: Ref
          name: Designator
        - Val
        - Package
        - id: PosX
          name: "Mid X"
        - id: PosY
          name: "Mid Y"
        - id: Rot
          name: Rotation
        - id: Side
          name: Layer

  - name: 'bom'
    comment: "BoM for JLC"
    type: bom
    options:
      output: '%f_%i_jlc.%x'
      exclude_filter: 'only_jlc_parts'
      ref_separator: ','
      columns:
        - field: Value
          name: Comment
        - field: References
          name: Designator
        - Footprint
        - field: 'LCSC#'
          name: 'LCSC Part #'
      csv:
        hide_pcb_info: true
        hide_stats_info: true
        quote_all: true

As you can see we now create a filter named fix_rotation of type rot_footprint:

  - name: fix_rotation
    comment: 'Adjust rotation for JLC'
    type: rot_footprint

Using it, instead of the internal filter named _rot_footprint, is the same here. But you can then customize the filter.

The filter supports the following options:

extend: [boolean=true] Extends the internal list of rotations with the one provided. Otherwise just use the provided list.
negative_bottom: [boolean=true] Rotation for bottom components is computed via subtraction as (component rot - angle). Note that this should be coherent with the bottom_negative_x of the position output.
invert_bottom: [boolean=false] Rotation for bottom components is negated, resulting in either: (- component rot - angle) or when combined with negative_bottom, (angle - component rot).
rotations: [list(list(string))] A list of pairs regular expression/rotation. Components matching the regular expression will be rotated the indicated angle. Special names _top and _bottom will match all components on that side of the board.

In order to add a new rotation or just change an existing one you just need to use the rotations option. As an example: the internal list of rotations rotates QFN packages by 270 degrees, no suppose you want to rotate them just 90 degrees. The filter will look like this:

  - name: fix_rotation
    comment: 'Adjust rotation for JLC'
    type: rot_footprint
    rotations:
      - ["^QFN-", 90.0]

This regular expression will match any footprint starting with QFN- and rotate it 90 degrees.

The internal list of rotations is:

Footprint	Rotation
`^Bosch_LGA-8_2x2.5mm_P0.65mm_ClockwisePinNumbering`	90.0
`^R_Array_Convex_`	90.0
`^R_Array_Concave_`	90.0
`^SOT-223`	180.0
`^SOT-23`	180.0
`^TSOT-23`	180.0
`^SOT-353`	180.0
`^QFN-`	270.0
`^LQFP-`	270.0
`^TQFP-`	270.0
`^SOP-(?!18_)`	270.0
`^TSSOP-`	270.0
`^DFN-`	270.0
`^SOIC-`	270.0
`^VSSOP-10_`	270.0
`^CP_EIA-3216-18_`	180.0
`^CP_EIA-3528-15_AVX-H`	180.0
`^CP_EIA-3528-21_Kemet-B`	180.0
`^CP_Elec_8x10.5`	180.0
`^CP_Elec_6.3x7.7`	180.0
`^CP_Elec_8x6.7`	180.0
`^CP_Elec_8x10`	180.0
`^(.*?_\|V)?QFN-(16\|20\|24\|28\|40)(-\|_\|$)`	270.0
`^PowerPAK_SO-8_Single`	270.0
`^HTSSOP-28-1EP_4.4x9.7mm*`	270.0

XYRS files

XYRS files are just BoM files in CSV format that includes pick and place data (X position, Y position, Rotation and Side). You can generate them using the internal BoM generator (bom output). The following fields contains the needed information:

Footprint X
Footprint Y
Footprint Rot
Footprint Side

Additionally we support:

Footprint Type (SMD, THT, VIRTUAL)
Footprint X-Size
Footprint Y-Size
Footprint Populate

Important: These files doesn't support manual panelization with repeated reference names, you'll get the coordinates for just one component because this is a BoM.

Notes about 3D models

This section contains some notes and advices about the use of 3D models. There are many strategies and you can choose the mix that better suits your needs. If you have any suggestion don't hesitate in contacting me to add them.

3D models and docker images

The default KiCad 3D models aren't included in the KiBot docker images. This is because the 3D models currently needs around 5 GB and the current docker images are between 1 and 2.8 GB. So adding them means a huge increase in size.

This is not a big problem because KiBot will download any missing 3D model from KiCad's repo.

As a side effect you'll get errors and/or warnings about the missing 3D models and/or KiCad environment variables pointing to them.

If you need to install the KiCad 3D models in one of the kicad_debian, kicad_auto or kicad_auto_test images just run the /usr/bin/kicad_3d_install.sh script included with the current images.

If you are running the GitHub action and you want to install the KiCad 3D models use the install3D: YES option.

Caching downloaded 3D models

You can store the downloaded 3D models in a GitHub cache, an example can be found in the following repo

Self contained projects

Try to make your project self contained. If you are using a repo this means the repo should contain anything needed to work with your project.

KiCad 6 helps a lot in this regard. Now schematic files are self contained, you don't need external files to work with them. Even with this I think including the used symbols and footprints isn't a bad idea. If you expect other people to edit your project then is much simpler if the originals are in the project.

The 3D models are a very special case. KiCad doesn't help much in this regard. I strongly suggest including all used 3D models in your repo. You can then use ${KIPRJMOD} as base for the path to the models, this will be expanded to the current path to your project. So you can use things like ${KIPRJMOD}/3D/MODEL_NAME and store all the 3D models in the 3D folder inside your project folder.

LCSC/JLCPCB/EasyEDA 3D models

KiBot can download 3D models for components that has an LCSC code and that has a 3D model at EasyEDA. If the 3D model is used locally, but not found in the repo, KiBot will try to download it. Use the field_lcsc_part option if KiBot fails to detect the schematic field containing the LCSC code.

3D models aliases

This is a KiCad 6 feature that was removed in KiCad 7. If you use it please migrate to environment variables as KiCad 7 did. If you still interested on it continue reading.

This is a very limited feature in KiCad. You can define an ALIAS and then use ALIAS:MODEL_NAME. The ALIAS will say where to look for MODEL_NAME. This looks coherent with the way KiCad handles symbols and footprints. But it currently has a huge limitation: this information is stored along with the user configuration and there is no way to complement it at project level. I don't recommend using aliases because it makes quite complicated to create self contained projects.

KiBot offers some mechanisms to help using aliases:

You can define your aliases in the global section using the aliases_for_3d_models option.
You can use environment and text variables to define aliases. This can be disabled using the disable_3d_alias_as_env option.

The problem with this is that you must keep two lists synchronized, one for KiCad and the other to make your project self contained.

How to handle addons

KiCad 6 introduces a Plugin and Content Manager, they can contain footprints and 3D models. Using 3D models aliases looks like a good solution here, but this isn't. The best solution here is to use the KICAD6_3RD_PARTY variable. Instead of defining an alias pointing to the content you can just use ${KICAD6_3RD_PARTY}/3dmodels/FULL_PLUGIN_NAME/MODEL_NAME. I know this is long, but this will make your project portable. The user will need to download the plugin, but won't need to define any alias.

Getting a self contained PCB

In order to help users to create self contained projects KiBot offers some help. The following configuration:

# Example KiBot config file
kibot:
  version: 1

outputs:
  - name: export_pcb
    comment: 'Copy 3D models'
    type: copy_files
    dir: 'expoted_pcb'
    options:
      files:
        - source_type: 3d_models
          dest: 3d_models+
          save_pcb: true

Will create a new PCB inside a directory called expoted_pcb, this PCB will use the 3D models copied to expoted_pcb/3d_models using relative paths. So you can move the new PCB file to any place, as long as the 3d_models directory is in the same place as the PCB.

Proposed advanced KiCad usage

This section contains some proposed solutions for special, or advanced, KiCad usage.

One circuit and more than one PCB implementation

Use hierarchical pages to share the circuit between two projects: example

System with more than one PCB

This case is discussed here

Credits

KiBot project: Salvador E. Tropea (@set-soft)
Original KiPlot project: John Beard (@johnbeard)
Original KiCad Automation Scripts: Scott Bezek, Productize SPRL
KiBoM: Oliver Henry Walters (@SchrodingersGat)
Interactive HTML BoM: @qu1ck
PcbDraw/Populate/KiKit: Jan Mrázek (@yaqwsx)
KiCost: Dave Vandenbout (@devbisme) and Hildo Guillardi Júnior (@hildogjr)
KiCAD to Boardview exporter: @whitequark
S-expression parser: Takafumi Arakaki
Python macros: Juha Jeronen (@Technologicat)
Board2Pdf: Albin Dennevi
PyPDF2: Mathieu Fenniak
svgutils: Bartosz Telenczuk (@btel)
svgpathtools: Andy A. Port
pybars: Will Bond and Mjumbe Wawatu Ukweli (Canonical Ltd.)
pymeta: Allen Short and Waldemar Kornewald
Contributors:
- Error filters ideas: Leandro Heck (@leoheck)
- GitHub Actions Integration/SVG output: @nerdyscout
- Plug-in loader fix: Stavros Korokithakis (@skorokithakis)
- SCH loader fix: @Sabolik
- SCH library loader fix: Bernhard B. (@bbernhard)
- GitHub Actions fix: @TheSlowGrowth
- Easier README navigation: Robin Vobruba (@hoijui)
- Typos corrections: Seth Kaz (@sethkaz) and Sebastian Grau (@SebastianGrau)
- Various tools suggested: MDW (@mdeweerd)
- Various tools suggested: Chris Wilson (@cdwilson)
- GENCAD export for KiAuto: Theo Hussey (@flaminggoat)
- Various fixes: Henning Kleen (@hkleen)
- SCH print all-pages option: Kevin Dong (@kevin-dong-nai-jia)
Sources of inspiration and good ideas:
- JLC Kicad Tools: Matthew Lai (@matthewlai)
- KiCad Gerber Zipper: @g200kg
- pimpmykicadbom: Anton Savov (@antto)
- electro-grammar: Kaspar Emanuel (@kasbah)
Others:
- Robot in the logo: Christian Plaza (from pixabay)
- Robot arm in assembly_simple.svg: Pixlok
- Chip in assembly_simple.svg: oNline Web Fonts
- Wrench: Freepik - Flaticon
- Most icons for the navigate_results output: The KiCad project
- PTV09A 3D Model: Dmitry Levin (GrabCad)
- PcbDraw PCB example: Arduino Learning Kit Starter
- Battery charger example: RB0002-BatteryPack
- IT-1187A 3D Model: Anton Pavlov (GrabCad)
- 105017-0001 3D Model: M.B.I. (GrabCad)
- ASCII Art generated: patorjk

License

taotieren/KiBot

ErrorLooks like something went wrong!

About

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Languages

Error
Looks like something went wrong!

Packages