Use Cases & Examples
Every project listed here lives under examples/ in the KalamDB repository. You can clone the repo, or let an installed kalam CLI download an example into your own project directory with kalam init --template <example-id>.
For Rust SDK examples, see Rust SDK — Examples. For SDK setup, see TypeScript SDK or Rust SDK.
Before you run an example
To start from the CLI without cloning the repo:
To run from a cloned checkout, open an example folder:
kalam dev starts the local server, applies the checked-in migration/schema, regenerates TypeScript artifacts when configured, and runs app or worker processes from [dev.processes].
Example catalog
| Example | What you’ll learn | Docs |
|---|---|---|
| Live OKF Context Sync | One SQL table + FILE column + sync worker: mirror an OKF Markdown folder to KalamDB with live pull and local watch push | Live OKF Context Sync |
| Realtime Ops Feed | queryAll(), live(), and browser auth in one React app | Realtime Ops Feed |
| Chat With AI | User messages, topic-driven agent worker, live chat UI | Chat With AI |
| React AI Chat | Full chat UI with @kalamdb/react, approvals, and file attachments | React AI Chat |
| Summarizer Agent | Topic consumer that enriches rows and handles failures | Summarizer Agent |
Repository paths
| Example | Path |
|---|---|
| Live OKF context sync | examples/live-okf-context-sync/ |
| Realtime ops feed | examples/simple-typescript/ |
| Chat with AI | examples/chat-with-ai/ |
| React AI chat | examples/react-ai-chat/ |
| Summarizer agent | examples/summarizer-agent/ |
Which example should I pick?
- Google Open Knowledge Format (OKF) folder sync for agents? Live OKF Context Sync
- Smallest browser app? Realtime Ops Feed
- AI chat with a worker? Chat With AI
- Full React chat with approvals? React AI Chat
- Worker-only topic enrichment? Summarizer Agent
Last updated on