Skip to Content
KnowledgeSDKInstallation

Installation

🚧

Coming Soon — Das KnowledgeSDK befindet sich in aktiver Entwicklung. Die NPM-Pakete und Docker-Images werden in Kuerze ueber den ProcessCube Marketplace veroeffentlicht. Fuer die lokale Nutzung ohne Node.js ist das SDK bereits Teil der ProcessCube CLI (pc knowledge).

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.

Lokale Nutzung: ProcessCube CLI

Fuer den lokalen Betrieb ohne Node.js oder Docker gibt es keine eigene KnowledgeSDK-Binary mehr — das SDK ist Teil der ProcessCube CLI und wird ueber pc knowledge bedient.

# CLI installieren (Linux / macOS)
curl -fsSL https://marketplace.processcube.io/cli/install | bash
 
# Index anlegen, Quelle registrieren, indizieren
pc knowledge init
pc knowledge add-source filesystem ./docs
pc knowledge index
 
# Suchen bzw. Such-Server (REST + MCP) starten
pc knowledge search "deployment" --limit 5
pc knowledge serve --rerank

Das pc-Binary deckt FTS5 + bm25 (ueber bun:sqlite) und optionales LLM-Reranking ab. Der Vektor-Hybrid (sqlite-vec) laeuft nur unter Node.js — dafuer die Docker-Images oder die NPM-Pakete nutzen.

Details zur Installation der CLI: CLI-Installation. Alle Befehle und Setup-Varianten: Knowledge-Befehle.

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