Getting Started

npm install @processcube-io/qmd-search

import { createIndexer, filesystemSource, githubSource } from '@processcube-io/qmd-search';
 
const indexer = createIndexer({
  dbPath: './data/index.sqlite',
  collections: [
    {
      name: 'docs',
      path: './content',
      pattern: '**/*.md',
      context: 'Projekt-Dokumentation',
      group: 'Allgemein',
    },
    {
      name: 'blog',
      path: './blog',
      pattern: '**/*.mdx',
      context: 'Blog-Artikel',
      group: 'Allgemein',
    },
  ],
  plugins: [filesystemSource, githubSource],
});
 
const result = await indexer.run();
console.log(`${result.indexed} Dokumente indexiert in ${result.duration_s}s`);

import { createSearchStore } from '@processcube-io/qmd-search';
 
const store = await createSearchStore({
  dbPath: './data/index.sqlite',
});
 
const result = await store.search('installation', { limit: 10 });
 
for (const hit of result.results) {
  console.log(`[${hit.collection}] ${hit.title} — ${hit.path}`);
}

// app/api/search/route.ts
import { createSearchStore } from '@processcube-io/qmd-search';
import { createNextHandler } from '@processcube-io/qmd-search/adapters/nextjs';
 
const store = await createSearchStore({ dbPath: './data/index.sqlite' });
export const GET = createNextHandler(store);

import { createSearchStore } from '@processcube-io/qmd-search';
import { startServer } from '@processcube-io/qmd-search/adapters/standalone';
 
const store = await createSearchStore({ dbPath: './data/index.sqlite' });
await startServer(store, { port: 3001 });
 
// GET /api/search?q=...    — Suche
// GET /api/collections     — Collections auflisten
// GET /health              — Health-Check

const store = await createSearchStore({
  dbPath: './data/index.sqlite',
  searchMode: 'hybrid',
  embedProvider: {
    provider: 'voyage',
    apiKey: process.env.VOYAGE_API_KEY,
    domainContext: 'eine technische Dokumentation ueber Kubernetes und Docker',
  },
});