Package Exports

resplite
resplite/embed
resplite/migration

Readme

RESPLite

A RESP2 server with practical Redis compatibility, backed by SQLite for persistent single-node workloads.

Overview

RESPLite is not a full Redis clone. It is a RESP server with Redis-like semantics for a carefully selected subset of commands that map naturally to SQLite. Ideal for small to medium applications, persistent caches, local development, and low-ops deployments.

Zero external services — just Node.js and a SQLite file.
Drop-in compatible — works with the official redis npm client and redis-cli.
Persistent by default — data survives restarts without snapshots or AOF.
Embeddable — start the server and connect from the same script (see examples below).

Install

npm install resplite

Quick start (standalone server)

npm start

By default the server listens on port 6379 and stores data in data.db in the current directory.

redis-cli -p 6379
> PING
PONG
> SET foo bar
OK
> GET foo
"bar"

Standalone server script (fixed port)

Run this as a persistent background process (node server.js). RESPLite will listen on port 6380 and stay up until the process is killed.

// server.js
import { createRESPlite } from 'resplite/embed';

const srv = await createRESPlite({ port: 6380, db: './data.db' });
console.log(`RESPLite listening on ${srv.host}:${srv.port}`);

Then connect from any other script or process:

redis-cli -p 6380 PING

Environment variables

Variable	Default	Description
`RESPLITE_PORT`	`6379`	Server port
`RESPLITE_DB`	`./data.db`	SQLite database file
`RESPLITE_PRAGMA_TEMPLATE`	`default`	SQLite PRAGMA preset (see below)

PRAGMA templates

Template	Description	Key settings
`default`	Balanced durability and speed (recommended)	WAL, synchronous=NORMAL, 20 MB cache
`performance`	Maximum throughput, reduced crash safety	WAL, synchronous=OFF, 64 MB cache, 512 MB mmap, exclusive locking
`safety`	Crash-safe writes at the cost of speed	WAL, synchronous=FULL, 20 MB cache
`minimal`	Only WAL + foreign keys	WAL, foreign_keys=ON
`none`	No pragmas applied — pure SQLite defaults	—

Programmatic usage (embedded)

RESPLite can be started and consumed entirely within a single Node.js script — no separate process needed. This is exactly how the test suite works.

Minimal example

import { createClient } from 'redis';
import { createRESPlite } from 'resplite/embed';

const srv = await createRESPlite({ db: './my-app.db' });
const client = createClient({ socket: { port: srv.port, host: '127.0.0.1' } });
await client.connect();

await client.set('hello', 'world');
console.log(await client.get('hello'));  // → "world"

await client.quit();
await srv.close();

Strings, TTL, and key operations

// SET with expiration
await client.set('session:abc', JSON.stringify({ user: 'alice' }));
await client.expire('session:abc', 3600);      // expire in 1 hour
console.log(await client.ttl('session:abc'));  // → 3600 (approx)

// Atomic counters
await client.set('visits', '0');
await client.incr('visits');
await client.incrBy('visits', 10);
console.log(await client.get('visits'));       // → "11"

// Multi-key operations
await client.mSet(['k1', 'v1', 'k2', 'v2']);
const values = await client.mGet(['k1', 'k2', 'missing']);
console.log(values);  // → ["v1", "v2", null]

// Key existence and deletion
console.log(await client.exists('k1'));        // → 1
await client.del('k1');
console.log(await client.exists('k1'));        // → 0

Hashes

await client.hSet('user:1', { name: 'Martin', age: '42', city: 'BCN' });

console.log(await client.hGet('user:1', 'name'));     // → "Martin"

const user = await client.hGetAll('user:1');
console.log(user);  // → { name: "Martin", age: "42", city: "BCN" }

await client.hIncrBy('user:1', 'age', 1);
console.log(await client.hGet('user:1', 'age'));      // → "43"

console.log(await client.hExists('user:1', 'email')); // → false

Sets

await client.sAdd('tags', ['node', 'sqlite', 'redis']);
console.log(await client.sMembers('tags'));           // → ["node", "sqlite", "redis"]
console.log(await client.sIsMember('tags', 'node'));  // → true
console.log(await client.sCard('tags'));              // → 3

await client.sRem('tags', 'redis');
console.log(await client.sCard('tags'));              // → 2

Lists

await client.lPush('queue', ['c', 'b', 'a']);      // push left: a, b, c
await client.rPush('queue', ['d', 'e']);           // push right: d, e

console.log(await client.lLen('queue'));           // → 5
console.log(await client.lRange('queue', 0, -1));  // → ["a", "b", "c", "d", "e"]
console.log(await client.lIndex('queue', 0));      // → "a"

