Getting Started //Quickstart Guide
Docs/Getting Started/Quickstart Guide

Quickstart Guide

Get up and running with OpenBoard in under 10 seconds with zero configuration.
3 min read
Last updated: 2026-08-17

Instant Launch via npx

The fastest way to use OpenBoard is via npx. No installation, configuration, or sign-up is required:

bash
npx openboard-app start

This command automatically:

  1. Initializes your local SQLite database at ~/.openboard/openboard.db if it doesn't already exist.
  2. Spawns the lightweight local HTTP and Server-Sent Events (SSE) server on http://localhost:4747.
  3. Opens the OpenBoard dark-mode workspace in your default browser.

Global CLI Installation

If you use OpenBoard daily for system architecture, whiteboard sketching, or AI pair programming, install it globally:

bash
npm install -g openboard-app

Once installed, use the short CLI command anywhere on your machine:

bash
# Start workspace server and open browser
openboard start

# Run in background daemon mode on custom port
openboard start --port 4747

# Start stdio Model Context Protocol server for AI Agents
openboard mcp

Local SQLite Storage Location

OpenBoard guarantees complete data sovereignty. All whiteboards, canvas documents, shapes, text, arrows, frames, and revision histories are stored on your local disk:

  • Database Path: ~/.openboard/openboard.db
  • Zero Cloud Sync: No external database calls, telemetry pings, or cloud servers.
  • Easy Backups: Simply copy ~/.openboard/openboard.db to backup your entire canvas library or commit it to your private dotfiles.

Accessing the Browser Workspace

Once the server is running, visit http://localhost:4747 in your browser:

  • Responsive Canvas: Ultra-smooth panning, infinite zoom, and high-performance vector rendering powered by tldraw.
  • Twenty-Inspired Dark Theme: Deep charcoal surfaces (#0c0d10), electric blue accents (#2563eb), and high legibility.
  • Live Agent Synchronization: Watch external AI coding agents (Claude Code, Cursor, Codex) create and modify shapes in real time over SSE streams.
Was this page helpful?
Edit this page on GitHub

© 2026 OpenBoard. 100% Free & MIT Licensed.

Database: ~/.openboard/openboard.db