Skip to content

JavaScript

Installation

In this section, you will learn how to install the JavaScript SDK in your project.

First, install the SurrealDB SDK using your favorite package manager:

bun install surrealdb
Note

The SurrealDB SDK for JavaScript is also available in the JSR registry as @surrealdb/surrealdb.

After installing the SDK as a dependency, you can import the SDK into your project. Depending on your setup and environment, we supported multiple options.

import { Surreal } from 'surrealdb';

After installing the SDK, check out the quick start guide to build your a simple application with the SDK. You can also learn more about carrying out common tasks with the SDK in the following sections:

Was this page helpful?