console.log(await client.lPop('queue'));           // → "a"
console.log(await client.rPop('queue'));           // → "e"

Blocking list commands (BLPOP / BRPOP)

BLPOP and BRPOP block until an element is available or a timeout (seconds) is reached. Use them for simple queues or coordination between producers and consumers.

// Consumer: block up to 10 seconds for an element from "tasks" or "fallback"
const result = await client.blPop(['tasks', 'fallback'], 10);
// result is { key: 'tasks', element: 'item1' } or null on timeout

// Producer (e.g. another client or process)
await client.rPush('tasks', 'item1');

Timeout: 0 = block indefinitely; > 0 = block up to that many seconds.
Return: { key, element } on success, or null on timeout.
Multi-key: Keys are checked in order; the first key that has an element wins. One push wakes at most one blocked client (FIFO per key).

Sorted sets

await client.zAdd('leaderboard', [
  { score: 100, value: 'alice' },
  { score: 250, value: 'bob' },
  { score: 175, value: 'carol' },
]);

console.log(await client.zCard('leaderboard'));                // → 3
console.log(await client.zScore('leaderboard', 'bob'));        // → 250
console.log(await client.zRange('leaderboard', 0, -1));        // → ["alice", "carol", "bob"]
console.log(await client.zRangeByScore('leaderboard', 100, 200)); // → ["alice", "carol"]

Full-text search (RediSearch-like)

// Create an index
await client.sendCommand(['FT.CREATE', 'articles', 'SCHEMA', 'payload', 'TEXT']);

// Add documents
await client.sendCommand([
  'FT.ADD', 'articles', 'doc:1', '1', 'REPLACE', 'FIELDS',
  'payload', 'Introduction to SQLite full-text search'
]);
await client.sendCommand([
  'FT.ADD', 'articles', 'doc:2', '1', 'REPLACE', 'FIELDS',
  'payload', 'Building a Redis-compatible server in Node.js'
]);

// Search
const results = await client.sendCommand([
  'FT.SEARCH', 'articles', 'SQLite', 'NOCONTENT', 'LIMIT', '0', '10'
]);
console.log(results);  // → [1, "doc:1"]  (count + matching doc IDs)

// Autocomplete suggestions
await client.sendCommand(['FT.SUGADD', 'articles', 'sqlite full-text', '10']);
await client.sendCommand(['FT.SUGADD', 'articles', 'sqlite indexing', '5']);
const suggestions = await client.sendCommand(['FT.SUGGET', 'articles', 'sqlite']);
console.log(suggestions);  // → ["sqlite full-text", "sqlite indexing"]

Introspection and admin

// Scan keys (cursor-based)
const scanResult = await client.scan(0);
console.log(scanResult);  // → { cursor: 0, keys: [...] }

// Key type
console.log(await client.type('user:1'));  // → "hash"

// Admin commands (via sendCommand)
const sqliteInfo = await client.sendCommand(['SQLITE.INFO']);
const cacheInfo  = await client.sendCommand(['CACHE.INFO']);
const memInfo    = await client.sendCommand(['MEMORY.INFO']);

Data persists across restarts

import { createClient } from 'redis';
import { createRESPlite } from 'resplite/embed';

const DB_PATH = './persistent.db';

// --- First session: write data ---
const srv1 = await createRESPlite({ db: DB_PATH });
const c1 = createClient({ socket: { port: srv1.port, host: '127.0.0.1' } });
await c1.connect();
await c1.set('persistent_key', 'survives restart');
await c1.hSet('user:1', { name: 'Alice' });
await c1.quit();
await srv1.close();

// --- Second session: data is still there ---
const srv2 = await createRESPlite({ db: DB_PATH });
const c2 = createClient({ socket: { port: srv2.port, host: '127.0.0.1' } });
await c2.connect();
console.log(await c2.get('persistent_key'));     // → "survives restart"
console.log(await c2.hGet('user:1', 'name'));    // → "Alice"
await c2.quit();
await srv2.close();

Compatibility matrix

Supported (v1)

Category	Commands
Connection	PING, ECHO, QUIT
Strings	GET, SET, MGET, MSET, DEL, EXISTS, INCR, DECR, INCRBY, DECRBY
TTL	EXPIRE, PEXPIRE, TTL, PTTL, PERSIST
Hashes	HSET, HGET, HMGET, HGETALL, HDEL, HEXISTS, HINCRBY
Sets	SADD, SREM, SMEMBERS, SISMEMBER, SCARD
Lists	LPUSH, RPUSH, LLEN, LRANGE, LINDEX, LPOP, RPOP, BLPOP, BRPOP
Sorted sets	ZADD, ZREM, ZCARD, ZSCORE, ZRANGE, ZRANGEBYSCORE
*Search (FT.)**	FT.CREATE, FT.INFO, FT.ADD, FT.DEL, FT.SEARCH, FT.SUGADD, FT.SUGGET, FT.SUGDEL
Introspection	TYPE, SCAN
Admin	SQLITE.INFO, CACHE.INFO, MEMORY.INFO
Tooling	Redis import CLI (see Migration from Redis)

