CLI Reference

The DeltaBase CLI provides commands for local development and infrastructure deployment.

Installation

npm

npm install -g @delta-base/cli

pnpm

pnpm add -g @delta-base/cli

yarn

yarn global add @delta-base/cli

Or use without installing:

npm

npx @delta-base/cli <command>

pnpm

pnpx @delta-base/cli <command>

bun

bunx @delta-base/cli <command>

---

Commands

Command	Description
deltabase dev	Start local development environment
deltabase deploy	Deploy infrastructure from config file
deltabase --help	Show all available commands
deltabase --version	Show CLI version

---

Quick Start

Local Development

Start a local DeltaBase environment with one command:

pnpx @delta-base/cli dev

This starts:

• API Server at http://localhost:8787
• Studio UI at http://localhost:3000

Deploy Infrastructure

Deploy event stores and subscriptions from a config file:

pnpx @delta-base/cli deploy --api-key your-api-key

---

Environment Variables

The CLI respects these environment variables:

Variable	Description
DELTABASE_API_KEY	API key for authentication
DELTABASE_API_URL	API URL (defaults to https://api.delta-base.com)

Using environment variables:

export DELTABASE_API_KEY=your-api-key
pnpx @delta-base/cli deploy

---

Configuration File

The CLI uses deltabase.config.ts for infrastructure definitions:

import type { InfrastructureConfig as DeltaBaseConfig } from '@delta-base/server';

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

export default config;

Learn more: Infrastructure as Code Guide

---

What’s Next?

• dev command - Local development details
• deploy command - Deployment options
• Infrastructure as Code - Configuration guide