Skip to content

Latest commit

 

History

History

README.md

Examples

Runnable TypeScript examples for Huscarl. Each file is self-contained and demonstrates a specific use case.

Prerequisites

  • A running OpenViking server (see openviking.ai)
  • Huscarl installed: npm install @yfedberts/huscarl

Set your server URL and API key before running:

export OPENVIKING_URL=http://localhost:1933
export OPENVIKING_API_KEY=your-api-key

Running an example

npx tsx examples/01-quickstart.ts

Examples

File What it covers
01-quickstart.ts Connect, ingest a file, run a semantic search
02-rag-pipeline.ts Full session-based RAG loop with memory extraction
03-batch-ingestion.ts Ingest a directory, wait for processing, inspect results
04-multi-tenant.ts Create accounts, register users, scope per-user contexts