Skip to main content

Getting Started with Lyra

migrating to v0.4.x

Version v0.4.0 is a major release that introduces breaking changes. Please read the migration guide before upgrading.

Lyra is an immutable, runtime-agnostic, edge, and in-memory full-text search engine that works both on client and server.

Through implementing an optimized prefix tree and some clever tweaks, Lyra can perform searches through millions of entries in microseconds.

Requirements​

A JavaScript runtime is the only requirement. Lyra has been designed to work on any runtime and has no dependencies.

Installation​

You can install Lyra using npm, yarn, pnpm:

npm install @lyrasearch/lyra
yarn add @lyrasearch/lyra
pnpm add @lyrasearch/lyra

Or import it directly in a browser module:

<html>
  <body>
    <script type="module">
      import { create, search, insert } from "https://unpkg.com/@lyrasearch/lyra@latest/dist/index.js";

      // ...
    </script>
  </body>
</html>