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.
  • 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.
  • 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.
      • 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.
  • 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.
  • 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.
  • 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.
• 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.
  • 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.
• 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.
      • 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.
  • 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.
  • 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.
  • 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.
  • 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.
• 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.
  • 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.
• 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.
  • 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.
• 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.
      • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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. KiCad 5: including the frame is slow. KiCad 6: for custom frames use the enable_ki6_frame_fix, is slow.
• 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.
  • 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.
  • 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.
  • 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.
• 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.
  • 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.
• 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.
  • 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.
• 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.
      • 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.
  • 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.
  • 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.
  • 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.
      • 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.
      • 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.
  • 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.
• 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.
  • 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.
• 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.
      • 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.
  • 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.
  • 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.
      • rotate_y: [number=0] Steps to rotate around the Y axis, positive is clockwise. Each step is currently 10 degrees. Only for KiCad 6.
      • rotate_z: [number=0] Steps to rotate around the Z axis, positive is clockwise. Each step is currently 10 degrees. Only for KiCad 6.
      • 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.
      • 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.
      • 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.
  • 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.
  • 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.
  • 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.
  • 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.
  • 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.
      • 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.
  • 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.
• 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.
  • 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.
• 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.
  • 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.
• 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.
      • 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.
  • 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.
      • 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 is disabled.
      • ref_y: [number=0] Y coordinate to use as reference when use_pcb_center_as_ref is disabled.
      • 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.
  • 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.