Skip to main content
Get started with RuloDB by installing the SDK in your TypeScript/JavaScript project.
SDKs for other languages will be available once the query language is stabilized.

​
Package Installation

npm install @rulodb/rulodb

​
Verify Installation

Create a test file to verify the connection: 
import { Client, r } from '@rulodb/rulodb';

async function testConnection() {
  const client = new Client();

  try {
    await client.connect();
    console.log('✅ Connected to RuloDB');

    await r.dbCreate('test').run(client);
    console.log('✅ Database created');

    const result = await r.dbList().run(client);
    console.table('Databases:', await result.toArray());

    await r.dbDrop('test').run(client);
    console.log('✅ Database "test" dropped');

    await client.disconnect();
  } catch (error) {
    console.error('❌ Validation failed:', error);
  }
}

testConnection();

​
Configuration

Configure the client with connection options: 
const client = new Client({
  host: process.env.RULODB_HOST || 'localhost',
  port: parseInt(process.env.RULODB_PORT) || 6090,
  timeout: 30000,
  retries: 3,
  poolSize: 10
});
Found a typo? Or maybe a broken link? RuloDB is open-source, help us fix it!