KiRiOptions parameters

  • color_theme : [string] (default: '_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.

  • keep_generated : [boolean] (default: false) Avoid PCB and SCH images regeneration. Useful for incremental usage.

  • background_color : [string] (default: '#FFFFFF') Color used for the background of the diff canvas.

  • dnf_filter : [string | list(string)] (default: '_null') Name of the filter to mark components as not fitted. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • exclude_filter : [string | list(string)] (default: '_null') Name of the filter to exclude components from processing. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • max_commits : [number] (default: 0) Maximum number of commits to include. Use 0 for all available commits.

  • pre_transform : [string | list(string)] (default: '_null') Name of the filter to transform fields before applying other filters. Is a short-cut to use for simple cases where a variant is an overkill.
    Can be used to fine-tune a variant for a particular output that needs extra filtering done before the variant.

  • revision : [string] (default: 'HEAD') Starting point for the commits, can be a branch, a hash, etc. Note that this can be a revision-range, consult the gitrevisions manual for more information.

  • variant : [string] (default: '') Board variant to apply.

  • zones : [string] (default: 'global') (choices: “global”, “fill”, “unfill”, “none”) How to handle PCB zones. The default is global and means that we fill zones if the check_zone_fills preflight is enabled. The fill option always forces a refill, unfill forces a zone removal and none lets the zones unchanged.
    Be careful with the keep_generated option when changing this setting.