Documentation

Getting started

Install a prebuilt release, or build TableR from source for development.

Get started in 4 steps
  1. Download the installer marked Recommended for your OS.
  2. Install and launch TableR.
  3. Create a connection — or bootstrap a local database — from the launcher.
  4. Open a query tab (Ctrl + N) and run your first statement (Ctrl + Enter).

There are two ways to get TableR: install a prebuilt release (fastest, recommended for most people) or build it from source (for contributors and anyone who wants the latest development branch). Both are covered below.

Install a release

Prebuilt installers are available for Windows, macOS, and Linux. Downloads redirect straight to the official GitHub release assets.

  1. 1
    Download

    Open the Download page and pick the option marked Recommended for your operating system.

  2. 2
    Install

    Windows: run the setup .exe or .msi. macOS: open the .dmg and drag TableR to Applications. Linux: use the AppImage, .deb, or .rpm.

  3. 3
    Launch

    Open TableR and create your first connection, or start a local database from the launcher.

macOS: unsigned build

Move TableR to Applications, try to open it once, then choose Open Anyway in System Settings → Privacy & Security. If Gatekeeper still blocks it, run the command below and open it again. This does not mean the app is Apple-notarized.

xattr -dr com.apple.quarantine /Applications/TableR.app

System requirements

TableR is a native desktop app built on Tauri 2, so it reuses your operating system's web runtime and stays small and fast.

  • Windows 10 or 11 (64-bit). The WebView2 runtime is required and is already present on Windows 11.
  • macOS 11 Big Sur or newer, on both Apple Silicon and Intel.
  • A modern 64-bit Linux distribution with WebKitGTK (pulled in automatically by the .deb and .rpm packages).
  • About 200 MB of free disk space, plus extra room for any local databases you create.

Create your first connection

The connection launcher is the first screen you see. Open a saved workspace, or start a new connection to any of the 18 supported engines.

  1. 1
    Choose an engine

    Pick a card in the launcher. Each one shows whether it supports remote connections, file databases, or a local bootstrap.

  2. 2
    Enter details

    Provide host, port, and credentials, paste a full connection string, or select a database file where supported.

  3. 3
    Connect and save

    Test the connection, then save the profile so it reappears in the launcher the next time you open TableR.

No server? Bootstrap one locally

TableR can start a local PostgreSQL, MySQL, MariaDB, or SQLite database straight from the launcher, so you can begin querying without installing a separate server. Connection secrets are always kept in the OS keyring.

See Connections & databases for the full engine list and every connection option.

Run your first query

  1. Open a new query tab with Ctrl + N.
  2. Type SQL in the Monaco editor; autocomplete and schema hints appear as you type (Ctrl + Space forces suggestions).
  3. Press Ctrl + Enter to run the statement under the cursor.
  4. Read the results grid — sort, filter, and page through rows, or switch to the chart view.
  5. Export the result set to CSV, JSON, Excel, or SQL when you want to share it.

Explore and visualize

Beyond running SQL, TableR ships a searchable schema explorer, interactive ER diagrams, metrics boards, and query-plan visualization, so you can understand a database rather than just query it. See Exploring data and Visualize for the details.

Ask the built-in AI assistant

A database-aware assistant sits beside the editor with Prompt, Edit, and Agent modes. It reads your schema for context, accepts file attachments, and always shows the generated SQL for review before anything runs. See AI agent for provider setup.

Troubleshooting first launch

  1. 1
    Windows SmartScreen

    If Defender SmartScreen warns about an unrecognized app, choose More info, then Run anyway. The installers are not code-signed yet.

  2. 2
    macOS Gatekeeper

    Use Open Anyway in System Settings, Privacy & Security, or run the quarantine command shown above.

  3. 3
    Linux AppImage

    Mark the download as executable before you run it:

chmod +x TableR-*.AppImage
./TableR-*.AppImage

Update TableR

To update, download the newest release from the Download page and install it over the current version. Saved connections live in the OS keyring and your preferences are stored locally, so they carry across updates.

Build from source

The Tauri development command starts Vite, builds the Rust backend, and opens the desktop application with hot reload.

git clone https://github.com/minhe51805/TabLer.git
cd TabLer
npm install
npm run tauri -- dev

Prerequisites

  • Node.js 18 or newer
  • npm
  • Rust (stable toolchain)
  • Platform dependencies required by Tauri 2

Useful commands

CommandPurpose
npm run devStart the frontend development server
npm run tauri -- devRun the complete desktop application
npm run typecheckType-check TypeScript without emitting files
npm run test:runRun the Vitest suite once
npm run buildType-check and build the frontend
npm run tauri -- buildCreate platform-specific desktop bundles
cd website && npm run devStart this public product website
Before you contribute

Run the quality gate before submitting a change:

npm run typecheck
npm run test:run
npm run build

Next steps