Skip to Content
KnowledgeSDKInstallation

Installation

🚧

Coming Soon — Das KnowledgeSDK befindet sich in aktiver Entwicklung. Die NPM-Pakete, Docker-Images und die Single-Binary werden in Kuerze ueber den ProcessCube Marketplace veroeffentlicht.

Voraussetzungen

  • Node.js >= 22 (LTS empfohlen)
  • SQLite wird als native Dependency (better-sqlite3) automatisch mitinstalliert
  • Fuer Hybrid-Suche: API-Key eines Embedding-Providers (OpenAI oder Voyage AI)

NPM-Pakete

Das KnowledgeSDK besteht aus zwei Paketen:

PaketBeschreibung
@processcube-io/knowledge-sdkCore-SDK: Indexer, Store, Adapter, MCP, Auth, CLI
@processcube-io/knowledge-sdk-uiReact-Suchkomponente (SearchDialog)

Core-SDK installieren

npm install @processcube-io/knowledge-sdk

UI-Komponente installieren (optional)

npm install @processcube-io/knowledge-sdk-ui

Registry-Konfiguration

Die Pakete werden ueber den ProcessCube Marktplatz veroeffentlicht. Die vollstaendige Anleitung zur .npmrc-Konfiguration finden Sie unter NPM-Registry.

Kurzform:

# .npmrc
@processcube-io:registry=https://marketplace.processcube.io/npm/
//marketplace.processcube.io/npm/:_authToken=DEIN_API_KEY

Docker-Images

Fuer den Standalone-Betrieb ohne eigene Anwendung stehen zwei Docker-Images bereit:

ImageBeschreibung
knowledge-sdk-serverSuch-Server mit REST-API und optionalem MCP-Endpoint
knowledge-sdk-indexerIndexer zum Erstellen/Aktualisieren des Such-Index
docker pull marketplace.processcube.io/processcube-io/knowledge-sdk-server
docker pull marketplace.processcube.io/processcube-io/knowledge-sdk-indexer

Die vollstaendige Docker-Dokumentation mit Kubernetes-Manifesten finden Sie unter Deployment.

Single-Binary

Das KnowledgeSDK kann als Single-Binary ohne Node.js oder Docker betrieben werden (kompiliert mit Bun).

curl -fsSL https://marketplace.processcube.io/knowledge-sdk/install | bash

Unterstuetzte Plattformen: macOS arm64, Linux x64, Windows x64.

⚠️

Known Issue — Die Single-Binary wird zwar gebaut und veroeffentlicht, startet aber aktuell nicht aufgrund einer Inkompatibilitaet zwischen Bun und better-sqlite3 (nativer Node.js C++ Addon, ABI Mismatch). Siehe oven-sh/bun#16050 . Nutze stattdessen die Docker-Images oder die NPM-Pakete.

Details zur Single-Binary finden Sie unter Deployment.

Schnellstart

Nach der Installation kann in wenigen Schritten ein Such-Index erstellt und abgefragt werden:

import { createIndexer, createSearchStore, filesystemSource } from '@processcube-io/knowledge-sdk';
 
// 1. Index erstellen
const indexer = createIndexer({
  dbPath: './data/index.sqlite',
  collections: [
    {
      name: 'docs',
      path: './content',
      pattern: '**/*.md',
      context: 'Projekt-Dokumentation',
      group: 'Allgemein',
    },
  ],
  plugins: [filesystemSource],
});
 
await indexer.run();
 
// 2. Suche ausfuehren
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}`);
}

Naechste Schritte

ÜbersichtGetting Started