Skip to content

Getting started

Installation

How to install KiteDB in your project

KiteDB ships packages for JavaScript/TypeScript (native N-API bindings), Rust, and Python. The language you pick here also sets the language of every code sample in the docs.

Install

Language
bun add @kitedb/core
npm install @kitedb/core

Requirements

  • JavaScript/TypeScript: Bun 1.0+ or Node.js 16+
  • Rust: Stable Rust toolchain. Add the crate with --no-default-features (or default-features = false in Cargo.toml): the default napi feature compiles the Node.js binding layer, which Rust programs don't use.
  • Python: Python 3.9 to 3.13 (prebuilt wheels for Linux x86_64/aarch64, macOS arm64, and Windows x64)

Verify the installation

Save this as a test file. It opens a database with a one-type schema and closes it again.

test.ts
import { kite } from '@kitedb/core';// Open database with a simple schemaconst db = await kite('./test.kitedb', {  nodes: [    {      name: 'user',      props: { name: { type: 'string' } },    },  ],  edges: [],});console.log('KiteDB is working!');db.close();

Run it:

bun run test.ts# ornpx tsx test.ts

Next steps

The quick start walks through a schema, a few inserts, and your first traversal.