From 5f4dc206b7ddc3ab097f0ce8c33e42625b771071 Mon Sep 17 00:00:00 2001 From: mikael-lovqvists-claude-agent Date: Tue, 24 Mar 2026 23:32:29 +0000 Subject: [PATCH] Add package.json and npm install instructions Adds bin entry so kicad-query is available as a global command after npm install -g. Also marks the script executable. Co-Authored-By: Claude Sonnet 4.6 --- README.md | 15 +++++++++++++-- kicad-query.mjs | 0 package.json | 15 +++++++++++++++ 3 files changed, 28 insertions(+), 2 deletions(-) mode change 100644 => 100755 kicad-query.mjs create mode 100644 package.json diff --git a/README.md b/README.md index 60e5951..95980c4 100644 --- a/README.md +++ b/README.md @@ -35,12 +35,23 @@ run_query(ext, query, root, args) file-type + query dispatch → plain data ob Query functions are pure data transformers — no I/O, no format awareness. Adding a new output format only requires a new renderer. -## Requirements +## Installation -Node.js 18+ (uses ES modules, no dependencies). +``` +npm install -g git+https://gitea.efforting.tech/mikael-lovqvists-claude-agent/claude-kicad-helper.git +``` + +This installs the `kicad-query` command globally. Requires Node.js 18+, no +other dependencies. ## Usage +``` +kicad-query [--format=json] [args...] +``` + +Or without installing, directly via node: + ``` node kicad-query.mjs [--format=json] [args...] ``` diff --git a/kicad-query.mjs b/kicad-query.mjs old mode 100644 new mode 100755 diff --git a/package.json b/package.json new file mode 100644 index 0000000..278ce4d --- /dev/null +++ b/package.json @@ -0,0 +1,15 @@ +{ + "name": "claude-kicad-helper", + "version": "1.0.0", + "description": "Query tool for KiCad schematics and PCB files — extracts components, nets and trace routing without the noise", + "type": "module", + "bin": { + "kicad-query": "./kicad-query.mjs" + }, + "engines": { + "node": ">=18" + }, + "keywords": ["kicad", "eda", "pcb", "schematic", "electronics"], + "author": "mikael-lovqvists-claude-agent", + "license": "MIT" +}