KiBot Logo

Contents:

  • Introduction
  • Installation
  • Configuration
    • Quick start
    • Section order
    • The header
    • The outputs section
      • Specifying the layers
      • Supported outputs
        • Blender Export
        • BoardView
        • BoM (Bill of Materials)
        • BoM Labels Printer
        • Archiver (files compressor)
        • Files copier
        • Diff
        • Datasheets downloader
        • DXF (Drawing Exchange Format)
        • DXF Schematic Print (Drawing Exchange Format)
        • Excellon drill format
        • Various 3D models exports using KiCad (BREP/GLB/STL/STEP/XAO)
        • GenCAD
        • Gerber drill format
        • Gerber format
        • HPGL (Hewlett & Packard Graphics Language)
        • HPGL Schematic Print (Hewlett & Packard Graphics Language)
        • IBoM (Interactive HTML BoM)
        • Info
        • IPC-DPMX (IPC-2581)
        • KiCad Jobset (batch execution)
        • KiBoM (KiCad Bill of Materials)
        • Hugo KiCad Site helper
        • KiCanvas
        • KiCost (KiCad Cost calculator)
        • KiKit’s Present - Project Presentation
        • KiRi
        • Navigate Results
        • Navigate Results
        • Netlist
        • ODB++
        • Panelize
        • PCB2Blender Tools
        • PCB Print
        • PCB statistics
        • PCB with variant generator
        • PcbDraw - Beautiful 2D PCB render
        • PDF (Portable Document Format)
        • PDF PCB Print (Portable Document Format) Deprecated
        • PDF Schematic Print (Portable Document Format)
        • PDF joiner
        • Populate - Assembly instructions builder
        • Pick & place
        • PS (Postscript)
        • PS Schematic Print (Postscript)
        • QR_Lib
        • 3D render of the PCB
        • Design report
        • Schematic with variant generator
        • 3D Printed Stencils
        • Steel Stencils for Alignment Jig
        • STEP (ISO 10303-21 Clear Text Encoding of the Exchange Structure)
        • SVG (Scalable Vector Graphics)
        • SVG PCB Print (Scalable Vector Graphics) Deprecated
        • SVG Schematic Print
        • VRML (Virtual Reality Modeling Language)
      • Consolidating BoMs
      • Using KiCad’s internal BoM options
      • Columns available for the BoM
      • Using other output as base for a new one
      • Grouping outputs
      • Adding images from an output to the PCB print
      • Creating a group in your PCB
    • The preflight section
    • Default global options
    • Filters and variants
    • Import (include) from other config file
    • Doing YAML substitution or preprocessing
  • Usage
  • Usage for CI/CD

Notes and extra information:

  • Examples
  • Resources
  • Notes about Gerber format
  • Notes about the position file
  • Notes about 3D models
  • Proposed advanced KiCad usage
  • KiPlot YAML
  • Changelog

Final notes:

  • Contributing
  • Credits

Indices and tables:

  • Index
KiBot
  • Configuration
  • The outputs section
  • Navigate Results

Navigate Results

Generates a web page to navigate the generated outputs

Type: navigate_results

Parameters:

  • comment : [string] (default: '') A comment for documentation purposes. It helps to identify the output.

  • dir : [string] (default: './') Output directory for the generated files. If it starts with + the rest is concatenated to the default dir.

  • name : [string] (default: '') Used to identify this particular output definition. Avoid using _ as first character. These names are reserved for KiBot.

  • options : [Navigate_ResultsOptions parameters] [dict] (default: empty dict, default values used) Options for the navigate_results output.

  • type : ‘navigate_results’

  • category : [string | list(string)] (default: '') [comma separated] 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.
    Using ‘.’ or ‘./’ as a category puts the file at the root.
    The categories are currently used for navigate_results and navigate_results_rb.

  • disable_run_by_default : [string | boolean] (default: '') 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] (default: '') Copy the options section from the indicated output. Used to inherit options from another output of the same type.

  • groups : [string | list(string)] (default: '') One or more groups to add this output. In order to catch typos we recommend to add outputs only to existing groups. You can create an empty group if needed.

  • output_id : [string] (default: '') Text to use for the %I expansion content. To differentiate variations of this output.

  • priority : [number] (default: 10) (range: 0 to 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] (default: true) When enabled this output will be created when no specific outputs are requested.

Used dicts

  • Navigate_ResultsOptions parameters

Previous Next

© Copyright 2018-2026, Salvador E. Tropea/INTI/John Beard.

Built with Sphinx using a theme provided by Read the Docs.