Installation

Install the package

GraphDB is published as @graphdb/core on npm. Install it with your preferred package manager:

# Bun (recommended)
bun add @graphdb/core

# npm
npm install @graphdb/core

# pnpm
pnpm add @graphdb/core

The @graphdb/types package is included as a dependency of @graphdb/core — you don’t need to install it separately.

import { GraphDB } from '@graphdb/core';

const { GraphDB } = require('@graphdb/core');

If you need just the types (e.g., for interfaces in a separate file):

import type { Doc, Collection, Where, QueryOptions } from '@graphdb/core';

All types from @graphdb/types are re-exported from @graphdb/core, so you never need to import from @graphdb/types directly.

Runtime	Minimum Version
Bun	1.x+
Node.js	18+

GraphDB uses crypto.randomUUID() for ID generation, which requires Node.js 18 or later. Bun supports this natively.

GraphDB ships dual CJS/ESM builds with TypeScript declaration files. Your bundler will automatically resolve the correct format.

Head to the Quick Start to create your first database and collection.