A simple PostgreSQL database viewer tool. Perfect to quickly view and explore your PostgreSQL database through a web interface.
- 🔌 Connection Manager: Manage multiple database connections from a single UI
- 💾 Connection Persistence: Saved connections are restored when you reopen the app
- 🚀 Background Service: Runs as a daemon process for persistent access
- 🗂️ Table Browser: View all tables in your database in a clean, searchable sidebar
- 🔎 Spotlight Search: Quick table search with
Cmd+K/Ctrl+Kfor fast navigation - 📊 Data Viewer: Browse table rows with a modern, easy-to-read interface
- 🔢 Row Numbers: Row numbers displayed for easier navigation and reference
- 📋 Table Schema: View table structure and column definitions directly from the UI
- 📝 Cell Content Viewer: Double-click any cell to view full content in a popup
- 🎨 JSON/JSONB Formatting: Auto-formats JSON data with syntax highlighting
- 🕒 Timezone Support: View timestamps in local, UTC, or other timezones
- 📋 Clipboard Support: One-click copy for cell contents
- 🪟 Multiple Tabs: Open multiple tables simultaneously in separate tabs
- 🔄 Server-Side Sorting: Click column headers to sort data directly on the database server
- 📄 Pagination: Navigate through large tables with Previous/Next buttons
- 🔍 Table Search: Quickly find tables by name using the search bar
- 👁️ Column Visibility: Show or hide columns to focus on what matters
- 📏 Column Resizing: Resize columns by dragging the column borders
- 🎨 Theme Support: Choose between light, dark, or system theme
- ⚡ Optimized Performance: Uses cursor-based pagination for efficient large table navigation
- 🔒 SSL Support: Configurable SSL modes (Disable, Require, Prefer, Verify CA/Full)
- 🔄 Auto-Updates: Desktop app automatically checks for and installs updates
- 🚀 Easy Setup: Install globally and run with a single command
npm install -g pglensOr install locally in your project:
npm install pglensStart pglens as a background service:
pglens startThis will start the server on http://localhost:54321 (or the next available port if 54321 is busy).
The URL will be printed to the console. You can also check the running URL at any time with:
pglens url- Open
http://localhost:54321to see the All Connections landing page. - Click the Add Connection card or the + icon in the grid.
- Enter your connection details using one of the tabs:
- Parameters (Default): Enter Host, Port, Database, User, and Password separately.
- Connection URL: Paste a standard PostgreSQL connection string (e.g.,
postgresql://user:pass@localhost:5432/db).
- Select the SSL Mode appropriate for your server.
- Click Connect. The server will be added to your grid.
- Click the server card to open the Explorer.
To stop the b 9BA2 ackground service:
pglens stop- Start: Run
pglens startto launch the background service - Connect: Add one or more database connections via the Web UI
- Explore:
- Use the sidebar to browse tables across different connections
- Double-click cells to view detailed content
- Use the "Columns" menu to toggle visibility
- Switch themes for comfortable viewing
To develop or modify pglens:
# Clone the repository
git clone https://github.com/tsvillain/pglens.git
cd pglens
# Install dependencies
# Install dependencies
npm installTo run the application as a standalone desktop app during development:
npm run electron:startTo build the desktop application for your current platform:
npm run distTo build for specific platforms (requires supported environment):
npm run dist:mac # Build for macOS
npm run dist:win # Build for Windows
npm run dist:linux # Build for LinuxTo run the server locally in foreground:
node bin/pglens serveContributions are welcome! Please read our Contributing Guidelines for details on:
- How to set up your development environment
- Code style and guidelines
- Pull request process
- Issue reporting
This tool is designed for local development use. While it supports SSL for database connections, the web interface itself runs on HTTP (localhost) and has no user authentication. Do not expose the pglens port (54321) directly to the internet.
MIT