Skip to content

Installation

KiLM (KiCad Library Manager) is a Python CLI tool that requires Python 3.9+ and KiCad 6.x+ to be installed and run at least once.

  • Python 3.9 or newer
  • KiCad 6.x or newer (must be launched at least once to create configuration directories)
  • Operating System: Windows, macOS, or Linux

You can install KiLM using several methods:

uv is an extremely fast Python package installer:

Terminal window
# Install uv (Linux/macOS) if you don't have it
curl -sSf https://astral.sh/uv/install.sh | sh
# Install KiLM using uv
uv tool install kilm

Using uv you can run KiLM without installing it:

Terminal window
# Install uv (Linux/macOS) if you don't have it
curl -sSf https://astral.sh/uv/install.sh | sh
# Run KiLM using uv
uvx kilm

pipx installs CLI tools in isolated environments, preventing dependency conflicts:

Terminal window
# Install pipx if you don't have it
python -m pip install --user pipx
python -m pipx ensurepath
# Install KiLM using pipx
pipx install kilm

Standard Python package installation:

Terminal window
pip install kilm

For contributors or those wanting the latest development version:

Terminal window
# Clone the repository
git clone https://github.com/barisgit/kilm.git
cd kilm
# Install in editable mode with development dependencies
pip install -e ".[dev]"

See the Development Setup guide for more details.

After installation, verify KiLM is installed correctly:

Terminal window
# Check version
kilm --version
# View available commands
kilm --help
# Check KiCad detection
kilm status