Up and running.

Download one SDK file. Give it a home in your Node project. Start building.

Check your environment

Requirement	Current profile
Windows	Windows 10 version 1903+ or Windows 11, x64; compatible Windows Server releases
Node.js	20+ or a compatible runtime packaged with your application; Windows CI uses Node.js 24
Filesystem	A private writable location with access controls, normally NTFS
Network	No external database service is required; the engine binds to local loopback

Release candidate

Automated validation ran on Windows Server 2022. Clean Windows Home/Pro PCs and packaged Electron apps remain additional validation work.

Try the starter

Download the Windows starter ZIP from the Download page and extract it. Open a terminal in the folder containing BsonLite.cjs and index.js.

node index.js

The starter connects the database and starts a local HTTP server. Open http://127.0.0.1:3000/health to see health status and the database port. Press Ctrl+C to stop the app and database. Startup does not create sample records.

No npm install for the SDK

The validated CJS already includes its required JavaScript dependencies and custom Windows engine. Your own application may have additional dependencies.

Add it to your project

Copy BsonLite.cjs into your project, then call connect once from the application entry point. Import the same file from other modules after the connection is ready.

const BsonLite = require('./BsonLite.cjs');

async function main() {
  await BsonLite.connect('myapp');
  // Launch the application after the database is ready.
}
main().catch(console.error);

Using ES modules

import BsonLite from './BsonLite.cjs';

await BsonLite.connect('myapp');
const users = BsonLite.collection('users');

// On application shutdown:
await BsonLite.disconnect();

The .cjs SDK supports CommonJS require and an ES-module default import. Use the validated downloadable native artifact; a source-preview build intentionally has no embedded engine.

Documentation for BsonLite 0.6.0-rc.1. View SDK source · Download the validated SDK