Command Line¶

Choosing revisions¶

kigit                      # HEAD vs the working tree
kigit HEAD~3               # HEAD~3 vs the working tree
kigit c46da63..HEAD        # two commits
kigit v1.0 v1.1 board.kicad_pcb

If you give the newer revision first, kigit swaps them so "added" always means "added in the newer revision".

Choosing the project¶

Run it inside a project folder, or point at one from anywhere with --kicad-repo (short: -C):

kigit -C ~/boards/owl HEAD~1                 # finds the board in subfolders
kigit -C path/to/board.kicad_pro HEAD~1      # a .kicad_pro or .kicad_pcb works too

Common options¶

Option	What it does
`-o FILE`	Write the page here (`-o -` for stdout)
`-n`	Don't open a browser
`-s`, `--stats`	Print every changed net (and cosmetic schematic changes)
`--json`	Write the data as JSON instead of the page
`--silkscreen`	Compare and draw silkscreen
`--source`	Add the source panel
`--files OLD NEW`	Compare two files, no git needed
`-V`	Print the log to the console, with debug lines
`--log-dir DIR`, `--no-log`	Where the log goes, or no log

Run kigit --help for the full list.

Scripting¶

What the GUI uses, if you want to build on it:

kigit --projects [--depth N]    # KiCad projects in the folder and below, as JSON
kigit --log [--max N] [--since DATE] [--until DATE] [--kicad-only]
                                # commits (+ uncommitted changes), as JSON
kigit -n -o - A..B              # the viewer page on stdout
kigit -n --json -o - A..B       # the data on stdout

Logs¶

Every run keeps a log named after when it started:

Platform	Default folder
Linux	`~/.local/state/kigit/log/`
Windows	`%LOCALAPPDATA%\kigit\log\`