tabularis

<div align="center"> <img src="public/logo-sm.png" width="120" height="120" /> </div> # tabularis <p align="center">    [](https://snyk.io//test/github/debba/tabularis?targetFile=package.json) [](https://discord.gg/YrZPHAwMSG) [](https://gitster.dev/repo/debba/tabularis) </p> <p align="center"> <a href="https://snapcraft.io/tabularis"><img src="https://img.shields.io/badge/snap-tabularis-blue?logo=snapcraft" alt="Snap Store" /></a> <a href="https://aur.archlinux.org/packages/tabularis-bin"><img src="https://img.shields.io/badge/AUR-tabularis--bin-1793D1?logo=archlinux&logoColor=white" alt="AUR" /></a> <a href="https://winstall.app/apps/Debba.Tabularis"><img src="https://img.shields.io/winget/v/Debba.Tabularis?label=WinGet&logo=windows&color=0078D4" alt="WinGet" /></a> </p> A lightweight, developer-focused database management tool, built with Tauri and React. **Available in:** English, Italian, Spanish **Discord** - [Join our discord server](https://discord.gg/YrZPHAwMSG) and chat with the maintainers. <div align="center"> <img src="website/public/img/overview.png?v" width="80%" alt="Tabularis" /> </div> ## Release Download: [](https://github.com/debba/tabularis/releases/download/v0.9.6/tabularis_0.9.6_x64-setup.exe) [](https://github.com/debba/tabularis/releases/download/v0.9.6/tabularis_0.9.6_x64.dmg) [](https://github.com/debba/tabularis/releases/download/v0.9.6/tabularis_0.9.6_amd64.AppImage) ## Table of Contents - [Installation](#installation) - [Windows](#windows) - [macOS](#macos) - [Linux (Snap)](#linux-snap) - [Linux (AppImage)](#linux-appimage) - [Arch Linux (AUR)](#arch-linux-aur) - [Updates](#updates) - [Gallery](#gallery) - [Discord](#discord) - [Changelog](#changelog) - [Features](#features) - [Connection Management](#connection-management) - [Database Explorer](#database-explorer) - [SQL Editor](#sql-editor) - [Keyboard Shortcuts](#keyboard-shortcuts) - [Visual Query Builder](#visual-query-builder) - [Data Grid](#data-grid) - [Logging](#logging) - [Plugin System](#plugin-system) - [Configuration Storage](#configuration-storage) - [AI Features (Optional)](#ai-features-optional) - [Tech Stack](#tech-stack) - [Development](#development) - [Roadmap](#roadmap) - [License](#license) ## Installation ### Windows #### WinGet (Recommended) ```bash winget install Debba.Tabularis ``` #### Direct Download Download the installer from the [Releases page](https://github.com/debba/tabularis/releases) and run it: ``` tabularis_x.x.x_x64-setup.exe ``` Follow the on-screen instructions to complete the installation. ### macOS #### Homebrew (Recommended) To add our tap, run: ```bash brew tap debba/tabularis ``` Then install: ```bash brew install --cask tabularis ``` [](https://github.com/debba/homebrew-tabularis) #### Direct Download When you install tabularis on macOS, you need to allow accessibility access (Privacy & Security) to the tabularis app. If you are upgrading and you already have tabularis on the allowed list you will need to manually remove them before accessibility access can be granted to the new version. macOS users who download directly from releases may need to run: ```bash xattr -c /Applications/tabularis.app ``` after copying the app to the Applications directory. ### Linux (Snap) ```bash sudo snap install tabularis ``` [](https://snapcraft.io/tabularis) ### Linux (AppImage) Download the `.AppImage` file from the [Releases page](https://github.com/debba/tabularis/releases), make it executable and run it: ```bash chmod +x tabularis_x.x.x_amd64.AppImage ./tabularis_x.x.x_amd64.AppImage ``` ### Arch Linux (AUR) ```bash yay -S tabularis-bin ``` ## Updates ### Automatic Updates Tabularis checks for updates automatically on startup. When a new version is available, a notification will appear, allowing you to download and install the update seamlessly. ### Manual Updates You can also manually check for updates or download the latest version directly from the [Releases page](https://github.com/debba/tabularis/releases). ## Gallery **View the full gallery at [tabularis.dev](https://tabularis.dev)** ## Discord Join our [Discord server](https://discord.gg/YrZPHAwMSG) to chat with the maintainers, suggest features, or get help from the community. ## [Changelog](./CHANGELOG.md) ## Features ### Connection Management > [Full reference on tabularis.dev →](https://tabularis.dev/wiki/connections) - Support for **MySQL/MariaDB**, **PostgreSQL** (with multi-schema support) and **SQLite**. - **Multi-Database Selection:** Select multiple MySQL/MariaDB databases in a single connection — each appears as its own collapsible node in the sidebar. - Save, manage, and clone connection profiles with secure local persistence. - **Redesigned Connections Page:** Grid and list view modes, real-time search, branded driver icons (PostgreSQL elephant, MySQL dolphin, SQLite cylinder) in their official colors. - **Open in Editor:** Right-click any connection in the sidebar to open it directly in the editor via context menu. - Manage **SSH Connections** from the connection manager. - Optional secure password storage in system **Keychain**. - **SSH Tunneling** with automatic readiness detection. ### Database Explorer > [Full reference on tabularis.dev →](https://tabularis.dev/wiki/schema-management) - **Tree View:** Browse tables, columns, keys, foreign keys, indexes, views, and stored routines. - **Inline Editing:** Edit table and column properties directly from the sidebar. - **ER Diagram:** Interactive Entity-Relationship visualization (Pan, Zoom, Layout) with selective table diagram generation. - **Context Actions:** Show data, count rows, modify schema, duplicate/delete tables. - **Views Support:** Browse, inspect, and query database views with full metadata. - **Stored Routines:** View and manage stored procedures and functions with parameter details. - **Fast Metadata:** Parallel fetching for schema loading. - **SQL Dump & Import:** Export and restore databases with a single flow. ### SQL Editor > [Full reference on tabularis.dev →](https://tabularis.dev/wiki/editor) - **Monaco Editor:** Syntax highlighting and auto-completion. - **Tabbed Interface:** Isolated connections per tab. - **Split View:** Open multiple database connections side-by-side in a resizable split-pane layout. - **Execution:** Run full scripts, selections, or specific statements. - **Saved Queries:** Persist frequently used SQL. - **AI Assist Overlay:** AI assistance buttons accessible as a floating overlay directly in the editor. ### Keyboard Shortcuts > [Full reference on tabularis.dev →](https://tabularis.dev/wiki/keyboard-shortcuts) - **Built-in shortcuts** for navigation, editor, and data grid actions (e.g. `Ctrl+B` to toggle sidebar, `Ctrl+T` for a new tab, `Ctrl+→/←` to paginate results). - **Fully customizable:** Remap any non-locked shortcut from **Settings → Keyboard Shortcuts** — press the combo to record it, click ↺ to reset. - **Platform-aware:** Uses `Cmd` on macOS and `Ctrl` on Windows/Linux throughout. - **Visual hints:** Hold `Ctrl+Shift` in the sidebar to reveal numbered badges (1–9) for instant connection switching. - **Persistent overrides:** Saved to `keybindings.json` in the app config directory; can also be edited manually. ### Visual Query Builder > [Full reference on tabularis.dev →](https://tabularis.dev/wiki/visual-query-builder) - **Drag-and-Drop:** Build queries visually with ReactFlow. - **Visual JOINs:** Connect tables to create relationships. - **Advanced Logic:** WHERE/HAVING filters, aggregates (COUNT, SUM, AVG), sorting, and limits. - **Real-time SQL:** Instant code generation. ### Data Grid > [Full reference on tabularis.dev →](https://tabularis.dev/wiki/data-grid) - **Inline & Batch Editing:** Modify cells and commit multiple changes at once. - **Row Management:** Create, delete, and select multiple rows. - **Copy Selected Rows:** Export selections straight to the clipboard. - **Export:** Save results as CSV or JSON. - **Smart Context:** Read-only mode for aggregates, edit mode for tables. - **Spatial Data Support:** Initial GEOMETRY support for MySQL with raw SQL function inputs for spatial data. ### Plugin System > [Full reference on tabularis.dev →](https://tabularis.dev/wiki/plugins) Tabularis supports extending its database support via an **external plugin system**. Plugins are standalone executables that communicate with the app over **JSON-RPC 2.0 via stdin/stdout**, and can be written in any language. - **Install Plugins:** Browse and install community drivers from **Settings → Available Plugins** — no restart required. - **Manage Drivers:** View all registered drivers (built-in and plugins) in **Settings → Installed Drivers** and uninstall plugins with one click. - **Any Database:** Add support for DuckDB, MongoDB, or any other database by writing or installing a plugin. - **Plugin Registry:** Official plugins are listed in [`plugins/registry.json`](./plugins/registry.json). - **Developer Guide:** See [`plugins/PLUGIN_GUIDE.md`](./plugins/PLUGIN_GUIDE.md) to build your own driver in any language. ### Logging - **Real-time Monitoring:** View application logs directly in Settings. - **Level Filtering:** Filter by DEBUG, INFO, WARN, or ERROR severity. - **In-memory Buffer:** Configurable retention. - **Query Expansion:** Automatically expand and inspect SQL queries in logs. - **Export Logs:** Save logs to `.log` files for debugging or audit trails. - **Toggle Control:** Enable/disable logging and adjust buffer size without restart. - **CLI Debug Mode:** Start with `tabularis --debug` to enable verbose logging (including internal SQLx queries) from launch. ### Configuration Storage Configuration is stored in `~/.config/tabularis/` (Linux), `~/Library/Application Support/tabularis/` (macOS), or `%APPDATA%\tabularis\` (Windows). - `connections.json`: Connection profiles. - `saved_queries.json`: Saved SQL queries. - `config.json`: App settings (theme, language, page size). - `themes/`: Custom themes. - `preferences/`: Editor preferences per connection (tabs, queries, layout). #### Editor Preferences Tabularis automatically saves your editor state for each database connection. When you reopen a connection, you'll see your previously opened tabs with their queries restored. **Location:** `~/.config/tabularis/preferences/{connectionId}/preferences.json` **What is saved:** - Tab titles and types (Console, Table, Visual Query) - SQL queries and query parameters - Active table and selected columns - Filter, sort, and limit clauses - Visual Query Builder flow state - Editor visibility state **What is NOT saved:** - Query results (you'll need to re-run queries) - Error messages - Execution times - Pending edits or deletions - Loading states This approach ensures fast startup times while preserving your workspace layout across sessions. #### `config.json` options - `theme`: Theme ID (e.g., `"tabularis-dark"`, `"monokai"`). - `fontFamily`: Editor font family. - `fontSize`: Editor font size (px). - `language`: `"auto"`, `"en"` (English), `"it"` (Italian), `"es"` (Spanish). - `resultPageSize`: Default rows per page. - `aiEnabled`: Enable/Disable AI features. - `customRegistryUrl`: Custom URL for the plugin registry (overrides the default official registry). #### Custom AI Models override You can override or add custom models for AI providers by editing `config.json` and adding the `aiCustomModels` object: ```json { "resultPageSize": 1000, "language": "en", "aiEnabled": true, "aiProvider": "openai", "aiCustomModels": { "openai": ["gpt-4o", "gpt-4-turbo", "gpt-3.5-turbo", "gpt-5-preview"], "anthropic": ["claude-3-opus-20240229", "claude-3-sonnet-20240229"], "openrouter": ["google/gemini-pro-1.5", "meta-llama/llama-3-70b-instruct"] } } ``` ### AI Features (Optional) Optional Text-to-SQL and query explanation powered by: - **OpenAI** - **Anthropic** - **OpenRouter** (access to Gemini, Llama, DeepSeek, etc.) - **Ollama** (Local LLM support for total privacy) - **OpenAI-Compatible APIs** (Groq, Perplexity, Azure OpenAI, LocalAI, and more) #### Local AI (Ollama) Select "Ollama" as your provider in Settings. Tabularis will automatically detect your local models running on port `11434` (configurable). No API key required. #### OpenAI-Compatible APIs Select "OpenAI Compatible" as your provider to connect to any service that implements the OpenAI API format. Configure your custom endpoint URL and model name in Settings. Examples: - **Groq**: `https://api.groq.com/openai/v1` - **Perplexity**: `https://api.perplexity.ai` - **Local servers**: `http://localhost:8000/v1` #### Dynamic Model Fetching Tabularis automatically fetches the latest available models from your configured provider. - **Refresh:** Click the refresh icon in Settings to update the model list from the API. - **Cache:** Model lists are cached locally for 24h to ensure fast startup. - **Validation:** Visual feedback if the selected model is not available for the current provider. Includes a built-in **MCP Server** (`tabularis --mcp`) to expose connections to external agents (Claude Desktop, Cursor). ## Tech Stack - **Frontend:** React 19, TypeScript, Tailwind CSS v4. - **Backend:** Rust, Tauri v2, SQLx. ## Development ### Setup ```bash npm install npm run tauri dev ``` ### Build ```bash npm run tauri build ``` ## Roadmap - [x] [Plugin System](https://github.com/debba/tabularis/issues/19) - [ ] [[Feat]: Allow loading of multiple Databases per connection](https://github.com/debba/tabularis/issues/47) - [ ] [Feature: Remote Control](https://github.com/debba/tabularis/issues/46) - [ ] [Command Palette](https://github.com/debba/tabularis/issues/25) - [ ] [JSON/JSONB Editor & Viewer](https://github.com/debba/tabularis/issues/24) - [ ] [SQL Formatting / Prettier](https://github.com/debba/tabularis/issues/23) - [ ] [Visual Explain Analyze](https://github.com/debba/tabularis/issues/22) - [ ] [Data Compare / Diff Tool](https://github.com/debba/tabularis/issues/21) - [ ] [Team Collaboration](https://github.com/debba/tabularis/issues/20) - [ ] [Query History](https://github.com/debba/tabularis/issues/18) - [ ] [Better SQLite Support](https://github.com/debba/tabularis/issues/17) - [ ] [Better PostgreSQL Support](https://github.com/debba/tabularis/issues/16) ## License Apache License 2.0