Docs · v0.21 · last updated today

The manual for data-peek.
Short sections. Real examples. No fluff.

Everything you need to install, connect, query, and configure data-peek across Postgres, MySQL, SQL Server, and SQLite. If a page is wrong or missing, the edit link goes straight to GitHub.

Start with the intro GitHub
01

Getting started

Install data-peek, connect your first database, and run a query.

  • Installation
  • First connection
  • Your first query
  • Keyboard basics
02

Features

Command palette, AI assist, inline editing, telemetry, ER diagrams, and more.

  • Command palette
  • AI assistant
  • Inline editing
  • Query telemetry
  • ER diagrams
03

Database support

Feature matrix and connection specifics for every supported engine.

  • PostgreSQL
  • MySQL
  • SQL Server
  • SQLite
04

Configuration

Themes, shortcuts, AI providers, SSH tunnels, and everything you can tune.

  • Settings
  • AI providers
  • SSH tunnels
  • Themes
  • Shortcuts
05

Reference

Quick-lookup guides. Keyboard shortcuts, CLI flags, file formats.

  • Keyboard shortcuts
Something off?

Docs live alongside the source. Open an issue, send a PR, or DM @gillarohith. Replies come from the person who wrote the code.

Open issueSource