Metadata-Version: 2.5
Name: kilm
Version: 0.6.0
Summary: A command-line tool for managing KiCad libraries across projects and workstations
Project-URL: Homepage, https://github.com/barisgit/KiLM
Project-URL: Documentation, https://kilm.aristovnik.me
Project-URL: Repository, https://github.com/barisgit/KiLM
Project-URL: Bug Tracker, https://github.com/barisgit/KiLM/issues
Author-email: Blaž Aristovnik <blaz@paxia.co>
Maintainer-email: Blaž Aristovnik <blaz@paxia.co>
License-Expression: MIT
License-File: LICENSE
Keywords: cli,eda,electronics,kicad,library-management,pcb-design
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: Python :: 3.15
Classifier: Topic :: Scientific/Engineering :: Electronic Design Automation (EDA)
Requires-Python: >=3.10
Requires-Dist: click>=8.0
Requires-Dist: jinja2>=3.1.6
Requires-Dist: packaging>=25.0
Requires-Dist: pathspec>=0.12.1
Requires-Dist: pyyaml>=6.0
Requires-Dist: questionary>=1.10.0
Requires-Dist: requests>=2.32.4
Requires-Dist: rich>=14.0.0
Requires-Dist: typer>=0.17.4
Requires-Dist: typing-extensions>=4.4.0
Description-Content-Type: text/markdown

# KiCad Library Manager (KiLM)

[![PyPI version](https://img.shields.io/pypi/v/kilm.svg)](https://pypi.org/project/kilm/)
[![Python versions](https://img.shields.io/pypi/pyversions/kilm.svg)](https://pypi.org/project/kilm/)
[![PyPI Downloads](https://static.pepy.tech/badge/kilm)](https://pepy.tech/projects/kilm)
[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
[![Documentation](https://img.shields.io/badge/docs-website-brightgreen.svg)](https://kilm.aristovnik.me)

Professional command-line tool for managing KiCad libraries across projects and workstations.

**[Official Documentation](https://kilm.aristovnik.me)**

## Features

- Automatically detect KiCad configurations across different platforms (Windows, macOS, Linux)
- Add symbol and footprint libraries to KiCad from a centralized repository
- Set environment variables directly in KiCad configuration
- Pin favorite libraries for quick access in KiCad
- Create timestamped backups of configuration files
- Support for environment variables
- Dry-run mode to preview changes
- Compatible with KiCad 6.x and newer
- Project template management to standardize new designs
- Import vendor part ZIPs (SamacSys/Mouser, UltraLibrarian, SnapMagic) into your library

## Quick Start

```bash
# Install (recommended)
pipx install kilm

# Verify installation
kilm --version

# Initialize a library
kilm init --name my-library --description "My KiCad components"

# Set up KiCad to use your libraries
kilm setup

# Check current configuration
kilm status
```

> **[Complete Installation Guide](https://kilm.aristovnik.me/guides/installation/)** - Multiple installation methods, verification steps, and troubleshooting.

## Nix

Run without installing:

```bash
nix run github:barisgit/KiLM -- --version
```

Build, or drop into a dev shell:

```bash
nix build github:barisgit/KiLM   # ./result/bin/kilm
nix develop                      # Python, deps, pytest, and uv for lint gates
```

Add to a NixOS / home-manager config via the overlay:

```nix
{
  inputs.kilm.url = "github:barisgit/KiLM";

  # in your config:
  nixpkgs.overlays = [ inputs.kilm.overlays.default ];
  environment.systemPackages = [ pkgs.kilm ];  # or home.packages
}
```

## Documentation

**[Complete Documentation](https://kilm.aristovnik.me)**

| Guide | Description |
|-------|-------------|
| [Getting Started](https://kilm.aristovnik.me/guides/getting-started/) | Creator and consumer workflows with Git integration |
| [Configuration](https://kilm.aristovnik.me/guides/configuration/) | KiLM and KiCad configuration management |
| [CLI Reference](https://kilm.aristovnik.me/reference/cli/) | Complete command documentation with examples |
| [Development](https://kilm.aristovnik.me/community/development/) | Setup guide for contributors and development |

## License

[MIT License](LICENSE)

## Contributing

Contributions are welcome. With [uv](https://docs.astral.sh/uv/),
[just](https://just.systems), and [pnpm](https://pnpm.io) installed:

```bash
git clone https://github.com/barisgit/KiLM.git
cd KiLM
just setup   # locked dependencies and git hooks
just check   # everything CI runs
```

See [CONTRIBUTING.md](CONTRIBUTING.md) for the pull request process and
[AGENTS.md](AGENTS.md) for the layout and coding standards.