Not supported (v1)

Pub/Sub (SUBSCRIBE, PUBLISH, etc.)
Streams (XADD, XRANGE, etc.)
Lua (EVAL, EVALSHA)
Transactions (MULTI, EXEC, WATCH)
BRPOPLPUSH, BLMOVE (blocking list moves)
SELECT (multiple logical DBs)

Unsupported commands return: ERR command not supported yet.

Migration from Redis

Migration supports two modes:

Simple one-shot import (legacy)

For small datasets or when downtime is acceptable:

# Default: redis://127.0.0.1:6379 → ./data.db
npm run import-from-redis -- --db ./migrated.db

# Custom Redis URL
npm run import-from-redis -- --db ./migrated.db --redis-url redis://127.0.0.1:6379

# Or host/port
npm run import-from-redis -- --db ./migrated.db --host 127.0.0.1 --port 6379

# Optional: PRAGMA template for the target DB
npm run import-from-redis -- --db ./migrated.db --pragma-template performance

Redis with authentication

Migration supports Redis instances protected by a password. Use a Redis URL that includes the password (or username and password for Redis 6+ ACL):

Password only: redis://:PASSWORD@host:port
Username and password: redis://username:PASSWORD@host:port

Examples:

# One-shot import from authenticated Redis
npm run import-from-redis -- --db ./migrated.db --redis-url "redis://:mysecret@127.0.0.1:6379"

# SPEC_F flow: use --from with the full URL (or set RESPLITE_IMPORT_FROM)
npx resplite-import preflight --from "redis://:mysecret@10.0.0.10:6379" --to ./resplite.db
npx resplite-dirty-tracker start --run-id run_001 --from "redis://:mysecret@10.0.0.10:6379" --to ./resplite.db

For one-shot import, authentication is only available when using --redis-url; the --host / --port options do not support a password.

Minimal-downtime migration (SPEC_F)

For large datasets (~30 GB), use the Dirty Key Registry flow so the bulk of the migration runs online and only a short cutover is needed.

Enable keyspace notifications in Redis (required for the dirty-key tracker). Either run at runtime:

redis-cli CONFIG SET notify-keyspace-events KEA

Or add to redis.conf and restart Redis:

notify-keyspace-events KEA

(K = keyspace prefix, E = keyevent prefix, A = all event types — lets the tracker see every key change and expiration.)

Renamed CONFIG command? Some Redis deployments rename CONFIG for security. Pass --config-command <name> to the CLI tools, or the configCommand option to the JS API — see below.

Preflight – Check Redis, key count, type distribution, and that keyspace notifications are enabled:
```
npx resplite-import preflight --from redis://10.0.0.10:6379 --to ./resplite.db
```

Start dirty-key tracker – Captures keys modified during bulk (requires notify-keyspace-events in Redis):

npx resplite-dirty-tracker start --run-id run_001 --from redis://10.0.0.10:6379 --to ./resplite.db
# If CONFIG was renamed:
npx resplite-dirty-tracker start --run-id run_001 --from redis://10.0.0.10:6379 --to ./resplite.db --config-command MYCONFIG

Bulk import – SCAN and copy all keys; progress is checkpointed and resumable:

npx resplite-import bulk --run-id run_001 --from redis://10.0.0.10:6379 --to ./resplite.db \
  --scan-count 1000 --max-rps 2000 --batch-keys 200 --batch-bytes 64MB --resume

Monitor – Check run and dirty-key counts:

npx resplite-import status --run-id run_001 --to ./resplite.db

Cutover – Freeze app writes to Redis, then apply remaining dirty keys:

npx resplite-import apply-dirty --run-id run_001 --from redis://10.0.0.10:6379 --to ./resplite.db

Stop tracker and switch – Stop the tracker and point clients to RespLite:
```
npx resplite-dirty-tracker stop --run-id run_001 --to ./resplite.db
```

Verify – Optional sampling check between Redis and destination:

npx resplite-import verify --run-id run_001 --from redis://10.0.0.10:6379 --to ./resplite.db --sample 0.5%

Then start RespLite with the migrated DB: RESPLITE_DB=./resplite.db npm start.

Programmatic migration API

As an alternative to the CLI, the full migration flow is available as a JavaScript API via resplite/migration. Useful for embedding the migration inside your own scripts or automation pipelines.

