Skip to main content

Installation

Getting started with RushDB SDK is straightforward. This section will guide you through installing the SDK and setting up your first SDK instance.

Step 1: Install the Package​

To begin, you need to add the RushDB SDK to your project.

TypeScript / JavaScript​

Using npm:

npm install @rushdb/javascript-sdk

Using yarn:

yarn add @rushdb/javascript-sdk

Using pnpm:

pnpm add @rushdb/javascript-sdk

The RushDB SDK is lightweight, coming in at just 6.9KB gzipped. Learn more about the package size here.

Python​

pip install rushdb

Step 2: Initialize the SDK​

Once the package is installed, you can create an instance of the RushDB SDK in your project.

TypeScript / JavaScript​

import RushDB from '@rushdb/javascript-sdk';

const db = new RushDB('API_TOKEN');

Python​

from rushdb import RushDB

db = RushDB("API_TOKEN")

Replace API_TOKEN with your actual API token, which you can obtain from the RushDB Dashboard.

Next steps​

To make full use of the SDK, you'll need a valid API token. In the next section, Configuring RushDB Dashboard, we'll guide you through the process of registering on the dashboard, creating a project, and generating your API token.