https://github.com/oaslananka/kicad-studio-kit
Python toolkit for KiCad project automation, electronics design workflows, library checks, release packaging, and hardware documentation support.
https://github.com/oaslananka/kicad-studio-kit
automation developer-tools documentation eda electronics github-actions hardware kicad packaging pcb pcb-design python testing vscode vscode-extension
Last synced: 9 days ago
JSON representation
Python toolkit for KiCad project automation, electronics design workflows, library checks, release packaging, and hardware documentation support.
- Host: GitHub
- URL: https://github.com/oaslananka/kicad-studio-kit
- Owner: oaslananka
- License: mit
- Created: 2026-05-19T23:17:36.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2026-06-10T19:09:13.000Z (13 days ago)
- Last Synced: 2026-06-10T21:06:31.195Z (12 days ago)
- Topics: automation, developer-tools, documentation, eda, electronics, github-actions, hardware, kicad, packaging, pcb, pcb-design, python, testing, vscode, vscode-extension
- Language: TypeScript
- Homepage: https://oaslananka.github.io/kicad-studio-kit/
- Size: 11.6 MB
- Stars: 8
- Watchers: 0
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
- Security: SECURITY.md
- Support: docs/support-matrix.md
- Agents: AGENTS.md
Awesome Lists containing this project
README
# KiCad Studio Kit
Build & Quality
Marketplace
Community
Monorepo for:
- KiCad Studio VS Code extension (`apps/vscode-extension`)
- KiCad MCP Pro server (source removed — see [oaslananka/kicad-mcp](https://github.com/oaslananka/kicad-mcp))
- shared test harness (`packages/test-harness`)
Canonical repository: https://github.com/oaslananka/kicad-studio-kit
Searchable documentation: https://oaslananka.github.io/kicad-studio-kit/
## Version Baseline
This repository's local release surface is:
- VS Code extension: `oaslananka.kicadstudiokit` (`1.8.0`)
The Python package `kicad-mcp-pro`, container image, and MCP Registry listing
are released from [oaslananka/kicad-mcp](https://github.com/oaslananka/kicad-mcp).
## KiCad Compatibility
KiCad Studio Kit treats KiCad `10.0.x` as the primary tested line, keeps KiCad
`9.x` as deprecated best-effort compatibility after upstream EOL, and keeps
KiCad `8.x` as deprecated file-level compatibility. The canonical matrix, tested patch versions, CI
coverage level, and feature gates are maintained in
[docs/support-matrix.md](docs/support-matrix.md) and `compatibility.yaml`.
## Local Validation
```powershell
corepack enable
corepack pnpm run dev:doctor
corepack pnpm install --frozen-lockfile
corepack pnpm run check:forbidden-refs
corepack pnpm run check:version
corepack pnpm --filter kicadstudiokit run check
corepack pnpm --filter kicadstudiokit run package
```
Product-scoped entrypoints are available from the root:
```powershell
corepack pnpm run check:kicad-studio
corepack pnpm --dir packages/test-harness run check
corepack pnpm run check:protocol-schemas
corepack pnpm run check:compatibility-contract
corepack pnpm run check:dev-doctor
```
Python/MCP server checks run from the
[oaslananka/kicad-mcp](https://github.com/oaslananka/kicad-mcp) repository.
For a reproducible VS Code Dev Containers or GitHub Codespaces environment, use
the checked-in [devcontainer configuration](docs/devcontainer.md). The container
sets up Node, pnpm, Python, uv, Playwright, shellcheck, actionlint, GitHub CLI,
and best-effort KiCad CLI support for root checks and MCP tests.
## Install
Install the extension from the Visual Studio Marketplace or Open VSX, or build
it locally:
```powershell
corepack enable
corepack pnpm install --frozen-lockfile
corepack pnpm run package:kicad-studio
```
## Usage
Open a workspace containing a KiCad project and use the KiCad Studio activity
bar views and commands. See [docs/getting-started.md](docs/getting-started.md)
for the guided workflow and [docs/extension/commands.md](docs/extension/commands.md)
for the command catalog.
## Architecture
- [Searchable documentation site](https://oaslananka.github.io/kicad-studio-kit/)
- [Repository structure](docs/architecture/repo-structure.md)
- [Product boundaries](docs/architecture/product-boundaries.md)
- [Release model](docs/architecture/release-model.md)
- [Testing strategy](docs/testing-strategy.md)
- [Dev container](docs/devcontainer.md)
- [KiCad fixture corpus](docs/kicad-fixture-corpus.md)
- [Integration model](docs/integration/kicad-studio-mcp.md)
- [Agent onboarding](docs/agents/index.md)
- [MCP client config examples](examples/mcp-clients/README.md)
- [VS Code MCP workspace example](.vscode/mcp.example.json)
## Examples
- [Examples overview](examples/README.md)
- [LED Basic KiCad example](examples/led-basic/README.md)
- [MCP Workflow Demo](examples/mcp-demo/README.md)
## Publishing
Publishing is handled by GitHub Actions workflows under `.github/workflows`. External setup for environments, marketplace secrets, and trusted publishers is documented in [docs/publishing.md](docs/publishing.md).
The structured pre-1.0 beta program and tester feedback loop are documented in [docs/beta-program.md](docs/beta-program.md).
## Maintenance
Dependency update policy, dashboard triage, and security-update handling are documented in [docs/dependency-lifecycle.md](docs/dependency-lifecycle.md).
Compatibility support states and release gates are documented in [docs/support-matrix.md](docs/support-matrix.md).
Canonical repository and portfolio workflow status are recorded in [CANONICAL.md](CANONICAL.md), [.repo-health.yaml](.repo-health.yaml), and [docs/reusable-workflows.md](docs/reusable-workflows.md).
Telemetry and error reporting are opt-in, disabled by default, and documented in [docs/telemetry.md](docs/telemetry.md).
## Contributing
Read [CONTRIBUTING.md](CONTRIBUTING.md) and run `corepack pnpm run check` before
opening a pull request.
## License
KiCad Studio Kit is available under the [MIT License](LICENSE).