Are you an LLM? Read llms.txt for a summary of the docs, or llms-full.txt for the full context.
Skip to content

Getting Started

Get up and running with Postbase in under 5 minutes.

Prerequisites

Before installing Postbase, ensure you have:

  • Node.js 20 or later
  • pnpm 9 or later (recommended) or npm
  • Docker Desktop or Docker Engine
  • Git (for version control)

Installation

From npm (Recommended)

# Install globally
npm install -g postbase
 
# Or with pnpm
pnpm add -g postbase

From Source

# Clone the repository
git clone https://github.com/zeroexcore/postbase.git
cd postbase
 
# Install dependencies
pnpm install
 
# Build all packages
pnpm build
 
# Link CLI globally
pnpm --filter @postbase/cli link --global

Start the Daemon

The Postbase daemon manages your local PostgreSQL instance:

postbase start

This will:

  1. Start the Postbase API server on port 9432
  2. Pull and start a PostgreSQL Docker container
  3. Initialize the default database

Create Your First Database

# Create a new database
postbase db create myapp

Verify Installation

# Check daemon status
postbase status
 
# List databases
postbase db list
 
# Get connection details
postbase connect myapp

You should see output like:

Database: myapp
 
Connection Details:
  Host:     localhost
  Port:     5432
  Database: myapp
  User:     postgres
  Password: postgres
 
Connection String:
  postgresql://postgres:postgres@localhost:5432/myapp

Open the Admin UI

Start the Admin UI development server:

# From the postbase directory
pnpm --filter @postbase/ui dev

Then open http://localhost:3000 in your browser.

Next Steps