Installation

CongraphDB is distributed as an npm package with prebuilt native binaries for multiple platforms.

Requirements

• Node.js 20 or later
• npm or yarn package manager

Supported Platforms

Platform	Architecture	Status
Windows	x64	:white_check_mark: Supported
macOS	x64, arm64	:white_check_mark: Supported
Linux	x64, arm64	:white_check_mark: Supported

Install via npm

npm install congraphdb

Install via yarn

yarn add congraphdb

Verify Installation

Create a test file test.js:

const { Database } = require('congraphdb');

console.log('CongraphDB version:', Database.getVersion());

Run it:

node test.js

You should see the version number printed.

Next Steps

• Quick Start — Learn the basics with a simple example
• Schemas — Define your graph schema