vorDBeste

0.3.5 verified Mon Apr 27 auth: no javascript

vorDBeste (v0.3.5) is a natural language interface for PostgreSQL and MySQL databases that translates plain English questions into safe, read-only SQL queries. It uses AI providers like Anthropic, OpenRouter, or Ollama to generate SELECT and DESCRIBE statements, with a clarification step before execution to resolve ambiguity. The tool is designed for non-technical users and automatically documents schemas, queries, and insights as markdown files. It runs as a local web app (port 3456) and is read-only by design, with bounded results (limited to 100 rows per query). It is actively developed on GitHub and supports Node.js 18+.

Common errors

error Error: Cannot find module 'vordbeste' ↓

cause The package is not installed globally or locally.

fix

Run 'npm install -g vordbeste' to install it globally.

error Error: listen EADDRINUSE :::3456 ↓

cause Port 3456 is already in use by another process.

fix

Stop the other process or use a different port by setting the PORT environment variable (e.g., PORT=3457 vordbeste).

error Error: connect ECONNREFUSED 127.0.0.1:3306 ↓

cause MySQL database is not running or connection credentials are wrong.

fix

Ensure your MySQL server is running and the connection string in the setup page is correct.

error Error: AI provider request failed: 401 Unauthorized ↓

cause The API key for Anthropic or OpenRouter is invalid or missing.

fix

Re-enter your API key in the settings page. Make sure it's active and has credits.

Warnings

breaking Requires Node.js >=18.0.0. Older versions will fail at runtime. ↓

fix Upgrade Node.js to version 18 or later.

breaking Only PostgreSQL and MySQL databases are supported. Other databases (SQLite, MSSQL, etc.) will not connect. ↓

fix Use a compatible database or run the tool with a supported dialect.

gotcha The AI provider key (Anthropic, OpenRouter) is configured via the web UI and stored locally in ~/.vordbeste. If you move machines, you must reconfigure. ↓

fix Copy the ~/.vordbeste directory to the new machine, or re-enter keys in the setup page.

gotcha All queries are automatically limited to 100 rows. This may inadvertently restrict answers that require full datasets (e.g., aggregate counts across large tables). ↓

fix Use the 'LIMIT' command explicitly in your question if you need more rows, but the hard cap is 1000.

gotcha The tool does not execute write operations, but the AI may still generate unsafe SQL if misconfigured. Always review generated queries in the confirmation step. ↓

fix Keep the read-only mode enabled and do not grant database user write permissions.

Install

npm install vordbeste

yarn add vordbeste

pnpm add vordbeste

Imports

vordbeste
wrong
```
require('vordbeste')
```
correct
```
npx vordbeste
```
This package is a CLI tool, not a library. Run via npx or global install.
default
```
import vordbeste from 'vordbeste'
```
There is no programmatic API; the package only exports a CLI.

Quickstart

Install global CLI and launch web UI to interact with database via natural language.

npm install -g vordbeste && vordbeste
# Open http://localhost:3456 in your browser
# Follow the setup wizard to connect your database and AI provider
# Ask: "Show me the top 5 customers by total order amount"