deltabase dev

Start a local DeltaBase development environment with hot reloading.

Usage

deltabase dev [options]

Or without global installation:

pnpx @delta-base/cli dev

---

What It Starts

Running deltabase dev starts two services:

Service	URL	Description
API Server	http://localhost:8787	DeltaBase event store API
Studio UI	http://localhost:3000	Visual management interface

---

Output

┌────────────────────────────────────────────────────────────────────────────┐
│                                                                            │
│  ┌──────────────────────────────────────────────────────────────────────┐  │
│  │██████╗ ███████╗██╗  ████████╗ █████╗ ██████╗  █████╗ ███████╗███████╗│  │
│  │██╔══██╗██╔════╝██║  ╚══██╔══╝██╔══██╗██╔══██╗██╔══██╗██╔════╝██╔════╝│  │
│  │██║  ██║█████╗  ██║     ██║   ███████║██████╔╝███████║███████╗█████╗  │  │
│  │██║  ██║██╔══╝  ██║     ██║   ██╔══██║██╔══██╗██╔══██║╚════██║██╔══╝  │  │
│  │██████╔╝███████╗███████╗██║   ██║  ██║██████╔╝██║  ██║███████║███████╗│  │
│  │╚═════╝ ╚══════╝╚══════╝╚═╝   ╚═╝  ╚═╝╚═════╝ ╚═╝  ╚═╝╚══════╝╚══════╝│  │
│  └──────────────────────────────────────────────────────────────────────┘  │
│                                                                            │
│  Deltabase development environment is ready!                               │
│                                                                            │
│  API Server: http://localhost:8787                                         │
│  Studio UI:  http://localhost:3000                                         │
│                                                                            │
└────────────────────────────────────────────────────────────────────────────┘

---

Features

Local Event Store

The local environment provides a fully functional event store:

• Create and manage event stores
• Append and read events
• WebSocket subscriptions
• All API endpoints

Studio UI

Visual interface for development:

• Browse event stores
• View streams and events
• Inspect event payloads
• Monitor subscriptions

Hot Reloading

Changes to your code are automatically detected and the server reloads.

SQLite Storage

Events are stored in a local SQLite database. Data persists between restarts.

---

Using with Your Application

Connect Your App

Point your application to the local API:

import { DeltaBase } from '@delta-base/server';

const deltabase = new DeltaBase({
  baseUrl: 'http://localhost:8787',  // Local development
  // No API key needed for local dev
});

const eventStore = deltabase.getEventStore('my-events');

Create Event Stores

Create event stores via the SDK:

const management = deltabase.getManagementClient();

await management.createEventStore({
  name: 'my-events',
  description: 'Development event store',
});

Or via the Studio UI at http://localhost:3000.

---

Development Workflow

1. Start DeltaBase:

   pnpx @delta-base/cli dev

2. Create an event store via Studio or SDK

3. Run your application pointing to localhost:8787

4. View events in Studio at localhost:3000

5. Iterate - changes auto-reload

---

Differences from Production

Feature	Local Dev	Production
Authentication	None required	API key required
Storage	SQLite	Cloudflare Durable Objects
URL	localhost:8787	api.delta-base.com
Webhooks	Local only	Public URLs required

---

Troubleshooting

Port Already in Use

If port 8787 or 3000 is in use:

# Find and kill the process using the port
lsof -i :8787
kill -9 <PID>

Connection Refused

Ensure DeltaBase is running:

pnpx @delta-base/cli dev

Check that your app is pointing to http://localhost:8787.

---

What’s Next?

• Local Development Guide - Full walkthrough
• deploy command - Deploy to production
• Studio - Studio UI details