User Guide
Verql is a fast, cross-platform desktop database client. You connect to your databases, browse their structure, write and run SQL, visualise results, and move data in and out — all from one app. It runs on macOS, Linux, and Windows, and it’s open source (MIT, by Arshad Shah).
Out of the box, Verql speaks PostgreSQL, MySQL, and SQLite, with MongoDB, Redis, and Snowflake added by bundled plugins. It includes a SQL editor with autocomplete, an interactive results grid, ER diagrams, charts, import/export tools, and a built-in AI assistant — and it can be extended further with plugins.
This guide is for people using Verql to work with databases. If you want to build a plugin or contribute to Verql itself, see the developer docs in the
docs/folder instead.
Contents
Section titled “Contents”| Page | What it covers |
|---|---|
| Installation | Installing on macOS, Linux, and Windows; verifying your download; auto-updates. |
| Connecting to a database | Creating connection profiles, supported databases, SSH tunnels, and how your credentials are kept safe. |
| Running queries | The SQL editor, autocomplete, the results grid, transactions, and the command palette. |
| Exploring your schema | The schema browser, ER diagrams, table previews, the inspector, and charts. |
| Importing & exporting data | Moving data in and out as CSV, JSON, SQL, and JSON-Lines. |
| The AI assistant | Using OpenAI, Anthropic, or Ollama, tool-call approvals, and the built-in MCP server. |
| Managing plugins | What plugins are, how to enable/disable and install/uninstall them, and staying safe. |
| Keeping Verql updated | Update channels and how Homebrew upgrades work. |
| Troubleshooting | Common problems and how to report a bug. |
A quick tour
Section titled “A quick tour”When Verql opens you’ll see a three-panel workspace: a sidebar for your connections and schema, a central tabbed area for editors and table views, and context panels for details, charts, and the AI assistant.
A typical first session looks like:
- Install Verql for your platform.
- Create a connection to your database.
- Browse the schema to see what’s there.
- Open a query tab and run some SQL.
- Export the results — or ask the AI assistant for help.
Getting help
Section titled “Getting help”- Browse the rest of this guide using the table above.
- Hit a problem? Start with Troubleshooting.
- Found a bug or have a feature request? Open an issue at github.com/arshad-shah/verql/issues.