mirror of
https://github.com/Rohithgilla12/data-peek
synced 2026-04-21 12:57:16 +00:00
A minimal, fast, database client desktop application. Built for developers who want to quickly peek at their data without the bloat.
f9a58e76b5
* docs(plan): add docs site revamp design Root-causes the slow layout transitions on docs.datapeek.dev (Framer Motion 500ms fade, sidebar tree re-sent per nav, version lag) and plans phased fix: triage, version bumps, MDX brittleness, prerender, brand polish, follow-up distinctive design pass. * docs(plan): add docs site revamp implementation plan Phased tasks covering Framer Motion / tree-reload removal, version bumps (Fumadocs 16.7, TanStack 1.168), remark plugins for resilient MDX parsing, CI types:check gate, prerender, and typography polish. Validation checklist at the end. * perf(docs): remove page fade-in and move tree to parent route Framer Motion wrapper added a 500ms fade on every nav and the sidebar tree was re-sent and re-transformed per navigation. Move the tree to a new /docs parent layout route with staleTime:Infinity and drop the motion wrapper + CSS fade-in on main. Navigating /docs/* now feels instant. * chore(docs): bump fumadocs to 16.7 / 14.2 and switch to useContent fumadocs-ui/core 16.2.1 -> 16.7.x and fumadocs-mdx 14.0.4 -> 14.2.x. fumadocs-mdx 14.2 tightened ClientLoader typings so getComponent() returns FC<never> by default. Switch to clientLoader.useContent() which is the canonical Fumadocs-on-TanStack pattern anyway — cleaner and handles Suspense internally. * chore(docs): bump tanstack router/start to 1.168/1.167 Bumps @tanstack/react-router to ^1.168.10, @tanstack/react-start to ^1.167.16, and @tanstack/react-router-devtools to ^1.166.11. Catches ~34 minor versions of hydration, loader, scroll restoration, and routing fixes. No source changes required - existing createFileRoute, createServerFn, inputValidator, and createRouter APIs remain compatible. * fix(docs): harden MDX parsing and add types:check CI gate Add remark-gfm + remark-smartypants to fumadocs MDX config so prose containing numeric operators, comparisons, and angle brackets parses cleanly without author discipline. The workaround from |
||
|---|---|---|
| .github | ||
| apps | ||
| assets | ||
| docs | ||
| homebrew/Casks | ||
| notes | ||
| packages | ||
| plans | ||
| seeds | ||
| .gitignore | ||
| .impeccable.md | ||
| .npmrc | ||
| CLAUDE.md | ||
| CONTRIBUTING.md | ||
| install.ps1 | ||
| install.sh | ||
| LICENSE | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| turbo.json | ||
data-peek
A minimal, fast SQL client desktop application with AI-powered querying. Built for developers who want to quickly peek at their data without the bloat. Supports PostgreSQL, MySQL, Microsoft SQL Server, and SQLite.
Screenshots
AI Assistant - Generate charts and insights
AI Assistant - Natural language to SQL
ER Diagrams - Visualize relationships
Command Palette - Quick actions
Light Mode
Features
Core
- Fast - Opens in under 2 seconds, low memory footprint
- Multi-Database - PostgreSQL, MySQL, Microsoft SQL Server, SQLite
- SSH Tunnels - Connect securely through bastion hosts with password or key auth
- Secure - Connection credentials encrypted locally using OS keychain, no telemetry
AI Assistant
- Natural Language Queries - Ask questions in plain English, get SQL
- Multi-Provider - OpenAI, Anthropic, Google, Groq, and local Ollama models (BYOK)
- Charts & Insights - Generate visualizations and metrics from query results
- Schema-Aware - AI understands your database structure for accurate queries
Query Editor
- Monaco Editor - SQL syntax highlighting with smart autocomplete
- Table Aliases - Autocomplete understands aliases for complex queries
- Multi-tab & Multi-window - Work with multiple queries and databases simultaneously
- Saved Queries - Bookmark and organize queries with folders and tags
- Command Palette -
Cmd+Kto access everything instantly
Performance Analysis
- Query Telemetry - Detailed timing breakdown with waterfall visualization
- Benchmark Mode - Run queries multiple times, get p50/p90/p99 statistics
- EXPLAIN Viewer - Analyze query plans with interactive node breakdown
- Performance Indicator - Detect missing indexes, N+1 patterns, and slow queries with auto-generated fix suggestions
- Cancel Queries - Stop long-running queries mid-execution
Data Management
- Schema Explorer - Browse tables, views, stored procedures, and functions
- Inline Editing - Edit table data directly with INSERT/UPDATE/DELETE
- Table Designer - Create and alter tables with full DDL support (columns, indexes, constraints, partitions)
- JSON Editor - Dedicated editor for JSON/JSONB columns
- Export - Export results to CSV, JSON, or Excel
- CSV Import - Import CSV files with column mapping, type inference, and conflict handling
- Data Generator - Generate realistic fake data with Faker.js, FK-aware, in a dedicated tab
- Column Statistics - One-click data profiling per column (min/max/avg, histograms, top values)
- Data Masking - Blur sensitive columns for demos and screenshots with auto-mask rules
Visualization
- ERD Diagrams - See table relationships with interactive entity-relationship diagrams
- Foreign Key Navigation - Jump to related records with one click
Database Monitoring
- Connection Health Monitor - Dashboard with active queries, table sizes, cache hit ratios, and lock detection
- PostgreSQL Notifications - Subscribe to LISTEN/NOTIFY channels with real-time event log
- Kill Queries - Terminate long-running or blocking queries from the health dashboard
User Experience
- Dark/Light Mode - Easy on the eyes, follows system preference
- Keyboard-First - Power users shouldn't need a mouse
- Auto-Updates - Automatic updates with toast notifications
Installation
Quick Install
macOS and Linux
curl -fsSL https://install.cat/Rohithgilla12/data-peek | sh
The installer detects your platform, downloads the latest GitHub release, and installs:
- macOS: the matching
.dmg, copiesData Peek.app, and runsxattr -crautomatically - Linux: the latest
x86_64.AppImageinto~/.local/bin/data-peek
Windows PowerShell
irm https://install.cat/Rohithgilla12/data-peek | iex
The PowerShell installer downloads the latest setup.exe release and runs it for you.
Alternative Install Methods
macOS: Homebrew
brew install --cask Rohithgilla12/tap/data-peek
Download
Download the latest release for your platform from Releases.
- macOS:
.dmg(Intel & Apple Silicon) - Windows:
.exeinstaller - Linux:
.AppImage,.deb, or.tar.gz
macOS: Code Signing
Starting from v0.4.0, data-peek is code signed and notarized for macOS. You should be able to open it directly without any warnings.
If you install with the quick installer, it already runs the xattr cleanup for you.
If you're using an older version or a manual install and see an "App is damaged" warning:
Option 1: Terminal command
xattr -cr "/Applications/Data Peek.app"
Option 2: Right-click to open
- Right-click (or Control+click) on
Data Peek.app - Select "Open" from the menu
- Click "Open" in the dialog
Linux: Auto-Updates
Auto-updates only work with the AppImage format. If you installed via .deb or .tar.gz, you'll need to manually download new releases from the Releases page.
| Format | Auto-Update |
|---|---|
| AppImage | Yes |
| .deb | No (manual update) |
| .tar.gz | No (manual update) |
For the best experience with automatic updates, we recommend using the AppImage.
Build from Source
# Clone the repository
git clone https://github.com/Rohithgilla12/data-peek.git
cd data-peek
# Install dependencies
pnpm install
# Run in development mode
pnpm dev
# Build for your platform
pnpm build:mac # macOS
pnpm build:win # Windows
pnpm build:linux # Linux
Troubleshooting: Electron not found
If you get errors about Electron not being found after pnpm install:
# Option 1: Run the setup script
pnpm setup:electron
# Option 2: Rebuild native modules
pnpm rebuild
# Option 3: Clean install (nuclear option)
pnpm clean:install
This can happen when pnpm's cache skips Electron's postinstall script that downloads platform-specific binaries.
Tech Stack
| Layer | Technology |
|---|---|
| Desktop | Electron |
| Frontend | React 19 + TypeScript |
| UI | shadcn/ui + Tailwind CSS |
| State | Zustand |
| Query Editor | Monaco |
| Database | pg (PostgreSQL), mysql2 (MySQL), mssql (SQL Server), better-sqlite3 (SQLite) |
Project Structure
apps/
desktop/ # Electron desktop application
web/ # Marketing website + licensing
packages/
shared/ # Shared types for IPC
Development
# Install dependencies
pnpm install
# Start desktop app with hot reload
pnpm dev
# Start web app
pnpm dev:web
# Lint all workspaces
pnpm lint
# Build desktop app
pnpm build
Star History
Sponsors
Tembo — Goodbye Database Sprawl
License
MIT License - see LICENSE for details.
Pre-built binaries require a license for commercial use. See the license file for details on free vs. commercial use.
Contributing
Contributions are welcome! Please see CONTRIBUTING.md for guidelines.
Support
- GitHub Issues - Bug reports and feature requests
- GitHub Sponsors - Support development
- Twitter/X: @gillarohith
