README.md

Compare fast. Search in memory. Spotlight documents. Aggregate collections.

Glyph turns text into glyphs — fixed-size MinHash fingerprints. Compare similarity, search an in-memory index, rank document chunks with spotlight, pre-aggregate labeled examples into one glyph, or suggest the next word with completions.

Install

npm install @koda.oss/glyph

Node.js 18 or newer.

Quick start

import { Create, Compare } from "@koda.oss/glyph";

const a = Create("the quick brown fox jumps over the lazy dog");
const b = Create("the quick brown fox leaped over the lazy dog");

console.log(Compare(a, b).similarity); // ~0–1 Jaccard estimate

Documentation

Full doc index: docs/README.md · Changelog · Migration 0.4 → 1.0

Start here	Topic
Getting started	Install, first compare, mental model
Building an index	Store glyphs and run query.New(idx).Search()
Your first collection	Aggregate examples into col.glyph
Your first spotlight	Chunk and rank document snippets
Demo CLI	Try modes from the terminal
API surface	Every public export

License

Mozilla Public License 2.0 — see LICENCE.