sqlite-dashboard

library0.2.1jsnpmunverified

A web-based SQLite viewer and editor for self-hosting, loosely modeled after the Supabase dashboard. v0.2.1 (current stable) allows pointing at one or more SQLite files to get a browser UI with a table browser, data grid, inline editing, schema viewer, SQL editor, and REST API. Requires Node.js. Ships as plain HTML/CSS/JS with no build step. Supports password protection via environment variable. Alternative to commercial tools like TablePlus or Adminer for SQLite, designed for lightweight self-hosted deployments.

database

npm install sqlite-dashboard

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · SQLITE-DASHBOARD

sqlite-dashboard

databasejavascriptv0.2.1

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

createDashboard

✓ import { createDashboard } from 'sqlite-dashboard'

✗ const createDashboard = require('sqlite-dashboard')

Package supports both ESM and CJS. This import starts the server.

createApp

✓ import { createApp } from 'sqlite-dashboard'

Returns Express app without starting server, useful for testing.

Start the dashboard by scanning a directory for SQLite files on port 3000.

const { createDashboard } = require('sqlite-dashboard'); createDashboard({ directory: './data', port: 3000, host: '127.0.0.1', }); console.log('Dashboard running at http://127.0.0.1:3000');

Debug

Known issues

breakingThe `name` property in database config with `--name` flag is applied to databases; if not specified, the filename (without extension) is used as name.

fix

When using the CLI, always provide a --name for each .db file to avoid confusion.

affects: >=0.1.0

gotchaThe server binds to 127.0.0.1 (localhost) only by default. To access from other devices, set host to '0.0.0.0'.

fix

Add host: '0.0.0.0' to config or pass --host 0.0.0.0 in CLI.

affects: >=0.1.0

gotchaEnvironment variable SQLITE_DASHBOARD_PASSWORD is read at startup; changing it requires restart.

fix

Restart the server after changing the password environment variable.

affects: >=0.1.0

Errors

Common errors & fixes

Error: Cannot find module 'better-sqlite3'

Missing optional dependency better-sqlite3 (not auto-installed).

fix

npm install better-sqlite3

Error: listen EADDRINUSE :::3000

Port 3000 is already in use by another process.

fix

Use a different port via --port or config.port.

Upgrade

Version history

0.2.1latest on npm

Audit

Dependencies

better-sqlite3requiredSQLite database driver for Node.js

expressrequiredHTTP server framework

Agent activity

20 hits · last 30 days

node