Installation

How to install KiteDB in your project

KiteDB is available for JavaScript/TypeScript (via NAPI), Rust, and Python. Choose your preferred language below.

Install

$bun add @kitedb/core

$npm install @kitedb/core

Requirements

JavaScript/TypeScript: Bun 1.0+ or Node.js 16+
Rust: Stable Rust toolchain
Python: Python 3.9+

Verify Installation

Create a simple test file to verify the installation works:

test.ts

import { kite } from '@kitedb/core';

// Open database with a simple schema
const 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
# or
npx tsx test.ts

Next Steps

Now that KiteDB is installed, head to the Quick Start guide to build your first graph database.

./edit --remote