Getting Started

Installation

Install the SinterDB server and Node.js driver, then start a local database server for development.

Requirements

SinterDB currently requires Node.js 24 or newer.

Install the server

The SinterDB server CLI is distributed as @sinterdb/cli. It provides the sinterd command.

npm install --global @sinterdb/cli

pnpm add --global @sinterdb/cli

bun add --global @sinterdb/cli

yarn global add @sinterdb/cli

yarn dlx @sinterdb/cli

Start the server

Start SinterDB with a local data directory:

sinterd --data-dir ./sinterdb-data

Using --data-dir enables durable storage so your data survives server restarts. Without it, the server runs entirely in memory.

Install the Node.js driver

In your application project, install the official SinterDB driver:

npm install sinterdb

pnpm add sinterdb

bun add sinterdb

yarn add sinterdb