Skip to content

qubicDB/sdks

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

3 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QubicDB Official SDKs

Official client libraries for QubicDB — a brain-like recursive memory database for LLMs.

Available SDKs

SDK Package Registry Description
TypeScript qubicdb npm Full TypeScript client with types — recommended for all JS/TS projects
JavaScript qubicdb-js npm Zero-dependency vanilla JS client (ESM + CJS)
Python qubicdb PyPI Python client using httpx
Go github.com/qubicDB/qubicdb-go Go Modules Idiomatic Go client with context support

Framework-specific integrations are maintained in the main qubicdb repo under frameworks/.

Quick Start

TypeScript / JavaScript

import { QubicDBClient } from "qubicdb";

const db = new QubicDBClient({
  connectionString: "qubicdb://admin:secret@localhost:6060/my-app",
});

await db.write({ content: "User prefers dark mode" });
const results = await db.search({ query: "UI preferences", limit: 5 });

Python

from qubicdb import QubicDBClient

db = QubicDBClient(connection_string="qubicdb://admin:secret@localhost:6060/my-app")
db.write("User prefers dark mode")
results = db.search("UI preferences", limit=5)

Go

client := qubicdb.NewClient(qubicdb.Config{
    ConnectionString: "qubicdb://admin:secret@localhost:6060/my-app",
})
client.Write(ctx, qubicdb.WriteRequest{Content: "User prefers dark mode"})
results, _ := client.Search(ctx, qubicdb.SearchRequest{Query: "UI preferences", Limit: 5})

Connection String Format

qubicdb://[user:password@]host[:port]/[indexID]
qubicdb+tls://[user:password@]host[:port]/[indexID]   # TLS

Plain http:// / https:// URLs are also supported as a fallback.

MCP (Model Context Protocol)

If the server has MCP enabled (mcp.enabled: true), you can also call POST /mcp:

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/list",
  "params": {}
}

Running Examples

Each SDK has an examples/ directory. Copy .env.test.env and fill in your server details.

# TypeScript
cd typescript/examples && npm install && npm run basic

# JavaScript
cd javascript/examples && npm install && node basic.js

# Python
cd python/examples && pip install -r requirements.txt && python basic.py

# Go
cd golang/examples/basic && go run main.go

Publishing

  • npm: npm publish from typescript/ or javascript/
  • PyPI: python -m build && twine upload dist/* from python/
  • Go: Tag and push to github.com/qubicDB/qubicdb-go

Docs

Full API reference: github.com/qubicDB/docs

License

MIT


Developed by Deniz Umut Dereli

Releases

Packages

Contributors

Languages