KiBot (formerly KiPlot)

This is the documentation for the current development KiBot, not yet released. To know what changed see the changelog

Important for CI/CD:

• The GitHub actions now use the full/test docker images. So now they include PanDoc and also Blender.

• If you are looking for the GitHub Actions documentation, and you already know how to use KiBot, or want a quick start, read: Usage for CI/CD

New on v1.6.3

• Parametrizable imports

• value_split and spec_to_field filters

Contents:

• Introduction
• Installation
  • Dependencies
  • Installation on Ubuntu or Debian
  • Installation on Arch Linux
  • Installation using pip
  • Notes about virtualenv
  • Installation on other targets
• Configuration
  • Quick start
  • Section order
  • The header
  • The preflight section
    • Supported preflights
    • More about pcb_replace and sch_replace
    • Filtering DRC and ERC errors
  • Default global options
    • Default output option
    • Default dir option
    • Default variant option
    • Default units option
    • Output directory option
    • Date format option
    • PCB details options
    • Filtering KiBot warnings
    • All available global options
  • Filters and variants
    • Supported filters
    • Examples for filters
    • Built-in filters
    • Supported variants
    • Changing the 3D model, simple mechanism
    • Changing the 3D model, complex mechanism
    • DNF and DNC internal keys
  • The outputs section
    • Specifying the layers
    • Supported outputs
    • Consolidating BoMs
    • Importing outputs from another file
    • Importing other stuff from another file
    • Parametrizable imports
    • Importing internal templates
    • Using other output as base for a new one
    • Grouping outputs
  • Doing YAML substitution or preprocessing
    • Default definitions
    • Definitions during import
    • Recursive definitions expansion
• Usage
  • Command line help
• Usage for CI/CD
  • Usage of GitHub Actions
    • GitHub Actions tags
  • GitHub Cache

Notes and extra information:

• Notes about Gerber format
• Notes about the position file
  • XYRS files
• Notes about 3D models
  • 3D models and docker images
  • Caching downloaded 3D models
  • Self contained projects
  • LCSC/JLCPCB/EasyEDA 3D models
  • 3D models aliases
  • How to handle addons
  • Getting a self contained PCB
• Proposed advanced KiCad usage
  • One circuit and more than one PCB implementation
  • System with more than one PCB
• KiPlot YAML
  • The basic idea
  • Basic data types
  • Compound data types
  • Indentation
  • Compact notation
  • Putting all together
  • Advanced tricks

Final notes:

• Contributing
• Credits

Indices and tables:

• Index