kicad-wakatime is a WakaTime plugin for KiCAD.

On all platforms:

1. Download the latest release of kicad-wakatime from the releases section. Click here for downloads.
2. Open kicad-wakatime and fill out the settings.
3. Start designing!

If you are on Linux, you also have to install zenity via your package manager.

If you are on MacOS, you need to go to Settings > Privacy & Security > Security and click Allow (Might need to scroll down)

If you know what you're doing, you can build kicad-wakatime from the main branch instead. Just run cargo build in the kicad-wakatime directory and everything should work.

The code in the main branch should be considered unstable, as some features may still be in progress between releases.

Open kicad-wakatime and kicad. Click on "settings" in kicad wakatime and enter your API key. (Should be auto-filled if you have already installed hackatime)

Click on the first "select folder" button, and select your ".kicad_pro" file. Click OK!

Now go back to kicad, please make the following changes to your KiCAD settings (Control+,) to use this version of kicad-wakatime:

Auto save should be set to 1 minute.
"Automatically backup projects" should be checked.
"Create backups when auto save occurs" should be checked.
Minimum time between backups should be set to 0 minutes.

Your settings tab should look like this: (The backup part matters!)

And you are done! Happy pcb-ing!

If you plan on doing symbol editing, select your .kicad_sym using the second button, and if you are going to do footprint editing, select your .pretty folder containing all the .kicad_mod fils using the third button. They can be left empty.

If you are on Linux Wayland (Hyprland doesn't count - it is supported), open kicad using the following command:

GDK_BACKEND=x11 kicad

or if you installed the flatpak:

flatpak override --env=GDK_BACKEND=x11 org.kicad.KiCad

This solution only works if xwayland is running and supported by the compositor. This works by default on most compositors, but if it isn't check out https://github.com/Supreeeme/xwayland-satellite

Prior to version 0.2.0, KiCAD 8.99 nightly or greater was required in order to use kicad-wakatime. This is no longer required.

sudo add-apt-repository --yes ppa:kicad/kicad-dev-nightly
sudo apt update
sudo apt install kicad-nightly

Known issue: When using hierarchy sheets, kicad-wakatime will create a project for each sheet. If you are going to use this for SoM, just select all the projects applicable in their UI.

If kicad-wakatime keeps saying No change detected!, create a new project, select that new project in wakatime, go back to the old project, select the old project in wakatime. Kicad is most likely stuck in a weird state.

If kicad-wakatime is not doing what you expect, please open an issue.

The bug report template will ask you for a magic word to confirm that you've read this README.
The magic word is "dreadnought".