import { createMigration } from 'resplite/migration';

const m = createMigration({
  from:  'redis://127.0.0.1:6379',  // source Redis URL (default)
  to:    './resplite.db',           // destination SQLite DB path (required)
  runId: 'my-migration-1',          // unique run ID (required for bulk/status/applyDirty)

  // optional — same defaults as the CLI:
  scanCount:      1000,
  batchKeys:      200,
  batchBytes:     64 * 1024 * 1024,  // 64 MB
  maxRps:         0,                  // 0 = unlimited
  pragmaTemplate: 'default',

  // If your Redis deployment renamed CONFIG for security:
  // configCommand: 'MYCONFIG',
});

// Step 0 — Preflight: inspect Redis before starting
const info = await m.preflight();
console.log('keys (estimate):', info.keyCountEstimate);
console.log('type distribution:', info.typeDistribution);
console.log('notify-keyspace-events:', info.notifyKeyspaceEvents);
console.log('CONFIG available:', info.configCommandAvailable);  // false if renamed
console.log('recommended params:', info.recommended);

// Step 0b — Enable keyspace notifications (required for dirty-key tracking)
// Reads the current value and merges the new flags — existing flags are preserved.
const ks = await m.enableKeyspaceNotifications();
// → { ok: true, previous: '', applied: 'KEA' }
// If CONFIG is renamed and configCommand was not set, ok=false and error explains how to fix it.

// Step 1 — Bulk import (checkpointed, resumable)
await m.bulk({
  resume: false,                            // true to resume a previous run
  onProgress: (r) => console.log(
    `scanned=${r.scanned_keys} migrated=${r.migrated_keys} errors=${r.error_keys}`
  ),
});

// Check status at any point (synchronous, no Redis needed)
const { run, dirty } = m.status();
console.log('bulk status:', run.status, '— dirty counts:', dirty);

// Step 2 — Apply dirty keys that changed in Redis during bulk
await m.applyDirty();

// Step 3 — Verify a sample of keys match between Redis and the destination
const result = await m.verify({ samplePct: 0.5, maxSample: 10000 });
console.log(`verified ${result.sampled} keys — mismatches: ${result.mismatches.length}`);

// Disconnect Redis when done
await m.close();

The dirty-key tracker (to capture writes during bulk) still runs as a separate process via npx resplite-dirty-tracker. The API above handles everything else in a single script.

Renamed CONFIG command

If your Redis instance has the CONFIG command renamed (a common hardening practice), pass the new name to createMigration:

const m = createMigration({
  from: 'redis://10.0.0.10:6379',
  to:   './resplite.db',
  runId: 'run_001',
  configCommand: 'MYCONFIG',  // the renamed command
});

// preflight will use MYCONFIG GET notify-keyspace-events
const info = await m.preflight();
// info.configCommandAvailable → false if the name is wrong

// enableKeyspaceNotifications will use MYCONFIG SET notify-keyspace-events KEA
const result = await m.enableKeyspaceNotifications({ value: 'KEA' });

The same flag is available in the CLI:

npx resplite-dirty-tracker start --run-id run_001 --to ./resplite.db \
  --from redis://10.0.0.10:6379 --config-command MYCONFIG

Low-level re-exports

If you need more control, the individual functions and registry helpers are also exported:

import {
  runPreflight, runBulkImport, runApplyDirty, runVerify,
  getRun, getDirtyCounts, createRun, setRunStatus, logError,
} from 'resplite/migration';

Benchmark (Redis vs RESPLite)

Compare throughput of local Redis and RESPLite with the same workload (PING, SET/GET, hashes, sets, lists, zsets, etc.):

# Terminal 1: Redis on 6379 (default). Terminal 2: RESPLite on 6380
RESPLITE_PORT=6380 npm start

# Terminal 3: run benchmark (Redis=6379, RESPLite=6380 by default)
npm run benchmark

# Optional: custom iterations and ports
npm run benchmark -- --iterations 10000 --redis-port 6379 --resplite-port 6380

Scripts

Script	Description
`npm start`	Run the server
`npm test`	Run all tests
`npm run test:unit`	Unit tests
`npm run test:integration`	Integration tests
`npm run test:contract`	Contract tests (redis client)
`npm run test:stress`	Stress tests
`npm run benchmark`	Comparative benchmark Redis vs RESPLite
`npm run import-from-redis`	One-shot import from Redis into a SQLite DB
`npx resplite-import` (preflight, bulk, status, apply-dirty, verify)	Migration CLI (SPEC_F minimal-downtime flow)
`npx resplite-dirty-tracker <start\|stop>`	Dirty-key tracker for migration cutover

Specification

See SPEC.md for the full specification.