Skip to content

Git actions directly from KiCad's PCB editor window

License

Notifications You must be signed in to change notification settings

adamws/kicad-git

Repository files navigation

kicad-git

KiCad Repository GitHub all releases CircleCI Coverage Status

KiCad plugin for git integration. Launch git commit graphical interface without leaving PCB editor window.

Installation

To install release version of this plugin, use KiCad's Plugin and Content Manager and select Git plugin from official plugin repository.

pcm-image

Latest master build is automatically uploaded to unofficial PCM compatible repository hosted on GitHub pages. To use it, add https://adamws.github.io/kicad-git/repository.json to PCM repository list.

Warning

By default, this plugin uses git gui. On most systems it is distributed as part of the git suite. On macOS it might be required to install it separately with brew install git-gui

How to use?

  • Click plugin button to open commit window

    toolbar-image

    how-to-commit

Important

Plugin button appears only in PCB editor and not in schematic editor. This is KiCad limitation.

Configuration

To configure different command for starting git GUI or explicitly define git executable path, create config.ini file in the plugin directory.

For example, to use TortoiseGit and non standard (not in system search PATH) git executable:

[paths]
git = C:\some\path\git.exe
git_gui = TortoiseGitProc.exe /command:commit

Warning

The [paths] section in config file is required and can't be skipped.

By default, this plugin starts git gui window which will remain open after clicking 'commit' button. To start window for arranging and making exactly one commit use git citool instead:

[paths]
git = C:\some\path\git.exe
git_gui = C:\some\path\git.exe citool

Warning

The citool is limited only to commits, push to remote is not supported from this view. See git manual page to learn more.

See also

🔗 PCB visual diff with kicad-cli and lukaj