knolo-core 0.1.0 → 0.1.2

package/README.md

@@ -1,30 +1,39 @@
 
+
 # 🧠 KnoLo Core
 
-KnoLo Core is a **local-first knowledge base system** for small language models (LLMs).
+[![npm version](https://img.shields.io/npm/v/knolo-core.svg)](https://www.npmjs.com/package/knolo-core)
+[![npm downloads](https://img.shields.io/npm/dm/knolo-core.svg)](https://www.npmjs.com/package/knolo-core)
+[![License](https://img.shields.io/npm/l/knolo-core.svg)](./LICENSE)
+
+**KnoLo Core** is a **local-first knowledge base system** for small language models (LLMs).
 It lets you package your own documents into a compact `.knolo` file and query them deterministically — **no embeddings, no vector DBs, no cloud**. Perfect for **on-device LLMs**.
 
 ---
 
 ## ✨ Features
 
-* 📦 **Single-file packs** (`.knolo`) you can ship or load offline.
-* 🔎 **Deterministic lexical retrieval** (BM25L + phrase + heading boosts).
-* ⚡ **Tiny & fast** — runs in Node, browsers, and Expo.
-* 📑 **Context Patches**: structured snippets for direct LLM input.
-* 🔒 **Privacy-first**: all data stays local.
+* 📦 **Single-file packs** (`.knolo`) you can ship or load offline
+* 🔎 **Deterministic lexical retrieval** (BM25L + phrase + heading boosts)
+* ⚡ **Tiny & fast** — runs in Node, browsers, and Expo
+* 📑 **Context Patches**: structured snippets optimized for LLM prompts
+* 🔒 **Privacy-first**: all data stays local
 
 ---
 
 ## 📦 Install
 
 ```bash
-# local build
+npm install knolo-core
+```
+
+For local development (building from source):
+
+```bash
+git clone https://github.com/yourname/knolo-core.git
+cd knolo-core
 npm install
 npm run build
-
-# or if published later
-npm install @knolo/core
 ```
 
 ---
@@ -34,7 +43,7 @@ npm install @knolo/core
 ### 1. Node.js (in-memory build + query)
 
 ```js
-import { buildPack, mountPack, query, makeContextPatch } from "./dist/index.js";
+import { buildPack, mountPack, query, makeContextPatch } from "knolo-core";
 
 const docs = [
   { heading: "React Native Bridge", text: "The bridge sends messages between JS and native. You can throttle events to reduce jank." },
@@ -74,13 +83,13 @@ console.log("Context Patch:", patch);
 
 ```bash
 # writes mypack.knolo
-node bin/knolo.mjs docs.json mypack.knolo
+npx knolo docs.json mypack.knolo
 ```
 
 **Query it in a script:**
 
 ```js
-import { mountPack, query } from "./dist/index.js";
+import { mountPack, query } from "knolo-core";
 
 const kb = await mountPack({ src: "./mypack.knolo" });
 const hits = query(kb, "throttle events", { topK: 3 });
@@ -94,7 +103,7 @@ console.log(hits);
 ```ts
 import { Asset } from "expo-asset";
 import * as FileSystem from "expo-file-system";
-import { mountPack, query, makeContextPatch } from "@knolo/core";
+import { mountPack, query, makeContextPatch } from "knolo-core";
 
 async function loadKnowledge() {
   const asset = Asset.fromModule(require("./assets/mypack.knolo"));
@@ -124,18 +133,18 @@ mountPack({ src: string | Uint8Array | ArrayBuffer }) -> Promise<Pack>
 query(pack, "your query", { topK?: number, requirePhrases?: string[] }) -> Hit[]
 
 // Create LLM-friendly patch
-makeContextPatch(hits, { budget?: "mini"|"small"|"full" }) -> ContextPatch
+makeContextPatch(hits, { budget?: "mini" | "small" | "full" }) -> ContextPatch
 ```
 
 ---
 
 ## 🔮 Roadmap
 
-* Multi-resolution packs (summaries + facts).
-* Overlay store for user notes.
-* WASM core for very large packs.
+* Multi-resolution packs (summaries + facts)
+* Overlay store for user notes
+* WASM core for very large packs
 
 ---
 
-👉 With KnoLo, you can **carry knowledge with your model** — no servers, no dependencies, just a tiny portable pack.
+👉 With **KnoLo**, you can **carry knowledge with your model** — no servers, no dependencies, just a tiny portable pack.
 

package/bin/knolo.mjs

@@ -1,30 +1,69 @@
 #!/usr/bin/env node
+// Robust CLI that works with ESM or CJS builds and odd resolution cases.
 
-// Simple CLI wrapper around the KnoLo pack builder. Reads an input JSON
-// containing an array of documents with `heading` and `text` fields and
-// writes a `.knolo` binary pack. Requires that the compiled `dist` files
-// exist (run `npm run build` before using). This script uses ESM syntax.
+import { readFileSync, writeFileSync } from "node:fs";
+import path from "node:path";
+import { fileURLToPath, pathToFileURL } from "node:url";
+import { createRequire } from "node:module";
 
-import { readFileSync, writeFileSync } from 'node:fs';
-import { buildPack } from '../dist/builder.js';
+const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const require = createRequire(import.meta.url);
 
-async function main() {
-  const [,, inputFile, outputFile = 'knowledge.knolo'] = process.argv;
-  if (!inputFile) {
-    console.log('Usage: knolo <input.json> [output.knolo]');
-    process.exit(1);
+async function tryImport(filePath) {
+  // 1) ESM via file URL
+  try {
+    const url = pathToFileURL(filePath).href;
+    return await import(url);
+  } catch (_) {}
+  // 2) CJS via require
+  try {
+    return require(filePath);
+  } catch (_) {}
+  return null;
+}
+
+function getBuildPack(mod) {
+  if (!mod) return undefined;
+  // Named export (ESM)
+  if (typeof mod.buildPack === "function") return mod.buildPack;
+  // CJS default export object: { buildPack } or function
+  if (mod.default) {
+    if (typeof mod.default === "function") return mod.default;
+    if (typeof mod.default.buildPack === "function") return mod.default.buildPack;
   }
-  const json = JSON.parse(readFileSync(inputFile, 'utf8'));
-  if (!Array.isArray(json)) {
-    console.error('Input JSON must be an array of objects');
-    process.exit(1);
+  // Some CJS setups export { buildPack } directly
+  if (typeof mod === "function") return mod;
+  if (typeof mod.buildPack === "function") return mod.buildPack;
+  return undefined;
+}
+
+async function loadBuildPack() {
+  const candidates = [
+    path.resolve(__dirname, "../dist/index.js"),
+    path.resolve(__dirname, "../dist/builder.js"),
+    // Also try .cjs just in case someone built CJS
+    path.resolve(__dirname, "../dist/index.cjs"),
+    path.resolve(__dirname, "../dist/builder.cjs"),
+  ];
+  for (const p of candidates) {
+    const mod = await tryImport(p);
+    const buildPack = getBuildPack(mod);
+    if (buildPack) return buildPack;
   }
-  const bytes = await buildPack(json);
-  writeFileSync(outputFile, Buffer.from(bytes));
-  console.log(`wrote ${outputFile}`);
+  throw new Error("Could not locate a buildPack function in dist/");
 }
 
-main().catch((err) => {
-  console.error(err);
+const buildPack = await loadBuildPack();
+
+const inFile = process.argv[2];
+const outFile = process.argv[3] || "knowledge.knolo";
+
+if (!inFile) {
+  console.log("Usage: knolo <input.json> [output.knolo]");
   process.exit(1);
-});
+}
+
+const docs = JSON.parse(readFileSync(inFile, "utf8"));
+const bytes = await buildPack(docs);
+writeFileSync(outFile, Buffer.from(bytes));
+console.log(`wrote ${outFile}`);

package/package.json

@@ -1,9 +1,9 @@
 {
   "name": "knolo-core",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "description": "Local-first knowledge packs for small LLMs.",
   "keywords": ["llm", "knowledge-base", "rag", "local", "expo"],
-  "author": "Your Name",
+  "author": "Sam Paniagua",
   "license": "MIT",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",