Deltabase CLI

A command-line tool for running Deltabase Event Store applications. Built on top of the Deltabase Platform Core, it provides a simple way to get started with event-driven applications.

Installation

npm install -g @delta-base/cli
# or
pnpm add -g @delta-base/cli

Quick Start

Start the development server in any directory:

deltabase dev

Your Deltabase Event Store will be running at http://localhost:8787 with automatic hot reloading.

What You Get

The CLI provides:

• Event Store API - Ready-to-use event sourcing endpoints
• Web UI - Built-in management interface via Deltabase Studio
• Local Development - Hot reloading with Wrangler
• Production Ready - Optimized for Cloudflare Workers deployment

Project Structure

When working with Deltabase projects:

your-project/
├── package.json        # Dependencies and scripts
├── wrangler.jsonc      # Cloudflare Workers configuration
└── src/
    └── index.ts        # Main application entry point

Key Features

🚀 Zero Configuration

Get started immediately with sensible defaults for event sourcing applications.

🔄 Automatic Version Management

Always uses the latest compatible versions of Deltabase packages.

🛠️ Development Mode

Built-in development server with hot reloading and error reporting.

☁️ Cloudflare Workers Ready

Pre-configured for deployment to Cloudflare Workers.

Commands

• deltabase dev - Start development server
• deltabase deploy - Deploy infrastructure from configuration file
• deltabase --help - Show all available commands

Infrastructure as Code

DeltaBase supports Infrastructure as Code (IaC) through TypeScript configuration files. Define your event stores and subscriptions declaratively and deploy them with a single command.

Quick Start with IaC

1. Create a deltabase.config.ts file in your project:

import type { DeltaBaseConfig } from '@delta-base/cli';

const config: DeltaBaseConfig = {
  eventStores: [
    {
      name: 'my-events',
      description: 'My application events',
      subscriptions: [
        {
          id: 'webhook',
          eventFilter: 'user.*',
          subscriberType: 'webhook',
          webhook: {
            url: 'https://api.example.com/webhooks/events',
          },
        },
      ],
    },
  ],
};

export default config;

2. Deploy your infrastructure:

deltabase deploy --api-key your-api-key

For detailed documentation on Infrastructure as Code, see INFRASTRUCTURE_AS_CODE.md.

Requirements

• Node.js 18 or later

Documentation

For detailed documentation, visit the Deltabase Documentation.